diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 00000000..f9e262e8 --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +docs.m5stack.com \ No newline at end of file diff --git a/docs/assets/css/main-min.css b/docs/assets/css/main-min.css index 6df9ae6b..6ae812c6 100644 --- a/docs/assets/css/main-min.css +++ b/docs/assets/css/main-min.css @@ -28,9 +28,8 @@ img { } .markdown-section { - max-width: 80%; + max-width: 75%; margin-top: 50px; - padding: 2rem 10px 2rem 60px; } .markdown-section a { @@ -255,7 +254,7 @@ body[data-page="zh_CN/quick_start/m5stickc/m5stickc_quick_start.md"] article.mar .mask-btn1 { position: relative; - top: 60px; + top: 50px; left: 30px } @@ -337,7 +336,7 @@ div.card-img-overlay:hover { } .product_page { - margin-left: 110px; + margin-left: 60px; margin-top: 100px } @@ -827,8 +826,8 @@ mark { .anchor-box { position: fixed; - top: 30%; - left: 25px; + top: 25%; + left: 50px; display: -webkit-flex; display: flex; flex-direction: column; @@ -906,32 +905,33 @@ mark { @media screen and (max-width:1580px) { .anchor-box { - left: 10px + left: 20px } } -@media screen and (max-width:1445px) { - .anchor-box { - left: -10px - } -} @media screen and (max-width:1260px) { .anchor-box { - left: -35px + left: 0px } } -@media screen and (max-width:1000px) { +@media screen and (max-width:1100px) { .anchor-box { - left: -60px + left: -12px + } +} + +@media screen and (max-width:980px) { + .anchor-box { + left: -34px } } @media screen and (max-width:768px) { .anchor-box { position: fixed; - top: 45%; + top: 35%; left: auto; right: -120px; display: -webkit-flex; @@ -1169,4 +1169,25 @@ table tr:nth-child(odd) { display: block !important; overflow: scroll; } -} \ No newline at end of file +} + + +.files_download { + display: flex; + flex-direction: row; + justify-content: space-evenly; + flex-wrap: wrap; + margin: 45px; +} + +.files_download .item{ + display: flex; + justify-content: center; + width: 200px; + box-shadow: 4px 4px 7px 0px #cecece; + transition:all .25s ease; +} + +.files_download .item:hover{ + transform:scale(1.2); +} diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css index 48c0b91d..b552e00f 100755 --- a/docs/assets/css/main.css +++ b/docs/assets/css/main.css @@ -28,9 +28,8 @@ img { } .markdown-section { - max-width: 80%; + max-width: 75%; margin-top: 50px; - padding: 2rem 10px 2rem 60px; } .markdown-section a { @@ -255,7 +254,7 @@ body[data-page="zh_CN/quick_start/m5stickc/m5stickc_quick_start.md"] article.mar .mask-btn1 { position: relative; - top: 60px; + top: 50px; left: 30px } @@ -337,7 +336,7 @@ div.card-img-overlay:hover { } .product_page { - margin-left: 110px; + margin-left: 60px; margin-top: 100px } @@ -827,8 +826,8 @@ mark { .anchor-box { position: fixed; - top: 30%; - left: 25px; + top: 25%; + left: 50px; display: -webkit-flex; display: flex; flex-direction: column; @@ -906,32 +905,33 @@ mark { @media screen and (max-width:1580px) { .anchor-box { - left: 10px + left: 20px } } -@media screen and (max-width:1445px) { - .anchor-box { - left: -10px - } -} @media screen and (max-width:1260px) { .anchor-box { - left: -35px + left: 0px } } -@media screen and (max-width:1000px) { +@media screen and (max-width:1100px) { .anchor-box { - left: -60px + left: -12px + } +} + +@media screen and (max-width:980px) { + .anchor-box { + left: -34px } } @media screen and (max-width:768px) { .anchor-box { position: fixed; - top: 45%; + top: 35%; left: auto; right: -120px; display: -webkit-flex; @@ -1169,4 +1169,25 @@ table tr:nth-child(odd) { display: block !important; overflow: scroll; } -} \ No newline at end of file +} + + +.files_download { + display: flex; + flex-direction: row; + justify-content: space-evenly; + flex-wrap: wrap; + margin: 45px; +} + +.files_download .item{ + display: flex; + justify-content: center; + width: 200px; + box-shadow: 4px 4px 7px 0px #cecece; + transition:all .25s ease; +} + +.files_download .item:hover{ + transform:scale(1.2); +} diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/01.jpg b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/01.jpg new file mode 100644 index 00000000..fdcbdff1 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/01.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/hello_m5.gif b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/hello_m5.gif new file mode 100644 index 00000000..c457bdd1 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/hello_m5.gif differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/m5burner_wifi.jpg b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/m5burner_wifi.jpg new file mode 100644 index 00000000..b8a944c8 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/m5burner_wifi.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/uiflow_apikey.jpg b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/uiflow_apikey.jpg new file mode 100644 index 00000000..72896f47 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/uiflow_apikey.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/uiflow_program_mode.jpg b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/uiflow_program_mode.jpg new file mode 100644 index 00000000..5e742383 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/uiflow_program_mode.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/uiflow_wifi_setup1.jpg b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/uiflow_wifi_setup1.jpg new file mode 100644 index 00000000..53e548aa Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/uiflow_wifi_setup1.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/uiflow_wifi_setup2.jpg b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/uiflow_wifi_setup2.jpg new file mode 100644 index 00000000..2b7dbc12 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stack_core/get_started_with_uiflow/uiflow_wifi_setup2.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5burner_stickc01.jpg b/docs/assets/img/getting_started_pics/m5stickc/m5burner_stickc01.jpg new file mode 100644 index 00000000..22562d38 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/m5burner_stickc01.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5burner_stickc02.jpg b/docs/assets/img/getting_started_pics/m5stickc/m5burner_stickc02.jpg new file mode 100644 index 00000000..8dbce516 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/m5burner_stickc02.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5stickc_apikey01.jpg b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_apikey01.jpg new file mode 100644 index 00000000..65f6e393 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_apikey01.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5stickc_desktop_ide01.jpg b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_desktop_ide01.jpg new file mode 100644 index 00000000..ef54e9d8 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_desktop_ide01.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5stickc_example.jpg b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_example.jpg new file mode 100644 index 00000000..abf08a73 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_example.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5stickc_usb_connect.jpg b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_usb_connect.jpg new file mode 100644 index 00000000..24015bff Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_usb_connect.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5stickc_usb_mode01.jpg b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_usb_mode01.jpg new file mode 100644 index 00000000..bca49e7d Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_usb_mode01.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5stickc_wifi_mode.jpg b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_wifi_mode.jpg new file mode 100644 index 00000000..1c6de0c6 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_wifi_mode.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/m5stickc_wifi_setup01.jpg b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_wifi_setup01.jpg new file mode 100644 index 00000000..8770e26a Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/m5stickc_wifi_setup01.jpg differ diff --git a/docs/en/core/face_kit.md b/docs/en/core/face_kit.md index aa8f8aab..dc2d3f01 100644 --- a/docs/en/core/face_kit.md +++ b/docs/en/core/face_kit.md @@ -136,6 +136,7 @@ Key string values Key Int Values (Int values are the ASCII value of each key) + diff --git a/docs/en/hat/hat-joyc.md b/docs/en/hat/hat-joyc.md index a237843f..2d60632a 100644 --- a/docs/en/hat/hat-joyc.md +++ b/docs/en/hat/hat-joyc.md @@ -46,7 +46,12 @@ -- **[Arduino](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Hat/JoyC)** +- **Arduino** + +Use with RoverC HAT, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Hat/JoyC) + +Use alone [here](https://github.com/m5stack/M5StickC/blob/master/examples/Hat/JoyC/JoyC.ino) + diff --git a/docs/en/quick_start/m5core/m5stack_core_quick_start.md b/docs/en/quick_start/m5core/m5stack_core_quick_start.md index 6f4661d4..eb2efc67 100644 --- a/docs/en/quick_start/m5core/m5stack_core_quick_start.md +++ b/docs/en/quick_start/m5core/m5stack_core_quick_start.md @@ -4,7 +4,7 @@
- +

UIFlow

diff --git a/docs/en/quick_start/m5stickc/m5stickc_quick_start.md b/docs/en/quick_start/m5stickc/m5stickc_quick_start.md index 81b0633d..adfc6805 100644 --- a/docs/en/quick_start/m5stickc/m5stickc_quick_start.md +++ b/docs/en/quick_start/m5stickc/m5stickc_quick_start.md @@ -5,7 +5,7 @@
- +

UIFlow

diff --git a/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_uiflow.md b/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_uiflow.md index d6e4dd89..c938465c 100644 --- a/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_uiflow.md +++ b/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_uiflow.md @@ -1,161 +1,163 @@ -# M5StickC Quick Start - UIFlow {docsify-ignore-all} +# UIFlow Quick Start - +?> This tutorial applies to M5StickC -**[1. Burn UIFlow Firmware](#_1-Burn-UIFlow-Firmware)** +## Burning tool -**[2. Wi-Fi Setting](#_2-Wi-Fi-Setting)** +> Please click the button below to download the corresponding M5Burner firmware burning tool according to your operating system. Unzip and open the application. -**[3. Program](#_3-Program)** +
+

+ + + Windows10 + +

-## 1. Burn UIFlow Firmware +

+ + + MacOS + +

-### (1) Download M5Burner +

+ + + Linux + +

+
->1.Click on the M5Burner burning tool for your operating system below to download. + - - -
-
+

Hardware

Some basic control of device hardware in UIFlow, and information acquisition.

@@ -31,14 +29,14 @@

UIFlow display control for characters and graphics, as well as image upload and drawing functions.

View details »

-
- -

Data structure

Introduction to data types in UIFlow, including constants, variables, characters, random numbers, lists, etc.

View details »

+
+ +

Logic

The use of logic judgments, operations, and conditional loops, iterations, functions, etc. in UIFlow.

@@ -49,14 +47,14 @@

The higher-level functions in UIFlow involve remote functions and the use of MQTT communication.

View details »

+
+

Units

+

Introduction to how to use unit devices, such as ToF, ENV, Realy, inlucde I/O,UART,I2C,etc.

+

View details »

+
-
-

Units

-

Introduction to how to use unit devices, such as ToF, ENV, Realy, inlucde I/O,UART,I2C,etc.

-

View details »

-

Modules

Introduce some useful modules block add to your project in UIFlow.

@@ -67,17 +65,12 @@

UIFlow uses FACES panel for interface interaction or data manipulation help you to improve input efficiency.

View details »

-
- - -

Custom

The creation and use of UIFlow custom program blocks.

View details »

-




\ No newline at end of file diff --git a/docs/image/base/device_select.jpg b/docs/image/base/device_select.jpg new file mode 100644 index 00000000..04afcdd5 Binary files /dev/null and b/docs/image/base/device_select.jpg differ diff --git a/docs/index.html b/docs/index.html index 0beabe5f..bf6f14da 100755 --- a/docs/index.html +++ b/docs/index.html @@ -335,6 +335,30 @@ gtag('config', 'UA-138139529-2'); + + + + \ No newline at end of file + diff --git a/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md b/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md index 3a7aa24c..6d901e6c 100644 --- a/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md +++ b/docs/zh_CN/quick_start/m5core/m5stack_core_quick_start.md @@ -4,7 +4,7 @@
- +

UIFlow

diff --git a/docs/zh_CN/quick_start/m5stickc/m5stickc_quick_start.md b/docs/zh_CN/quick_start/m5stickc/m5stickc_quick_start.md index 9acb33b1..d00ffb21 100644 --- a/docs/zh_CN/quick_start/m5stickc/m5stickc_quick_start.md +++ b/docs/zh_CN/quick_start/m5stickc/m5stickc_quick_start.md @@ -5,7 +5,7 @@
- +

UIFlow

diff --git a/docs/zh_CN/quick_start/m5stickc/m5stickc_quick_start_with_uiflow.md b/docs/zh_CN/quick_start/m5stickc/m5stickc_quick_start_with_uiflow.md index cd5ec450..1aa6de79 100644 --- a/docs/zh_CN/quick_start/m5stickc/m5stickc_quick_start_with_uiflow.md +++ b/docs/zh_CN/quick_start/m5stickc/m5stickc_quick_start_with_uiflow.md @@ -1,171 +1,163 @@ -# M5StickC 上手指南 - UIFlow {docsify-ignore-all} +# UIFlow 快速上手 - +?>本教程适用于M5StickC -**[1. 烧录 UIFlow 固件](#_1-烧录-UIFlow-固件)** +## 烧录工具 -**[2. 设置 Wi-Fi](#_2-设置-Wi-Fi)** +>请根据您所使用的操作系统,点击下方按钮下载相应的M5Burner固件烧录工具.解压打开应用程序。 -**[3. 例程](#_3-例程)** +
+

+ + + Windows10 + +

-## 1. 烧录 UIFlow 固件 +

+ + + MacOS + +

-#### (1) 下载 M5Burner +

+ + + Linux + +

+
->1.点击下方对应自己操作系统的 M5Burner烧录工具 进行下载. + -
KeyACM% ÷0-9X-+= +/-.