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

add quick start link

Browse Source
This commit is contained in:
LiHuashen
2018-12-05 18:42:54 +08:00
parent 5cacc39d70
commit efb7e66aee
13 changed files with 30 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/quick_start.md
+1 -33
View File
@@ -2,32 +2,7 @@
[中文](/zh_CN/quick_start) | English | [日本語](/ja/quick_start)
**This document is intended to help you set up the software environment(<mark>Arudino</mark>, <mark>MicroPython</mark>) for development of M5Stack. Through a simple example we would like to illustrate how to develop M5Stack boards, firmware(<mark>Arduino</mark>) or source files(<mark>MicroPython</mark>) download to M5Stack boards.**
## Introduction
**M5 stack is a modular stackable development device. The M stands for Modular and 5 stands for the the units compact 5 x 5 cm size.**
## What You Need
To develop applications for M5Stack Core you need:
* **PC** loaded with either Windows, Linux or Mac operating system
* a **Type-C** cable
Before setting development environment, the step below you need to follow:
1. Establish **serial** connection
[How to Establish serial connection](/en/related_documents/establish_serial_connection)
## Quick Start
!> **Notice** Make sure you have installed USB driver so that your board can establish serial connection with PC. If not, please view this article [How to Establish serial connection](/en/related_documents/establish_serial_connection) for connection.
At the first time, you need to burn the specific firmware file(.bin) to your board following this article [How to burn firmware](/en/related_documents/how_to_burn_firmware) befor developing it.
If you have one of ESP32 development boards listed below, click the corresponding one to start your development.
*This document is intended to help you set up the software environment(<mark>Arudino</mark>, <mark>MicroPython</mark>) for development of M5Stack. Through a simple example we would like to illustrate how to develop M5Stack boards, firmware(<mark>Arduino</mark>) or source files(<mark>MicroPython</mark>) download to M5Stack boards.*
<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">
---|---|---
@@ -40,10 +15,3 @@ If you have one of ESP32 development boards listed below, click the correspondin
<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) | [UiFlow-Blockly](/en/practice/practice_blockly) | [UiFlow-MicroPython](/en/practice/practice_micropython) -->
## Related Documents
- [establish_serial_connection](/en/related_documents/establish_serial_connection)
- [how_to_burn_firmware](/en/related_documents/how_to_burn_firmware)
- [how_to_connect_wifi_using_core](/en/related_documents/how_to_connect_wifi_using_core)
- [upgrade_m5stack_lib](/en/related_documents/upgrade_m5stack_lib)
docs/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md
+4 -4
View File
@@ -2,7 +2,9 @@
[中文](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | English | [日本語](ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS)
?> **Tip** If your OS is Windows, please click [here](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows).
?> If your OS is Windows, please click [here](/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows).
!> Before setting the development environment, we suggest you confirm whether the USB driver has installed. If not, please visit this link [establish serial connection](/en/related_documents/establish_serial_connection).
## CONTENT
@@ -16,8 +18,6 @@
2. [Example](#example)
!> **Note** *Before setting the development environment, we suggest you confirm whether the USB driver has installed. If not, please visit this link [establish serial connection](/en/related_documents/establish_serial_connection).*
## Setting Environment
### Step1. Install `Arduino IDE`
@@ -132,4 +132,4 @@ Although most versions of MacOS have no problem with detecting the COM port, on
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/macOS_security_and_privacy_02.png">
</figure>
?> **Tip** **If you want to read more the permission about the CP2104 USB driver, visit the below link please.** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html
?> **If you want to read more the permission about the CP2104 USB driver, visit the below link please.** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html
docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython.md
+4 -4
View File
@@ -2,15 +2,15 @@
[中文](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython) | English | [日本語](ja/quick_start/m5core/m5stack_core_get_started_MicroPython)
?> **Tip** *a. If your M5Stack Core was not burnt with a specific firmware named `UiFlow` in advance, please visit this article [How to burn firmware](/en/related_documents/how_to_burn_firmware) for burnning). b. If it's first time to use M5Stack Core or you want to change the networkable AP that means the Core can't access [flow.m5stack.com](flow.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core](/en/related_documents/how_to_connect_wifi_using_core).*
?> a. If your M5Stack Core was not burnt with a specific firmware named `UiFlow` in advance, please visit this article [How to burn firmware](/en/related_documents/how_to_burn_firmware) for burnning). b. If it's first time to use M5Stack Core or you want to change the networkable AP that means the Core can't access [flow.m5stack.com](flow.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core](/en/related_documents/how_to_connect_wifi_using_core).
*By default, we account your M5Core has been connected with the networkable AP. And the screen shows like this figure below after you pressed the `UPLOAD` button on the left.*
By default, we account your M5Core has been connected with the networkable AP. And the screen shows like this figure below after you pressed the `UPLOAD` button on the left. After a few seconds if nothing is pressed the M5 will automatically run the code that was previously uploaded. If we want to upload new code we have to make sure we press the `upload` button on this menu before the M5 boots the code in it’s memory.
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/apikey.jpg">
</figure>
?> **Tip** *After a few seconds if nothing is pressed the M5 will automatically run the code that was previously uploaded. If we want to upload new code we have to make sure we press the `upload` button on this menu before the M5 boots the code in it’s memory.*
## **CONTENT**
@@ -102,4 +102,4 @@ Now, run it and enjoy your musical work!
## **Complete**
?> **Note** *Also, For being more familiar with M5, you can contact us for a WorkShop <support@m5stack.com>*
?> *Also, For being more familiar with M5, you can contact us for a WorkShop <support@m5stack.com>*
docs/en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md
+2 -2
View File
@@ -2,9 +2,9 @@
[中文](zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) | English | [日本語](ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud)
?> **Note** *If it's first time to use M5Core or you want to change the networkable AP that means the Core can't access [http://cloud.m5stack.com](http://cloud.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core with M5Cloud](/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud).*
?> If it's first time to use M5Core or you want to change the networkable AP that means the Core can't access [http://cloud.m5stack.com](http://cloud.m5stack.com), you need visit this article for setting wifi [How to connect wifi using Core with M5Cloud](/en/related_documents/how_to_connect_wifi_using_core_with_m5cloud).
*By default, we consider your M5Core has been connected with the networkable AP successfully. And the screen shows like this figure below.*
By default, we consider your M5Core has been connected with the networkable AP successfully. And the screen shows like this figure below.
<figure>
<img src="assets/img/getting_started_pics/get_started_with_m5cloud/check_code_on_m5stack.png">
docs/ja/quick_start.md
+5 -5
View File
@@ -2,9 +2,9 @@
[中文](/zh_CN/quick_start) | [English](/en/quick_start) | 日本語
**このページはM5Stack開発のためのソフトウェア環境（Arduino/MicroPython）構築支援のページです。開発方法や、ファームウェアやソースファイルをM5Stackに書き込む方法を簡単な例を通して説明していきます。**
*このページはM5Stack開発のためのソフトウェア環境（Arduino/MicroPython）構築支援のページです。開発方法や、ファームウェアやソースファイルをM5Stackに書き込む方法を簡単な例を通して説明していきます。*
## イントロダクション
<!-- ## イントロダクション
**M5Stackはモジュール積み重ねるタイプの開発デバイスです。M5Stackの名前はModuleのM、5x5cmサイズの5、積み重ねるを意味するStackからきています。**
@@ -27,7 +27,7 @@ M5Stackを使った開発に必要なもの:
最初に特定のファームウェアファイルを(.bin)をあなたのM5Stackに書き込む必要があります。 開発の前にこちらのページを参照してください。[ファームウェアの更新方法](/ja/related_documents/how_to_burn_firmware)
以下のリストから、あなたの持っているM5Stackに合わせてコースを選択してください。
以下のリストから、あなたの持っているM5Stackに合わせてコースを選択してください。 -->
<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">
---|---|---
@@ -41,9 +41,9 @@ M5Stackを使った開発に必要なもの:
---|---|---
[Arduino](/ja/practice/practice_arduino) | [UiFlow-Blockly](/ja/practice/practice_blockly) | [UiFlow-MicroPython](/ja/practice/practice_micropython) -->
## 関連するドキュメント
<!-- ## 関連するドキュメント
- [シリアル接続の確立方法](/ja/related_documents/establish_serial_connection)
- [ファームウェアの更新方法](/ja/related_documents/how_to_burn_firmware)
- [M5StackのWi-Fi接続方法](/ja/related_documents/how_to_connect_wifi_using_core)
- [Arduino IDEのM5Stackライブラリ更新方法](/ja/related_documents/upgrade_m5stack_lib)
- [Arduino IDEのM5Stackライブラリ更新方法](/ja/related_documents/upgrade_m5stack_lib) -->
docs/ja/sidebar.md
+1 -1
View File
@@ -1,5 +1,5 @@
- [製品ドキュメント](ja/product_documents)
<!-- - [クイックスタート](ja/quick_start) -->
- [クイックスタート](ja/quick_start)
- [API リファレンス](ja/api_reference)
- [M5Stack アプリケーション](ja/m5stack_cases)
- [その他のドキュメント](ja/related_documents)
docs/sidebar.md
+1 -1
View File
@@ -1,5 +1,5 @@
- [Product Documents](en/product_documents)
<!-- - [Quick Start](en/quick_start) -->
- [Quick Start](en/quick_start)
- [API Reference](en/api_reference)
- [M5Stack Cases](en/m5stack_cases)
- [Related Documents](en/related_documents)
docs/zh_CN/quick_start.md
+1 -33
View File
@@ -2,32 +2,7 @@
中文 | [English](/en/quick_start) | [日本語](/ja/quick_start)
**这篇文章主要帮助你搭建M5Stack系列产品中<mark>Arduino</mark>，<mark>MicroPython</mark>的开发环境，并通过简单的例子引导你学会使用和开发M5Stack的所有产品，实现自己的创意作品。**
## 介绍(Introduction)
**M5是以M5Core主控为核心的一系列可堆叠、模块化的电子产品。 M 代表可堆叠的模块，5 代表模块尺寸为5 * 5 cm大小。**
## 需要准备的(What Your Need)
在开发之前，你需要着手准备一下东西：
* 一台装了Windows, Linux 或者 Mac系统的**电脑**
* 一根 **Type-C** 线
在搭建环境之前，你需要做一下软件准备：
1. 建立板子和PC之间的串口连接：
[如何下载串口驱动并建立串口连接](/zh_CN/related_documents\establish_serial_connection)
## 快速上手(Quick Start)
!> **注意** 确保你的板子已经能够与PC进行串口通信。如果还没的话，参考这篇教程 [如何下载串口驱动并建立串口连接](/zh_CN/related_documents\establish_serial_connection) for connection.
首先，在能进行串口通讯之后，你要根据板子类型和下面的教程，下载对应的固件程序(.bin)到板子里。 固件程序后缀名是.bin。 [如何烧录固件程序](/zh_CN/related_documents\how_to_burn_firmware)
点击下图中你所对应的板子开始开发，实现创意：
*这篇文章主要帮助你搭建M5Stack系列产品中<mark>Arduino</mark>，<mark>MicroPython</mark>的开发环境，并通过简单的例子引导你学会使用和开发M5Stack的所有产品，实现自己的创意作品。*
<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">
---|---|---
@@ -40,10 +15,3 @@
<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](/zh_CN/practice\practice_arduino) | [UiFlow-Blockly](/zh_CN/practice\practice_blockly) | [UiFlow-MicroPython](/zh_CN/practice\practice_micropython) -->
## 相关文档(Related Documents)
- [如何下载串口驱动并建立串口连接](/zh_CN/related_documents/establish_serial_connection)
- [如何烧录固件](/zh_CN/related_documents/how_to_burn_firmware)
- [如何让Core连接能上网的WIFI热点](/zh_CN/related_documents/how_to_connect_wifi_using_core)
- [如何升级Arduino IDE中的M5Stack库](/zh_CN/related_documents/upgrade_m5stack_lib)
docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS.md
+4 -4
View File
@@ -2,7 +2,9 @@
中文 | [English](en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS) | [日本語](ja/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS)
?> **提示** 如果你的操作系统是Windows，请点击[这里](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows)。
?> 如果你的操作系统是Windows，请点击[这里](zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows)。
!> 在配置环境之前，先确保你已经安装了USB驱动，并且M5Core能通过串口与PC通信。 如果还没的话，看这篇文章[如何建立串口连接](/zh_CN/related_documents/establish_serial_connection).
## 目录
@@ -16,8 +18,6 @@
2. [示例](#example)
!> **注意** *在配置环境之前，先确保你已经安装了USB驱动，并且M5Core能通过串口与PC通信。 如果还没的话，看这篇文章[如何建立串口连接](/zh_CN/related_documents/establish_serial_connection).*
## 配置环境
### Step1. 安装`Arduino IDE`
@@ -124,4 +124,4 @@ python get.py
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_arduino_m5core/mac/macOS_security_and_privacy_02.png">
</figure>
?> **Tip** **如果你想了解更多关于CP2104 USB驱动的资料，请阅读这个链接的内容** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html
?> **如果你想了解更多关于CP2104 USB驱动的资料，请阅读这个链接的内容** https://developer.apple.com/library/archive/technotes/tn2459/\_index.html
docs/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows.md
-1
View File
@@ -6,7 +6,6 @@
!> 建议你先确认安装了`USB驱动`, `Git` 和 `Arduino IDE`。 如果还没的话，阅读这两篇文档[如何建立串口连接](/zh_CN/related_documents/establish_serial_connection)和[安装Git和Arduino IDE](/zh_CN/related_documents/how_to_install_git_and_arduino)。
## 目录
1. [配置环境](#setting-environment)
docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython.md
+3 -4
View File
@@ -2,15 +2,14 @@
中文 | [English](en/quick_start/m5core/m5stack_core_get_started_MicroPython) | [日本語](ja/quick_start/m5core/m5stack_core_get_started_MicroPython)
?> **Tip** *a. 如果你的设备还没烧录UiFlow固件的话，请参考这篇文档[如果使用M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware).* *b. 如果你是第一次使用这个Core或者想Core连接其他可联网的热点AP的话，请参考这篇文档[如果使用Core连接WIFI和UiFlow](/zh_CN/related_documents/how_to_connect_wifi_using_core)。*
?> a. 如果你的设备还没烧录UiFlow固件的话，请参考这篇文档[如果使用M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware). b. 如果你是第一次使用这个Core或者想Core连接其他可联网的热点AP的话，请参考这篇文档[如果使用Core连接WIFI和UiFlow](/zh_CN/related_documents/how_to_connect_wifi_using_core)。
*这时候，你的M5Core已经连接到了可联网WIFI热点，如果按下Core上左边的按键`UPLOAD`的话，会如下图显示。*
这时候，你的M5Core已经连接到了可联网WIFI热点，如果按下Core上左边的按键`UPLOAD`的话，会如下图显示。如果M5Core开机之后，两三秒内没做操作的话，会自动地显示预置的程序界面。所以最好开机之后，立马按下`upload`按键。
<figure>
<img src="assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/apikey.jpg">
</figure>
?> **Tip** *如果M5Core开机之后，两三秒内没做操作的话，会自动地显示预置的程序界面。所以最好开机之后，立马按下`upload`按键。*
## 目录
@@ -101,4 +100,4 @@ lcd.print("Hello M5Stack")
## 最后
?> **Tip** *如果你想了解更多UiFlow方面的编程的话，可以给我们发邮件，报名我们的课程<support@m5stack.com>.*
?> *如果你想了解更多UiFlow方面的编程的话，可以给我们发邮件，报名我们的课程<support@m5stack.com>.*
docs/zh_CN/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud.md
+3 -3
View File
@@ -2,11 +2,11 @@
中文 | [English](en/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud) | [日本語](ja/quick_start/m5core/m5stack_core_get_started_MicroPython_m5cloud)
?> **Note** *如果你的设备还没烧录M5Cloud固件的话，请参考这篇文档[如果使用M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware).*
?> 如果你的设备还没烧录M5Cloud固件的话，请参考这篇文档[如果使用M5Burner烧录固件](/zh_CN/related_documents/how_to_burn_firmware).
?> **Note** *如果你是第一次使用这个Core或者想Core连接其他可联网的热点AP的话，请参考这篇文档[如果使用Core连接WIFI和M5Cloud](/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud).*
?> 如果你是第一次使用这个Core或者想Core连接其他可联网的热点AP的话，请参考这篇文档[如果使用Core连接WIFI和M5Cloud](/zh_CN/related_documents/how_to_connect_wifi_using_core_with_m5cloud).
*如果你的Core已经连接了可联网WIFI热点之后，屏幕会如下图显示，出现check code(check code用于M5Core设备与M5Cloud绑定)，下面开始M5Cloud的编程*
如果你的Core已经连接了可联网WIFI热点之后，屏幕会如下图显示，出现check code(check code用于M5Core设备与M5Cloud绑定)，下面开始M5Cloud的编程
<figure>
<img src="assets/img/getting_started_pics/get_started_with_m5cloud/check_code_on_m5stack.png">
docs/zh_CN/sidebar.md
+1 -1
View File
@@ -1,5 +1,5 @@
- [产品介绍](zh_CN/product_documents)
<!-- - [快速上手](zh_CN/quick_start) -->
- [快速上手](zh_CN/quick_start)
- [API参考](zh_CN/api_reference)
- [M5Stack案例](zh_CN/m5stack_cases)
- [相关文档](zh_CN/related_documents)