diff --git a/.gitignore b/.gitignore index 8a59dac3..836a4ebb 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ build coverage dist node_modules +.vscode # Files *.log diff --git a/ESP32Support.exe b/ESP32Support.exe new file mode 100644 index 00000000..627cb72b Binary files /dev/null and b/ESP32Support.exe differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_add_board_manager_01.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_add_board_manager_01.png new file mode 100644 index 00000000..0721fb44 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_add_board_manager_01.png differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_add_board_manager_02.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_add_board_manager_02.png new file mode 100644 index 00000000..747e52ce Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_add_board_manager_02.png differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_bala_power_switch.jpg b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_bala_power_switch.jpg new file mode 100644 index 00000000..49865881 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_bala_power_switch.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_burn.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_burn.png new file mode 100644 index 00000000..0f74148f Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_burn.png differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_comment_out.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_comment_out.png new file mode 100644 index 00000000..ca1876b6 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_comment_out.png differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_files.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_files.png new file mode 100644 index 00000000..87ec3198 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_files.png differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_indicator.jpg b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_indicator.jpg new file mode 100644 index 00000000..c81bec16 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_indicator.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_newtab_01.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_newtab_01.png new file mode 100644 index 00000000..5aed55e4 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_newtab_01.png differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_newtab_02.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_newtab_02.png new file mode 100644 index 00000000..38b00e70 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_newtab_02.png differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_pogopin.jpg b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_pogopin.jpg new file mode 100644 index 00000000..70716a38 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_pogopin.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_power_switch.jpg b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_power_switch.jpg new file mode 100644 index 00000000..b99369fd Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_power_switch.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_search_esp32.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_search_esp32.png new file mode 100644 index 00000000..4df42dba Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_search_esp32.png differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_search_m5stack.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_search_m5stack.png new file mode 100644 index 00000000..33ccb6f3 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_search_m5stack.png differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_search_mpu6050_tockn.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_search_mpu6050_tockn.png new file mode 100644 index 00000000..f5af3eba Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_search_mpu6050_tockn.png differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_search_neopixelbus.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_search_neopixelbus.png new file mode 100644 index 00000000..5cd98925 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_search_neopixelbus.png differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_uiflow_01.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_uiflow_01.png new file mode 100644 index 00000000..37a1ded2 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_uiflow_01.png differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/download_esp32_support.gif b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/download_esp32_support.gif new file mode 100644 index 00000000..cda3afa0 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/download_esp32_support.gif differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib.gif b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib.gif new file mode 100644 index 00000000..a83a54e3 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/windows/install_m5stack_lib.gif differ diff --git a/docs/assets/img/product_pics/modules/lego+_01.jpg b/docs/assets/img/product_pics/modules/lego+_01.jpg new file mode 100644 index 00000000..14acefa1 Binary files /dev/null and b/docs/assets/img/product_pics/modules/lego+_01.jpg differ diff --git a/docs/assets/img/product_pics/modules/lego+_02.jpg b/docs/assets/img/product_pics/modules/lego+_02.jpg new file mode 100644 index 00000000..7b5c49fe Binary files /dev/null and b/docs/assets/img/product_pics/modules/lego+_02.jpg differ diff --git a/docs/assets/img/product_pics/modules/usb_01.jpg b/docs/assets/img/product_pics/modules/usb_01.jpg new file mode 100644 index 00000000..49cf522a Binary files /dev/null and b/docs/assets/img/product_pics/modules/usb_01.jpg differ diff --git a/docs/assets/img/product_pics/modules/usb_02.jpg b/docs/assets/img/product_pics/modules/usb_02.jpg new file mode 100644 index 00000000..e69d413e Binary files /dev/null and b/docs/assets/img/product_pics/modules/usb_02.jpg differ diff --git a/docs/en/api_reference.md b/docs/en/api_reference.md index 42ae2f42..a63cf29a 100644 --- a/docs/en/api_reference.md +++ b/docs/en/api_reference.md @@ -1,8 +1,12 @@ # API Reference -[中文](/zh_CN/api_reference) | English | [日本語](/ja/api_reference) +[中文](zh_CN/api_reference) | English | [日本語](ja/api_reference) -## [LCD](en/api_reference/api_lcd) +| MicroPython | Arduino | +|:------------|:--------| +|[LCD](en/api_reference/micropython/api_lcd) | / | + + diff --git a/docs/en/api_reference/api_lcd.md b/docs/en/api_reference/micropython/api_lcd.md similarity index 96% rename from docs/en/api_reference/api_lcd.md rename to docs/en/api_reference/micropython/api_lcd.md index 0ad4325b..2a15870f 100644 --- a/docs/en/api_reference/api_lcd.md +++ b/docs/en/api_reference/micropython/api_lcd.md @@ -1,6 +1,6 @@ # LCD -[中文](https://m5stack.github.io/m5-docs/#/zh_CN/api_reference/api_lcd) | English +[中文](/zh_CN/api_reference/micropython/api_lcd) | English | [日本語](/ja/api_reference/micropython/api_lcd) ### lcd.setRotation(degree) @@ -24,7 +24,7 @@ lcd.setRotation(90) **Example** ```python lcd.setColor(lcd.RED) -lcd.setColor(lcd.ORANGE, LCD.DARKCYAN) +lcd.setColor(lcd.ORANGE, lcd.DARKCYAN) ``` **Set the default foreground/background color of text.** diff --git a/docs/ja/api_reference/api_speaker.md b/docs/en/api_reference/micropython/api_speaker.md similarity index 65% rename from docs/ja/api_reference/api_speaker.md rename to docs/en/api_reference/micropython/api_speaker.md index 8936220a..9cbd5a38 100644 --- a/docs/ja/api_reference/api_speaker.md +++ b/docs/en/api_reference/micropython/api_speaker.md @@ -1,5 +1,7 @@ # Speaker +[中文](/zh_CN/api_reference/micropython/api_speaker) | English | [日本語](/ja/api_reference/micropython/api_speaker) + ### tone > M5.Speaker.tone(uint32_t freq); diff --git a/docs/ja/api_reference/peripherals/api_gpio.md b/docs/en/api_reference/micropython/peripherals/api_gpio.md similarity index 71% rename from docs/ja/api_reference/peripherals/api_gpio.md rename to docs/en/api_reference/micropython/peripherals/api_gpio.md index 76abbad3..33abe530 100644 --- a/docs/ja/api_reference/peripherals/api_gpio.md +++ b/docs/en/api_reference/micropython/peripherals/api_gpio.md @@ -1,5 +1,7 @@ # GPIO +[中文](/zh_CN/api_reference/micropython/peripherals/api_gpio) | English | [日本語](/ja/api_reference/micropython/peripherals/api_gpio) + *Refer to GPIO API of [Arduino](http://www.arduino.cc)* ### digitalRead diff --git a/docs/en/file_to_display_null.md b/docs/en/file_to_display_null.md deleted file mode 100644 index 266736c3..00000000 --- a/docs/en/file_to_display_null.md +++ /dev/null @@ -1 +0,0 @@ -### Coming soon... diff --git a/docs/en/product_documents.md b/docs/en/product_documents.md index 298765a9..d976b887 100644 --- a/docs/en/product_documents.md +++ b/docs/en/product_documents.md @@ -1,57 +1,29 @@ # Product Documents +[中文](zh_CN/product_documents) | English | [日本語](ja/product_documents) + +?> The `Quick Start` section of each product is placed in the corresponding product document. + -|M5Core | | | -|:---|:---|:---| -|[![](https://img-blog.csdnimg.cn/20181210155042186.jpg)](en/product_documents/m5stack-core/m5core_basic)|[![](https://img-blog.csdnimg.cn/20181210155059380.jpg)](en/product_documents/m5stack-core/m5core_gray)|[![](https://img-blog.csdnimg.cn/20181210155116910.jpg)](en/product_documents/m5stack-core/m5core_fire)| -|[BASIC](en/product_documents/m5stack-core/m5core_basic)|[GRAY](en/product_documents/m5stack-core/m5core_gray)|[FIRE](en/product_documents/m5stack-core/m5core_fire)| - -MiniCore | | | | ----|---|---|--- -[![](https://img-blog.csdnimg.cn/2018121015515360.jpg)](en/product_documents/m5stack-core/minicore_stick)|||| -[M5Stick]() - -|Kit | | -|:---|:---| -|[![](https://img-blog.csdnimg.cn/20181210155134684.png)](en/product_documents/m5stack-core/m5go_iot_starter_kit)|[![](https://img-blog.csdnimg.cn/20181210155938827.jpg)](en/product_documents/m5stack-core/face_kit)| -|[M5GO Starter Kit]()|[FACES Kit]()| - - - -|Communication Modules | | | | -|:---|:---|:---|:---| -|[![](https://img-blog.csdnimg.cn/20181210163322273.jpg)](en/product_documents/m5stack-core/m5core_basic)|[![](https://img-blog.csdnimg.cn/20181210163333682.jpg)](en/product_documents/m5stack-core/m5core_basic)|[![](https://img-blog.csdnimg.cn/20181210163345680.jpg)](en/product_documents/m5stack-core/m5core_basic)|[![](https://img-blog.csdnimg.cn/20181210163357400.jpg)](en/product_documents/m5stack-core/m5core_basic)|| -|[GPS]()|[LORA]()|[SIM800/GPRS/GSM]()|[COMMU]()| - -|Accessry Modules | | | -|:---|:---|:---| -|[![](https://img-blog.csdnimg.cn/20181210163430353.jpg)](en/product_documents/m5stack-core/minicore_stick)|[![](https://img-blog.csdnimg.cn/20181210163857125.jpg)](en/product_documents/m5stack-core/minicore_stick)||| -|[BATTERY]()|[PROTO]()| - -|Controlling Modules | | | -|:---|:---|:---| -|[![](https://img-blog.csdnimg.cn/20181210163555583.jpg)](en/product_documents/m5stack-core/minicore_stick)|[![](https://img-blog.csdnimg.cn/20181210163610300.jpg)](en/product_documents/m5stack-core/minicore_stick)||| -|[STEPMOTOR]()|[SERVO]()| - - +* [M5Stack USB Downloader](/en/product_documents/tools/tool_usb_downloader) diff --git a/docs/en/product_documents/applications/application_lidarbot.md b/docs/en/product_documents/applications/application_lidarbot.md index a2e80a43..0037115f 100644 --- a/docs/en/product_documents/applications/application_lidarbot.md +++ b/docs/en/product_documents/applications/application_lidarbot.md @@ -60,7 +60,7 @@ And in addition to controlling the car's flexible front, rear, left and right mo ## DOCUMENTS - **Example** - [Arduino](https://github.com/m5stack/Applications-LidarBot/tree/master/LidarBot/Example) - [MicroPython]() -- **[Quick Start](zh_CN/file_to_display_null)** +- **Quick Start** - (coming soon...) - **[Purchase](https://www.aliexpress.com/store/product/M5Stack-New-Lidar-Bot-Mini-Car-Lidar-8m-6Hz-McNamm-Wheels-NeoPixel-LED-Bar-with-ESP32/3226069_32951134988.html?spm=a2g1y.12024536.productList_5885013.subject_7)**
diff --git a/docs/en/product_documents/m5stack-core/m5core_basic.md b/docs/en/product_documents/m5stack-core/m5core_basic.md index 44dd011e..fcdd7257 100644 --- a/docs/en/product_documents/m5stack-core/m5core_basic.md +++ b/docs/en/product_documents/m5stack-core/m5core_basic.md @@ -97,6 +97,10 @@ The a Bottom board on the back of M5Core. It's designed for expanding gpio on M- - **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) +- **Quick Start** + - Arduino - [MacOS](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - [Windows_64](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) + - [MicroPython](/en/quick_start/m5core/m5stack_core_get_started_MicroPython) + - **[The difference between M5Cores](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores.md)**
diff --git a/docs/en/product_documents/m5stack-core/m5core_fire.md b/docs/en/product_documents/m5stack-core/m5core_fire.md index 9da7d037..6c156748 100644 --- a/docs/en/product_documents/m5stack-core/m5core_fire.md +++ b/docs/en/product_documents/m5stack-core/m5core_fire.md @@ -152,8 +152,6 @@ M5Go CHG. Base is composed of POGO pin. M5Go Base is composed of PORT B, PORT C, - **Register map** - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/RM-MPU-9250A-00-v1.6.pdf) -- **GitHub** - [Arduino](https://github.com/m5stack/M5Stack) - [MicroPython](https://github.com/m5stack/M5GO) - - **[Purchase](https://www.aliexpress.com/store/product/M5Stack-NEW-PSRAM-2-0-FIRE-IoT-Kit-Dual-Core-ESP32-16M-FLash-4M-PSRAM-Development/3226069_32847906756.html?spm=2114.12010615.8148356.10.1c93724d7cJ5rG.html)** - **Quick Start** diff --git a/docs/en/product_documents/m5stack-core/m5core_gray.md b/docs/en/product_documents/m5stack-core/m5core_gray.md index 1774bf39..b23a8082 100644 --- a/docs/en/product_documents/m5stack-core/m5core_gray.md +++ b/docs/en/product_documents/m5stack-core/m5core_gray.md @@ -111,9 +111,6 @@ The a Bottom board on the back of M5Core. It's designed for expanding gpio on M- - **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) - -- **GitHub** - [Arduino](https://github.com/m5stack/M5Stack) - [MicroPython](https://github.com/m5stack/M5GO) - - **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-ESP32-Mpu9250-9Axies-Motion-Sensor-Core-Development-Kit-Extensible-IoT-Development-Board/3226069_32836393710.html?spm=2114.12010615.8148356.12.25e96be7zRik8r.html)** - **Quick Start** diff --git a/docs/en/product_documents/m5stack-core/m5core_white.md b/docs/en/product_documents/m5stack-core/m5core_white.md index 07540c12..58773a95 100644 --- a/docs/en/product_documents/m5stack-core/m5core_white.md +++ b/docs/en/product_documents/m5stack-core/m5core_white.md @@ -144,8 +144,6 @@ The a Bottom board on the back of M5Core. It's designed for expanding gpio on M- - **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) -- **GitHub** - [Arduino](https://github.com/m5stack/M5Stack) - [MicroPython](https://github.com/m5stack/M5GO) - - **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.6.44fa2da3D2i5Yi)** - **Quick Start** diff --git a/docs/en/product_documents/m5stack-core/m5go_iot_starter_kit.md b/docs/en/product_documents/m5stack-core/m5go_iot_starter_kit.md index 497a3ef9..f196419d 100644 --- a/docs/en/product_documents/m5stack-core/m5go_iot_starter_kit.md +++ b/docs/en/product_documents/m5stack-core/m5go_iot_starter_kit.md @@ -147,8 +147,6 @@ We also supply some courses for teaching IOT programming. If you are interesting - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) -- **GitHub** - [Arduino](https://github.com/m5stack/M5Stack) - [MicroPython](https://github.com/m5stack/M5GO) - - **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.6.44fa2da3D2i5Yi)** - **Quick Start** diff --git a/docs/en/product_documents/modules/module_sim800.md b/docs/en/product_documents/modules/module_sim800.md index c794c5f4..dec33bb6 100644 --- a/docs/en/product_documents/modules/module_sim800.md +++ b/docs/en/product_documents/modules/module_sim800.md @@ -17,7 +17,7 @@ your own. - SIM800L Module - Build-in Antenna -- 3.5 mm phone audio jack +- 3.5 mm phone audio jack and MIC(MIC is disable. If you want to enable it, you need to weld a 0 ohm resistor for enabling.) - Microphone - Parameter: - GSM/GPRS @@ -25,6 +25,18 @@ your own. - transmit Voice, SMS and data information with low power consumption - Featur Bluetooth and Embedded AT +## PinMap + +*After SIM800 was stacked with M5Core, they communicat through UART2* + +**SIM800** + +| SIM800 Pin | ESP32 Chip | +| :----------: |:------------: | +| TXD | GPIO16 | +| RXD | GPIO17 | +| RST | GPIO5 | + ## INCLUDES - 1x M5Stack SIM800L Module @@ -37,10 +49,8 @@ your own. ## DOCUMENTS -- [WebSite](https://m5stack.com) -- [Example](https://github.com/m5stack/M5Stack/tree/master/examples) + - [SIM800L Info](http://simcomm2m.com/En/module/detail.aspx?id=138) (SIM800L) -- [GitHub](https://github.com/m5stack/M5Stack) - [Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-GSM-Module-SIM800L-Stackable-IoT-Development-Board-for-Arduino-ESP32-with-MIC/3226069_32843211923.html?spm=2114.12010615.8148356.20.25e96be7xE1y22.html) diff --git a/docs/en/product_documents/units/unit_esp32cam.md b/docs/en/product_documents/units/unit_esp32cam.md index 73cfe30b..d0b810bd 100644 --- a/docs/en/product_documents/units/unit_esp32cam.md +++ b/docs/en/product_documents/units/unit_esp32cam.md @@ -4,15 +4,15 @@ ## DESCRIPTION -The **ESP32Cam** is a tiny unit based on ESP32 chip and OV2640. You can even program it through Arduino IDE. +The **ESP32Cam** is a tiny unit based on ESP32 chip and OV2640. You can even program it through ESP-IDF. -The ESP32Cam equips the ESP32 with everything necessary to program, run and develop on the wonderful chip. It also features a LiPo charger , so your ESP32Cam project can be battery-powered and truly wireless. Additionally, the board reserved the MPU6050,BME280 and an analog MIC. +The ESP32Cam equips the ESP32 with everything necessary to program, run and develop on the wonderful chip. It also features a LiPo charger , so your ESP32Cam project can be battery-powered and truly wireless. Additionally, the board reserved the Welding positions of MPU6050,BME280 and an analog MIC. ## INCLUDES - 1x M5 Camera -- 1x Type-C USB v +- 1x Type-C USB Cable ## FEATURES @@ -51,6 +51,8 @@ The ESP32Cam equips the ESP32 with everything necessary to program, run and deve - **[Example](https://github.com/m5stack/esp32-cam-demo/tree/m5cam) (ESP32)** - **[Datasheet](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) (ESP32)** - **[Datasheet](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) (OV2640)** +- **[PinMap](https://github.com/m5stack/M5-Schematic/blob/master/Units/esp32-cam/hardware_diff_with_ESP32CAM_M5Camera.md)** +- **[Schematic](https://github.com/m5stack/M5-Schematic/blob/master/Units/esp32-cam/M5CAM-ESP32-A1-POWER.pdf)** - **[Quick Start](/en/quick_start/m5camera/m5camera_quick_start)** - [ESP32Cam purchase (AliExpress)](https://www.aliexpress.com/store/product/M5Stack-Official-ESP32-Camera-Module-Development-Board-OV2640-Camera-Type-C-Grove-Port-3D-Wifi-Antenna/3226069_32881414545.html) diff --git a/docs/en/product_documents/units/unit_m5camera.md b/docs/en/product_documents/units/unit_m5camera.md index 49b1422f..78f9b8f9 100644 --- a/docs/en/product_documents/units/unit_m5camera.md +++ b/docs/en/product_documents/units/unit_m5camera.md @@ -4,15 +4,15 @@ ## DESCRIPTION -The **M5Camera** is a tiny unit based on ESP32 chip and OV2640 including PSRAM. You can even program it through Arduino IDE. +The **M5Camera** is a tiny unit based on ESP32 chip and OV2640 including PSRAM. You can even program it through ESP-IDF. -The M5Camera equips the ESP32 with everything necessary to program, run and develop on the wonderful chip. It also features a LiPo charger (IP5306) , so your M5Camera project can be battery-powered and truly wireless. Additionally, the board reserved the MPU6050,BME280 and an analog MIC. +The M5Camera equips the ESP32 with everything necessary to program, run and develop on the wonderful chip. It also features a LiPo charger (IP5306) , so your M5Camera project can be battery-powered and truly wireless. Additionally, the board reserved the Welding positions of MPU6050,BME280 and an analog MIC. ## INCLUDES - 1x M5 Camera -- 1x Type-C USB v +- 1x Type-C USB Cable ## FEATURES @@ -50,6 +50,7 @@ The M5Camera equips the ESP32 with everything necessary to program, run and deve - **[Example](https://github.com/m5stack/esp32-cam-demo/tree/m5cam-psram) (ESP32)** - **[Datasheet](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) (ESP32)** - **[Datasheet](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) (OV2640)** +- **[PinMap](https://github.com/m5stack/M5-Schematic/blob/master/Units/m5camera/hardware_diff_with_ESP32CAM_M5Camera.md)** - **[Quick Start](/en/quick_start/m5camera/m5camera_quick_start)**
diff --git a/docs/en/quick_start.md b/docs/en/quick_start.md index 8d9d6516..2eb2e595 100644 --- a/docs/en/quick_start.md +++ b/docs/en/quick_start.md @@ -2,36 +2,11 @@ [中文](/zh_CN/quick_start) | English | [日本語](/ja/quick_start) -**This document is intended to help you set up the software environment(Arudino, MicroPython) for development of M5Stack. Through a simple example we would like to illustrate how to develop M5Stack boards, firmware(Arduino) or source files(MicroPython) download to M5Stack boards.** +*This document is intended to help you set up the software environment(Arudino, MicroPython) for development of M5Stack. Through a simple example we would like to illustrate how to develop M5Stack boards, firmware(Arduino) or source files(MicroPython) download to M5Stack boards.* -## Introduction - -**M5 stack is a modular stackable development device. The M stands for Modular and 5 stands for the the units compact 5 x 5 cm size.** - -## What You Need - -To develop applications for M5Stack Core you need: - -* **PC** loaded with either Windows, Linux or Mac operating system -* a **Type-C** cable - -Before setting development environment, the step below you need to follow: - -1. Establish **serial** connection - - [How to Establish serial connection](/en/related_documents/establish_serial_connection) - -## Quick Start - -!> **Notice** Make sure you have installed USB driver so that your board can establish serial connection with PC. If not, please view this article [How to Establish serial connection](/en/related_documents/establish_serial_connection) for connection. - -At the first time, you need to burn the specific firmware file(.bin) to your board following this article [How to burn firmware](/en/related_documents/how_to_burn_firmware) befor developing it. - -If you have one of ESP32 development boards listed below, click the corresponding one to start your development. - - | | ----|---|--- -[M5StackCore](/en/quick_start/m5core/m5stack_core_quick_start) | [M5Camera](/en/quick_start/m5camera/m5camera_quick_start) | [M5BALA](/en/quick_start/bala/bala_quick_start) + | +---|--- +[M5StackCore](/en/quick_start/m5core/m5stack_core_quick_start) | [M5Camera](/en/quick_start/m5camera/m5camera_quick_start) - -## Related Documents - -- [establish_serial_connection](/en/related_documents/establish_serial_connection) -- [how_to_burn_firmware](/en/related_documents/how_to_burn_firmware) -- [how_to_connect_wifi_using_core](/en/related_documents/how_to_connect_wifi_using_core) -- [upgrade_m5stack_lib](/en/related_documents/upgrade_m5stack_lib) \ No newline at end of file diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md index 61df7c7d..3c02cb04 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md @@ -1,7 +1,11 @@ # M5Core Quick Start(macOS, Arudino) +[中文](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | English | [日本語](ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) + ?> If your OS is Windows, please click [here](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows). +!> Before setting the development environment, we suggest you confirm whether the USB driver has installed. If not, please visit this link [establish serial connection](/en/related_documents/establish_serial_connection). + ## CONTENT 1. [Setting Environment](#setting-environment) @@ -14,8 +18,6 @@ 2. [Example](#example) -!> **Note** *Before setting the development environment, we suggest you confirm whether the USB driver has installed. If not, please visit this link [establish serial connection](/en/related_documents/establish_serial_connection).* - ## Setting Environment ### Step1. Install `Arduino IDE` @@ -130,4 +132,4 @@ Although most versions of MacOS have no problem with detecting the COM port, on
-?> **Tip** **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 \ No newline at end of file +?> **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 \ No newline at end of file diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md index 6d994b4a..5581333e 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md @@ -1,7 +1,11 @@ # M5Core Quick Start(Windows, Arudino) +[中文](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) | English | [日本語](ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) + ?> If your OS is MacOS, please click [here](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS). +!> We suggest you confirm whether the `USB driver`, `Git` and `Arduino IDE` has installed first. If not, please view this two articles [establish serial connection](/en/related_documents/establish_serial_connection) and [Install Git and Arduino IDE](/en/related_documents/how_to_install_git_and_arduino). + ## CONTENT 1. [Setting Environment](#setting-environment) @@ -12,37 +16,20 @@ 2. [Example](#example) -?> *If you want to upgrade the M5Stack Lib, please view this article [upgrade M5Stack Lib](/en/related_documents/upgrade_m5stack_lib).* - -!> **Note** *We suggest you confirm whether the `USB driver`, `Git` and `Arduino IDE(Installation path: C:\Program Files\Arduino)` has installed first. If not, please view this two articles [establish serial connection](/en/related_documents/establish_serial_connection) and [Install Git and Arduino IDE](/en/related_documents/how_to_install_git_and_arduino). If your arduino installation path is not `C:\Program Files\Arduino`, reinstall this IDE please with default path setting.* - -## Setting Environment +## 1. Setting Environment *(Only two steps to complete setting)* ### Step1. Download Arduino-ESP32 Support -Download the batch file [download_arduino_esp32_support.bat](https://github.com/m5stack/m5-docs/tree/master/docs/assets/scripts/download_arduino_esp32_support.bat), and execte it as Administrator. +Download the executable file [download_arduino_esp32_support.exe](https://github.com/m5stack/m5-docs/blob/master/ESP32Support.exe), put it in the folder of **Arduino IDE**, and execte the executable file as Administrator.
- +
-Then this a new window will appear as shown below. -Please waiting for cloning... - -
- -
- - -When completed, it will show below. - -
- -
- +Then please waiting for cloning... ### Step2. Download the M5Stack Lib @@ -50,11 +37,7 @@ Open Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` Search `M5Stack` and install it
- -
- -
- +
!> **Note:** *As shown below, it means you need update* @@ -119,3 +102,5 @@ void loop() { ``` compile it and upload, the M5Stack screen will show "Hello World!" "M5Stack is running successfully!" + +?> *If you want to upgrade the M5Stack Lib, please view this article [upgrade M5Stack Lib](/en/related_documents/upgrade_m5stack_lib).* \ No newline at end of file diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md index e32213ff..1c0e999a 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md @@ -2,15 +2,15 @@ [中文](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) | English | [日本語](ja/quick_start/m5core/m5stack_core_get_started_MicroPython) -?> **Tip** *a. If your M5Stack Core was not burnt with a specific firmware named `UiFlow` in advance, please visit this article [How to burn firmware](/en/related_documents/how_to_burn_firmware) for burnning). b. If it's first time to use M5Stack Core or you want to change the networkable AP that means the Core can't access [flow.m5stack.com](flow.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core](/en/related_documents/how_to_connect_wifi_using_core).* +?> a. If your M5Stack Core was not burnt with a specific firmware named `UiFlow` in advance, please visit this article [How to burn firmware](/en/related_documents/how_to_burn_firmware) for burnning). b. If it's first time to use M5Stack Core or you want to change the networkable AP that means the Core can't access [flow.m5stack.com](flow.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core](/en/related_documents/how_to_connect_wifi_using_core). -*By default, we account your M5Core has been connected with the networkable AP. And the screen shows like this figure below after you pressed the `UPLOAD` button on the left.* +By default, we account your M5Core has been connected with the networkable AP. And the screen shows like this figure below after you pressed the `UPLOAD` button on the left. After a few seconds if nothing is pressed the M5 will automatically run the code that was previously uploaded. If we want to upload new code we have to make sure we press the `upload` button on this menu before the M5 boots the code in it’s memory.
-?> **Tip** *After a few seconds if nothing is pressed the M5 will automatically run the code that was previously uploaded. If we want to upload new code we have to make sure we press the `upload` button on this menu before the M5 boots the code in it’s memory.* + ## **CONTENT** @@ -102,4 +102,4 @@ Now, run it and enjoy your musical work! ## **Complete** -?> **Note** *Also, For being more familiar with M5, you can contact us for a WorkShop * +?> *Also, For being more familiar with M5, you can contact us for a WorkShop * diff --git a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md index 3e1c83d4..c6056a2e 100644 --- a/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md +++ b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md @@ -2,9 +2,9 @@ [中文](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) | English | [日本語](ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) -?> **Note** *If it's first time to use M5Core or you want to change the networkable AP that means the Core can't access [http://cloud.m5stack.com](http://cloud.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core with M5Cloud](/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud).* +?> If it's first time to use M5Core or you want to change the networkable AP that means the Core can't access [http://cloud.m5stack.com](http://cloud.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core with M5Cloud](/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud). -*By default, we consider your M5Core has been connected with the networkable AP successfully. And the screen shows like this figure below.* +By default, we consider your M5Core has been connected with the networkable AP successfully. And the screen shows like this figure below.
diff --git a/docs/en/related_documents.md b/docs/en/related_documents.md index 9bed0108..bf8c389d 100644 --- a/docs/en/related_documents.md +++ b/docs/en/related_documents.md @@ -2,12 +2,12 @@ [中文](/zh_CN/related_documents) | English | [日本語](/ja/related_documents) -### [1. Establish Serial Connection](en/related_documents/establish_serial_connection) +1. [Establish Serial Connection](en/related_documents/establish_serial_connection) -### [2. How to Burn Firmware](en/related_documents/how_to_burn_firmware) +2. [How to Install Git and Arduino](en/related_documents/how_to_install_git_and_arduino) -### [3. How to Connect WiFi Using Core](en/related_documents/how_to_connect_wifi_using_core) +3. [Upgrade M5Stack Lib](en/related_documents/upgrade_m5stack_lib) -### [4. How to Install Git and Arduino](en/related_documents/how_to_install_git_and_arduino) +4. [How to Burn Firmware](en/related_documents/how_to_burn_firmware) -### [5. Upgrade M5Stack Lib](en/related_documents/upgrade_m5stack_lib) +5. [How to Connect WiFi Using Core](en/related_documents/how_to_connect_wifi_using_core) diff --git a/docs/index.html b/docs/index.html index 22c755aa..ce81a9c9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -43,10 +43,6 @@ // NAVIGATION // ----------------------------------------------------------------- alias: { - // '.*?/changelog': 'https://unpkg.com/docsify-themeable/CHANGELOG.md', - // '/cn/practice_cn': 'docs/practice_cn.md', - // '/cn/': 'README_cn.md', - // '/cn/product_documents_cn': 'docs/product_documents_cn.md', '/en/sidebar.md': '/sidebar.md', '/en/.*/sidebar.md':'/sidebar.md', '/zh_CN/.*/sidebar.md': '/zh_CN/sidebar.md', @@ -54,7 +50,7 @@ '/.*/navbar.md':'/navbar.md', '/en/':'/' }, - // auto2top : true, + auto2top : true, maxLevel : 1, subMaxLevel: 1, diff --git a/docs/ja/README.md b/docs/ja/README.md index 8521d0f2..c84753a7 100644 --- a/docs/ja/README.md +++ b/docs/ja/README.md @@ -5,7 +5,9 @@ [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fjhildenbiddle%2Fdocsify-themeable&hashtags=css,docsify,developers,frontend) Star -## **M5Stackの世界へようこそ!** +**M5Stackの世界へようこそ!** + +?> アンダーラインが引かれた部分はリンクになっています。 \ No newline at end of file +| MicroPython | Arduino | +|:------------|:--------| +|[LCD](ja/api_reference/micropython/api_lcd) | / | \ No newline at end of file diff --git a/docs/ja/api_reference/api_lcd.md b/docs/ja/api_reference/api_lcd.md deleted file mode 100644 index dd9f15c7..00000000 --- a/docs/ja/api_reference/api_lcd.md +++ /dev/null @@ -1,73 +0,0 @@ -# LCD - -### setbrightness -> M5.Lcd.setbrightness(uint8_t brightness); - -Set the brightness of LCD. - -| Param | Type | Description | -| --- | --- | --- | -| brightness | uint8_t | brightness(0-254) | - -**Example** -```c++ -M5.Lcd.setbrightness(100); -``` - -* * * - -### fillScreen -> M5.Lcd.fillScreen(uint16_t color); - -Set the color to display of the whole LCD. - -| Param | Type | Description | -| --- | --- | --- | -| color | uint16_t | color value | - -**Example** -```c++ -M5.Lcd.fillScreen(RED); -delay(500); -M5.Lcd.fillScreen(WHITE); -delay(500); -``` - -* * * - -### fillRect -> M5.Lcd.fillRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color); - -Draw a filled rectangle. - -| Param | Type | Description | -| --- | --- | --- | -| x, y | int16_t | offset of x, y direction | -| w, h | int16_t | width and height of graphics | -| color | uint16_t | color to fill | - -**Example** -```c++ -M5.Lcd.fillRect(50,50,60,150,WHITE); -``` - -* * * - -### fillRoundRect -> M5.Lcd.fillRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color); - -Draw a filled round rectangle. - -| Param | Type | Description | -| --- | --- | --- | -| x, y | int16_t | offset of x, y direction | -| w, h | int16_t | width and height of graphics | -| radius | int16_t | fillet radius | -| color | uint16_t | color to fill | - -**Example** -```c++ -M5.Lcd.fillRoundRect(50,50,60,150,4,WHITE); -``` - -* * * \ No newline at end of file diff --git a/docs/ja/api_reference/micropython/api_lcd.md b/docs/ja/api_reference/micropython/api_lcd.md new file mode 100644 index 00000000..ab64316a --- /dev/null +++ b/docs/ja/api_reference/micropython/api_lcd.md @@ -0,0 +1,245 @@ +# LCD + +[中文](/zh_CN/api_reference/micropython/api_lcd) | [English](/en/api_reference/micropython/api_lcd) | 日本語 + +### lcd.setRotation(degree) + +**画面全体の回転角度を設定します。** + +| パラメータ | 説明 | +|:---|:---| +| degree | 回転角度 | + +**使用例** + +```python +lcd.setRotation(90) +``` + +--- + +### lcd.setColor(color [, background_color]) + +**テキストの色と背景色を設定します。** + +| パラメータ | 説明 | +| :--- | :--- | +| color | テキストの色 | +| background_color| テキストの背景色 | + +**使用例** + +```python +lcd.setColor(lcd.RED) +lcd.setColor(lcd.ORANGE, lcd.DARKCYAN) +``` + +--- + +### lcd.fillScreen(color) + +**画面全体を指定した色で塗りつぶします。** + +| パラメータ | 説明 | +|:--- | :--- | +| color | 塗りつぶしの色 | + +**使用例** + +```python +lcd.fillScreen(lcd.RED) +``` + +--- + +### lcd.drawPixel(x, y [,color]) + +**(x,y)の位置に点（ピクセル）を描画します。** + +*色の指定がない場合は、現在設定されている前景色が使用されます。* + +| パラメータ | 説明 | +| :--- | :--- | +| x | 点のx座標 | +| y | 点のy座標 | +| color | 点の色 | + +**使用例** + +```python +lcd.drawPixel(22, 22, lcd.RED) +``` + +--- + +### lcd.drawLine(x, y, x1, y1 [,color]) + +**点(x,y) から 点(x1,y1) へ直線を描画します。** + +*色の指定がない場合は、現在設定されている前景色が使用されます。* + +| パラメータ | 説明 | +| :--- | :--- | +| x | 線の始点のx座標 | +| y | 線の始点のy座標 | +| x1 | 線の終点のx1座標 | +| y1 | 線の終点のy1座標 | +| color | 線の色 | + +**使用例** + +```python +lcd.drawLine(0, 0, 12, 12, lcd.WHITE) +``` + +--- + +### lcd.drawTriangle(x, y, x1, y1, x2, y2 [,color]) + +**3つの頂点 (x,y), (x1,y1), (x2,y2) を持つ三角形を描画します。** + +*色の指定がない場合は、現在設定されている前景色が使用されます。* + +| パラメータ | 説明 | +| :--- | :--- | +| x | 三角形の頂点0のx座標 | +| y | 三角形の頂点0のy座標 | +| x1 | 三角形の頂点1のx座標 | +| y1 | 三角形の頂点1のy座標 | +| x2 | 三角形の頂点2のx座標 | +| y2 | 三角形の頂点2のy座標 | +| color | 三角形の線の色 | + +**使用例** + +```python +lcd.drawTriangle(22, 22, 69, 98, 51, 22, lcd.RED) +``` + +--- + +### lcd.fillTriangle(x, y, x1, y1, x2, y2 [,color]) + +**3つの頂点 (x,y), (x1,y1), (x2,y2) を持つ三角形を塗りつぶします。** + +*色の指定がない場合は、現在設定されている前景色が使用されます。* + +| パラメータ | 説明 | +| :--- | :--- | +| x | 三角形の頂点0のx座標 | +| y | 三角形の頂点0のy座標 | +| x1 | 三角形の頂点1のx座標 | +| y1 | 三角形の頂点1のy座標 | +| x2 | 三角形の頂点2のx座標 | +| y2 | 三角形の頂点2のy座標 | +| color | 三角形の色 | + +**使用例** + +```python +lcd.fillTriangle(122, 122, 169, 198, 151, 182, lcd.RED) +``` + +--- + +### lcd.drawRect(x, y, w, h, [,color]) + +**左上の点(x,y)と幅と高さを指定して、四角形を描画します。** + +*色の指定がない場合は、現在設定されている前景色が使用されます。* + +| パラメータ | 説明 | +| :--- | :--- | +| x | 四角形の左上の頂点のx座標 | +| y | 四角形の左上の頂点のy座標 | +| w | 四角形の幅 | +| h | 四角形の高さ | +| color | 四角形の線の色 | + +**使用例** + +```python +lcd.drawRect(180, 12, 122, 10, lcd.BLUE) +``` + +--- + +### lcd.drawRoundRect(x, y, w, h, r [,color]) + +**左上の点(x,y)と幅と高さを指定して、かど丸の四角形を描画します。** + +*色の指定がない場合は、現在設定されている前景色が使用されます。* + +| パラメータ | 説明 | +| :--- | :--- | +| x | 四角形の左上の頂点のx座標 | +| y | 四角形の左上の頂点のy座標 | +| w | 四角形の幅 | +| h | 四角形の高さ | +| r | コーナー半径 | +| color | 四角形の線の色 | + +**使用例** + +```python +lcd.fillRoundRect(180, 70, 122, 10, 4, lcd.BLUE) +``` + +--- + +### lcd.print(‘text’, [x, y]) + +**位置(x,y)にテキストを表示します。** + +| パラメータ | 説明 | +| :--- | :--- | +| text | 表示するテキスト | +| x | テキストを表示する位置のx座標 | +| y | テキストを表示する位置のy座標 | + +**使用例** + +```python +lcd.print('this is a print text function', 80, 80) +``` + +--- + +### lcd.clear([color]) + +**デフォルトの背景色、または指定の色で画面を塗りつぶします。** + +| パラメータ | 説明 | +| :--- | :--- | +| color | 塗りつぶしの色 | + +**使用例** + +```python +lcd.clear(lcd.WHITE) +``` + +--- + +### 使い方 + +```python +from machine import SPI, Pin +from display import LCD + +spi = SPI(1, baudrate=32000000, mosi=Pin(23), miso=Pin(19), sck=Pin(18)) + +lcd = LCD(spi = spi) # lcd 初期化 +lcd.fillScreen(lcd.BLACK) # デフォルトの背景色を設定 + +lcd.drawLine(0, 0, lcd.WHITE) +lcd.drawTriangle(22, 22, 69, 98, 51, 22, lcd.RED) +lcd.fillTriangle(122, 122, 169, 198, 151, 182, lcd.RED) +lcd.drawCircle(180, 180, 10, lcd.BLUE) +lcd.fillcircle(100, 100, 10, lcd.BLUE) +lcd.drawRect(180, 12, 122, 10, lcd.BLUE) +lcd.fillRect(180, 30, 122, 10, lcd.BLUE) +lcd.drawRoundRect(180, 50, 122, 10, 4, lcd.BLUE) +lcd.fillRoundRect(180, 70, 122, 10, 4, lcd.BLUE) +lcd.print('this is a print text function', 80, 80) +``` diff --git a/docs/en/api_reference/api_speaker.md b/docs/ja/api_reference/micropython/api_speaker.md similarity index 65% rename from docs/en/api_reference/api_speaker.md rename to docs/ja/api_reference/micropython/api_speaker.md index 8936220a..d363f120 100644 --- a/docs/en/api_reference/api_speaker.md +++ b/docs/ja/api_reference/micropython/api_speaker.md @@ -1,5 +1,7 @@ # Speaker +[中文](/zh_CN/api_reference/micropython/api_speaker) | [English](/en/api_reference/micropython/api_speaker) | 日本語 + ### tone > M5.Speaker.tone(uint32_t freq); diff --git a/docs/en/api_reference/peripherals/api_gpio.md b/docs/ja/api_reference/micropython/peripherals/api_gpio.md similarity index 71% rename from docs/en/api_reference/peripherals/api_gpio.md rename to docs/ja/api_reference/micropython/peripherals/api_gpio.md index 76abbad3..ce910600 100644 --- a/docs/en/api_reference/peripherals/api_gpio.md +++ b/docs/ja/api_reference/micropython/peripherals/api_gpio.md @@ -1,5 +1,7 @@ # GPIO +[中文](/zh_CN/api_reference/micropython/peripherals/api_gpio) | [English](/en/api_reference/micropython/peripherals/api_gpio) | 日本語 + *Refer to GPIO API of [Arduino](http://www.arduino.cc)* ### digitalRead diff --git a/docs/ja/faq.md b/docs/ja/faq.md index b6e1808c..cbf2b89f 100644 --- a/docs/ja/faq.md +++ b/docs/ja/faq.md @@ -10,8 +10,8 @@ --- - Q. ArduinoでI2Cがうまく動きません。 - - A. ボードマネージャを利用して導入されるesp32ライブラリstable-1.0.0にはI2Cまわりにバグがあり、使用できない場合があります。最新のライブラリを[GitHub](https://github.com/espressif/arduino-esp32)より取得することで回避可能です。 - + - A. Arduino IDEのボードマネージャから最新のesp32ライブラリ(>=1.0.1)を導入してください。 + --- - Q. UiFlowのソースは公開されていますか？ diff --git a/docs/ja/product_documents/applications/application_bala.md b/docs/ja/product_documents/applications/application_bala.md index bfe351ee..1eb3d930 100644 --- a/docs/ja/product_documents/applications/application_bala.md +++ b/docs/ja/product_documents/applications/application_bala.md @@ -56,6 +56,9 @@ - **GitHub** - [M5Bala](https://github.com/m5stack/M5Bala) +- **クイックスタート** + - [M5Balaクイックスタート](/ja/quick_start/bala/bala_quick_start) +
diff --git a/docs/ja/product_documents/m5stack-core/m5core_basic.md b/docs/ja/product_documents/m5stack-core/m5core_basic.md index 382f047c..42266a95 100644 --- a/docs/ja/product_documents/m5stack-core/m5core_basic.md +++ b/docs/ja/product_documents/m5stack-core/m5core_basic.md @@ -110,9 +110,9 @@ - [M5Stack](https://github.com/m5stack/M5Stack) - **クイックスタート (Arduino)** - - [macOS](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - - [Windows](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - - [MicroPython](/en/quick_start/m5core/m5stack_core_get_started_MicroPython) + - [macOS](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) + - [Windows](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) + - [MicroPython](/ja/quick_start/m5core/m5stack_core_get_started_MicroPython)
basic_01 diff --git a/docs/ja/product_documents/m5stack-core/m5core_fire.md b/docs/ja/product_documents/m5stack-core/m5core_fire.md index 209a0b5f..417225cd 100644 --- a/docs/ja/product_documents/m5stack-core/m5core_fire.md +++ b/docs/ja/product_documents/m5stack-core/m5core_fire.md @@ -167,9 +167,9 @@ M5Go CHG.ベースはPOGOピン、M5GoベースはPORT B, PORT C, 2つのLEDバ - [M5GO](https://github.com/m5stack/M5GO) - **クイックスタート (Arduino)** - - [macOS](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - - [Windows](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - - [MicroPython](/en/quick_start/m5core/m5stack_core_get_started_MicroPython) + - [macOS](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) + - [Windows](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) + - [MicroPython](/ja/quick_start/m5core/m5stack_core_get_started_MicroPython)
fire_01 diff --git a/docs/ja/product_documents/m5stack-core/m5core_gray.md b/docs/ja/product_documents/m5stack-core/m5core_gray.md index 71162864..1672e858 100644 --- a/docs/ja/product_documents/m5stack-core/m5core_gray.md +++ b/docs/ja/product_documents/m5stack-core/m5core_gray.md @@ -119,9 +119,9 @@ - [M5GO](https://github.com/m5stack/M5GO) - **クイックスタート (Arduino)** - - [macOS](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - - [Windows](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - - [MicroPython](/en/quick_start/m5core/m5stack_core_get_started_MicroPython) + - [macOS](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) + - [Windows](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) + - [MicroPython](/ja/quick_start/m5core/m5stack_core_get_started_MicroPython)
gray_01 diff --git a/docs/ja/product_documents/m5stack-core/m5core_white.md b/docs/ja/product_documents/m5stack-core/m5core_white.md index 7dc6b142..773d52c1 100644 --- a/docs/ja/product_documents/m5stack-core/m5core_white.md +++ b/docs/ja/product_documents/m5stack-core/m5core_white.md @@ -152,9 +152,9 @@ M5Coreの下のボトムボードには、I2Sピン(GPIO0, GPIO12, GPIO13, GPIO1 - **クイックスタート** - Arduino - - [MacOS](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - - [Windows_64](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - - [MicroPython](/en/quick_start/m5core/m5stack_core_get_started_MicroPython) + - [MacOS](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) + - [Windows_64](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) + - [MicroPython](/ja/quick_start/m5core/m5stack_core_get_started_MicroPython) - **[M5Coreによる違い](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_diff_between_m5cores.md)** diff --git a/docs/ja/product_documents/m5stack-core/m5go_iot_starter_kit.md b/docs/ja/product_documents/m5stack-core/m5go_iot_starter_kit.md index f475894d..5dc46c56 100644 --- a/docs/ja/product_documents/m5stack-core/m5go_iot_starter_kit.md +++ b/docs/ja/product_documents/m5stack-core/m5go_iot_starter_kit.md @@ -151,9 +151,9 @@ - **Quick Start** - Arduino - - [MacOS](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - - [Windows_64](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - - [MicroPython](/en/quick_start/m5core/m5stack_core_get_started_MicroPython) + - [MacOS](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) + - [Windows_64](/ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) + - [MicroPython](/ja/quick_start/m5core/m5stack_core_get_started_MicroPython)
diff --git a/docs/ja/product_documents/modules/module_sim800.md b/docs/ja/product_documents/modules/module_sim800.md index eba3aaab..cd7e3516 100644 --- a/docs/ja/product_documents/modules/module_sim800.md +++ b/docs/ja/product_documents/modules/module_sim800.md @@ -13,7 +13,7 @@ M5Stackシリーズのコアを使用し、Blockly、Arduino、MicroPythonでプ - SIM800L モジュール - アンテナ内蔵 -- 3.5 mm オーディオジャック +- 3.5 mm オーディオジャック, マイク(ユーザーは、マイクを有効にするためにO ohm抵抗を半田付けする必要があります) - マイク - パラメータ - GSM/GPRS @@ -21,6 +21,18 @@ M5Stackシリーズのコアを使用し、Blockly、Arduino、MicroPythonでプ - 低消費電力で通話、SMS、データ通信が可能 - Bluetooth と Embedded AT +## ピンマッピング + +*After SIM800 was stacked with M5Core, they communicat through UART2* + +**SIM800** + +| SIM800 Pin | ESP32 Chip | +| :----------: |:------------: | +| TXD | GPIO16 | +| RXD | GPIO17 | +| RST | GPIO5 | + ## パッケージ内容 - 1x SIM800L モジュール @@ -33,14 +45,10 @@ M5Stackシリーズのコアを使用し、Blockly、Arduino、MicroPythonでプ ## ドキュメント -- **ウェブサイト** - - [M5Stack](https://m5stack.com) - **サンプルコード** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - **データシート** - [SIM800L](http://simcomm2m.com/En/module/detail.aspx?id=138)(SIM800L) -- **GitHub** - - [M5Stack](https://github.com/m5stack/M5Stack)
sim800_01 diff --git a/docs/ja/product_documents/units/unit_esp32cam.md b/docs/ja/product_documents/units/unit_esp32cam.md index bde0e858..273af988 100644 --- a/docs/ja/product_documents/units/unit_esp32cam.md +++ b/docs/ja/product_documents/units/unit_esp32cam.md @@ -38,7 +38,7 @@ ## パッケージ内容 -- 1x M5 カメラ +- 1x ESP32Cam - 1x USB Type-C ケーブル ## ドキュメント @@ -48,7 +48,7 @@ - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) - **クイックスタート** - - [Arduino](/en/quick_start/m5camera/m5camera_quick_start) + - [Arduino](/ja/quick_start/m5camera/m5camera_quick_start) - **サンプルコード** - [Arduino](https://github.com/1zlab/1ZLAB_ESP32_Wifi_Camera) diff --git a/docs/ja/product_documents/units/unit_m5camera.md b/docs/ja/product_documents/units/unit_m5camera.md index df76bc7b..319c3500 100644 --- a/docs/ja/product_documents/units/unit_m5camera.md +++ b/docs/ja/product_documents/units/unit_m5camera.md @@ -39,7 +39,7 @@ ## パッケージ内容 -- 1x M5 カメラ +- 1x M5Camera - 1x USB Type-C ケーブル ## ドキュメント @@ -49,7 +49,7 @@ - [OV2640](https://www.uctronics.com/download/cam_module/OV2640DS.pdf) - **クイックスタート** - - [Arduino](/en/quick_start/m5camera/m5camera_quick_start) + - [Arduino](/ja/quick_start/m5camera/m5camera_quick_start) - **サンプルコード** - [Arduino](https://github.com/1zlab/1ZLAB_ESP32_Wifi_Camera) @@ -69,4 +69,5 @@ ## 関連情報 +- [M5Camera ユニット 購入(スイッチサイエンス)](https://www.switch-science.com/catalog/5207/) - [M5Camera ユニット 購入(AliExpress)](https://www.aliexpress.com/store/product/M5Stack-ESP32-WROVER-PSRAM-OV2640-C/3226069_32909972455.html) \ No newline at end of file diff --git a/docs/ja/quick_start.md b/docs/ja/quick_start.md index 11cdf5e6..98a02ed1 100644 --- a/docs/ja/quick_start.md +++ b/docs/ja/quick_start.md @@ -2,9 +2,9 @@ [中文](/zh_CN/quick_start) | [English](/en/quick_start) | 日本語 -**このページはM5Stack開発のためのソフトウェア環境（Arduino/MicroPython）構築支援のページです。開発方法や、ファームウェアやソースファイルをM5Stackに書き込む方法を簡単な例を通して説明していきます。** +*このページはM5Stack開発のためのソフトウェア環境（Arduino/MicroPython）構築支援のページです。開発方法や、ファームウェアやソースファイルをM5Stackに書き込む方法を簡単な例を通して説明していきます。* -## イントロダクション + + + | +---|--- +[M5StackCore](/ja/quick_start/m5core/m5stack_core_quick_start) | [M5Camera](/ja/quick_start/m5camera/m5camera_quick_start) - | | ----|---|--- -[M5StackCore](/ja/quick_start/m5core/m5stack_core_quick_start) | [M5Camera](/ja/quick_start/m5camera/m5camera_quick_start) | [M5BALA](/ja/quick_start/bala/bala_quick_start) +[Arduino](/ja/practice/practice_arduino) | [UiFlow-Blockly](/ja/practice/practice_blockly) | [UiFlow-MicroPython](/ja/practice/practice_micropython) --> -## 関連するドキュメント + \ No newline at end of file diff --git a/docs/ja/quick_start/bala/bala_quick_start.md b/docs/ja/quick_start/bala/bala_quick_start.md index 87574702..f589fcd0 100644 --- a/docs/ja/quick_start/bala/bala_quick_start.md +++ b/docs/ja/quick_start/bala/bala_quick_start.md @@ -2,4 +2,141 @@ [中文](zh_CN/quick_start/bala/bala_quick_start) | [English](en/quick_start/bala/bala_quick_start) | 日本語 -## (coming soon...) \ No newline at end of file +!>M5Balaを使用するためには、M5Stack FIREまたはM5GO(WHITE)のいずれかが別途必要になります。 + +## 準備 + +- シリアルドライバをインストールします。- [シリアル接続の確立方法](/ja/related_documents/establish_serial_connection) + +## 開発環境選択 + +1. [UiFlow編](#UiFlow編) +2. [Arduino IDE編](#Arduino-IDE編) + +## UIFlow編 + +1. UiFlow向けのファームウェアを書込みます。- [ファームウェアの更新方法](/ja/related_documents/how_to_burn_firmware) +2. Wi-Fi接続設定を行います。- [M5StackのWi-Fi接続方法](/ja/related_documents/how_to_connect_wifi_using_core) +3. ポゴピンの位置を確認して、M5BalaにM5Stackコアを重ねます。 +
+ +
+ +4. M5Stackの横の赤いスイッチを押して、起動します。(２回連続でクリックすると電源OFF) +
+ +
+ +5. M5Balaのスイッチを押して起動します。(２回連続でクリックすると電源OFF) +
+ +
+
+ +
+ +6. [UiFlow](http://flow.m5stack.com/)にアクセスし、モードをBlocklyからPythonに切り替えます。 +
+ +
+ +7. 以下のコードを貼り付けて実行すると、バランスを取ります。 + +```python +from m5stack import * +from m5ui import * +from m5bala import M5Bala +import i2c_bus +clear_bg(0x111111) + +m5bala = M5Bala(i2c_bus.get(i2c_bus.M_BUS)) +btnA = M5Button(name="ButtonA", text="ButtonA", visibility=False) +btnB = M5Button(name="ButtonB", text="ButtonB", visibility=False) +btnC = M5Button(name="ButtonC", text="ButtonC", visibility=False) +title0 = M5Title(title="Title", fgcolor=0xFFFFFF, bgcolor=0x0000FF) + +title0.setTitle('calirate start') +wait(2) +sampleCount = 2000 +gyroXSum = 0 +gyroYSum = 0 +gyroZSum = 0 + +for _ in range(sampleCount): + gyroXYZ = m5bala.imu.gyro + gyroXSum += gyroXYZ[0] # X + gyroYSum += gyroXYZ[1] # Y + gyroZSum += gyroXYZ[2] # Z + +gyroXMean = gyroXSum / sampleCount +gyroYMean = gyroYSum / sampleCount +gyroZMean = gyroZSum / sampleCount + +m5bala.imu.setGyroOffsets(gyroXMean, gyroYMean, gyroZMean) + +title0.setTitle('balance start') +while True: + m5bala.balance() + wait(0.001) +``` + +## Arduino IDE編 + +1. Arduino IDEをインストールします。 +2. Arduino IDEの設定から追加のボードマネージャのURLに`https://dl.espressif.com/dl/package_esp32_index.json`を追加します。 +
+ +
+
+ +
+ +3. Arduino IDEにボードマネージャから`esp32`をインストールします。 +
+ +
+ +1. Arduino IDEにライブラリマネージャから`m5stack`ライブラリをインストールします。 +
+ +
+ +5. Arduino IDEにライブラリマネージャから`NeoPixelBus`ライブラリをインストールします。 +
+ +
+ +6. Arduino IDEにライブラリマネージャから`MPU6050_tockn`ライブラリをインストールします。 +
+ +
+ +7. M5Stackがパソコンに接続されていることを確認してから、`ツール -> シリアルポート`から適切なシリアルポートを選択します。 +8. 同様にボードも`M5Stack-Core-ESP32`または`M5Stack-Fire`を選択します。 +9. [M5Bala](https://github.com/m5stack/M5Bala.git)のソースをダウンロードします。Gitが使えない方は、[こちら](https://git-scm.com/download/win)からインストールしてください。 +```shell +git clone --recursive https://github.com/m5stack/M5Bala.git +``` +10. Arduino IDE上で新規ファイルを作成し、`M5Bala/src/Default_firmware.ino`の中身をコピーして貼り付けます。 +
+ +
+ +11. `Default_firmware.ino`の89行目の`M5.setPowerBoostKeepOn(false);`をコメントアウトします。 +
+ +
+ +12. 新規タブを作成し、同様に`M5Bala/src/M5Bala.cpp`の中身をコピーして貼り付けます。 +
+ +
+
+ +
+ +13. 新規タブを作成し、同様に`M5Bala/src/M5Bala.h`の中身をコピーして貼り付けます。 +14. 最後に書込みを実行します。 +
+ +
\ No newline at end of file diff --git a/docs/ja/related_documents.md b/docs/ja/related_documents.md index c4a41fbc..2d9a3dcb 100644 --- a/docs/ja/related_documents.md +++ b/docs/ja/related_documents.md @@ -3,7 +3,7 @@ [中文](/zh_CN/related_documents) | [English](/en/related_documents) | 日本語 1. [シリアル接続の確立方法](ja/related_documents/establish_serial_connection) -2. [ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware) -3. [M5StackのWi-Fi接続方法](ja/related_documents/how_to_connect_wifi_using_core) -4. [GitとArduino IDEのインストール方法](ja/related_documents/how_to_install_git_and_arduino) -5. [Arduino IDEのM5Stackライブラリ更新方法](ja/related_documents/upgrade_m5stack_lib) +2. [GitとArduino IDEのインストール方法](ja/related_documents/how_to_install_git_and_arduino) +3. [Arduino IDEのM5Stackライブラリ更新方法](ja/related_documents/upgrade_m5stack_lib) +4. [ファームウェアの更新方法](ja/related_documents/how_to_burn_firmware) +5. [M5StackのWi-Fi接続方法](ja/related_documents/how_to_connect_wifi_using_core) diff --git a/docs/ja/related_documents/how_to_burn_firmware.md b/docs/ja/related_documents/how_to_burn_firmware.md index 34d6fe39..7fa3c357 100644 --- a/docs/ja/related_documents/how_to_burn_firmware.md +++ b/docs/ja/related_documents/how_to_burn_firmware.md @@ -22,6 +22,7 @@ pip install esptool 3. 次にファームウェアをダウンロードし、解凍します。 + - UiFlow以外 ```shell mkdir m5burner && \ cd m5burner && \ @@ -29,10 +30,18 @@ curl -O http://res.m5stack.com/M5Burner/M5Burner.zip && \ unzip M5Burner.zip ``` -4. 解凍が終わったら、リストを表示します。 + - UiFlowのみ +```shell +mkdir m5burner && \ +cd m5burner && \ +curl -O http://flow.m5stack.com/download/M5Burner-flow-only.zip && \ +unzip M5Burner-flow-only.zip +``` + +1. 解凍が終わったら、リストを表示します。 ```shell -ls +ls firmwares/ ```
@@ -41,12 +50,16 @@ ls 5. そして書き込みたいファームウェアを選び、ディレクトリを移動します。 +```shell cd path/to/firmware/version/ ls +``` 6. flash.sh という名前のファイルがあるところまで移動したら、M5Stackとパソコンの接続を確認し、以下のコマンドを入力します。 +```shell sh flash.sh +``` 7. 書き込みが完了したら、M5Stackのリセットボタンを押して、ファームウェアの更新の完了です。 diff --git a/docs/ja/sidebar.md b/docs/ja/sidebar.md index d62485b1..88d332ee 100644 --- a/docs/ja/sidebar.md +++ b/docs/ja/sidebar.md @@ -1,5 +1,5 @@ - [製品ドキュメント](ja/product_documents) - +- [クイックスタート](ja/quick_start) - [API リファレンス](ja/api_reference) - [M5Stack アプリケーション](ja/m5stack_cases) - [その他のドキュメント](ja/related_documents) diff --git a/docs/sidebar.md b/docs/sidebar.md index 0f415d71..36d729a8 100644 --- a/docs/sidebar.md +++ b/docs/sidebar.md @@ -1,5 +1,5 @@ - [Product Documents](en/product_documents) - +- [Quick Start](en/quick_start) - [API Reference](en/api_reference) - [M5Stack Cases](en/m5stack_cases) - [Related Documents](en/related_documents) diff --git a/docs/zh_CN/api_reference.md b/docs/zh_CN/api_reference.md index 9cd540ee..127fb466 100644 --- a/docs/zh_CN/api_reference.md +++ b/docs/zh_CN/api_reference.md @@ -1,10 +1,15 @@ # API Reference -中文 | [English](/en/api_reference) | [日本語](/ja/api_reference) +中文 | [English](en/api_reference) | [日本語](ja/api_reference) -*这是MicroPython的编程API* +| MicroPython | Arduino | +|:------------|:--------| +|[LCD](zh_CN/api_reference/micropython/api_lcd) | [LCD](zh_CN/api_reference/arduino/api_lcd) | -## [LCD](zh_CN/api_reference/api_lcd) + + + diff --git a/docs/zh_CN/api_reference/arduino/api_lcd.md b/docs/zh_CN/api_reference/arduino/api_lcd.md new file mode 100644 index 00000000..b0e67bb1 --- /dev/null +++ b/docs/zh_CN/api_reference/arduino/api_lcd.md @@ -0,0 +1,180 @@ +# LCD + + + +*屏幕像素为320x240，以屏幕左上角为原点(0,0)* + +### M5.lcd.setBrightness(uint8_t brightness); + +**例程** +```c++ +M5.lcd.setBrightness(200); +``` + +**设置整个屏幕显示的亮度。** + +| 参数 | 描述 | +| --- | --- | +| brightness | 屏幕的亮度(0-254) | + +* * * + +### M5.Lcd.setCursor(uint16_t x0, uint16_t y0); + +**例程** +```c++ +M5.lcd.setCursor(20, 40); +``` + +**设置下一次要显示的起始位置(x0, y0)** + +* * * + +### M5.Lcd.fillScreen(uint16_t color); +**例程** +```c++ +M5.Lcd.fillScreen(BLUE) +``` +**以指定的颜色填充整个屏幕。** + +| 参数 | 描述 | +| --- | --- | +| color | 颜色值 | + +* * * + +### M5.Lcd.drawPixel(int16_t x, int16_t y, uint16_t color); +**例程** +```c++ +M5.Lcd.drawPixel(20, 40); +``` +**在位置(x,y)处画color颜色的点。** + +*如果函数的color值没给出，则使用当前的背景颜色。* + +* * * + +### M5.Lcd.drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color); +**例程** +```c++ +M5.Lcd.drawLine(0,0,12,12,BLUE); +``` +**以指定的颜色color从点(x0,y0)到点(x1,y1)画直线。** + +*如果函数的color值没给出，则使用当前的背景颜色。* + +* * * + +### M5.Lcd.drawTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color); + +**例程** +```c++ +M5.Lcd.drawTriangle(22,22,69,98,51,22,BLUE); +``` + +**以指定颜色color画三角形，顶点分别为(x,y)，(x1,y1)和(x2,y2)。** + +*如果函数的color值没给出，则使用当前的背景颜色。* + +* * * + +### M5.Lcd.fillTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color); + +**例程** +```c++ +M5.Lcd.fillTriangle(122, 122, 169, 198, 151, 182, BLUE); +``` +**以指定颜色画填充形式的三角形，顶点分别为(x,y)，(x1,y1)和(x2,y2)。** + +*如果函数的color值没给出，则使用当前的背景颜色。* + + +* * * + diff --git a/docs/zh_CN/api_reference/api_lcd.md b/docs/zh_CN/api_reference/micropython/api_lcd.md similarity index 94% rename from docs/zh_CN/api_reference/api_lcd.md rename to docs/zh_CN/api_reference/micropython/api_lcd.md index cf78ccd7..e0fc0a08 100644 --- a/docs/zh_CN/api_reference/api_lcd.md +++ b/docs/zh_CN/api_reference/micropython/api_lcd.md @@ -1,6 +1,8 @@ # LCD -中文 | [English](https://m5stack.github.io/m5-docs/#/en/api_reference/api_lcd) +中文 | [English](/en/api_reference/micropython/api_lcd) | [日本語](/ja/api_reference/micropython/api_lcd) + +*屏幕像素为320x240，以屏幕左上角为原点(0,0)* ### lcd.setRotation(degree) @@ -24,7 +26,7 @@ lcd.setRotation(90) **例程** ```python lcd.setColor(lcd.RED) -lcd.setColor(lcd.ORANGE, LCD.DARKCYAN) +lcd.setColor(lcd.ORANGE, lcd.DARKCYAN) ``` **设置显示文本的前景颜色和背景颜色。** @@ -163,7 +165,7 @@ lcd.fillRoundRect(180,70,122,10,4,lcd.BLUE) lcd.print('this is a print text function', 80, 80) ``` **在(x,y)处开始打印文本(字符串)text。** - + | 参数 | 描述 | | --- | --- | | text | 要打印的内容 | diff --git a/docs/zh_CN/api_reference/api_speaker.md b/docs/zh_CN/api_reference/micropython/api_speaker.md similarity index 65% rename from docs/zh_CN/api_reference/api_speaker.md rename to docs/zh_CN/api_reference/micropython/api_speaker.md index 0aea5190..9eece7cb 100644 --- a/docs/zh_CN/api_reference/api_speaker.md +++ b/docs/zh_CN/api_reference/micropython/api_speaker.md @@ -1,5 +1,7 @@ # Speaker +中文 | [English](/en/api_reference/micropython/api_speaker) | [日本語](/ja/api_reference/micropython/api_speaker) + ### tone > M5.Speaker.tone(uint32_t freq); diff --git a/docs/zh_CN/api_reference/peripherals/api_gpio.md b/docs/zh_CN/api_reference/micropython/peripherals/api_gpio.md similarity index 70% rename from docs/zh_CN/api_reference/peripherals/api_gpio.md rename to docs/zh_CN/api_reference/micropython/peripherals/api_gpio.md index 98112db5..58d1966d 100644 --- a/docs/zh_CN/api_reference/peripherals/api_gpio.md +++ b/docs/zh_CN/api_reference/micropython/peripherals/api_gpio.md @@ -1,5 +1,7 @@ # GPIO +中文 | [English](/en/api_reference/micropython/peripherals/api_gpio) | [日本語](/ja/api_reference/micropython/peripherals/api_gpio) + *使用Arduino库的GPIO API* ### digitalRead diff --git a/docs/zh_CN/faq.md b/docs/zh_CN/faq.md index 894ca90d..52d2a050 100644 --- a/docs/zh_CN/faq.md +++ b/docs/zh_CN/faq.md @@ -2,4 +2,18 @@ 中文 | [English](/en/faq) | [日本語](/ja/faq) -## （在编辑中...） \ No newline at end of file + \ No newline at end of file diff --git a/docs/zh_CN/file_to_display_null.md b/docs/zh_CN/file_to_display_null.md deleted file mode 100644 index 6b8ddcbd..00000000 --- a/docs/zh_CN/file_to_display_null.md +++ /dev/null @@ -1,3 +0,0 @@ -### 在编辑中... - -### 敬请期待... \ No newline at end of file diff --git a/docs/zh_CN/product_documents.md b/docs/zh_CN/product_documents.md index a39938fc..5e4885b3 100644 --- a/docs/zh_CN/product_documents.md +++ b/docs/zh_CN/product_documents.md @@ -22,8 +22,8 @@ | [GPS](zh_CN/product_documents/modules/module_gps) | [PROTO](zh_CN/product_documents/modules/module_proto) | [STEPMOTOR](zh_CN/product_documents/modules/module_stepmotor)| | [LORA](zh_CN/product_documents/modules/module_lora) | [BATTERY](zh_CN/product_documents/modules/module_battery) | [SERVO](zh_CN/product_documents/modules/module_servo) | | [SIM800/GPRS/GSM](zh_CN/product_documents/modules/module_sim800) | [BTC](zh_CN/product_documents/modules/module_btc) | [COMMU](zh_CN/product_documents/modules/module_commu) | -| [LoRaWAN](zh_CN/product_documents/modules/module_lorawan) | [PLUS](zh_CN/product_documents/modules/module_plus) | / | -| / | / | / | +| [LoRaWAN](zh_CN/product_documents/modules/module_lorawan) | [PLUS](zh_CN/product_documents/modules/module_plus) | [LEGO+](zh_CN/product_documents/modules/module_lego+) | +| / | [USB](zh_CN/product_documents/modules/module_usb) | / | | / | / | / | | / | / | / | | / | / | / | diff --git a/docs/zh_CN/product_documents/applications/application_bala.md b/docs/zh_CN/product_documents/applications/application_bala.md index b5f79385..f27c51c4 100644 --- a/docs/zh_CN/product_documents/applications/application_bala.md +++ b/docs/zh_CN/product_documents/applications/application_bala.md @@ -24,7 +24,7 @@ ## 相关链接 - **例程** - [Arduino](https://github.com/m5stack/M5Bala/tree/master/examples) - [MicroPython](https://github.com/m5stack/M5Bala/tree/master/mpy) -- **[上手指南](https://github.com/m5stack/M5Bala)** +- **[上手指南](/zh_CN/quick_start/bala/bala_quick_start)** - **[购买链接](https://www.aliexpress.com/store/product/M5Satck-New-BALA-Car-ESP32-Development-Mini-Electric-Self-balancing-Car-2DC-Motor-with-Encoder-PSRAM/3226069_32904033658.html?spm=2114.12010615.8148356.40.1fd3724dW3O2Bu.html)**
diff --git a/docs/zh_CN/product_documents/m5stack-core/m5core_basic.md b/docs/zh_CN/product_documents/m5stack-core/m5core_basic.md index 1aef4f27..a1e56b3e 100644 --- a/docs/zh_CN/product_documents/m5stack-core/m5core_basic.md +++ b/docs/zh_CN/product_documents/m5stack-core/m5core_basic.md @@ -94,8 +94,6 @@ M5Core **BASIC**是一款基于**ESP32**芯片(集成Wi-Fi和蓝牙 - **数据手册** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) -- **GitHub** - [Arduino GitHub](https://github.com/m5stack/M5Stack) - - **快速上手** - Arduino - [MacOS](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - [Windows_64](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - [MicroPython](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython)
diff --git a/docs/zh_CN/product_documents/m5stack-core/m5core_fire.md b/docs/zh_CN/product_documents/m5stack-core/m5core_fire.md index ec7fd2ee..ccdb02ba 100644 --- a/docs/zh_CN/product_documents/m5stack-core/m5core_fire.md +++ b/docs/zh_CN/product_documents/m5stack-core/m5core_fire.md @@ -145,8 +145,6 @@ M5GO CHG.底座包含POGO Pin。FIRE主控通过POGO Pin与这个充电底座连 - **Register map** - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/RM-MPU-9250A-00-v1.6.pdf) -- **GitHub** - [Arduino](https://github.com/m5stack/M5Stack) - [MicroPython](https://github.com/m5stack/M5GO) - - **[旗舰店](https://www.aliexpress.com/store/product/M5Stack-NEW-PSRAM-2-0-FIRE-IoT-Kit-Dual-Core-ESP32-16M-FLash-4M-PSRAM-Development/3226069_32847906756.html?spm=2114.12010615.8148356.10.1c93724d7cJ5rG.html)** - **快速上手** - Arduino - [MacOS](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - [Windows_64](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - [MicroPython](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) diff --git a/docs/zh_CN/product_documents/m5stack-core/m5core_gray.md b/docs/zh_CN/product_documents/m5stack-core/m5core_gray.md index 4b2bacd8..b393e78f 100644 --- a/docs/zh_CN/product_documents/m5stack-core/m5core_gray.md +++ b/docs/zh_CN/product_documents/m5stack-core/m5core_gray.md @@ -101,9 +101,6 @@ M5Core **GRAY**是一款基于**ESP32**芯片(集成Wi-Fi和蓝牙) - **数据手册** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU9250](https://www.invensense.com/wp-content/uploads/2015/02/PS-MPU-9250A-01-v1.1.pdf) - -- **GitHub** - [Arduino](https://github.com/m5stack/M5Stack) - [MicroPython](https://github.com/m5stack/M5GO) - - **[旗舰店](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-ESP32-Mpu9250-9Axies-Motion-Sensor-Core-Development-Kit-Extensible-IoT-Development-Board/3226069_32836393710.html?spm=2114.12010615.8148356.12.25e96be7zRik8r.html)** - **快速上手** - Arduino - [MacOS](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - [Windows_64](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - [MicroPython](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) diff --git a/docs/zh_CN/product_documents/m5stack-core/m5go_iot_starter_kit.md b/docs/zh_CN/product_documents/m5stack-core/m5go_iot_starter_kit.md index e9ba6e15..80b8aaf4 100644 --- a/docs/zh_CN/product_documents/m5stack-core/m5go_iot_starter_kit.md +++ b/docs/zh_CN/product_documents/m5stack-core/m5go_iot_starter_kit.md @@ -142,11 +142,9 @@ - **例程** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) -- **源码** - [Arduino](https://github.com/m5stack/M5Stack) - [MicroPython](https://github.com/m5stack/M5GO) - - **[旗舰店](https://www.aliexpress.com/store/product/M5Stack-Official-Stock-Offer-M5GO-IoT-Starter-Kit-ESP32-for-Arduino-MicroPython-Programming-Development-IR-MIC/3226069_32881911596.html?spm=2114.12010615.8148356.6.44fa2da3D2i5Yi)** -- **快速上手** - Arduino - [MacOS](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - [Windows_64](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - [MicroPython](/en/quick_start/m5core/m5stack_core_get_started_MicroPython) +- **快速上手** - Arduino - [MacOS](/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - [Windows_64](/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - [MicroPython](/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython)
diff --git a/docs/zh_CN/product_documents/modules/module_lego+.md b/docs/zh_CN/product_documents/modules/module_lego+.md new file mode 100644 index 00000000..5544726c --- /dev/null +++ b/docs/zh_CN/product_documents/modules/module_lego+.md @@ -0,0 +1,32 @@ +# LEGO+模块 + + + +## 描述 + +LEGO+模块是直流编码电机模块，内置MEGA328芯片，管理和控制每个DC口电机。LEGO+模块与M5Core之间通过I2C通信，其I2C地址为0x56。 +模块还自带了直流电源接口，如果需要更高的电压输入驱动电机的话，可以接入电源。 + +## 特性 + +- 电源接口输入电压范围：6-12V + +## 包含 + +- 1x LEGO+模块 +- 1x 10cm LEGO线 +- 1x DC接头 + +## 相关链接 + + + +- **[购买链接](https://www.aliexpress.com/store/product/M5Stack-New-LEGO-Module-MEGA328-Inside-4-Channels-DC-Encoder-Motor-with-10cm-Motor-and-DC/3226069_32961587834.html?spm=a2g1y.12024536.productList_5885013.subject_3)** + +
+ +
+ +
+ +
diff --git a/docs/zh_CN/product_documents/modules/module_sim800.md b/docs/zh_CN/product_documents/modules/module_sim800.md index af080527..0a256eae 100644 --- a/docs/zh_CN/product_documents/modules/module_sim800.md +++ b/docs/zh_CN/product_documents/modules/module_sim800.md @@ -11,11 +11,24 @@ SIM800L是完整的支持四种频宽的GSM/GPRS解决方案。通过串口发 ## 特性 - 内置SIM800L模块和天线 -- 3.5 mm耳机插孔 +- 3.5 mm耳机插孔和麦克风(麦克风位置需要用户自行焊接O欧姆电阻来使能) - Parameter: - GSM/GPRS - 支持频宽：850/900/1800/1900MHz +## 管脚映射 + +*SIM800モジュールは、M5Coreとスタックされた後、UART2を介して通信します。* + +**SIM800** + +| SIM800 Pin | ESP32 Chip | +| :----------: |:------------: | +| TXD | GPIO16 | +| RXD | GPIO17 | +| RST | GPIO5 | + + ## 包含 - 1x SIM800L模块 @@ -28,7 +41,7 @@ SIM800L是完整的支持四种频宽的GSM/GPRS解决方案。通过串口发 ## 相关链接 -- **[例程](https://github.com/m5stack/M5Stack/tree/master/examples)** + - **[SIM800L信息](http://simcomm2m.com/En/module/detail.aspx?id=138)** (SIM800L) - **[购买链接](https://www.aliexpress.com/store/product/M5Stack-Official-In-Stock-GSM-Module-SIM800L-Stackable-IoT-Development-Board-for-Arduino-ESP32-with-MIC/3226069_32843211923.html?spm=2114.12010615.8148356.20.25e96be7xE1y22.html)** diff --git a/docs/zh_CN/product_documents/modules/module_usb.md b/docs/zh_CN/product_documents/modules/module_usb.md new file mode 100644 index 00000000..308216b1 --- /dev/null +++ b/docs/zh_CN/product_documents/modules/module_usb.md @@ -0,0 +1,39 @@ +# USB + + + +## 描述 + +USB模块是一款USB控制器，内置了USB芯片MAX3421E。堆叠了M5Core之后，通过通信速率可高达26MHz的SPI接口与M5Core连接，即可作USB外设又可作USB主机。 + +## 特性 + +- 高达26MHz的SPI接口 +- 8路GPIO输入输出 +- 内置锂电池接口 + +## 包含 + +- 1x USB模块 + +## 应用 + +- USB键盘记录器 +- M5Core读写U盘 + +## 相关链接 + + + + +- **[数据手册](https://www.sparkfun.com/datasheets/DevTools/Arduino/MAX3421E.pdf)** (MAX3421E) +- **[原理图](https://github.com/m5stack/M5-Schematic/blob/master/Modules/USBHost.pdf)** +- **[购买链接](https://www.aliexpress.com/store/product/M5Stack-New-USB-Module-USB-HOST-HID-with-MAX3421E-SPI-Interface-Output-5-Input-5-Compatible/3226069_32961627365.html?spm=a2g1y.12024536.productList_5885013.subject_1)** + +
+ +
+ +
+ +
diff --git a/docs/zh_CN/quick_start.md b/docs/zh_CN/quick_start.md index 763ebde3..a3101005 100644 --- a/docs/zh_CN/quick_start.md +++ b/docs/zh_CN/quick_start.md @@ -2,36 +2,11 @@ 中文 | [English](/en/quick_start) | [日本語](/ja/quick_start) -**这篇文章主要帮助你搭建M5Stack系列产品中Arduino，MicroPython的开发环境，并通过简单的例子引导你学会使用和开发M5Stack的所有产品，实现自己的创意作品。** +*这篇文章主要帮助你搭建M5Stack系列产品中Arduino，MicroPython的开发环境，并通过简单的例子引导你学会使用和开发M5Stack的所有产品，实现自己的创意作品。* -## 介绍(Introduction) - -**M5是以M5Core主控为核心的一系列可堆叠、模块化的电子产品。 M 代表可堆叠的模块，5 代表模块尺寸为5 * 5 cm大小。** - -## 需要准备的(What Your Need) - -在开发之前，你需要着手准备一下东西： - -* 一台装了Windows, Linux 或者 Mac系统的**电脑** -* 一根 **Type-C** 线 - -在搭建环境之前，你需要做一下软件准备： - -1. 建立板子和PC之间的串口连接： - - [如何下载串口驱动并建立串口连接](/zh_CN/related_documents\establish_serial_connection) - -## 快速上手(Quick Start) - -!> **注意** 确保你的板子已经能够与PC进行串口通信。如果还没的话，参考这篇教程 [如何下载串口驱动并建立串口连接](/zh_CN/related_documents\establish_serial_connection) for connection. - -首先，在能进行串口通讯之后，你要根据板子类型和下面的教程，下载对应的固件程序(.bin)到板子里。 固件程序后缀名是.bin。 [如何烧录固件程序](/zh_CN/related_documents\how_to_burn_firmware) - -点击下图中你所对应的板子开始开发，实现创意： - - | | ----|---|--- -[M5StackCore](/zh_CN/quick_start/m5core/m5stack_core_quick_start) | [M5Camera](/zh_CN/quick_start/m5camera/m5camera_quick_start) | [M5BALA](/zh_CN/quick_start/bala/bala_quick_start) + | +---|--- +[M5StackCore](/zh_CN/quick_start/m5core/m5stack_core_quick_start) | [M5Camera](/zh_CN/quick_start/m5camera/m5camera_quick_start) - -## 相关文档(Related Documents) - -- [如何下载串口驱动并建立串口连接](/zh_CN/related_documents/establish_serial_connection) -- [如何烧录固件](/zh_CN/related_documents/how_to_burn_firmware) -- [如何让Core连接能上网的WIFI热点](/zh_CN/related_documents/how_to_connect_wifi_using_core) -- [如何升级Arduino IDE中的M5Stack库](/zh_CN/related_documents/upgrade_m5stack_lib) \ No newline at end of file diff --git a/docs/zh_CN/quick_start/bala/bala_quick_start.md b/docs/zh_CN/quick_start/bala/bala_quick_start.md index b051280c..ddf5a662 100644 --- a/docs/zh_CN/quick_start/bala/bala_quick_start.md +++ b/docs/zh_CN/quick_start/bala/bala_quick_start.md @@ -1,5 +1,142 @@ -# BALA Get Started +# BALA 上手指南 中文 | [English](en/quick_start/bala/bala_quick_start) | [日本語](ja/quick_start/bala/bala_quick_start) -## (在编辑中...) \ No newline at end of file +!>为了使用M5Bala，需要M5Stack FIRE或M5GO（白色）。 + +## 准备 + +- 安装串行驱动程序 - [如何安装USB驱动并建立与PC的串口通讯](/ja/related_documents/establish_serial_connection) + +## 开发环境 + +1. [UiFlow编辑](#UiFlow编辑) +2. [Arduino IDE编辑](#Arduino-IDE编辑) + +## UIFlow编辑 + +1. 烧录UiFlow的固件 - [如何通过M5Burner烧录固件](/ja/related_documents/how_to_burn_firmware) +2. WiFi链接 - [如何使用M5Core连接可联网的WiFi热点](/ja/related_documents/how_to_connect_wifi_using_core) +3. 检查弹簧针的位置，并将M5Core堆叠在M5Bala上 +
+ +
+ +4. 按M5Core旁边的红色按钮启动（连续点击两次时关闭电源） +
+ +
+ +1. 按M5Bala旁边的按钮启动（连续点击两次时关闭电源） +
+ +
+
+ +
+ +6. 转到[UiFlow](http://flow.m5stack.com/)网站并将模式从Blockly切换到Python +
+ +
+ +7. 粘贴以下代码并执行它以平衡 + +```python +from m5stack import * +from m5ui import * +from m5bala import M5Bala +import i2c_bus +clear_bg(0x111111) + +m5bala = M5Bala(i2c_bus.get(i2c_bus.M_BUS)) +btnA = M5Button(name="ButtonA", text="ButtonA", visibility=False) +btnB = M5Button(name="ButtonB", text="ButtonB", visibility=False) +btnC = M5Button(name="ButtonC", text="ButtonC", visibility=False) +title0 = M5Title(title="Title", fgcolor=0xFFFFFF, bgcolor=0x0000FF) + +title0.setTitle('calirate start') +wait(2) +sampleCount = 2000 +gyroXSum = 0 +gyroYSum = 0 +gyroZSum = 0 + +for _ in range(sampleCount): + gyroXYZ = m5bala.imu.gyro + gyroXSum += gyroXYZ[0] # X + gyroYSum += gyroXYZ[1] # Y + gyroZSum += gyroXYZ[2] # Z + +gyroXMean = gyroXSum / sampleCount +gyroYMean = gyroYSum / sampleCount +gyroZMean = gyroZSum / sampleCount + +m5bala.imu.setGyroOffsets(gyroXMean, gyroYMean, gyroZMean) + +title0.setTitle('balance start') +while True: + m5bala.balance() + wait(0.001) +``` + +## Arduino IDE编辑 + +1. 安装Arduino IDE +2. 在Arduino IDE的设置board manager附加网址加`https://dl.espressif.com/dl/package_esp32_index.json` +
+ +
+
+ +
+ +1. 在Arduino IDE的板管理安装`esp32`库 +
+ +
+ +1. 在Arduino IDE的库管理安装`m5stack`库 +
+ +
+ +5. 在Arduino IDE的库管理安装`NeoPixelBus`库 +
+ +
+ +1. 在Arduino IDE的库管理安装`MPU6050_tockn`库 +
+ +
+ +7. 确保M5Core连接到PC，然后从`工具 - >串行端口`中选择适当的串行端口 +8. 同样选择`M5Stack-Core-ESP32`或`M5Stack-Fire`板 +9. 下载[M5Bala](https://github.com/m5stack/M5Bala.git)如果你不能使用Git，请从[这里](https://git-scm.com/download/win)安装 +```shell +git clone --recursive https://github.com/m5stack/M5Bala.git +``` +10. 在Arduino IDE上创建一个新文件，然后复制并粘贴`M5Bala/src/Default_firmware.ino`的内容 +
+ +
+ +11. 在`Default_firmware.ino`的第89行注释掉`M5.setPowerBoostKeepOn(false);` +
+ +
+ +12. 创建一个新选项卡，并以相同的方式复制和粘贴`M5Bala/src/M5Bala.cpp`的内容 +
+ +
+
+ +
+ +13. 创建一个新选项卡，并以相同的方式复制和粘贴`M5Bala/src/M5Bala.h`的内容 +14. 最后执行 +
+ +
\ No newline at end of file diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md index ea517023..7d4f8672 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md @@ -2,7 +2,9 @@ 中文 | [English](en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [日本語](ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) -?> **提示** 如果你的操作系统是Windows，请点击[这里](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows)。 +?> 如果你的操作系统是Windows，请点击[这里](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows)。 + +!> 在配置环境之前，先确保你已经安装了USB驱动，并且M5Core能通过串口与PC通信。 如果还没的话，看这篇文章[如何建立串口连接](/zh_CN/related_documents/establish_serial_connection). ## 目录 @@ -16,8 +18,6 @@ 2. [示例](#example) -!> **注意** *在配置环境之前，先确保你已经安装了USB驱动，并且M5Core能通过串口与PC通信。 如果还没的话，看这篇文章[如何建立串口连接](/zh_CN/related_documents/establish_serial_connection).* - ## 配置环境 ### Step1. 安装`Arduino IDE` @@ -124,4 +124,4 @@ python get.py
-?> **Tip** **如果你想了解更多关于CP2104 USB驱动的资料，请阅读这个链接的内容** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html \ No newline at end of file +?> **如果你想了解更多关于CP2104 USB驱动的资料，请阅读这个链接的内容** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html \ No newline at end of file diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md index d08f32d7..4e1f3ecd 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md @@ -2,7 +2,9 @@ 中文 | [English](en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) | [日本語](ja/quick_start/m5core/m5stack_core_get_started_Arduino_Windows) -?> **提示** 如果你的操作系统是MacOS的话，请点击[这里](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS)。 +?> 如果你的操作系统是MacOS的话，请点击[这里](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS)。 + +!> 建议你先确认安装了`USB驱动`, `Git` 和 `Arduino IDE`。 如果还没的话，阅读这两篇文档[如何建立串口连接](/zh_CN/related_documents/establish_serial_connection)和[安装Git和Arduino IDE](/zh_CN/related_documents/how_to_install_git_and_arduino)。 ## 目录 @@ -14,9 +16,6 @@ 2. [示例](#example) -?> **提示** *如果你想升级Arduino-M5Stack库的话，请移步阅读这篇文档[如何升级Arduino-M5Stack库](/zh_CN/related_documents/upgrade_m5stack_lib).* - -!> **注意** *建议你先确认安装了`USB驱动`, `Git` 和 `Arduino IDE(安装路径为: C:\Program Files\Arduino)`。 如果还没的话，阅读这两篇文档[如何建立串口连接](/zh_CN/related_documents/establish_serial_connection)和[安装Git和Arduino IDE](/zh_CN/related_documents/how_to_install_git_and_arduino)。 如果你的Arduino IDE安装路径不是`C:\Program Files\Arduino`的话, 为了方便搭建以下的开发环境，请按照默认安装路径重新安装。 ## 1. 配置环境 @@ -24,25 +23,14 @@ ### Step1. 下载Arduino-ESP32的支持包 -下载batch脚本文件[download_arduino_esp32_support.bat](https://github.com/m5stack/m5-docs/tree/master/docs/assets/scripts/download_arduino_esp32_support.bat)，并以管理员身份运行，如下图所示. +下载可执行文件[download_arduino_esp32_support.exe](https://github.com/m5stack/m5-docs/blob/master/ESP32Support.exe)，放置到Arduino IDE的安装路径下，并以管理员身份运行这个可执行文件。
- +
-接着你的界面会出现如下图所示，耐心等待下载... - -
- -
- - -当完成之后，会显示如下。 - -
- -
+接着耐心等待下载... ### Step2. 安装Arduino-M5Stack库 @@ -51,14 +39,10 @@ 搜索`M5Stack`并安装，如下图所示。
- +
-
- -
- -!> **注意** *如果显示下图这样，表示你需要升级Arduino-M5Stack库* +!> *如果显示下图这样，表示你需要升级Arduino-M5Stack库*
@@ -121,3 +105,5 @@ void loop() { ``` 编译并上传这个程序，如果成功后，就会看到屏幕上显示"Hello World!" "M5Stack is running successfully!"啦！ + +?> *如果你想升级Arduino-M5Stack库的话，请移步阅读这篇文档[如何升级Arduino-M5Stack库](/zh_CN/related_documents/upgrade_m5stack_lib).* \ No newline at end of file diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md index ad55b251..6b35182b 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md @@ -2,15 +2,14 @@ 中文 | [English](en/quick_start/m5core/m5stack_core_get_started_MicroPython) | [日本語](ja/quick_start/m5core/m5stack_core_get_started_MicroPython) -?> **Tip** *a. 如果你的设备还没烧录UiFlow固件的话，请参考这篇文档[如果使用M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware).* *b. 如果你是第一次使用这个Core或者想Core连接其他可联网的热点AP的话，请参考这篇文档[如果使用Core连接WIFI和UiFlow](/zh_CN/related_documents/how_to_connect_wifi_using_core)。* +?> a. 如果你的设备还没烧录UiFlow固件的话，请参考这篇文档[如果使用M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware). b. 如果你是第一次使用这个Core或者想Core连接其他可联网的热点AP的话，请参考这篇文档[如果使用Core连接WIFI和UiFlow](/zh_CN/related_documents/how_to_connect_wifi_using_core)。 -*这时候，你的M5Core已经连接到了可联网WIFI热点，如果按下Core上左边的按键`UPLOAD`的话，会如下图显示。* +这时候，你的M5Core已经连接到了可联网WIFI热点，如果按下Core上左边的按键`UPLOAD`的话，会如下图显示。如果M5Core开机之后，两三秒内没做操作的话，会自动地显示预置的程序界面。所以最好开机之后，立马按下`upload`按键。
-?> **Tip** *如果M5Core开机之后，两三秒内没做操作的话，会自动地显示预置的程序界面。所以最好开机之后，立马按下`upload`按键。* ## 目录 @@ -101,4 +100,4 @@ lcd.print("Hello M5Stack") ## 最后 -?> **Tip** *如果你想了解更多UiFlow方面的编程的话，可以给我们发邮件，报名我们的课程.* +?> *如果你想了解更多UiFlow方面的编程的话，可以给我们发邮件，报名我们的课程.* diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md index 70e7d0ad..ec65bc1c 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md @@ -2,11 +2,11 @@ 中文 | [English](en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) | [日本語](ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) -?> **Note** *如果你的设备还没烧录M5Cloud固件的话，请参考这篇文档[如果使用M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware).* +?> 如果你的设备还没烧录M5Cloud固件的话，请参考这篇文档[如果使用M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware). -?> **Note** *如果你是第一次使用这个Core或者想Core连接其他可联网的热点AP的话，请参考这篇文档[如果使用Core连接WIFI和M5Cloud](/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud).* +?> 如果你是第一次使用这个Core或者想Core连接其他可联网的热点AP的话，请参考这篇文档[如果使用Core连接WIFI和M5Cloud](/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud). -*如果你的Core已经连接了可联网WIFI热点之后，屏幕会如下图显示，出现check code(check code用于M5Core设备与M5Cloud绑定)，下面开始M5Cloud的编程* +如果你的Core已经连接了可联网WIFI热点之后，屏幕会如下图显示，出现check code(check code用于M5Core设备与M5Cloud绑定)，下面开始M5Cloud的编程
diff --git a/docs/zh_CN/related_documents.md b/docs/zh_CN/related_documents.md index 19ca5b62..59e2ae0d 100644 --- a/docs/zh_CN/related_documents.md +++ b/docs/zh_CN/related_documents.md @@ -2,12 +2,12 @@ 中文 | [English](/en/related_documents) | [日本語](/ja/related_documents) -### [1. 如何安装USB驱动并建立与PC的串口通讯](zh_CN/related_documents/establish_serial_connection) +1. [如何安装USB驱动并建立与PC的串口通讯](zh_CN/related_documents/establish_serial_connection) -### [2. 如何通过M5Burner烧录固件](zh_CN/related_documents/how_to_burn_firmware) +2. [如何安装Git和Arduino](zh_CN/related_documents/how_to_install_git_and_arduino) -### [3. 如何使用M5Core连接可联网的WiFi热点](zh_CN/related_documents/how_to_connect_wifi_using_core) +3. [如何更新Arduino-M5Stack库](zh_CN/related_documents/upgrade_m5stack_lib) -### [4. 如何安装Git和Arduino](zh_CN/related_documents/how_to_install_git_and_arduino) +4. [如何通过M5Burner烧录固件](zh_CN/related_documents/how_to_burn_firmware) -### [5. 如何更新Arduino-M5Stack库](zh_CN/related_documents/upgrade_m5stack_lib) +5. [如何使用M5Core连接可联网的WiFi热点](zh_CN/related_documents/how_to_connect_wifi_using_core) diff --git a/docs/zh_CN/sidebar.md b/docs/zh_CN/sidebar.md index d7d3175d..030a0f9f 100644 --- a/docs/zh_CN/sidebar.md +++ b/docs/zh_CN/sidebar.md @@ -1,5 +1,5 @@ - [产品介绍](zh_CN/product_documents) - +- [快速上手](zh_CN/quick_start) - [API参考](zh_CN/api_reference) - [M5Stack案例](zh_CN/m5stack_cases) - [相关文档](zh_CN/related_documents)