diff --git a/docs/README.md b/docs/README.md index 3755666d..3b2eb967 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # M5Stack -**welcome to M5Stack documents!** +**Welcome to M5Stack Documents!** ## Introduction diff --git a/docs/_coverpage.md b/docs/_coverpage.md deleted file mode 100644 index 6b8e43d9..00000000 --- a/docs/_coverpage.md +++ /dev/null @@ -1,12 +0,0 @@ -![logo](assets/img/coverpage_logo.png) - -# Style Dictionary - -> Style once, use everywhere. - -**Style Dictionary** is a build system that allows you to define styles once, in a way for any platform or language to consume. A single place to create and edit your styles, and a single command exports these rules to all the places you need them - iOS, Android, CSS, JS, HTML, sketch files, style documentation, or anything you can think of. It is available as a CLI through npm, but can also be used like any normal node module if you want to extend its functionality. - -[GitHub](https://github.com/amzn/style-dictionary) -[Get Started](README.md) - -![color](#D9F8F5) diff --git a/docs/_navbar.md.orig b/docs/_navbar.md.orig new file mode 100644 index 00000000..4efc315e --- /dev/null +++ b/docs/_navbar.md.orig @@ -0,0 +1,3 @@ +- [中文](/zh-cn/) +- [En](/) +- [日本語](/ja/) \ No newline at end of file diff --git a/docs/_sidebar.md.orig b/docs/_sidebar.md.orig new file mode 100644 index 00000000..c037c827 --- /dev/null +++ b/docs/_sidebar.md.orig @@ -0,0 +1,14 @@ +<<<<<<< HEAD:docs/_sidebar.md +- [Introduction](README) +======= +>>>>>>> origin/master:docs/sidebar.md +- [Product Documents](product_documents) +- [Quick Start](quick_start) +- [API Rreference](api_reference) +- [M5Stack Cases](m5stack_cases) +- [FAQ](faq) + + +- **Links** +- [![Github](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github](https://github.com/watson8544/M5Stack-Documentation-docsify) +- [![Twitter](https://icongram.jgog.in/simple/twitter.svg?colored&size=16)@M5Stack](http://twitter.com/M5Stack) diff --git a/docs/actions.md b/docs/actions.md deleted file mode 100644 index 1fe90a01..00000000 --- a/docs/actions.md +++ /dev/null @@ -1,44 +0,0 @@ -# Actions - -Actions provide a way to run custom build code such as generating binary assets like images. - -Here are all the actions that come with the Style Dictionary build system. We try to include what most people might need. You can define custom actions with the [`registerAction`](api.md#registeraction). If you think we are missing some things, take a look at our [contributing docs](https://github.com/amzn/style-dictionary/blob/master/CONTRIBUTING.md) and send us a pull request! If you have a specific need for your project, you can always write your own [custom actions](#adding-custom-actions). - -You use actions in your config file under platforms > [platform] > actions - -```json -{ - "source": ["properties/**/*.json"], - "platforms": { - "android": { - "transformGroup": "android", - "files": [], - "actions": ["copy_assets"] - } - } -} -``` - - ----- - -## Pre-defined Actions - -[lib/common/actions.js](https://github.com/amzn/style-dictionary/blob/master/lib/common/actions.js) - -### android/copyImages - - -Action to copy images into appropriate android directories. - - -* * * - -### copy_assets - - -Action that copies everything in the assets directory to a new assets directory in the build path of the platform. - - -* * * - diff --git a/docs/coverpage.md b/docs/coverpage.md index 087645ad..e2558746 100644 --- a/docs/coverpage.md +++ b/docs/coverpage.md @@ -2,7 +2,7 @@ > A documentation for [M5Stack](https://www.m5stack.com) -- A modular stackable development device integrating WIFI/BLE +- A series of modular stackable development devices integrating WIFI/BLE - For Industry Development/STEM Education - Programming with UIFlow(Blockly/MicroPython) diff --git a/docs/api_reference.md b/docs/en/api_reference.md similarity index 100% rename from docs/api_reference.md rename to docs/en/api_reference.md diff --git a/docs/api_reference/api_lcd.md b/docs/en/api_reference/api_lcd.md similarity index 100% rename from docs/api_reference/api_lcd.md rename to docs/en/api_reference/api_lcd.md diff --git a/docs/faq.md b/docs/en/faq.md similarity index 100% rename from docs/faq.md rename to docs/en/faq.md diff --git a/docs/m5stack_cases.md b/docs/en/m5stack_cases.md similarity index 100% rename from docs/m5stack_cases.md rename to docs/en/m5stack_cases.md diff --git a/docs/practice.md b/docs/en/practice.md similarity index 100% rename from docs/practice.md rename to docs/en/practice.md diff --git a/docs/practice/practice_arduino.md b/docs/en/practice/practice_arduino.md similarity index 100% rename from docs/practice/practice_arduino.md rename to docs/en/practice/practice_arduino.md diff --git a/docs/practice/practice_blockly.md b/docs/en/practice/practice_blockly.md similarity index 100% rename from docs/practice/practice_blockly.md rename to docs/en/practice/practice_blockly.md diff --git a/docs/practice/practice_micropython.md b/docs/en/practice/practice_micropython.md similarity index 100% rename from docs/practice/practice_micropython.md rename to docs/en/practice/practice_micropython.md diff --git a/docs/product_documents.md b/docs/en/product_documents.md similarity index 96% rename from docs/product_documents.md rename to docs/en/product_documents.md index 34dac37d..f9cdcf4d 100644 --- a/docs/product_documents.md +++ b/docs/en/product_documents.md @@ -1,5 +1,7 @@ # Product Documents +[中文](zh_CN/product_documents_zh_CN.md) | English | [日本語](ja/product_documents_ja.md) + | M5Core | MiniCore | @@ -17,7 +19,7 @@ | [GPS](product_documents/modules/module_gps) | [PROTO](product_documents/modules/module_proto) | [STEPMOTOR](product_documents/modules/module_stepmotor)| | [LORA](product_documents/modules/module_lora) | [BATTERY](product_documents/modules/module_battery) | [PLC](product_documents/modules/module_plc) | | [LAN](product_documents/modules/module_lan) | [BTC](product_documents/modules/module_btc) | [FACES](product_documents/modules/module_face) | -| [SIM800/GPRS/GSM](product_documents/modules/module_sim800) | [PLUS](product_documents/modules/module_plus) | / | +| [SIM800/GPRS/GSM](product_documents/modules/module_sim800) | [PLUS](product_documents/modules/module_plus) | [Node](product_documents/modules/module_node) | | / | / | / | | / | / | / | | / | / | / | @@ -63,4 +65,4 @@ -- [M5Stack USB Downloader](product_documents/tools/tool_usb_downloader) +- [M5Stack USB Downloader](product_documents/tools/tool_usb_downloader) \ No newline at end of file diff --git a/docs/product_documents/accessorries/cables/accessory_lego_cable.md b/docs/en/product_documents/accessorries/cables/accessory_lego_cable.md similarity index 100% rename from docs/product_documents/accessorries/cables/accessory_lego_cable.md rename to docs/en/product_documents/accessorries/cables/accessory_lego_cable.md diff --git a/docs/product_documents/accessorries/frame.md b/docs/en/product_documents/accessorries/frame.md similarity index 100% rename from docs/product_documents/accessorries/frame.md rename to docs/en/product_documents/accessorries/frame.md diff --git a/docs/product_documents/accessorries/headers_socket.md b/docs/en/product_documents/accessorries/headers_socket.md similarity index 100% rename from docs/product_documents/accessorries/headers_socket.md rename to docs/en/product_documents/accessorries/headers_socket.md diff --git a/docs/product_documents/applications/application_bala.md b/docs/en/product_documents/applications/application_bala.md similarity index 100% rename from docs/product_documents/applications/application_bala.md rename to docs/en/product_documents/applications/application_bala.md diff --git a/docs/product_documents/m5stack-core/m5core_basic.md b/docs/en/product_documents/m5stack-core/m5core_basic.md similarity index 57% rename from docs/product_documents/m5stack-core/m5core_basic.md rename to docs/en/product_documents/m5stack-core/m5core_basic.md index aef620a9..88b7d5de 100644 --- a/docs/product_documents/m5stack-core/m5core_basic.md +++ b/docs/en/product_documents/m5stack-core/m5core_basic.md @@ -2,7 +2,7 @@ ## DESCRIPTION -The M5Stack BASIC is a development kit based on ESP32 chip. You can even +The M5Stack **BASIC** is a development kit based on ESP32 chip. You can even program The M5Stack BASIC through Blockly, Arduino or MicroPython. The M5Stack BASIC equips the ESP32 with everything necessary to program, @@ -22,7 +22,7 @@ and so on. | Source | Parameter | | :----------: |:------------: | -| ESP32 | 240MHz dual core, 600 DMIPS, 520K, Wi-Fi, dual mode Bluetooth | +| ESP32 | 240MHz dual core, 600 DMIPS, 520K, Wi-Fi, dual mode Bluetooth | | Flash) | 4M-Bytes | | Input | 5V @ 500mA | | Interface | TypeC x 1, GROVE(I2C+I/0+UART) x 1 | @@ -43,16 +43,12 @@ and so on. ## DOCUMENTS -- [Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf) +- **[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)** -- Example +- **Example** - [Arduino Example](https://github.com/m5stack/M5Stack/tree/master/examples) - - [Arduino Example](https://github.com/m5stack/M5Stack/tree/master/examples) +- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) -- Datasheet +- **GitHub** - [Arduino GitHub](https://github.com/m5stack/M5Stack) - - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - -- GitHub - - - [Arduino GitHub](https://github.com/m5stack/M5Stack) +- **Quick Start** - Arduino - [MacOS](../../quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - [Windows_64](../../quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - [MicroPython](../../quick_start/m5core/m5stack_core_get_started_MicroPython) diff --git a/docs/product_documents/m5stack-core/m5core_fire.md b/docs/en/product_documents/m5stack-core/m5core_fire.md similarity index 59% rename from docs/product_documents/m5stack-core/m5core_fire.md rename to docs/en/product_documents/m5stack-core/m5core_fire.md index d1bc1754..4454ed0b 100644 --- a/docs/product_documents/m5stack-core/m5core_fire.md +++ b/docs/en/product_documents/m5stack-core/m5core_fire.md @@ -2,7 +2,7 @@ ## DESCRIPTION -The M5Stack FIRE is a development kit based on ESP32 chip. You can even +The M5Stack **FIRE** is a development kit based on ESP32 chip. You can even program The M5Stack FIRE through Blockly, Arduino or MicroPython. The M5Stack FIRE equips the ESP32 with everything necessary to program, @@ -25,7 +25,7 @@ and so on. | Source | Parameter | | :----------: |:------------: | -| ESP32 | 240MHz dual core, 600 DMIPS, 4MB SRAM, Wi-Fi, dual mode Bluetooth | +| ESP32 | 240MHz dual core, 600 DMIPS, 4MB SRAM, Wi-Fi, dual mode Bluetooth | | Flash) | 16M-Bytes | | Input | 5V @ 500mA | | Interface | TypeC x 1, GROVE(I2C+I/0+UART) x 1 | @@ -50,27 +50,15 @@ and so on. ## DOCUMENTS -- Example +- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) - - [Arduino Example](https://github.com/m5stack/M5Stack/tree/master/examples) +- **Datasheet** - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - [MPU6050](https://www.invensense.com/wp-content/uploads/2015/02/MPU-6000-Datasheet1.pdf) - [MAG3110](https://www.nxp.com/docs/en/data-sheet/MAG3110.pdf) - - [MicroPython Example](https://github.com/m5stack/M5GO/tree/master/examples) +- **GitHub** - [Arduino](https://github.com/m5stack/M5Stack) - [MicroPython](https://github.com/m5stack/M5GO) -- Datasheet +- **[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)** - - [ESP32](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf) - - - [MPU6050](https://www.invensense.com/wp-content/uploads/2015/02/MPU-6000-Datasheet1.pdf) - - - [MAG3110](https://www.nxp.com/docs/en/data-sheet/MAG3110.pdf) - -- GitHub - - - [Arduino GitHub](https://github.com/m5stack/M5Stack) - - - [MicroPython GitHub](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** - Arduino - [MacOS](../../quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - [Windows_64](../../quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - [MicroPython](../../quick_start/m5core/m5stack_core_get_started_MicroPython) ## READ MORE diff --git a/docs/product_documents/m5stack-core/m5core_gray.md b/docs/en/product_documents/m5stack-core/m5core_gray.md similarity index 50% rename from docs/product_documents/m5stack-core/m5core_gray.md rename to docs/en/product_documents/m5stack-core/m5core_gray.md index 44105a1c..bb7e48e9 100644 --- a/docs/product_documents/m5stack-core/m5core_gray.md +++ b/docs/en/product_documents/m5stack-core/m5core_gray.md @@ -2,7 +2,7 @@ ## DESCRIPTION -The M5Stack GRAY is a development kit based on ESP32 chip. You can even +The M5Stack **GRAY**GRAY is a development kit based on ESP32 chip. You can even program The M5Stack GRAY through Blockly, Arduino or MicroPython. The M5Stack GRAY equips the ESP32 with everything necessary to program, @@ -23,7 +23,7 @@ Motion" via M5Stack GRAY in a day in stead of couple weeks and so on. | Source | Parameter | | :----------: |:------------: | -| ESP32 | 240MHz dual core, 600 DMIPS, 520K, Wi-Fi, dual mode Bluetooth | +| ESP32 | 240MHz dual core, 600 DMIPS, 520K, Wi-Fi, dual mode Bluetooth | | Flash) | 4M-Bytes | | Input | 5V @ 500mA | | Interface | TypeC x 1, GROVE(I2C+I/0+UART) x 1 | @@ -44,25 +44,15 @@ Motion" via M5Stack GRAY in a day in stead of couple weeks and so on. ## DOCUMENTS -- [Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf) +- **[Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf)** -- Example +- **Example** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples) - [MicroPython](https://github.com/m5stack/M5GO/tree/master/examples) - - [Arduino Example](https://github.com/m5stack/M5Stack/tree/master/examples) - - - [MicroPython Example](https://github.com/m5stack/M5GO/tree/master/examples) - -- 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) +- **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 +- **GitHub** - [Arduino](https://github.com/m5stack/M5Stack) - [MicroPython](https://github.com/m5stack/M5GO) - - [Arduino GitHub](https://github.com/m5stack/M5Stack) +- **[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)** - - [MicroPython GitHub](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** - Arduino - [MacOS](../../quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) - [Windows_64](../../quick_start/m5core/m5stack_core_get_started_Arduino_Windows) - [MicroPython](../../quick_start/m5core/m5stack_core_get_started_MicroPython) \ No newline at end of file diff --git a/docs/product_documents/m5stack-core/minicore_stick.md b/docs/en/product_documents/m5stack-core/minicore_stick.md similarity index 100% rename from docs/product_documents/m5stack-core/minicore_stick.md rename to docs/en/product_documents/m5stack-core/minicore_stick.md diff --git a/docs/product_documents/modules/module_battery.md b/docs/en/product_documents/modules/module_battery.md similarity index 100% rename from docs/product_documents/modules/module_battery.md rename to docs/en/product_documents/modules/module_battery.md diff --git a/docs/product_documents/modules/module_btc.md b/docs/en/product_documents/modules/module_btc.md similarity index 100% rename from docs/product_documents/modules/module_btc.md rename to docs/en/product_documents/modules/module_btc.md diff --git a/docs/product_documents/modules/module_face.md b/docs/en/product_documents/modules/module_face.md similarity index 100% rename from docs/product_documents/modules/module_face.md rename to docs/en/product_documents/modules/module_face.md diff --git a/docs/product_documents/modules/module_gps.md b/docs/en/product_documents/modules/module_gps.md similarity index 100% rename from docs/product_documents/modules/module_gps.md rename to docs/en/product_documents/modules/module_gps.md diff --git a/docs/product_documents/modules/module_lan.md b/docs/en/product_documents/modules/module_lan.md similarity index 100% rename from docs/product_documents/modules/module_lan.md rename to docs/en/product_documents/modules/module_lan.md diff --git a/docs/product_documents/modules/module_lora.md b/docs/en/product_documents/modules/module_lora.md similarity index 100% rename from docs/product_documents/modules/module_lora.md rename to docs/en/product_documents/modules/module_lora.md diff --git a/docs/en/product_documents/modules/module_node.md b/docs/en/product_documents/modules/module_node.md new file mode 100644 index 00000000..54a41f60 --- /dev/null +++ b/docs/en/product_documents/modules/module_node.md @@ -0,0 +1,34 @@ +# Node Module + +## DESCRIPTION + +The Node is a sound box module with 12 RGBLed(SK6812), a codec chip(WM8978), DHT12, IR Transmitter and Receiver(CHQ0038H), two MICs. WM8978 is often used to be applied for Hi-Fi Speaker. +You can program it after connected to any series of M5Stack Core through Arduino. + +You can creat a Webradio, Bluetooth Speaker, even Intelligent sound box with this module. + +## FEATURES + +- Including 12 RGBLed +- Including a HiFi stereo codec chip(Up to 24bit DAC) +- Including a lithium battery interface + +## INCLUDES + +- 1x Node Module + +## Applications + +- Webradio +- Bluetooth Speaker +- Intelligent sound box + +## DOCUMENTS + +- [WebSite](https://m5stack.com) +- [WM8978](http://pdf1.alldatasheet.com/datasheet-pdf/view/96647/WOLFSON/WM8978.html) (WM8978) +- [Schematic]() +- [Example](https://github.com/m5stack/M5Stack/tree/master/examples/Modules/Lora) + - [RGB Example](https://github.com/Makuna/NeoPixelBus/tree/master/examples) +- [Quick Start]() +- [Purchase]() diff --git a/docs/product_documents/modules/module_plc.md b/docs/en/product_documents/modules/module_plc.md similarity index 100% rename from docs/product_documents/modules/module_plc.md rename to docs/en/product_documents/modules/module_plc.md diff --git a/docs/product_documents/modules/module_plus.md b/docs/en/product_documents/modules/module_plus.md similarity index 100% rename from docs/product_documents/modules/module_plus.md rename to docs/en/product_documents/modules/module_plus.md diff --git a/docs/product_documents/modules/module_proto.md b/docs/en/product_documents/modules/module_proto.md similarity index 100% rename from docs/product_documents/modules/module_proto.md rename to docs/en/product_documents/modules/module_proto.md diff --git a/docs/product_documents/modules/module_sim800.md b/docs/en/product_documents/modules/module_sim800.md similarity index 100% rename from docs/product_documents/modules/module_sim800.md rename to docs/en/product_documents/modules/module_sim800.md diff --git a/docs/product_documents/modules/module_stepmotor.md b/docs/en/product_documents/modules/module_stepmotor.md similarity index 100% rename from docs/product_documents/modules/module_stepmotor.md rename to docs/en/product_documents/modules/module_stepmotor.md diff --git a/docs/product_documents/tools/tool_usb_downloader.md b/docs/en/product_documents/tools/tool_usb_downloader.md similarity index 100% rename from docs/product_documents/tools/tool_usb_downloader.md rename to docs/en/product_documents/tools/tool_usb_downloader.md diff --git a/docs/product_documents/units/unit_396port.md b/docs/en/product_documents/units/unit_396port.md similarity index 100% rename from docs/product_documents/units/unit_396port.md rename to docs/en/product_documents/units/unit_396port.md diff --git a/docs/product_documents/units/unit_adc.md b/docs/en/product_documents/units/unit_adc.md similarity index 100% rename from docs/product_documents/units/unit_adc.md rename to docs/en/product_documents/units/unit_adc.md diff --git a/docs/product_documents/units/unit_adc_cn.md b/docs/en/product_documents/units/unit_adc_cn.md similarity index 100% rename from docs/product_documents/units/unit_adc_cn.md rename to docs/en/product_documents/units/unit_adc_cn.md diff --git a/docs/product_documents/units/unit_angle.md b/docs/en/product_documents/units/unit_angle.md similarity index 100% rename from docs/product_documents/units/unit_angle.md rename to docs/en/product_documents/units/unit_angle.md diff --git a/docs/product_documents/units/unit_button.md b/docs/en/product_documents/units/unit_button.md similarity index 100% rename from docs/product_documents/units/unit_button.md rename to docs/en/product_documents/units/unit_button.md diff --git a/docs/product_documents/units/unit_color_sensor.md b/docs/en/product_documents/units/unit_color_sensor.md similarity index 100% rename from docs/product_documents/units/unit_color_sensor.md rename to docs/en/product_documents/units/unit_color_sensor.md diff --git a/docs/product_documents/units/unit_dac.md b/docs/en/product_documents/units/unit_dac.md similarity index 100% rename from docs/product_documents/units/unit_dac.md rename to docs/en/product_documents/units/unit_dac.md diff --git a/docs/product_documents/units/unit_dac_cn.md b/docs/en/product_documents/units/unit_dac_cn.md similarity index 100% rename from docs/product_documents/units/unit_dac_cn.md rename to docs/en/product_documents/units/unit_dac_cn.md diff --git a/docs/product_documents/units/unit_dual_button.md b/docs/en/product_documents/units/unit_dual_button.md similarity index 100% rename from docs/product_documents/units/unit_dual_button.md rename to docs/en/product_documents/units/unit_dual_button.md diff --git a/docs/product_documents/units/unit_env.md b/docs/en/product_documents/units/unit_env.md similarity index 100% rename from docs/product_documents/units/unit_env.md rename to docs/en/product_documents/units/unit_env.md diff --git a/docs/product_documents/units/unit_esp32cam.md b/docs/en/product_documents/units/unit_esp32cam.md similarity index 69% rename from docs/product_documents/units/unit_esp32cam.md rename to docs/en/product_documents/units/unit_esp32cam.md index f4979f03..2b00d175 100644 --- a/docs/product_documents/units/unit_esp32cam.md +++ b/docs/en/product_documents/units/unit_esp32cam.md @@ -2,7 +2,7 @@ ## 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 Arduino IDE. 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. @@ -45,7 +45,8 @@ The ESP32Cam equips the ESP32 with everything necessary to program, run and deve ## DOCUMENTS -- [Example](https://github.com/m5stack/esp32-cam-demo) -- [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) -- [HowToWork](../../quick_start/m5camera/m5camera_quick_start) +- **[Example](https://github.com/m5stack/esp32-cam-demo)** +- **[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)** +- **[HowToWork](../../quick_start/m5camera/m5camera_quick_start)** +- **[Quick Start](../../quick_start/m5camera/m5camera_quick_start)** diff --git a/docs/product_documents/units/unit_hub.md b/docs/en/product_documents/units/unit_hub.md similarity index 100% rename from docs/product_documents/units/unit_hub.md rename to docs/en/product_documents/units/unit_hub.md diff --git a/docs/product_documents/units/unit_ir.md b/docs/en/product_documents/units/unit_ir.md similarity index 100% rename from docs/product_documents/units/unit_ir.md rename to docs/en/product_documents/units/unit_ir.md diff --git a/docs/product_documents/units/unit_joystick.md b/docs/en/product_documents/units/unit_joystick.md similarity index 100% rename from docs/product_documents/units/unit_joystick.md rename to docs/en/product_documents/units/unit_joystick.md diff --git a/docs/product_documents/units/unit_light.md b/docs/en/product_documents/units/unit_light.md similarity index 100% rename from docs/product_documents/units/unit_light.md rename to docs/en/product_documents/units/unit_light.md diff --git a/docs/product_documents/units/unit_m5camera.md b/docs/en/product_documents/units/unit_m5camera.md similarity index 67% rename from docs/product_documents/units/unit_m5camera.md rename to docs/en/product_documents/units/unit_m5camera.md index 7879fba7..b23f59b6 100644 --- a/docs/product_documents/units/unit_m5camera.md +++ b/docs/en/product_documents/units/unit_m5camera.md @@ -2,7 +2,7 @@ ## 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 Arduino IDE. 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. @@ -45,11 +45,13 @@ The M5Camera equips the ESP32 with everything necessary to program, run and deve ## DOCUMENTS -- [Example](https://github.com/m5stack/esp32-cam-demo) -- [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) -- [HowToWork](../../quick_start/m5camera/m5camera_quick_start) -- [Read more](https://github.com/1zlab/1ZLAB_ESP32_Wifi_Camera) +- **[Example](https://github.com/m5stack/esp32-cam-demo)** +- **[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)** +- **[HowToWork](../../quick_start/m5camera/m5camera_quick_start)** +- **[Read more](https://github.com/1zlab/1ZLAB_ESP32_Wifi_Camera)** +- **[Quick Start](../../quick_start/m5camera/m5camera_quick_start)** +
\ No newline at end of file diff --git a/docs/product_documents/units/unit_makey.md b/docs/en/product_documents/units/unit_makey.md similarity index 100% rename from docs/product_documents/units/unit_makey.md rename to docs/en/product_documents/units/unit_makey.md diff --git a/docs/product_documents/units/unit_moisture.md b/docs/en/product_documents/units/unit_moisture.md similarity index 100% rename from docs/product_documents/units/unit_moisture.md rename to docs/en/product_documents/units/unit_moisture.md diff --git a/docs/product_documents/units/unit_ncir.md b/docs/en/product_documents/units/unit_ncir.md similarity index 100% rename from docs/product_documents/units/unit_ncir.md rename to docs/en/product_documents/units/unit_ncir.md diff --git a/docs/product_documents/units/unit_neopixel.md b/docs/en/product_documents/units/unit_neopixel.md similarity index 100% rename from docs/product_documents/units/unit_neopixel.md rename to docs/en/product_documents/units/unit_neopixel.md diff --git a/docs/product_documents/units/unit_pir.md b/docs/en/product_documents/units/unit_pir.md similarity index 100% rename from docs/product_documents/units/unit_pir.md rename to docs/en/product_documents/units/unit_pir.md diff --git a/docs/product_documents/units/unit_proto.md b/docs/en/product_documents/units/unit_proto.md similarity index 100% rename from docs/product_documents/units/unit_proto.md rename to docs/en/product_documents/units/unit_proto.md diff --git a/docs/product_documents/units/unit_relay.md b/docs/en/product_documents/units/unit_relay.md similarity index 100% rename from docs/product_documents/units/unit_relay.md rename to docs/en/product_documents/units/unit_relay.md diff --git a/docs/product_documents/units/unit_rgb.md b/docs/en/product_documents/units/unit_rgb.md similarity index 100% rename from docs/product_documents/units/unit_rgb.md rename to docs/en/product_documents/units/unit_rgb.md diff --git a/docs/product_documents/units/unit_thermal.md b/docs/en/product_documents/units/unit_thermal.md similarity index 100% rename from docs/product_documents/units/unit_thermal.md rename to docs/en/product_documents/units/unit_thermal.md diff --git a/docs/product_documents/units/unit_tof.md b/docs/en/product_documents/units/unit_tof.md similarity index 100% rename from docs/product_documents/units/unit_tof.md rename to docs/en/product_documents/units/unit_tof.md diff --git a/docs/quick_start.md b/docs/en/quick_start.md similarity index 100% rename from docs/quick_start.md rename to docs/en/quick_start.md diff --git a/docs/quick_start/bala/bala_quick_start.md b/docs/en/quick_start/bala/bala_quick_start.md similarity index 100% rename from docs/quick_start/bala/bala_quick_start.md rename to docs/en/quick_start/bala/bala_quick_start.md diff --git a/docs/quick_start/m5camera/m5camera_quick_start.md b/docs/en/quick_start/m5camera/m5camera_quick_start.md similarity index 100% rename from docs/quick_start/m5camera/m5camera_quick_start.md rename to docs/en/quick_start/m5camera/m5camera_quick_start.md diff --git a/docs/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md similarity index 100% rename from docs/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md rename to docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md diff --git a/docs/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md b/docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md similarity index 100% rename from docs/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md rename to docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md diff --git a/docs/quick_start/m5core/m5stack_core_get_started_MicroPython.md b/docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md similarity index 100% rename from docs/quick_start/m5core/m5stack_core_get_started_MicroPython.md rename to docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md diff --git a/docs/quick_start/m5core/m5stack_core_quick_start.md b/docs/en/quick_start/m5core/m5stack_core_quick_start.md similarity index 100% rename from docs/quick_start/m5core/m5stack_core_quick_start.md rename to docs/en/quick_start/m5core/m5stack_core_quick_start.md diff --git a/docs/related_documents/establish_serial_connection.md b/docs/en/related_documents/establish_serial_connection.md similarity index 100% rename from docs/related_documents/establish_serial_connection.md rename to docs/en/related_documents/establish_serial_connection.md diff --git a/docs/related_documents/how_to_burn_firmware_en.md b/docs/en/related_documents/how_to_burn_firmware_en.md similarity index 100% rename from docs/related_documents/how_to_burn_firmware_en.md rename to docs/en/related_documents/how_to_burn_firmware_en.md diff --git a/docs/related_documents/how_to_connect_wifi_using_core.md b/docs/en/related_documents/how_to_connect_wifi_using_core.md similarity index 100% rename from docs/related_documents/how_to_connect_wifi_using_core.md rename to docs/en/related_documents/how_to_connect_wifi_using_core.md diff --git a/docs/related_documents/how_to_install_git_and_arduino.md b/docs/en/related_documents/how_to_install_git_and_arduino.md similarity index 100% rename from docs/related_documents/how_to_install_git_and_arduino.md rename to docs/en/related_documents/how_to_install_git_and_arduino.md diff --git a/docs/related_documents/upgrade_m5stack_lib.md b/docs/en/related_documents/upgrade_m5stack_lib.md similarity index 100% rename from docs/related_documents/upgrade_m5stack_lib.md rename to docs/en/related_documents/upgrade_m5stack_lib.md diff --git a/docs/index.html b/docs/index.html index d03a279d..240fe2bb 100644 --- a/docs/index.html +++ b/docs/index.html @@ -7,7 +7,7 @@ - M5Stack - A delightfully simple theme system for docsify.js + M5Stack - A series of modular stackable development devices @@ -19,9 +19,6 @@ -
@@ -31,26 +28,26 @@ // ----------------------------------------------------------------- name : 'M5Stack Documentation', repo : 'https://github.com/m5stack/m5stack-documentation', - coverpage : 'coverpage.md', + // coverpage : 'coverpage.md', homepage : 'index.md', loadNavbar : '_navbar.md', loadSidebar: '_sidebar.md', nameLink: { - '/cn/': '#/zh-cn/', + '/zh-cn/': '#/zh-cn/', '/ja/': '#/ja/', '/': '#/' }, // 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', + // 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', - }, + // }, // auto2top : true, maxLevel : 3, subMaxLevel: 3, diff --git a/docs/index.html.orig b/docs/index.html.orig new file mode 100644 index 00000000..ba8e1663 --- /dev/null +++ b/docs/index.html.orig @@ -0,0 +1,78 @@ + + + + + + + + + + M5Stack - A series of modular stackable development devices + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + diff --git a/docs/index.md b/docs/index.md index 59df9ba7..801c4256 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,9 +10,9 @@ ?> **Tip** The underline words designate `more info` links leading to advanced sections about the described task. -
+ ## Introduction @@ -24,17 +24,18 @@ Our a series of core boards are based on **ESP32** chip. Our aim is "**Stackable Board is Product**". Here's the [Official Website](www.m5stack.com) + -| | | | -|:---:|:---:|:---:| -|[Product Documents](product_documents) | [Quick Start](quick_start) | [Practice](practice)| +| | | +|:---:|:---:| +|[Product Documents](en/product_documents) | [M5Stack Cases](en/m5stack_cases) | -| | | | -|:---:|:---:|:---:| -|[API Rreference](api_reference) | [M5Stack Cases](m5stack_cases) | [FAQ](faq)| +| | | +|:---:|:---:| +|[API Rreference](en/api_reference) | [FAQ](en/faq)| ## Contact & Support @@ -42,7 +43,7 @@ Our aim is "**Stackable Board is Product**". Here's the [Official Website](www.m - :computer: Visit [Official Website](www.m5stack.com) for newest product - :busts_in_silhouette: Sign in our [Forum](http://forum.m5stack.com) for more designs with M5Stack - :mailbox_with_mail: If you have any questions, you can contact us by [Email](tech@m5stack.com) -- :convenience_store: If you want to get our products, access our [store](http://www.aliexpress.com/store/all-wholesale-products/3226069.html?spm=2114.12010108.100004.3.7e3a5379KoyhDo) +- :convenience_store: If you want to get our products, access our [Store](http://www.aliexpress.com/store/all-wholesale-products/3226069.html?spm=2114.12010108.100004.3.7e3a5379KoyhDo) ## License diff --git a/docs/ja/README.md b/docs/ja/README.md index 0c8917d2..cf2c5493 100644 --- a/docs/ja/README.md +++ b/docs/ja/README.md @@ -13,7 +13,11 @@ ## 製品紹介 +<<<<<<< HEAD **M5Stackはモジュール積層型の開発デバイスです。M5Stackの名前はModuleの「M」、5x5cmサイズの「5」、”積み重ねる”を意味する「Stack」からきています。** +======= +**M5Stackはモジュール積層型の開発デバイスです。M5Stackの名前はModuleのM、5x5cmサイズの5、積み重ねるを意味するStackからきています。** +>>>>>>> origin/master **M5Stackは、開発の際の煩わしさやストレスを軽減し、あなたがあなた自身の新しい発明やアイデアを具現化することに集中出来るように設計されています。M5Stackはいくつかのセンサー、Wi-Fi、Bluetooth、スクリーン、電源を自身に備えており、従来のブレッドボードでの煩雑な配線作業を行わなくても、拡張モジュールを積み重ねたり、Groveコネクタを介して拡張ユニットを簡単に接続することが可能です。** diff --git a/docs/ja/README.md.orig b/docs/ja/README.md.orig new file mode 100644 index 00000000..cf2c5493 --- /dev/null +++ b/docs/ja/README.md.orig @@ -0,0 +1,56 @@ +# M5Stack 公式ドキュメント + +[![Codacy grade](https://img.shields.io/codacy/grade/860d40719cbd4e0f91e145b87ec7c29a.svg?style=flat-square)](https://www.codacy.com/app/watson8544/M5Stack-Documentation-docsify?utm_source=github.com&utm_medium=referral&utm_content=watson8544/M5Stack-Documentation-docsify&utm_campaign=Badge_Grade) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE) +[![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の世界へようこそ!** + +
+ Screenshot of coverpage +
+ +## 製品紹介 + +<<<<<<< HEAD +**M5Stackはモジュール積層型の開発デバイスです。M5Stackの名前はModuleの「M」、5x5cmサイズの「5」、”積み重ねる”を意味する「Stack」からきています。** +======= +**M5Stackはモジュール積層型の開発デバイスです。M5Stackの名前はModuleのM、5x5cmサイズの5、積み重ねるを意味するStackからきています。** +>>>>>>> origin/master + +**M5Stackは、開発の際の煩わしさやストレスを軽減し、あなたがあなた自身の新しい発明やアイデアを具現化することに集中出来るように設計されています。M5Stackはいくつかのセンサー、Wi-Fi、Bluetooth、スクリーン、電源を自身に備えており、従来のブレッドボードでの煩雑な配線作業を行わなくても、拡張モジュールを積み重ねたり、Groveコネクタを介して拡張ユニットを簡単に接続することが可能です。** + +M5Stack Coreモジュールは **ESP32** チップをベースに開発されています。 + +私たちの目標は "**Stackable Board is Product(積んで形に)**"です。オフィシャルサイトは [こちら](www.m5stack.com)です。 + +
+ Screenshot of coverpage +
+ +| | | | +|:---:|:---:|:---:| +|[製品ドキュメント](/ja/product_documents) | [クイックスタート](/ja/quick_start) | [演習](/ja/practice)| + +| | | | +|:---:|:---:|:---:| +|[API リファレンス](/ja/api_reference) | [M5Stack 応用例](/ja/m5stack_cases) | [FAQ](/ja/faq)| + +?> **ヒント** アンダーラインが引かれた部分はリンクになっています。 + +## コンタクト&サポート + +- :computer: 最新情報は[公式サイト](http://www.m5stack.com)(英語) +- :busts_in_silhouette: [フォーラム](http://forum.m5stack.com)にサインインしてM5Stackの情報交換をしよう +- :mailbox_with_mail: 質問・疑問は[Email](mailto:tech@m5stack.com) +- :convenience_store: 日本からの購入は[スイッチサイエンス](https://www.switch-science.com/catalog/list/770/)さんより + +## ライセンス + +このプロジェクトのライセンスは[MIT license](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE)です。 + +Copyright (c) 2018 M5Stack ([@M5Stack](https://twitter.com/M5Stack)) + + + diff --git a/docs/ja/_sidebar.md b/docs/ja/_sidebar.md index a0ff2e8b..c1e715b4 100644 --- a/docs/ja/_sidebar.md +++ b/docs/ja/_sidebar.md @@ -1,9 +1,9 @@ - [イントロダクション](/ja/) -- [製品ドキュメント](/ja/product_documents.md) -- [クイックスタート](/ja/quick_start.md) -- [API リファレンス](/ja/api_reference.md) -- [M5Stack 応用例](/ja/m5stack_cases.md) -- [FAQ](/ja/faq.md) +- [製品ドキュメント](/ja/product_documents) +- [クイックスタート](/ja/quick_start) +- [API リファレンス](/ja/api_reference) +- [M5Stack 応用例](/ja/m5stack_cases) +- [FAQ](/ja/faq) - **Links** diff --git a/docs/ja/product_documents_ja.md b/docs/ja/product_documents_ja.md new file mode 100644 index 00000000..19a5a12a --- /dev/null +++ b/docs/ja/product_documents_ja.md @@ -0,0 +1,68 @@ +# [製品ドキュメント + +[中文](zh_CN/product_documents_zh_CN.md) | [English](en/product_documents.md) | 日本語 + + + +| M5Core | MiniCore | +| :----------: |:------------: | +| [BASIC](product_documents/m5stack-core/m5core_basic) | [Stick](minicore_stick) | +| [GRAY](product_documents/m5stack-core/m5core_gray) | / | +| [FIRE](product_documents/m5stack-core/m5core_fire) | / | + + + + + +| 無線通信モジュール | アクセサリモジュール | 制御モジュール | +| :------------------: |:------------------:| :--------------------:| +| [GPS](product_documents/modules/module_gps) | [PROTO](product_documents/modules/module_proto) | [STEPMOTOR](product_documents/modules/module_stepmotor)| +| [LORA](product_documents/modules/module_lora) | [BATTERY](product_documents/modules/module_battery) | [PLC](product_documents/modules/module_plc) | +| [LAN](product_documents/modules/module_lan) | [BTC](product_documents/modules/module_btc) | [FACES](product_documents/modules/module_face) | +| [SIM800/GPRS/GSM](product_documents/modules/module_sim800) | [PLUS](product_documents/modules/module_plus) | [Node](product_documents/modules/module_node) | +| / | / | / | +| / | / | / | +| / | / | / | +| / | / | / | +| / | / | / | + + + + +- [LEGO-CABLE](product_documents/cables/accessory_lego_cable) +- [FRAME](product_documents/accessory_frame) + + + + + +| 入力/センシングクラス Unit | 出力/コントロールクラス Unit | インターフェイスクラス Unit | +| :-------------------: |:------------------------: | :----------------:| +| [ENV](product_documents/units/unit_env) | [RGB](product_documents/units/unit_rgb) | [HUB](product_documents/units/unit_hub) | +| [IR](product_documents/units/unit_ir) | [RELAY](product_documents/units/unit_relay) | [3.96PORT](product_documents/units/unit_396port) | +| [PIR](product_documents/units/unit_pir) | [NeoPixel](product_documents/units/unit_neopixel) | / | +| [ANGLE](product_documents/units/unit_angle) | [ESP32Cam](product_documents/units/unit_esp32cam) | / | +| [EARTH/Moisture](product_documents/units/unit_moisture) | [M5Camera](product_documents/units/unit_m5camera) | / | +| [LIGHT](product_documents/units/unit_light) | / | / | +| [MAKEY](product_documents/units/unit_makey) | / | / | +| [BUTTON](product_documents/units/unit_button) | / | / | +| [Dual-BUTTON](product_documents/units/unit_dual_button) | / | / | +| [JOYSTICK](product_documents/units/unit_joystick) | / | / | +| [THERMAL](product_documents/units/unit_thermal) | / | / | +| [ADC](product_documents/units/unit_ADC) | / | / | +| [DAC](product_documents/units/unit_DAC) | / | / | +| [Color Sensor](product_documents/units/unit_color_sensor) | / | / | +| [ToF](product_documents/units/unit_tof) | / | / | + + + + + + + +- [BALA](product_documents/applications/application_bala) + + + + +- [M5Stack USB Downloader](product_documents/tools/tool_usb_downloader) diff --git a/docs/ja/sidebar.md b/docs/ja/sidebar.md new file mode 100644 index 00000000..26159db6 --- /dev/null +++ b/docs/ja/sidebar.md @@ -0,0 +1,9 @@ +- [製品ドキュメント](product_documents) +- [クイックスタート](quick_start) +- [API リファレンス](api_reference) +- [M5Stack 応用例](m5stack_cases) +- [よくある質問](faq) + +- **Links** +- [![Github](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github](https://github.com/watson8544/M5Stack-Documentation-docsify) +- [![Twitter](https://icongram.jgog.in/simple/twitter.svg?colored&size=16)@M5Stack](http://twitter.com/M5Stack) diff --git a/docs/product_documents/modules/esp32cam.md b/docs/product_documents/modules/esp32cam.md deleted file mode 100644 index 2ec76483..00000000 --- a/docs/product_documents/modules/esp32cam.md +++ /dev/null @@ -1,53 +0,0 @@ -# ESP32CAM - -## DESCRIPTION - -The ESP32CAM is a tiny module based on ESP32 chip and OV2640. You can even program the ESP32CAM through the ESP-IDF by installing the ESP32 Core. - -The ESP32CAM equips the ESP32 with everything necessary to program, run and develop on the wonderful chip. It also features a LiPo charger (IP5306) , so your ESP32CAM project can be battery-powered and truly wireless. Additionally, the board reserved the MPU6050,BME280 and an analog MIC. - - -## INCLUDES - -- 1x M5 Camera -- 1x Type-C USB v - - -## FEATURES - -- ESP32 specifications - + Dual-core Tensilica LX6 microprocessor - + Up to 240MHz clock frequency - + 520kB internal SRAM - + 4MB Flash memory - + Integrated 802.11 BGN WiFi transceiver - + Integrated dual-mode Bluetooth (classic and BLE) - + Hardware accelerated encryption (AES, SHA2, ECC, RSA-4096) -- CP2104 USB TTL -- OV2640 sensor - - Output Formats(8-bit): - + YUV(422/420)/YCbCr422 - + RGB565/555 - + 8-bit compressed data - + 8-/10-bit Raw RGB data - - Maximum Image Transfer Rate - + UXGA/SXGA: 15fps - + SVGA: 30fps - + CIF: 60fps - - Scan Mode: Progressive -- Camera specifications - + CCD size : 1/4inch - + Field of View : 78 degree - + Maxmium Pixel: 200W -- Sensor best resolution: 1600 * 1200 -- Dimension: 25mm x 24mm -- Weight: 5g - - -## DOCUMENTS -- [Schematic](https://github.com/m5stack/esp32-cam-demo/blob/m5cam/M5CAM-ESP32-A1-POWER.pdf) -- [Example](https://github.com/m5stack/esp32-cam-demo) -- [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) -- [GitHub](https://github.com/m5stack/esp32-cam-demo) -- [HowToWork](https://github.com/watson8544/M5Stack-UserGuide/blob/master/ESP32CAM_UserGuide.md) diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md index e860e207..28a55f67 100644 --- a/docs/zh-cn/README.md +++ b/docs/zh-cn/README.md @@ -1,6 +1,6 @@ # M5Stack -中文 | [English](README.md) | [日本語](docs/README_ja.md) +中文 | [English](README.md) | [日本語](/ja/README.md) **Welcome to M5Stack Documents!** diff --git a/docs/zh-cn/README.md.orig b/docs/zh-cn/README.md.orig new file mode 100644 index 00000000..28a55f67 --- /dev/null +++ b/docs/zh-cn/README.md.orig @@ -0,0 +1,23 @@ +# M5Stack + +中文 | [English](README.md) | [日本語](/ja/README.md) + +**Welcome to M5Stack Documents!** + +## 介绍(Introduction) + +**M5是以M5Core主控为核心的一系列可堆叠、模块化的电子产品。 M 代表可堆叠的模块，5 代表模块尺寸为5 * 5 cm大小.** + +**The M5 stack aims to take the pain out of developing your new inventions and ideas. M5 stack comes packed with sensors, wifi, bluetooth, a screen and its own power supply which avoids the inconvenience of messy wires strewn across breadboards and adding new functionality is as simple as stacking it on top of one of the many expansion modules or plugging in a unit via the handy grove connectors.** + +我们的一系列产品基本以 **ESP32** 芯片为主控芯片. + +我们的产品出发点是 "**堆叠既是产品**". 这是公司官网 [Official Website](http://www.m5stack.com) + + +## 联系我们(Contact & Support) + +- :computer: 访问我们的[官网](http://www.m5stack.com) 了解最新的产品 +- :busts_in_silhouette: 登陆我们的 [论坛](http://forum.m5stack.com) 了解更多创意的设计 +- :mailbox_with_mail: 如果您有任何关于产品的问题，可以随时通过 [邮件](tech@m5stack.com)联系我们，我们坚持24小时在线及时回复您。 +- :convenience_store: 如果您想继续购买我们的产品，欢迎来 [官方旗舰店](http://www.aliexpress.com/store/all-wholesale-products/3226069.html?spm=2114.12010108.100004.3.7e3a5379KoyhDo) diff --git a/docs/zh-cn/faq.md.orig b/docs/zh-cn/faq.md.orig new file mode 100644 index 00000000..e6dc0d13 --- /dev/null +++ b/docs/zh-cn/faq.md.orig @@ -0,0 +1,3 @@ +# 常见问题解答 + +## （在编辑中...） \ No newline at end of file diff --git a/docs/zh-cn/index.md.orig b/docs/zh-cn/index.md.orig new file mode 100644 index 00000000..e7a8d3e4 --- /dev/null +++ b/docs/zh-cn/index.md.orig @@ -0,0 +1 @@ +# 中文介绍 \ No newline at end of file diff --git a/docs/zh-cn/practice.md.orig b/docs/zh-cn/practice.md.orig new file mode 100644 index 00000000..591b20a7 --- /dev/null +++ b/docs/zh-cn/practice.md.orig @@ -0,0 +1,5 @@ +# 练习(ractice) + + | | +---|---|--- +[M5StackCore](establish_serial_connection) | [M5Camera](establish_serial_connection) | [M5BALA](establish_serial_connection) \ No newline at end of file diff --git a/docs/zh-cn/product_documents.md.orig b/docs/zh-cn/product_documents.md.orig new file mode 100644 index 00000000..4c90b01b --- /dev/null +++ b/docs/zh-cn/product_documents.md.orig @@ -0,0 +1,66 @@ +# 产品列表 + + + +| M5Core | MiniCore | +| :----------: |:------------: | +| [BASIC](product_documents/m5stack-core/m5core_basic) | [Stick](minicore_stick) | +| [GRAY](product_documents/m5stack-core/m5core_gray) | / | +| [FIRE](product_documents/m5stack-core/m5core_fire) | / | + + + + + +| 无线通信模块 | 配件模块 | 控制模块 | +| :------------------: |:------------------:| :--------------------:| +| [GPS](product_documents/modules/module_gps) | [PROTO](product_documents/modules/module_proto) | [STEPMOTOR](product_documents/modules/module_stepmotor)| +| [LORA](product_documents/modules/module_lora) | [BATTERY](product_documents/modules/module_battery) | [PLC](product_documents/modules/module_plc) | +| [LAN](product_documents/modules/module_lan) | [BTC](product_documents/modules/module_btc) | [FACES](product_documents/modules/module_face) | +| [SIM800/GPRS/GSM](product_documents/modules/module_sim800) | [PLUS](product_documents/modules/module_plus) | / | +| / | / | / | +| / | / | / | +| / | / | / | +| / | / | / | +| / | / | / | + + + + +- [LEGO-CABLE](product_documents/cables/accessory_lego_cable) +- [FRAME](product_documents/accessory_frame) + + + + + +| 输入/传感类Unit | 输出/控制类Unit | 接口类Unit | +| :-------------------: |:------------------------: | :----------------:| +| [ENV](product_documents/units/unit_env) | [RGB](product_documents/units/unit_rgb) | [HUB](product_documents/units/unit_hub) | +| [IR](product_documents/units/unit_ir) | [RELAY](product_documents/units/unit_relay) | [3.96PORT](product_documents/units/unit_396port) | +| [PIR](product_documents/units/unit_pir) | [NeoPixel](product_documents/units/unit_neopixel) | / | +| [ANGLE](product_documents/units/unit_angle) | / | / | +| [EARTH/Moisture](product_documents/units/unit_moisture) | / | / | +| [LIGHT](product_documents/units/unit_light) | / | / | +| [MAKEY](product_documents/units/unit_makey) | / | / | +| [BUTTON](product_documents/units/unit_button) | / | / | +| [Dual-BUTTON](product_documents/units/unit_dual_button) | / | / | +| [JOYSTICK](product_documents/units/unit_joystick) | / | / | +| [THERMAL](product_documents/units/unit_thermal) | / | / | +| [ADC](product_documents/units/unit_ADC) | / | / | +| [DAC](product_documents/units/unit_DAC) | / | / | +| [Color Sensor](product_documents/units/unit_color_sensor) | / | / | +| [ToF](product_documents/units/unit_tof) | / | / | + + + + + + + +- [BALA](product_documents/applications/application_bala) + + + + +- [M5Stack USB Downloader](product_documents/tools/tool_usb_downloader) diff --git a/docs/zh-cn/quick_start.md.orig b/docs/zh-cn/quick_start.md.orig new file mode 100644 index 00000000..5f7aca2b --- /dev/null +++ b/docs/zh-cn/quick_start.md.orig @@ -0,0 +1,50 @@ +# 快速上手(Quick Start) + +**这篇文章主要帮助你搭建M5Stack系列产品中Arduino，MicroPython的开发环境，并通过简单的例子引导你学会使用和开发M5Stack的所有产品，实现自己的创意作品。** + +## 介绍(Introduction) + +**M5是以M5Core主控为核心的一系列可堆叠、模块化的电子产品。 M 代表可堆叠的模块，5 代表模块尺寸为5 * 5 cm大小。** + + +## 需要准备的(What Your Need) + +在开发之前，你需要着手准备一下东西： + +* 一台装了Windows, Linux 或者 Mac系统的**电脑** +* 一根 **Type-C** 线 + +在搭建环境之前，你需要做一下软件准备： + +1. 建立板子和PC之间的串口连接： + + [如何下载串口驱动并建立串口连接](related_documents\establish_serial_connection) + +## 快速上手(Quick Start) + +!> **注意** 确保你的板子已经能够与PC进行串口通信。如果还没的话，参考这篇教程 [如何下载串口驱动并建立串口连接](related_documents\establish_serial_connection) for connection. + +首先，在能进行串口通讯之后，你要根据板子类型和下面的教程，下载对应的固件程序(.bin)到板子里。 固件程序后缀名是.bin。 [如何烧录固件程序](related_documents\how_to_connect_wifi_using_core) + +点击下图中你所对应的板子开始开发，实现创意： + + | | +---|---|--- +[M5StackCore](quick_start/m5core/m5stack_core_quick_start) | [M5Camera](quick_start/m5camera/m5camera_quick_start) | [M5BALA](quick_start/bala/bala_quick_start) + + + +## 练习(Practice) + +**最好做一下下面对应的练习版块，这样更加熟悉如何使用M5Stack产品。** + + | | +---|---|--- +[Arduino](practice\practice_arduino) | [M5Flow-Blockly](practice\practice_blockly) | [M5Flow-MicroPython](practice\practice_micropython) + +## 相关文档(Related Documents) + + - [如何下载串口驱动并建立串口连接](related_documents/establish_serial_connection) + - [如何烧录固件](related_documents/how_to_burn_firmware_en) + - [如何让Core连接能上网的WIFI热点](related_documents/how_to_connect_wifi_using_core) + - [如何升级Arduino IDE中的M5Stack库](related_documents/upgrade_m5stack_lib) \ No newline at end of file diff --git a/docs/zh_CN/README.md b/docs/zh_CN/README.md new file mode 100644 index 00000000..11513968 --- /dev/null +++ b/docs/zh_CN/README.md @@ -0,0 +1,54 @@ +# M5Stack + +**Welcome to M5Stack Documents!** + +[![Codacy grade](https://img.shields.io/codacy/grade/860d40719cbd4e0f91e145b87ec7c29a.svg?style=flat-square)](https://www.codacy.com/app/watson8544/M5Stack-Documentation-docsify?utm_source=github.com&utm_medium=referral&utm_content=watson8544/M5Stack-Documentation-docsify&utm_campaign=Badge_Grade) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE) +[![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 + +?> **提示** 点击下划线的蓝色字体可以跳转到对应链接。 + + + +## 介绍(Introduction) + +**M5是以M5Core主控为核心的一系列可堆叠、模块化的电子产品。 M 代表可堆叠的模块，5 代表模块尺寸为5 * 5 cm大小。** + +**M5Stack的理念就是为了摆脱新发明开发过程复杂的痛苦，希望让用户的创意更容易实现。M5Stack主控内置wifi、蓝牙、多种传感器和一个小屏幕，还有电源模块和其他拓展传感器模块，每个产品都是单独模块，从而避免了结合面包板在设计产品原型时需要很多杂乱导线相连的情况，所以在设计一个新功能的时候，仅仅需要在各种我们提供的拓展模块之上堆叠一个M5Stack主控或者用M5Stack主控通过GROVE导线外接相应unit传感器就能实现一个完整的产品。** + +我们的全系列产品基本是以ESP芯片为主芯片。 + +我们希望"**堆叠即是产品**"。 这是我们的[官网](www.m5stack.com)。 + + + +| | | +|:---:|:---:| +|[产品介绍](zh_CN/product_documents_zh_CN) | [M5Stack案例](zh_CN/m5stack_cases_zh_CN) | + +| | | +|:---:|:---:| +|[API参考](zh_CN/api_reference_zh_CN) | [常见问题解答](zh_CN/faq_zh_CN)| + + +## 联系方式(Contact & Support) + +- :computer: 访问[官网](www.m5stack.com)了解最新的产品 +- :busts_in_silhouette: 登录我们的[论坛](http://forum.m5stack.com)了解更多基于M5产品的创意设计 +- :mailbox_with_mail: 如果你有对产品有任何疑问或有更好的建议，请联系我们的[邮箱](tech@m5stack.com) +- :convenience_store: 如果你想继续购买我们的产品，请访问我们的[官方旗舰店](http://www.aliexpress.com/store/all-wholesale-products/3226069.html?spm=2114.12010108.100004.3.7e3a5379KoyhDo) + +## License + +This project is licensed under the [MIT license](https://github.com/watson8544/M5Stack-Documentation-docsify/blob/master/LICENSE). + +Copyright (c) 2018 M5Stack ([@M5Stack](https://twitter.com/M5Stack)) + + + diff --git a/docs/zh_CN/faq_zh_CN.md b/docs/zh_CN/faq_zh_CN.md new file mode 100644 index 00000000..e6dc0d13 --- /dev/null +++ b/docs/zh_CN/faq_zh_CN.md @@ -0,0 +1,3 @@ +# 常见问题解答 + +## （在编辑中...） \ No newline at end of file diff --git a/docs/zh_CN/faq_zh_CN.md.orig b/docs/zh_CN/faq_zh_CN.md.orig new file mode 100644 index 00000000..e6dc0d13 --- /dev/null +++ b/docs/zh_CN/faq_zh_CN.md.orig @@ -0,0 +1,3 @@ +# 常见问题解答 + +## （在编辑中...） \ No newline at end of file diff --git a/docs/zh_CN/practice_zh_CN.md b/docs/zh_CN/practice_zh_CN.md new file mode 100644 index 00000000..591b20a7 --- /dev/null +++ b/docs/zh_CN/practice_zh_CN.md @@ -0,0 +1,5 @@ +# 练习(ractice) + + | | +---|---|--- +[M5StackCore](establish_serial_connection) | [M5Camera](establish_serial_connection) | [M5BALA](establish_serial_connection) \ No newline at end of file diff --git a/docs/zh_CN/practice_zh_CN.md.orig b/docs/zh_CN/practice_zh_CN.md.orig new file mode 100644 index 00000000..591b20a7 --- /dev/null +++ b/docs/zh_CN/practice_zh_CN.md.orig @@ -0,0 +1,5 @@ +# 练习(ractice) + + | | +---|---|--- +[M5StackCore](establish_serial_connection) | [M5Camera](establish_serial_connection) | [M5BALA](establish_serial_connection) \ No newline at end of file diff --git a/docs/zh_CN/product_documents_zh_CN.md b/docs/zh_CN/product_documents_zh_CN.md new file mode 100644 index 00000000..def15aec --- /dev/null +++ b/docs/zh_CN/product_documents_zh_CN.md @@ -0,0 +1,68 @@ +# 产品列表 + +中文 | [English](en/product_documents.md) | [日本語](ja/product_documents_ja.md) + + + +| M5Core | MiniCore | +| :----------: |:------------: | +| [BASIC](product_documents/m5stack-core/m5core_basic) | [Stick](minicore_stick) | +| [GRAY](product_documents/m5stack-core/m5core_gray) | / | +| [FIRE](product_documents/m5stack-core/m5core_fire) | / | + + + + + +| 无线通信模块 | 配件模块 | 控制模块 | +| :------------------: |:------------------:| :--------------------:| +| [GPS](product_documents/modules/module_gps) | [PROTO](product_documents/modules/module_proto) | [STEPMOTOR](product_documents/modules/module_stepmotor)| +| [LORA](product_documents/modules/module_lora) | [BATTERY](product_documents/modules/module_battery) | [PLC](product_documents/modules/module_plc) | +| [LAN](product_documents/modules/module_lan) | [BTC](product_documents/modules/module_btc) | [FACES](product_documents/modules/module_face) | +| [SIM800/GPRS/GSM](product_documents/modules/module_sim800) | [PLUS](product_documents/modules/module_plus) | / | +| / | / | / | +| / | / | / | +| / | / | / | +| / | / | / | +| / | / | / | + + + + +- [LEGO-CABLE](product_documents/cables/accessory_lego_cable) +- [FRAME](product_documents/accessory_frame) + + + + + +| 输入/传感类Unit | 输出/控制类Unit | 接口类Unit | +| :-------------------: |:------------------------: | :----------------:| +| [ENV](product_documents/units/unit_env) | [RGB](product_documents/units/unit_rgb) | [HUB](product_documents/units/unit_hub) | +| [IR](product_documents/units/unit_ir) | [RELAY](product_documents/units/unit_relay) | [3.96PORT](product_documents/units/unit_396port) | +| [PIR](product_documents/units/unit_pir) | [NeoPixel](product_documents/units/unit_neopixel) | / | +| [ANGLE](product_documents/units/unit_angle) | / | / | +| [EARTH/Moisture](product_documents/units/unit_moisture) | / | / | +| [LIGHT](product_documents/units/unit_light) | / | / | +| [MAKEY](product_documents/units/unit_makey) | / | / | +| [BUTTON](product_documents/units/unit_button) | / | / | +| [Dual-BUTTON](product_documents/units/unit_dual_button) | / | / | +| [JOYSTICK](product_documents/units/unit_joystick) | / | / | +| [THERMAL](product_documents/units/unit_thermal) | / | / | +| [ADC](product_documents/units/unit_ADC) | / | / | +| [DAC](product_documents/units/unit_DAC) | / | / | +| [Color Sensor](product_documents/units/unit_color_sensor) | / | / | +| [ToF](product_documents/units/unit_tof) | / | / | + + + + + + + +- [BALA](product_documents/applications/application_bala) + + + + +- [M5Stack USB Downloader](product_documents/tools/tool_usb_downloader) diff --git a/docs/zh_CN/product_documents_zh_CN.md.orig b/docs/zh_CN/product_documents_zh_CN.md.orig new file mode 100644 index 00000000..def15aec --- /dev/null +++ b/docs/zh_CN/product_documents_zh_CN.md.orig @@ -0,0 +1,68 @@ +# 产品列表 + +中文 | [English](en/product_documents.md) | [日本語](ja/product_documents_ja.md) + + + +| M5Core | MiniCore | +| :----------: |:------------: | +| [BASIC](product_documents/m5stack-core/m5core_basic) | [Stick](minicore_stick) | +| [GRAY](product_documents/m5stack-core/m5core_gray) | / | +| [FIRE](product_documents/m5stack-core/m5core_fire) | / | + + + + + +| 无线通信模块 | 配件模块 | 控制模块 | +| :------------------: |:------------------:| :--------------------:| +| [GPS](product_documents/modules/module_gps) | [PROTO](product_documents/modules/module_proto) | [STEPMOTOR](product_documents/modules/module_stepmotor)| +| [LORA](product_documents/modules/module_lora) | [BATTERY](product_documents/modules/module_battery) | [PLC](product_documents/modules/module_plc) | +| [LAN](product_documents/modules/module_lan) | [BTC](product_documents/modules/module_btc) | [FACES](product_documents/modules/module_face) | +| [SIM800/GPRS/GSM](product_documents/modules/module_sim800) | [PLUS](product_documents/modules/module_plus) | / | +| / | / | / | +| / | / | / | +| / | / | / | +| / | / | / | +| / | / | / | + + + + +- [LEGO-CABLE](product_documents/cables/accessory_lego_cable) +- [FRAME](product_documents/accessory_frame) + + + + + +| 输入/传感类Unit | 输出/控制类Unit | 接口类Unit | +| :-------------------: |:------------------------: | :----------------:| +| [ENV](product_documents/units/unit_env) | [RGB](product_documents/units/unit_rgb) | [HUB](product_documents/units/unit_hub) | +| [IR](product_documents/units/unit_ir) | [RELAY](product_documents/units/unit_relay) | [3.96PORT](product_documents/units/unit_396port) | +| [PIR](product_documents/units/unit_pir) | [NeoPixel](product_documents/units/unit_neopixel) | / | +| [ANGLE](product_documents/units/unit_angle) | / | / | +| [EARTH/Moisture](product_documents/units/unit_moisture) | / | / | +| [LIGHT](product_documents/units/unit_light) | / | / | +| [MAKEY](product_documents/units/unit_makey) | / | / | +| [BUTTON](product_documents/units/unit_button) | / | / | +| [Dual-BUTTON](product_documents/units/unit_dual_button) | / | / | +| [JOYSTICK](product_documents/units/unit_joystick) | / | / | +| [THERMAL](product_documents/units/unit_thermal) | / | / | +| [ADC](product_documents/units/unit_ADC) | / | / | +| [DAC](product_documents/units/unit_DAC) | / | / | +| [Color Sensor](product_documents/units/unit_color_sensor) | / | / | +| [ToF](product_documents/units/unit_tof) | / | / | + + + + + + + +- [BALA](product_documents/applications/application_bala) + + + + +- [M5Stack USB Downloader](product_documents/tools/tool_usb_downloader) diff --git a/docs/zh_CN/quick_start_zh_CN.md b/docs/zh_CN/quick_start_zh_CN.md new file mode 100644 index 00000000..5f7aca2b --- /dev/null +++ b/docs/zh_CN/quick_start_zh_CN.md @@ -0,0 +1,50 @@ +# 快速上手(Quick Start) + +**这篇文章主要帮助你搭建M5Stack系列产品中Arduino，MicroPython的开发环境，并通过简单的例子引导你学会使用和开发M5Stack的所有产品，实现自己的创意作品。** + +## 介绍(Introduction) + +**M5是以M5Core主控为核心的一系列可堆叠、模块化的电子产品。 M 代表可堆叠的模块，5 代表模块尺寸为5 * 5 cm大小。** + + +## 需要准备的(What Your Need) + +在开发之前，你需要着手准备一下东西： + +* 一台装了Windows, Linux 或者 Mac系统的**电脑** +* 一根 **Type-C** 线 + +在搭建环境之前，你需要做一下软件准备： + +1. 建立板子和PC之间的串口连接： + + [如何下载串口驱动并建立串口连接](related_documents\establish_serial_connection) + +## 快速上手(Quick Start) + +!> **注意** 确保你的板子已经能够与PC进行串口通信。如果还没的话，参考这篇教程 [如何下载串口驱动并建立串口连接](related_documents\establish_serial_connection) for connection. + +首先，在能进行串口通讯之后，你要根据板子类型和下面的教程，下载对应的固件程序(.bin)到板子里。 固件程序后缀名是.bin。 [如何烧录固件程序](related_documents\how_to_connect_wifi_using_core) + +点击下图中你所对应的板子开始开发，实现创意： + + | | +---|---|--- +[M5StackCore](quick_start/m5core/m5stack_core_quick_start) | [M5Camera](quick_start/m5camera/m5camera_quick_start) | [M5BALA](quick_start/bala/bala_quick_start) + + + +## 练习(Practice) + +**最好做一下下面对应的练习版块，这样更加熟悉如何使用M5Stack产品。** + + | | +---|---|--- +[Arduino](practice\practice_arduino) | [M5Flow-Blockly](practice\practice_blockly) | [M5Flow-MicroPython](practice\practice_micropython) + +## 相关文档(Related Documents) + + - [如何下载串口驱动并建立串口连接](related_documents/establish_serial_connection) + - [如何烧录固件](related_documents/how_to_burn_firmware_en) + - [如何让Core连接能上网的WIFI热点](related_documents/how_to_connect_wifi_using_core) + - [如何升级Arduino IDE中的M5Stack库](related_documents/upgrade_m5stack_lib) \ No newline at end of file diff --git a/docs/zh_CN/quick_start_zh_CN.md.orig b/docs/zh_CN/quick_start_zh_CN.md.orig new file mode 100644 index 00000000..5f7aca2b --- /dev/null +++ b/docs/zh_CN/quick_start_zh_CN.md.orig @@ -0,0 +1,50 @@ +# 快速上手(Quick Start) + +**这篇文章主要帮助你搭建M5Stack系列产品中Arduino，MicroPython的开发环境，并通过简单的例子引导你学会使用和开发M5Stack的所有产品，实现自己的创意作品。** + +## 介绍(Introduction) + +**M5是以M5Core主控为核心的一系列可堆叠、模块化的电子产品。 M 代表可堆叠的模块，5 代表模块尺寸为5 * 5 cm大小。** + + +## 需要准备的(What Your Need) + +在开发之前，你需要着手准备一下东西： + +* 一台装了Windows, Linux 或者 Mac系统的**电脑** +* 一根 **Type-C** 线 + +在搭建环境之前，你需要做一下软件准备： + +1. 建立板子和PC之间的串口连接： + + [如何下载串口驱动并建立串口连接](related_documents\establish_serial_connection) + +## 快速上手(Quick Start) + +!> **注意** 确保你的板子已经能够与PC进行串口通信。如果还没的话，参考这篇教程 [如何下载串口驱动并建立串口连接](related_documents\establish_serial_connection) for connection. + +首先，在能进行串口通讯之后，你要根据板子类型和下面的教程，下载对应的固件程序(.bin)到板子里。 固件程序后缀名是.bin。 [如何烧录固件程序](related_documents\how_to_connect_wifi_using_core) + +点击下图中你所对应的板子开始开发，实现创意： + + | | +---|---|--- +[M5StackCore](quick_start/m5core/m5stack_core_quick_start) | [M5Camera](quick_start/m5camera/m5camera_quick_start) | [M5BALA](quick_start/bala/bala_quick_start) + + + +## 练习(Practice) + +**最好做一下下面对应的练习版块，这样更加熟悉如何使用M5Stack产品。** + + | | +---|---|--- +[Arduino](practice\practice_arduino) | [M5Flow-Blockly](practice\practice_blockly) | [M5Flow-MicroPython](practice\practice_micropython) + +## 相关文档(Related Documents) + + - [如何下载串口驱动并建立串口连接](related_documents/establish_serial_connection) + - [如何烧录固件](related_documents/how_to_burn_firmware_en) + - [如何让Core连接能上网的WIFI热点](related_documents/how_to_connect_wifi_using_core) + - [如何升级Arduino IDE中的M5Stack库](related_documents/upgrade_m5stack_lib) \ No newline at end of file diff --git a/docs/zh_CN/sidebar.md b/docs/zh_CN/sidebar.md new file mode 100644 index 00000000..f5383da6 --- /dev/null +++ b/docs/zh_CN/sidebar.md @@ -0,0 +1,9 @@ +- [产品介绍](product_documents) +- [快速上手](quick_start) +- [API参考](api_reference) +- [M5Stack案例](m5stack_cases) +- [常见问题解答](faq) + +- **Links** +- [![Github](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github](https://github.com/watson8544/M5Stack-Documentation-docsify) +- [![Twitter](https://icongram.jgog.in/simple/twitter.svg?colored&size=16)@M5Stack](http://twitter.com/M5Stack)