m5/m5-docs
0
0
Fork 0
mirror of https://github.com/m5stack/m5-docs.git synced 2026-05-20 10:23:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

updated

Browse Source
This commit is contained in:
watson8544
2018-09-21 18:02:01 +08:00
parent 675864d9c3
commit 9673cc16f5
11 changed files with 167 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
_static/getting_started_pics/programming_mode_blockly.png
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 33 KiB

_static/getting_started_pics/programming_mode_micropython.png
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 127 KiB

After

Width:  |  Height:  |  Size: 132 KiB

_static/m5stack.png
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 720 KiB

After

Width:  |  Height:  |  Size: 212 KiB

en/get-started/m5stack_core_get_started.rst
+7 -9
View File
@@ -4,16 +4,14 @@ M5Stack Core Get Started
Pick up your programming mode below for getting started
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
============================ ============================ ============================
|Arduino|_ |Blockly|_ |MicroPython|_
---------------------------- ---------------------------- ----------------------------
`Arduino`_ `Blockly`_ `MicroPython`_
============================ ============================ ============================
============================ ============================
|Arduino|_ |Blockly/MicroPython|_
---------------------------- ----------------------------
`Arduino`_ `Blockly/MicroPython`_
============================ ============================
.. |Arduino| image:: ../../_static/getting_started_pics/arduino_logo.png
.. |Blockly| image:: ../../_static/getting_started_pics/programming_mode_blockly.png
.. |MicroPython| image:: ../../_static/getting_started_pics/micropython_logo.png
.. |Blockly/MicroPython| image:: ../../_static/getting_started_pics/micropython_logo.png
.. _Arduino: m5stack_core_get_started_Arduino_MacOS.html
.. _Blockly: m5Stack_core_get_started_MicroPython_MacOS.html
.. _MicroPython: m5Stack_core_get_started_MicroPython_MacOS.html
.. _Blockly/MicroPython: m5Stack_core_get_started_MicroPython_MacOS.html
en/get-started/m5stack_core_get_started_Arduino_MacOS.rst
+1 -1
View File
@@ -1,4 +1,4 @@
M5Stack-Core Get Started(MacOS, Arduino)
M5Stack Core Get Started(MacOS, Arduino)
========================================
.. note::
en/get-started/m5stack_core_get_started_Arduino_Windows.rst
+1 -1
View File
@@ -1,4 +1,4 @@
M5Stack-Core Get Started(Windows, Arduino)
M5Stack Core Get Started(Windows, Arduino)
===========================================
.. note::
en/get-started/m5stack_core_get_started_MicroPython_MacOS.md
View File
en/get-started/m5stack_core_get_started_MicroPython_MacOS.rst
+7
View File
@@ -0,0 +1,7 @@
M5Stack Core Get Started(MacOS, MicroPython)
========================================
.. note::
If your OS is Windows, please click `here`_.
.. _here: m5stack_core_get_started_MicroPython_Windows.html
en/get-started/m5stack_core_get_started_MicroPython_Windows.md
+6 -7
View File
@@ -1,4 +1,4 @@
# M5Stack-Core Get Started(Windows, MicroPython)
# M5Stack Core Get Started(Windows, MicroPython)
### CONTENT
@@ -23,7 +23,7 @@ Now, the M5Cloud firmware I downloaded named `m5cloud-20180516-v0.4.0.bin`
and it saved at `~/smbshare`
#### 2. Burn to M5Stack
![image](../../_static/windows-logo.png) | ![image](../../_static/linux-logo.png) | ![image](../../_static/macos-logo.png)
![image](../../_static/windows-logo.png) | ![image](../../_static/linux-logo.png) | ![image](../../_static/macos-logo.png)
---|---|---
Windows | Linux | MacOS
@@ -46,7 +46,7 @@ open Flash Download Tools([点击下载](https://www.espressif.com/sites/default
```
ls /dev/tty*
```
MacOS
```
@@ -72,11 +72,11 @@ Now, my serial port named `ttyUSB0`
```
esptool.py --chip esp32 --port /dev/ttyUSB0 erase_flash
```
- Download firmware to M5Stack:
- Download firmware to M5Stack:
```
esptool.py --chip esp32 --port /dev/ttyUSB0 write_flash --flash_mode dio -z 0x1000 m5cloud-20180516-v0.4.0.bin
```
### Connect Wi-Fi
@@ -102,7 +102,7 @@ Mobile Phone or PC connect to M5Stack AP(like `M5Stack-a67c`), and then open bro
*2. write your own code and press `Upload & Run` buttom on the M5Cloud IDE*
copy below code to `main.py` file and press `Upload & Run`
copy below code to `main.py` file and press `Upload & Run`
``` python
from m5stack import lcd
@@ -116,4 +116,3 @@ lcd.print("Hello World!")
```
![image](../../_static/M5Stack_MicroPython_UserGuidePictures/display_hello_world.png)
en/get-started/m5stack_core_get_started_MicroPython_Windows.rst
+1 -1
View File
@@ -1,4 +1,4 @@
M5Stack-Core Get Started(Windows, MicroPython)
M5Stack Core Get Started(Windows, MicroPython)
==============================================
CONTENT
en/get-started/m5stack_core_get_started_MicroPython_Windows_1.md
+144
View File
@@ -0,0 +1,144 @@
# M5Stack Core Get Started(Windows, Blockly/MicroPython)
This article will guide you for getting started with Blockly(or MicroPython) through [UIFlow](flow.m5stack.com)
### CONTENT
1. [Burn Firmware](#Burn-Firmwared)
- [1. Download Firmware](#1-download-firmware)
- [2. Burn to M5Stack](#2-Burn-to-M5Stack)
1. [Connect Wi-Fi](#connect-wi-fi)
3. [Binding device](#binding-device)
4. [Coding MicroPython](#coding-micropython)
### Burn Firmware
#### 1. Download Firmware
https://github.com/m5stack/M5Cloud/tree/master/firmwares
Now, the M5Cloud firmware I downloaded named `m5cloud-20180516-v0.4.0.bin`
and it saved at `~/smbshare`
#### 2. Burn to M5Stack
![image](../../_static/windows-logo.png) | ![image](../../_static/linux-logo.png) | ![image](../../_static/macos-logo.png)
---|---|---
Windows | Linux | MacOS
***Windows***
open Flash Download Tools([点击下载](https://www.espressif.com/sites/default/files/tools/flash_download_tools_v3.6.4.rar)) apply by Espressif, choose `ESP32 DownloadTool` option and execute three steps ( *choose firmware file, your serial port, erase and program flash* ) as shown below
![image](../../_static/M5Stack_MicroPython_UserGuidePictures/windows_download_firmware.png)
***MacOS/Linux***
*1. Check port on Linux and MacOS*
To check the device name for the serial port of your M5Stack board (or external converter dongle), run this command two times, first with the board / dongle unplugged, then with plugged in. The port which appears the second time is the one you need:
Linux
```
ls /dev/tty*
```
MacOS
```
ls /dev/cu.*
```
*2. Adding user to `dialout` on Linux*
The currently logged user should have read and write access the serial port over USB. On most Linux distributions, this is done by adding the user to `dialout` group with the following command:
```
sudo usermod -a -G dialout $USER
```
Now, my serial port named `ttyUSB0`
*3. Download M5Cloud firmware to M5Stack board*
- Installing esptool：
```
pip install esptool
```
- Erase flash on M5Stack:
```
esptool.py --chip esp32 --port /dev/ttyUSB0 erase_flash
```
- Download firmware to M5Stack:
```
esptool.py --chip esp32 --port /dev/ttyUSB0 write_flash --flash_mode dio -z 0x1000 m5cloud-20180516-v0.4.0.bin
```
###
Visit the [WebIDE](flow.m5stack.com), it will show as following figure.
![image](../../_static/getting_started_pics/m5stack_core/get_started_with_uiflow/webide.png)
Input the `APIKEY` which shows on the screen of M5Stack Core(Now, my APIKEY is `9C6469`) and click `SAVE`, that means your PC will bond with this Core so that you do not need to input `9C6469` again next time.
![image](../../_static/getting_started_pics/m5stack_core/get_started_with_uiflow/click_for_apikey.png)
![image](../../_static/getting_started_pics/m5stack_core/get_started_with_uiflow/input_apikey.png)
Then connect it
![image](../../_static/getting_started_pics/m5stack_core/get_started_with_uiflow/connecting.png)
At the moment, you can draw a UI or program it through Blockly(or Python) as shown below.
**Draw a UI**
![image](../../_static/getting_started_pics/m5stack_core/get_started_with_uiflow/draw_ui.png)
### Connect Wi-Fi
Mobile Phone or PC connect to M5Stack AP(like `M5Stack-a67c`), and then open brower to login 192.168.4.1 setting your LAN SSID and Password
![image](../../_static/M5Stack_MicroPython_UserGuidePictures/m5stack_connet_wifi.png)
### Binding device
*1.login http://io.m5stack.com and register your own account(or login your account)*
*2. press `Device->Add` buttom on M5Cloud IDE for binding M5Stack board to your account*
*3. Input the Check Code for the M5Stack screen display，Check Code is random, after 60s will refresh*
![image](../../_static/M5Stack_MicroPython_UserGuidePictures/WebIDE_check_code.png)
### Coding MicroPython
*1. create a new python project*
![image](../../_static/M5Stack_MicroPython_UserGuidePictures/create_a_new_project.png)
*2. write your own code and press `Upload & Run` buttom on the M5Cloud IDE*
copy below code to `main.py` file and press `Upload & Run`
``` python
from m5stack import lcd
lcd.clear()
lcd.setCursor(0, 0)
lcd.setColor(lcd.WHITE)
lcd.print("Hello World!")
```
![image](../../_static/M5Stack_MicroPython_UserGuidePictures/display_hello_world.png)