Merge branch 'master' into master

This commit is contained in:
LiHuashen
2018-11-05 01:41:57 +08:00
committed by GitHub
92 changed files with 802 additions and 695 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 110 KiB

+1 -1
View File
@@ -8,4 +8,4 @@
[Official Website](http://www.m5stack.com)
[Introdction](#main)
[Quick Start](quick_start)
[Quick Start](/en/quick_start)
+1 -9
View File
@@ -62,12 +62,9 @@ defined in the platform and calls the undo method on any actions.
### cleanPlatform
> StyleDictionary.cleanPlatform(platform) ⇒ [<code>style-dictionary</code>](#module_style-dictionary)
Takes a platform and performs all transforms to
the properties object (non-mutative) then
cleans all the files and perfoms the undo method of any [actions](actions.md).
cleans all the files and perfoms the undo method of any [actions](actions).
| Param | Type |
@@ -80,9 +77,6 @@ cleans all the files and perfoms the undo method of any [actions](actions.md).
### exportPlatform
> StyleDictionary.exportPlatform(platform) ⇒ <code>Object</code>
Exports a properties object with applied
platform transforms.
@@ -101,8 +95,6 @@ dictionary in JS build tools like webpack.
> StyleDictionary.extend(config) ⇒ [<code>style-dictionary</code>](#module_style-dictionary)
Create a Style Dictionary
+45 -37
View File
@@ -1,75 +1,83 @@
# Product Documents
[中文](zh_CN/product_documents_zh_CN.md) | English | [日本語](ja/product_documents.md)
[中文](zh_CN/product_documents) | English | [日本語](ja/product_documents)
## Cores
<img src='assets/img/product_pics/1.jpg'> <img src='assets/img/product_pics/cores.png'>
| M5Core | MiniCore |
| :----------: |:------------: |
| [BASIC](en/product_documents/m5stack-core/m5core_basic) | [Stick](en/product_documents/m5stack-core/minicore_stick) |
| [GRAY](en/product_documents/m5stack-core/m5core_gray) | / |
| [FIRE](en/product_documents/m5stack-core/m5core_fire) | / |
| [BASIC](/en/product_documents/m5stack-core/m5core_basic) | [Stick](/en/product_documents/m5stack-core/minicore_stick) |
| [GRAY](/en/product_documents/m5stack-core/m5core_gray) | / |
| [FIRE](/en/product_documents/m5stack-core/m5core_fire) | / |
## Modules
<img src='assets/img/product_pics/2.jpg'> <img src='assets/img/product_pics/module.png'>
| Wireless Modules | Accessory Modules | Controlling Modules |
| :------------------: |:------------------:| :--------------------:|
| [GPS](en/product_documents/modules/module_gps) | [PROTO](en/product_documents/modules/module_proto) | [STEPMOTOR](en/product_documents/modules/module_stepmotor)|
| [LORA](en/product_documents/modules/module_lora) | [BATTERY](en/product_documents/modules/module_battery) | / |
| [LAN](en/product_documents/modules/module_lan) | [BTC](en/product_documents/modules/module_btc) | / |
| [SIM800/GPRS/GSM](en/product_documents/modules/module_sim800) | [PLUS](en/product_documents/modules/module_plus) | / |
| [GPS](/en/product_documents/modules/module_gps) | [PROTO](/en/product_documents/modules/module_proto) | [STEPMOTOR](/en/product_documents/modules/module_stepmotor)|
| [LORA](/en/product_documents/modules/module_lora) | [BATTERY](/en/product_documents/modules/module_battery) | / |
| [LAN](/en/product_documents/modules/module_lan) | [BTC](/en/product_documents/modules/module_btc) | / |
| [SIM800/GPRS/GSM](/en/product_documents/modules/module_sim800) | [PLUS](/en/product_documents/modules/module_plus) | / |
| / | / | / |
| / | / | / |
| / | / | / |
| / | / | / |
| / | / | / |
## Bases
<img src='assets/img/product_pics/5.jpg'> <img src='assets/img/product_pics/bases.png'>
- [M5GO-Base](en/product_documents/bases/cables/m5go_base)
- [PLC-Base](en/product_documents/modules/module_plc)
- [FACE-Base](en/product_documents/modules/module_face)
- [LAN](en/product_documents/bases/lan_base)
- [Node-Base](en/product_documents/bases/node_base)
- [M5GO-Base](/en/product_documents/bases/cables/m5go_base)
- [PLC-Base](/en/product_documents/modules/module_plc)
- [FACE-Base](/en/product_documents/modules/module_face)
- [LAN](/en/product_documents/bases/lan_base)
- [Node-Base](/en/product_documents/bases/node_base)
## Accessories
<img src='assets/img/product_pics/5.jpg'> <img src='assets/img/product_pics/accessory.png'>
- [LEGO-CABLE](en/product_documents/accessorries/cables/accessory_lego_cable)
- [FRAME](en/product_documents/accessorries/accessory_frame)
- [LEGO-CABLE](/en/product_documents/accessorries/cables/accessory_lego_cable)
- [FRAME](/en/product_documents/accessorries/accessory_frame)
## Units
<img src='assets/img/product_pics/3.jpg'> <img src='assets/img/product_pics/unit.png'>
| Input/Sensing Class | Output/Controlling Class | Interface Class |
| :-------------------: |:------------------------: | :----------------:|
| [ENV](en/product_documents/units/unit_env) | [RGB](en/product_documents/units/unit_rgb) | [HUB](en/product_documents/units/unit_hub) |
| [IR](en/product_documents/units/unit_ir) | [RELAY](en/product_documents/units/unit_relay) | [3.96PORT](en/product_documents/units/unit_396port) |
| [PIR](en/product_documents/units/unit_pir) | [NeoPixel](en/product_documents/units/unit_neopixel) | / |
| [ANGLE](en/product_documents/units/unit_angle) | / | / |
| [EARTH/Moisture](en/product_documents/units/unit_moisture) | / | / |
| [LIGHT](en/product_documents/units/unit_light) | / | / |
| [MAKEY](en/product_documents/units/unit_makey) | / | / |
| [BUTTON](en/product_documents/units/unit_button) | / | / |
| [Dual-BUTTON](en/product_documents/units/unit_dual_button) | / | / |
| [JOYSTICK](en/product_documents/units/unit_joystick) | / | / |
| [THERMAL](en/product_documents/units/unit_thermal) | / | / |
| [ADC](en/product_documents/units/unit_ADC) | / | / |
| [DAC](en/product_documents/units/unit_DAC) | / | / |
| [Color Sensor](en/product_documents/units/unit_color_sensor) | / | / |
| [ToF](en/product_documents/units/unit_tof) | / | / |
| [ESP32Cam](en/product_documents/units/unit_esp32cam) | / | / |
| [M5Camera](en/product_documents/units/unit_m5camera) | / | / |
| [ENV](/en/product_documents/units/unit_env) | [RGB](/en/product_documents/units/unit_rgb) | [HUB](/en/product_documents/units/unit_hub) |
| [IR](/en/product_documents/units/unit_ir) | [RELAY](/en/product_documents/units/unit_relay) | [3.96PORT](/en/product_documents/units/unit_396port) |
| [PIR](/en/product_documents/units/unit_pir) | [NeoPixel](/en/product_documents/units/unit_neopixel) | / |
| [ANGLE](/en/product_documents/units/unit_angle) | / | / |
| [EARTH/Moisture](/en/product_documents/units/unit_moisture) | / | / |
| [LIGHT](/en/product_documents/units/unit_light) | / | / |
| [MAKEY](/en/product_documents/units/unit_makey) | / | / |
| [BUTTON](/en/product_documents/units/unit_button) | / | / |
| [Dual-BUTTON](/en/product_documents/units/unit_dual_button) | / | / |
| [JOYSTICK](/en/product_documents/units/unit_joystick) | / | / |
| [THERMAL](/en/product_documents/units/unit_thermal) | / | / |
| [ADC](/en/product_documents/units/unit_ADC) | / | / |
| [DAC](/en/product_documents/units/unit_DAC) | / | / |
| [Color Sensor](/en/product_documents/units/unit_color_sensor) | / | / |
| [ToF](/en/product_documents/units/unit_tof) | / | / |
| [ESP32Cam](/en/product_documents/units/unit_esp32cam) | / | / |
| [M5Camera](/en/product_documents/units/unit_m5camera) | / | / |
| [NCIR](/en/product_documents/units/unit_ncir) | / | / |
## Applications
<img src='assets/img/product_pics/4.jpg'> <img src='assets/img/product_pics/application.png'>
- [BALA](en/product_documents/applications/application_bala)
- [BALA](/en/product_documents/applications/application_bala)
## Tools
<img src='assets/img/product_pics/6.jpg'> <img src='assets/img/product_pics/tool.png'>
- [M5Stack USB Downloader](en/product_documents/tools/tool_usb_downloader)
- [M5Stack USB Downloader](/en/product_documents/tools/tool_usb_downloader)
@@ -51,4 +51,4 @@ and so on.
- **GitHub** - [Arduino GitHub](https://github.com/m5stack/M5Stack)
- **<mark>Quick Start</mark>** - 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)
- **<mark>Quick Start</mark>** - 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)
@@ -58,7 +58,7 @@ and so on.
- **[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)**
- **<mark>Quick Start</mark>** - 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)
- **<mark>Quick Start</mark>** - 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)
## READ MORE
@@ -55,4 +55,4 @@ Motion" via M5Stack GRAY in a day in stead of couple weeks and so on.
- **[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)**
- **<mark>Quick Start</mark>** - 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)
- **<mark>Quick Start</mark>** - 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)
@@ -31,4 +31,4 @@ There are two reserved pins(RTS, DTR) on M5Stack USB Downloader for other applic
<!-- <figure>
<img src="assets/img/product_pics/units/M5GO_Unit_moisture.jpg" height="50" width="49">
</figure> -->
</figure> -->
@@ -30,5 +30,5 @@ This is a unit can detecte the color of object surface which integrates TCS3472
- [Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Color-Unit-TCS34725-Color-Sensor-RGB-Color-Sensor-Development-Board-Module-GROVE-I2C-Compatible/3226069_32946957647.html?spm=a2g1x.12024536.productList_5885013.pic_5)
<figure>
<img src="assets/img/product_pics/units/M5GO_Unit_ncir.png" height="300" width="300">
<img src="assets/img/product_pics/units/M5GO_Unit_color_sensor.png" height="300" width="300">
</figure>
@@ -48,5 +48,6 @@ The ESP32Cam equips the ESP32 with everything necessary to program, run and deve
- **[Github](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)**
- **[Quick Start](en/quick_start/m5camera/m5camera_quick_start)**
- **[Quick Start](/en/quick_start/m5camera/m5camera_quick_start)**
- **[Read more](https://github.com/1zlab/1ZLAB_ESP32_Wifi_Camera)**
- [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)
@@ -48,7 +48,7 @@ The M5Camera equips the ESP32 with everything necessary to program, run and deve
- **[Github](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)**
- **[Quick Start](en/quick_start/m5camera/m5camera_quick_start)**
- **[Quick Start](/en/quick_start/m5camera/m5camera_quick_start)**
- **[Read more](https://github.com/1zlab/1ZLAB_ESP32_Wifi_Camera)**
<figure>
@@ -19,5 +19,5 @@ This is a RGB LED Cable unit. You can program it using NeoPixel Lib supported by
- [Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-NeoPixel-RGB-LEDs-Cable-SK6812-with-GROVE-Port-2m-1m-50cm-20cm-10cm/3226069_32950831315.html?spm=a2g1x.12024536.productList_5885013.pic_0)
<figure>
<img src="assets/img/product_pics/units/M5GO_Unit_neopixel.png" height="300" width="300">
<img src="assets/img/product_pics/units/M5GO_Unit_neopixel.jpg" height="300" width="300">
</figure>
+9 -13
View File
@@ -6,7 +6,6 @@
**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:
@@ -18,34 +17,31 @@ 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)
[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.
!> **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_connect_wifi_using_core) befor developing it.
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.
<img src="assets/img/getting_started_pics/m5stack_core.png"> | <img src="assets/img/getting_started_pics/m5camera.jpg"> | <img src="assets/img/getting_started_pics/M5Bala.jpg">
---|---|---
[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) | [M5BALA](/en/quick_start/bala/bala_quick_start)
## Practice
**For being familiar with the programming mode you lik, We suggest you following the corresponding option to do more practices.**
<img src="assets/img/getting_started_pics/programming_mode_arduino.png"> | <img src="assets/img/getting_started_pics/programming_mode_blockly.png"> | <img src="assets/img/getting_started_pics/programming_mode_micropython.png">
---|---|---
[Arduino](en/practice/practice_arduino) | [M5Flow-Blockly](en/practice/practice_blockly) | [M5Flow-MicroPython](en/practice/practice_micropython)
[Arduino](/en/practice/practice_arduino) | [M5Flow-Blockly](/en/practice/practice_blockly) | [M5Flow-MicroPython](/en/practice/practice_micropython)
## Related Documents
- [establish_serial_connection](en/related_documents/establish_serial_connection)
- [how_to_burn_firmware_en](en/related_documents/how_to_burn_firmware_en)
- [how_to_connect_wifi_using_core](en/related_documents/how_to_connect_wifi_using_core)
- [upgrade_m5stack_lib](en/related_documents/upgrade_m5stack_lib)
- [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)
@@ -1,6 +1,6 @@
# M5Core Quick Start(macOS, Arudino)
?> **Tip** If your OS is Windows, please click [here](en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows).
?> **Tip** If your OS is Windows, please click [here](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows).
## CONTENT
@@ -14,7 +14,7 @@
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).*
!> **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
@@ -1,6 +1,6 @@
# M5Core Quick Start(Windows, Arudino)
?> **Tip** If your OS is MacOS, please click [here](en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS).
?> **Tip** If your OS is MacOS, please click [here](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS).
## CONTENT
@@ -14,7 +14,7 @@
?> **Tip** *If you want to upgrade the M5Stack Lib, please view this article [upgrade M5Stack Lib](www.m5stack.com).*
!> **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.*
!> **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.*
## 1. Setting Environment
@@ -1,6 +1,6 @@
# M5Flow Quick Start(Blockly/MicroPython)
!> **Note** *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).*
!> **Note** *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.**
@@ -103,4 +103,4 @@ Now, run it and enjoy your musical work!
## Complete
?> **Note** *Also, For being more familiar with M5, here some simple pratices ([M5Flow Practices about Blockly](en/practice/practice_blockly) and [M5Flow Practices about Blockly](en/practice/practice_micropython)) for you or you can contact us for a [WorkShop](support@m5stack.com).*
?> **Note** *Also, For being more familiar with M5, here some simple pratices ([M5Flow Practices about Blockly](/en/practice/practice_blockly) and [M5Flow Practices about Blockly](/en/practice/practice_micropython)) for you or you can contact us for a [WorkShop](support@m5stack.com).*
@@ -4,4 +4,4 @@
<img src="assets/img/getting_started_pics/arduino_logo.png"> | <img src="assets/img/getting_started_pics/blockly_and_micropython.png">
---|---
[Arduino](en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Blockly/MicroPython](en/quick_start/m5core/m5stack_core_get_started_MicroPython)
[Arduino](/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [Blockly/MicroPython](/en/quick_start/m5core/m5stack_core_get_started_MicroPython)
@@ -31,7 +31,7 @@ Unzip the M5Burner tool which you donwloaded for official website just now, then
<img src="assets/img/getting_started_pics/how_to_burn_firmware/burn_firmware_02.png" alt="Screenshot of coverpage" title="Cover page">
</figure>
!> **Notice** If it does not display any ``COMx`` port or only ``COM1`` exists at the option, you need to visit this article [establish_serial_connection](related_documents/establish_serial_connection) and reinstall the USB driver.
!> **Notice** If it does not display any ``COMx`` port or only ``COM1`` exists at the option, you need to visit this article [establish_serial_connection](/en/related_documents/establish_serial_connection) and reinstall the USB driver.
**a. Choice a right firmware**
@@ -1,6 +1,6 @@
# How to Connect WIFI Using Core
?> **Tip** *If your M5Stack Core was not burnt with a specific firmware named `M5Flow` in advance, please visit this article [How to burn firmware](how_to_burn_firmware_en) for burnning)*
?> **Tip** *If your M5Stack Core was not burnt with a specific firmware named `M5Flow` in advance, please visit this article [How to burn firmware](/en/related_documents/how_to_burn_firmware) for burnning)*
**After powering on Core and pressing the red button on the left hand side of the M5you will be greeted by this screen. Let's connect to networkable AP.**
@@ -43,7 +43,7 @@
## Complete
Once you've reset M5Stack Core, pressed the upload buttom, you will arrive at a screen with a QR code. Now, you can try to program with your core following this article [Quick Start with M5Flow](quick_start/m5core/m5stack_core_get_started_MicroPython)
Once you've reset M5Stack Core, pressed the upload buttom, you will arrive at a screen with a QR code. Now, you can try to program with your core following this article [Quick Start with M5Flow](/en/quick_start/m5core/m5stack_core_get_started_MicroPython)
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/apikey.jpg">

Some files were not shown because too many files have changed in this diff Show More