diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css index f59d7f56..a5e167e7 100644 --- a/docs/assets/css/main.css +++ b/docs/assets/css/main.css @@ -275,7 +275,10 @@ body[data-page="ja/README.md"] #faces-kit { #unit-fan, #op90, #op180, -#accel { +#accel, +#laser-rx, +#laser-tx, +#mini-proto { width: 0; height: 0; overflow: hidden; @@ -337,7 +340,10 @@ body[data-page="ja/README.md"] #application { #hat-spk, #hat-proto, #hat-ncir, -#hat-thermal { +#hat-thermal, +#hat-adc, +#hat-dac, +#hat-rs485 { width: 0; height: 0; overflow: hidden; diff --git a/docs/assets/img/getting_started_pics/m5stickv/1561458023(1).jpg b/docs/assets/img/getting_started_pics/m5stickv/1561458023(1).jpg deleted file mode 100644 index 60835c31..00000000 Binary files a/docs/assets/img/getting_started_pics/m5stickv/1561458023(1).jpg and /dev/null differ diff --git a/docs/assets/img/getting_started_pics/m5stickv/1561458061(1).jpg b/docs/assets/img/getting_started_pics/m5stickv/1561458061(1).jpg deleted file mode 100644 index 5832f75d..00000000 Binary files a/docs/assets/img/getting_started_pics/m5stickv/1561458061(1).jpg and /dev/null differ diff --git a/docs/assets/img/getting_started_pics/m5stickv/kflash_gui_01.jpg b/docs/assets/img/getting_started_pics/m5stickv/kflash_gui_01.jpg index c5491804..60ee26ec 100644 Binary files a/docs/assets/img/getting_started_pics/m5stickv/kflash_gui_01.jpg and b/docs/assets/img/getting_started_pics/m5stickv/kflash_gui_01.jpg differ diff --git a/docs/assets/img/getting_started_pics/m5stickv/kflash_gui_02.jpg b/docs/assets/img/getting_started_pics/m5stickv/kflash_gui_02.jpg deleted file mode 100644 index a50875d1..00000000 Binary files a/docs/assets/img/getting_started_pics/m5stickv/kflash_gui_02.jpg and /dev/null differ diff --git a/docs/assets/img/getting_started_pics/m5stickv/putty_02.jpg b/docs/assets/img/getting_started_pics/m5stickv/putty_02.jpg index 93a751c9..53404887 100644 Binary files a/docs/assets/img/getting_started_pics/m5stickv/putty_02.jpg and b/docs/assets/img/getting_started_pics/m5stickv/putty_02.jpg differ diff --git a/docs/assets/img/product_pics/hat/adc_hat/adc_hat_04.jpg b/docs/assets/img/product_pics/hat/adc_hat/adc_hat_04.jpg new file mode 100644 index 00000000..abfc5084 Binary files /dev/null and b/docs/assets/img/product_pics/hat/adc_hat/adc_hat_04.jpg differ diff --git a/docs/assets/img/product_pics/hat/dac_hat/dac_hat_04.jpg b/docs/assets/img/product_pics/hat/dac_hat/dac_hat_04.jpg new file mode 100644 index 00000000..34bcd1e0 Binary files /dev/null and b/docs/assets/img/product_pics/hat/dac_hat/dac_hat_04.jpg differ diff --git a/docs/assets/img/product_pics/hat/rs485_hat/rs485_hat_04.jpg b/docs/assets/img/product_pics/hat/rs485_hat/rs485_hat_04.jpg new file mode 100644 index 00000000..7ae79fd2 Binary files /dev/null and b/docs/assets/img/product_pics/hat/rs485_hat/rs485_hat_04.jpg differ diff --git a/docs/assets/img/product_pics/module/faces_rfid/faces_rfid_01.jpg b/docs/assets/img/product_pics/module/faces_rfid/faces_rfid_01.jpg index 3f348b02..6f8a2a09 100644 Binary files a/docs/assets/img/product_pics/module/faces_rfid/faces_rfid_01.jpg and b/docs/assets/img/product_pics/module/faces_rfid/faces_rfid_01.jpg differ diff --git a/docs/assets/img/product_pics/module/module_lora_01.jpg b/docs/assets/img/product_pics/module/module_lora_01.jpg new file mode 100644 index 00000000..83f9d61a Binary files /dev/null and b/docs/assets/img/product_pics/module/module_lora_01.jpg differ diff --git a/docs/assets/img/product_pics/module/module_lora_01.png b/docs/assets/img/product_pics/module/module_lora_01.png deleted file mode 100644 index 246adf12..00000000 Binary files a/docs/assets/img/product_pics/module/module_lora_01.png and /dev/null differ diff --git a/docs/assets/img/product_pics/module/module_lora_02.jpg b/docs/assets/img/product_pics/module/module_lora_02.jpg new file mode 100644 index 00000000..9d9bfed7 Binary files /dev/null and b/docs/assets/img/product_pics/module/module_lora_02.jpg differ diff --git a/docs/assets/img/product_pics/module/module_lora_02.png b/docs/assets/img/product_pics/module/module_lora_02.png deleted file mode 100644 index 49791f57..00000000 Binary files a/docs/assets/img/product_pics/module/module_lora_02.png and /dev/null differ diff --git a/docs/assets/img/product_pics/module/module_lora_03.png b/docs/assets/img/product_pics/module/module_lora_03.png deleted file mode 100644 index 9ee27c56..00000000 Binary files a/docs/assets/img/product_pics/module/module_lora_03.png and /dev/null differ diff --git a/docs/assets/img/product_pics/module/module_lora_04.png b/docs/assets/img/product_pics/module/module_lora_04.png deleted file mode 100644 index 767b70d4..00000000 Binary files a/docs/assets/img/product_pics/module/module_lora_04.png and /dev/null differ diff --git a/docs/assets/img/product_pics/unit/laser_rx/unit_laser_rx_04.jpg b/docs/assets/img/product_pics/unit/laser_rx/unit_laser_rx_04.jpg new file mode 100644 index 00000000..d9c161e5 Binary files /dev/null and b/docs/assets/img/product_pics/unit/laser_rx/unit_laser_rx_04.jpg differ diff --git a/docs/assets/img/product_pics/unit/laser_tx/unit_laser_tx_04.jpg b/docs/assets/img/product_pics/unit/laser_tx/unit_laser_tx_04.jpg new file mode 100644 index 00000000..b1f116a7 Binary files /dev/null and b/docs/assets/img/product_pics/unit/laser_tx/unit_laser_tx_04.jpg differ diff --git a/docs/assets/img/product_pics/unit/mini_proto/unit_mini_proto_04.jpg b/docs/assets/img/product_pics/unit/mini_proto/unit_mini_proto_04.jpg new file mode 100644 index 00000000..e74d8f63 Binary files /dev/null and b/docs/assets/img/product_pics/unit/mini_proto/unit_mini_proto_04.jpg differ diff --git a/docs/assets/img/product_pics/unit/unit_hex_01.jpg b/docs/assets/img/product_pics/unit/unit_hex_01.jpg new file mode 100644 index 00000000..25bae664 Binary files /dev/null and b/docs/assets/img/product_pics/unit/unit_hex_01.jpg differ diff --git a/docs/assets/img/product_pics/unit/unit_hex_01.png b/docs/assets/img/product_pics/unit/unit_hex_01.png deleted file mode 100644 index 8ed988fc..00000000 Binary files a/docs/assets/img/product_pics/unit/unit_hex_01.png and /dev/null differ diff --git a/docs/en/core/m5stickc.md b/docs/en/core/m5stickc.md index a29e49d4..d403b9be 100644 --- a/docs/en/core/m5stickc.md +++ b/docs/en/core/m5stickc.md @@ -129,6 +129,13 @@ M5stickC is one of the core devices in M5Stack product series which is built in power management ICSCLSDA +**AXP192** + + + + +
INLEDTFTRTCESP32
LD02LD03LD01DIC DCI
+ **M5StickC extendable IO at top** gray_02 diff --git a/docs/en/faq.md b/docs/en/faq.md index d5fe1e60..f63b280a 100644 --- a/docs/en/faq.md +++ b/docs/en/faq.md @@ -110,13 +110,18 @@ -- **Q9: One issue commonly exists on M5Stick-C, which happens when the battery is at a low level. In this case, some of the devices will have problem powering on, this is probably caused by a chaos timing sequence of power-on of ESP32, some component is involved, such as AXP192, 552, ESP32** +- **Q9: I can't power on my M5stickC**
- There is one way to bring the device back to live: 1, Connect G0 to 3V3. 2. Plug in the USB cable. 3, The screen will light up and leave the USB to charge the device. + + + One issue commonly exists on M5Stick-C, which happens when the battery is at a low level. In this case, some of the devices will have problem powering on, this is probably caused by a chaos timing sequence of power-on of ESP32, some component is involved, such as AXP192, 552, ESP32 + + There is one way to bring the device back to live: 1, Connect G0 to 3V3. 2. Plug in the USB cable. 3, The screen will light up and leave the USB to charge the device. +
diff --git a/docs/en/hat/hat-adc.md b/docs/en/hat/hat-adc.md new file mode 100644 index 00000000..0007ab1f --- /dev/null +++ b/docs/en/hat/hat-adc.md @@ -0,0 +1,44 @@ +# Hat ADC {docsify-ignore-all} + + + +*** + +:memo:**[Description](#Description)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://m5stack.com/collections/m5-unit/products/m5stickc-env-hat)**   **[EasyLoader](#EasyLoader)** + + + + + + + + + + + + + + + + + +## Schematic + + + + + +## EasyLoader + + + + + +>1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader. + +>2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click **"Burn"** to start burning. + + +## Links + +- **Datasheet** - [ADS1100](http://pdf1.alldatasheet.com/datasheet-pdf/view/619024/TI1/ADS1100.html) diff --git a/docs/en/hat/hat-dac.md b/docs/en/hat/hat-dac.md new file mode 100644 index 00000000..b27b3ca2 --- /dev/null +++ b/docs/en/hat/hat-dac.md @@ -0,0 +1,43 @@ +# Hat DAC {docsify-ignore-all} + + + +*** + +:memo:**[Description](#Description)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://m5stack.com/collections/m5-unit/products/m5stickc-env-hat)**   **[EasyLoader](#EasyLoader)** + + + + + + + + + + + + + + + +## Schematic + + + + + +## EasyLoader + + + + + +>1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader. + +>2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click **"Burn"** to start burning. + + + +## Links + +- **Datasheet** - [MCP4725](http://pdf1.alldatasheet.com/datasheet-pdf/view/233449/MICROCHIP/MCP4725.html) \ No newline at end of file diff --git a/docs/en/hat/hat-rs485.md b/docs/en/hat/hat-rs485.md new file mode 100644 index 00000000..041927a5 --- /dev/null +++ b/docs/en/hat/hat-rs485.md @@ -0,0 +1,31 @@ +# Hat RS485 {docsify-ignore-all} + + + +*** + +:memo:**[Description](#Description)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://m5stack.com/collections/m5-unit/products/m5stickc-env-hat)**   **[EasyLoader](#EasyLoader)** + + + + +## Schematic + + + + +## EasyLoader + + + + + +>1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader. + +>2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click **"Burn"** to start burning. + + + +## Links + +- **Datasheet** - [SP485EEN](https://pdf1.alldatasheet.com/datasheet-pdf/view/45954/SIPEX/SP485EEN.html) \ No newline at end of file diff --git a/docs/en/module/lora.md b/docs/en/module/lora.md index 7833651b..970b3b9d 100644 --- a/docs/en/module/lora.md +++ b/docs/en/module/lora.md @@ -1,6 +1,6 @@ # Module LORA {docsify-ignore-all} - + *** diff --git a/docs/en/quick_start/m5stickv/m5stickv_quick_start.md b/docs/en/quick_start/m5stickv/m5stickv_quick_start.md new file mode 100644 index 00000000..df32e733 --- /dev/null +++ b/docs/en/quick_start/m5stickv/m5stickv_quick_start.md @@ -0,0 +1,141 @@ +# M5StickV 上手指南 {docsify-ignore-all} + +## 目录 + +**[1. 下载固件](#下载固件)** + +**[2. 烧录固件](#烧录固件)** + +**[3. 串口调试工具](#串口调试工具)** + +**[4. Hello World](#Hello-World)** + +**[5. 编辑与运行文件](#编辑与运行文件)** + +**[6. 程序库](#程序库)** + + + +## 下载固件 + + + + + +## 烧录固件 + +>1.点击下方对应自己操作系统的 Kflash_GUI烧录工具进行下载. + +
+

Kflash_GUI:

+

+ Windows + MacOS + Linux

+
+ +>2.将设备通过Tpye-C数据线连接至电脑，双击打开烧录工具**Kflash_GUI**应用程序,选择对应的设备端口、固件程序、波特率. 点击下载，开始烧录 . + + + + +### Kflash + +>3.对于习惯使用命令行操作的用户来说还可以选择Kflash作为固件烧录工具.[点击此处查看详情](https://github.com/kendryte/kflash.py) + + +## 串口调试工具 + +>1.编程M5StickV需要使用到串口调试工具，您可以使用Putty作为串口调试工具, [点击此处](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html)访问Putty资源页面，选择对应自己操作系统Putty进行下载，并安装. + +>2.运行Putty后，将M5StickV通过Tpye-C数据线连接至电脑端口，在Putty中设置相应的端口号与波特率，点击"open"，开始连接. （你可以通过查看设备管理器得到M5StickV所使用的端口号） + + + +> 连接成功后，将自动进入，MaixPy 的交互界面. 此时设备正在运行着默认程序，您可以通过按下快捷键"Ctrl+C"中断其运行，并进入命令行. + + + + +## Hello World + +>在命令行输入下方代码，M5StickV屏幕将显示"hello world". + +``` +import lcd + +lcd.init() +lcd.draw_string(100, 100, "hello world", lcd.RED, lcd.BLACK) + +``` + + +## 编辑与运行文件 + +### 编辑文件 + +>在交互解释器（REPL）中，我们能够便捷的输入程序并马上得到运行结果，但这仅适合用作短程序的验证，在实际项目中，庞大代码量使得我们不得不将代码编辑成一个个的文件. + +>在 MaixPy 中，内置了一款编开源编辑器 [Micropython Editor(pye)](https://github.com/robert-hh/Micropython-Editor)，这使得我们能够非常方便的修改程序文件. + +使用 `os.listdir()` 可以查看当前目录下的文件， + +使用 `pye("hello.py")` 可以创建文件并进入编辑模式(已存在同名文件，则仅进入编辑)， 快捷键等使用说明可以在[这里查看](https://github.com/robert-hh/Micropython-Editor/blob/master/Pyboard%20Editor.pdf) + +在编辑器中完成编辑后，按 `Ctrl+S` > `Enter` 键进行保存， 按 `Ctrl+Q` 退出编辑 + +**注意**： 使用这款编辑器对使用的串口工具有一定要求， 必须将 `BackSpace` 按键设置为 `DEL` 功能， 否则按 `BackSpace` 调用的是 `Ctrl+H` 一样的功能（即字符替换） + +### 上传文件 + +>虽然 MaixPy 内置编辑器使得我们能够直接操作文件内容.但对于多文件的情况下，使用电脑的其他编辑器编写代码然后再将文件上传，将大大提升工作效率. + +>[uPyLoader](https://github.com/BetaRavener/uPyLoader) 是一款开源软件，使用它可以方便地连接 MaixPy 并且上传、下载、执行文件，同时监控输出等等功能，功能比较完善 + + + + +### 运行文件 + +使用 `os.chdir()` 切换当前目录到文件的目录，比如 `os.chdir("/flash")` + +#### 方法一： `import` + +然后执行 `import hello` + +即可看到输出 `hello maixpy` + +使用此方法简单易用，但是需要注意的是， 目前 `import` 只能使用一次， 如果第二次 `import`， 则文件不会再执行， 如果需要多次执行，建议使用下面的方法 + +#### 方法二： `exec()` + +使用 `exec()` 函数来执行 + +```python +with open("hello.py") as f: + exec(f.read()) + +``` + +### 开机自动运行脚本 + +系统会在 `/flash` 或者 `/sd` 目录创建 `boot.py` 文件， 开机会自动先执行这个脚本， 编辑这个脚本的内容即可实现开机自启 + + + +## 程序库 + + + + + + + \ No newline at end of file diff --git a/docs/en/unit/accel.md b/docs/en/unit/accel.md index b946733d..9ea9d59c 100644 --- a/docs/en/unit/accel.md +++ b/docs/en/unit/accel.md @@ -4,7 +4,7 @@ *** -:memo:**[Description](#Description)**      :electric_plug:**[Schematic](#Schematic)**       :octocat:**[Code](#Code)**       🛒**[Purchase](https://m5stack.com/collections/m5-unit/products/3-axis-analog-accelerometer-unitadx345)**      **[EasyLoader](#EasyLoader)** +:memo:**[Description](#Description)**      :electric_plug:**[Schematic](#Schematic)**       :octocat:**[Code](#Code)**       🛒**[Purchase](https://m5stack.com/products/3-axis-digital-accelerometer-unit-adxl345)**      **[EasyLoader](#EasyLoader)** ## Description @@ -20,9 +20,17 @@ By measuring the amount of static acceleration due to gravity, you can find out ### Product Features -- Tiny -- ultralow power -- 3-axis accelerometer + +- Supply voltage range: 2.0 V to 3.6 V +- Ultralow power: as low as 23 µA in measurement mode and 0.1 µA in standby mode at VS = 2.5 V (typical) +- Single tap/double tap detection +- Activity/inactivity monitoring +- Free-fall detection +- I/O voltage range: 1.7 V to VS +- I2C digital interfaces +- Wide temperature range (−40°C to +85°C) + + ## Include diff --git a/docs/en/unit/hex.md b/docs/en/unit/hex.md index c35c9bc3..d4371356 100644 --- a/docs/en/unit/hex.md +++ b/docs/en/unit/hex.md @@ -1,6 +1,6 @@ # Unit HEX {docsify-ignore-all} - + *** diff --git a/docs/en/unit/laser-rx.md b/docs/en/unit/laser-rx.md new file mode 100644 index 00000000..fc350b84 --- /dev/null +++ b/docs/en/unit/laser-rx.md @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + +## Schematic + + \ No newline at end of file diff --git a/docs/en/unit/laser-tx.md b/docs/en/unit/laser-tx.md new file mode 100644 index 00000000..f80ff548 --- /dev/null +++ b/docs/en/unit/laser-tx.md @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + + + + + + + + + +## Schematic + + \ No newline at end of file diff --git a/docs/en/unit/mini-proto.md b/docs/en/unit/mini-proto.md new file mode 100644 index 00000000..a9a289b9 --- /dev/null +++ b/docs/en/unit/mini-proto.md @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + +## Schematic + + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index dc14ae7a..f7728172 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,10 +1,12 @@ + - + M5Stack - A series of modular stackable development devices @@ -15,13 +17,13 @@ - + - + - + - + @@ -30,10 +32,10 @@ window.$docsify = { // GENERAL // ----------------------------------------------------------------- - name : 'M5Stack docs', - repo : 'https://github.com/m5stack/m5-docs', - homepage : 'index.md', - loadNavbar : 'navbar.md', + name: 'M5Stack docs', + repo: 'https://github.com/m5stack/m5-docs', + homepage: 'index.md', + loadNavbar: 'navbar.md', loadSidebar: 'sidebar.md', autoHeader: true, mergeNavbar: true, // for mobile device @@ -53,21 +55,41 @@ '/.*/navbar.md': '/navbar.md', '/en/': '/', }, - auto2top : true, + auto2top: true, mergeNavbar: true, maxLevel: 4, subMaxLevel: 3, basePath: '/', formatUpdated: '{MM}/{DD} {HH}:{mm}', executeScript: true, - ga : 'UA-131246469-2', + ga: 'UA-131246469-2' }; + @@ -78,44 +100,15 @@ - + - - + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 083a5a38..c5c31258 100644 --- a/docs/index.md +++ b/docs/index.md @@ -44,7 +44,8 @@ ## M5StickC M5Stick QuickStart     - M5StickC QuickStart » + M5StickC QuickStart     + **M5Stick** @@ -62,6 +63,13 @@

M5StickC

+ + ## M5GO Lite ## M5GO Kit ## FACES Kit @@ -122,7 +130,7 @@
- +

LORA

@@ -693,6 +701,7 @@ ## PROTO ## Unit-FAN ## VIBRATOR-MOTOR +## MINI-PROTO
@@ -709,6 +718,13 @@

PROTO

+ +
@@ -729,6 +745,8 @@ ## IR ## RS485 ## RFID +## LASER-RX +## LASER-TX
@@ -751,6 +769,20 @@

RFID

+
+ + + +

LASER-RX

+
+ +
+ + + +

LASER-TX

+
+ **C-HAT class** ## HAT-ENV @@ -759,6 +791,7 @@ ## HAT-PROTO ## HAT-THERMAL ## HAT-NCIR +## HAT-RS485
@@ -802,6 +835,30 @@

Thermal

+ + **Visual class** diff --git a/docs/ja/README.md b/docs/ja/README.md index 00b5046c..3a26d379 100644 --- a/docs/ja/README.md +++ b/docs/ja/README.md @@ -112,7 +112,7 @@
- +

LORA

diff --git a/docs/ja/unit/hex.md b/docs/ja/unit/hex.md index 8c545c1f..4e3ec116 100644 --- a/docs/ja/unit/hex.md +++ b/docs/ja/unit/hex.md @@ -1,6 +1,6 @@ # HEX {docsify-ignore-all} - + *** diff --git a/docs/sidebar.md b/docs/sidebar.md index dc642165..fde4e0c3 100644 --- a/docs/sidebar.md +++ b/docs/sidebar.md @@ -1,4 +1,4 @@ -- [Product Documents](en/) + - - +
+ + + +
+ C-HAT +
+
+
+ ENV + PIR + SPK + PROTO + NCIR + Thermal + +
+
+
+
+
+ Visual +
+
+
+ RGB LED + CatEar + HEX + NeoFlash + BUTTERFLY + RGB +
+
+
+
+
@@ -131,11 +223,13 @@ Application
- BALA - LidarBOT - PIANO - FLIR - Demo Board +
+ BALA + LidarBOT + PIANO + FLIR + Demo Board +
@@ -143,12 +237,14 @@ Accessory
- Grove-T - Grove Cable - GROVE2GROVE - SCREW - BUS-Socket - Frame +
+ Grove-T + Grove Cable + GROVE2GROVE + SCREW + BUS-Socket + Frame +
@@ -156,10 +252,12 @@ Aluminium Profile
- CORNER - NUT - Connector - Aluminium-Profile +
+ CORNER + NUT + Connector + Aluminium-Profile +
@@ -167,8 +265,10 @@ Tools
- USB Downloader - USB-ISP +
+ USB Downloader + USB-ISP +
@@ -176,10 +276,10 @@ -> Arduino API -> M5Stack Cases -> Related Documents -> FAQ + » Arduino API + » M5Stack Cases + » Related Documents + » FAQ @@ -190,4 +290,4 @@ - M5Stack - [![Github](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github](https://github.com/m5stack) - [![Twitter](https://icongram.jgog.in/simple/twitter.svg?colored&size=16)@M5Stack](http://twitter.com/M5Stack) -- [![Facebook](https://icongram.jgog.in/simple/facebook.svg?colored&size=16)@M5Stack](https://www.facebook.com/M5Stack) --> +- [![Facebook](https://icongram.jgog.in/simple/facebook.svg?colored&size=16)@M5Stack](https://www.facebook.com/M5Stack) \ No newline at end of file diff --git a/docs/zh_CN/README.md b/docs/zh_CN/README.md index ad170360..ee13b129 100644 --- a/docs/zh_CN/README.md +++ b/docs/zh_CN/README.md @@ -48,7 +48,9 @@ M5Stick上手指南     - M5StickC上手指南 » + M5StickC上手指南     + + **M5Stick** @@ -68,6 +70,13 @@

M5StickC

+ + ## M5GO Lite ## M5GO Kit ## FACES Kit @@ -130,7 +139,7 @@
- +

LORA

@@ -697,6 +706,7 @@ ## PROTO ## Unit-FAN ## VIBRATOR-MOTOR +## MINI-PROTO
@@ -713,6 +723,13 @@

PROTO

+ +
@@ -732,6 +749,8 @@ ## IR ## RS485 ## RFID +## LASER-RX +## LASER-TX
@@ -754,6 +773,20 @@

RFID

+ + **C-HAT 类** ## HAT-ENV @@ -762,6 +795,7 @@ ## HAT-PROTO ## HAT-THERMAL ## HAT-NCIR +## HAT-RS485
@@ -784,7 +818,7 @@

SPK

- **视觉类** diff --git a/docs/zh_CN/core/m5stickc.md b/docs/zh_CN/core/m5stickc.md index 68a70e94..6c863c46 100644 --- a/docs/zh_CN/core/m5stickc.md +++ b/docs/zh_CN/core/m5stickc.md @@ -119,6 +119,13 @@ M5stick C 是 M5Stack 产品系列中的核心设备之一，该产品系列建 电源管理芯片SCLSDA +**AXP192** + + + + +
INLEDTFTRTCESP32
LD02LD03LD01DIC DCI
+ **M5StickC 顶部拓展的 IO 口** gray_02 diff --git a/docs/zh_CN/faq.md b/docs/zh_CN/faq.md index 5f89d172..68093ed2 100644 --- a/docs/zh_CN/faq.md +++ b/docs/zh_CN/faq.md @@ -103,13 +103,16 @@
-- **Q9: M5Stick-C上经常存在一个问题，即电池处于低电量情况下，容易发生无法开机的现象.** +- **Q9: M5stickC 无法开机.**
- 以下操作能够使设备恢复正常：1，将G0短接到3V3。 2.插入USB线。 3，屏幕亮起后停止短接，USB继续为设备充电. + + M5Stick-C上经常存在一个问题，即电池处于低电量情况下，容易发生无法开机的现象. + + 以下操作能够使设备恢复正常：1，将G0短接到3V3。 2.插入USB线。 3，屏幕亮起后停止短接，USB继续为设备充电.
diff --git a/docs/zh_CN/hat/hat-adc.md b/docs/zh_CN/hat/hat-adc.md new file mode 100644 index 00000000..7b8006cf --- /dev/null +++ b/docs/zh_CN/hat/hat-adc.md @@ -0,0 +1,45 @@ +# Hat ADC {docsify-ignore-all} + + + +*** + +:memo:**[描述](#描述)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://m5stack.com/collections/m5-unit/products/m5stickc-env-hat)**   **[EasyLoader](#EasyLoader)** + + + + + + + + + + + + + + + +## Schematic + + + + + + +## EasyLoader + + + + + +>1.EasyLoader是一个简洁快速的程序烧录器，每一个产品页面里的EasyLoader都提供了一个与产品相关的案例程序. + +>2.下载软件后，双击运行应用程序，将M5设备通过数据线连接至电脑,选择端口参数，点击 **"Burn"** 即可开始烧录 + + + +## 相关链接 + +- **Datasheet** - [ADS1100](http://pdf1.alldatasheet.com/datasheet-pdf/view/619024/TI1/ADS1100.html) + diff --git a/docs/zh_CN/hat/hat-dac.md b/docs/zh_CN/hat/hat-dac.md new file mode 100644 index 00000000..f97ec428 --- /dev/null +++ b/docs/zh_CN/hat/hat-dac.md @@ -0,0 +1,43 @@ +# Hat DAC {docsify-ignore-all} + + + +*** + +:memo:**[描述](#描述)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://m5stack.com/collections/m5-unit/products/m5stickc-env-hat)**   **[EasyLoader](#EasyLoader)** + + + + + + + + + + + + + + + +## Schematic + + + + + + +## EasyLoader + + + + + +>1.EasyLoader是一个简洁快速的程序烧录器，每一个产品页面里的EasyLoader都提供了一个与产品相关的案例程序. + +>2.下载软件后，双击运行应用程序，将M5设备通过数据线连接至电脑,选择端口参数，点击 **"Burn"** 即可开始烧录 + + +## 相关链接 + +- **Datasheet** - [MCP4725](http://pdf1.alldatasheet.com/datasheet-pdf/view/233449/MICROCHIP/MCP4725.html) \ No newline at end of file diff --git a/docs/zh_CN/hat/hat-ncir.md b/docs/zh_CN/hat/hat-ncir.md index 3f7e63d9..c2fa3190 100644 --- a/docs/zh_CN/hat/hat-ncir.md +++ b/docs/zh_CN/hat/hat-ncir.md @@ -4,7 +4,7 @@ *** -:memo:**[描述](#描述)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://m5stack.com/collections/m5-unit/products/m5stickc-speaker-hat)**   **[EasyLoader](#EasyLoader)** +:memo:**[描述](#描述)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://m5stack.com/collections/m5-unit/products/m5stickc-ncir-hatmlx90614)**   **[EasyLoader](#EasyLoader)** ## 描述 @@ -16,6 +16,7 @@ IIC（0x5A） ## 产品特性 +- 兼容M5StickC - 工作电压: 4.5 to 5.5V - 测温范围: -70°C ~ 382.2°C - 室温下测量精度: ±0.5°C @@ -42,21 +43,33 @@ IIC（0x5A） - **[官方论坛](http://forum.m5stack.com/)** -- **数据手册** - [MLX90614](https://github.com/m5stack/M5-Schematic/blob/master/datasheet/MLX90614-Datasheet-Melexis.pdf) +- **[MLX90614 Datasheet](https://github.com/m5stack/M5-Schematic/blob/master/datasheet/MLX90614-Datasheet-Melexis.pdf)** ## EasyLoader - + >1.EasyLoader是一个简洁快速的程序烧录器，每一个产品页面里的EasyLoader都提供了一个与产品相关的案例程序. >2.下载软件后，双击运行应用程序，将M5设备通过数据线连接至电脑,选择端口参数，点击 **"Burn"** 即可开始烧录 + +## 例程 + +- **[Arduino](https://github.com/m5stack/M5StickC/tree/master/examples/Hat/NCIR_HAT)** + ### 管脚映射 -
M5StickCGPIO0GPIO263.3VGND
HAT NCIRSDASCL3.3VGND
\ No newline at end of file + + + +## 相关视频 + + diff --git a/docs/zh_CN/hat/hat-proto.md b/docs/zh_CN/hat/hat-proto.md index 5f13c92c..c4ee33b9 100644 --- a/docs/zh_CN/hat/hat-proto.md +++ b/docs/zh_CN/hat/hat-proto.md @@ -10,8 +10,11 @@ **Hat PROTO** 是一款兼容M5SticKC的万能板,你可以自由的在板上进行电路设计.如果你打算为你的设计添加简单的电路并为其添加可靠的保护外壳, Hat PROTO 是一个不错的选择. + + ## 产品特性 +- 兼容M5StickC - 孔尺寸: 0.039" 1mm (CNC Drilled) - 孔间距: 0.1 in - (2.54 mm) - 板孔数量: x Holes @@ -23,7 +26,8 @@ ## 应用 -- MP4/MP3 +- 电路原型设计 + ## 原理图 @@ -37,4 +41,13 @@ - **[官方论坛](http://forum.m5stack.com/)** +## 例程 +- **[Arduino](https://github.com/m5stack/M5StickC/tree/master/examples/Hat/ENV)** + + +## 相关视频 + + \ No newline at end of file diff --git a/docs/zh_CN/hat/hat-rs485.md b/docs/zh_CN/hat/hat-rs485.md new file mode 100644 index 00000000..41f0665a --- /dev/null +++ b/docs/zh_CN/hat/hat-rs485.md @@ -0,0 +1,40 @@ +# Hat RS485 {docsify-ignore-all} + + + +*** + +:memo:**[描述](#描述)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://m5stack.com/collections/m5-unit/products/m5stickc-env-hat)**   **[EasyLoader](#EasyLoader)** + + + + + + + + + + + +## Schematic + + + + + + +## EasyLoader + + + + + +>1.EasyLoader是一个简洁快速的程序烧录器，每一个产品页面里的EasyLoader都提供了一个与产品相关的案例程序. + +>2.下载软件后，双击运行应用程序，将M5设备通过数据线连接至电脑,选择端口参数，点击 **"Burn"** 即可开始烧录 + + + +## 相关链接 + +- **Datasheet** - [SP485EEN](https://pdf1.alldatasheet.com/datasheet-pdf/view/45954/SIPEX/SP485EEN.html) diff --git a/docs/zh_CN/hat/hat-thermal.md b/docs/zh_CN/hat/hat-thermal.md index 8a5dc30d..41c4413e 100644 --- a/docs/zh_CN/hat/hat-thermal.md +++ b/docs/zh_CN/hat/hat-thermal.md @@ -4,18 +4,19 @@ *** -:memo:**[描述](#描述)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://m5stack.com/collections/m5-unit/products/m5stickc-speaker-hat)**   **[EasyLoader](#EasyLoader)** +:memo:**[描述](#描述)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://m5stack.com/collections/m5-unit/products/m5stickc-thermal-camera-hatmlx90640)**   **[EasyLoader](#EasyLoader)** ## 描述 **Hat Thermal**是一款兼容M5StickC的人体红外热成像.内置**MLX90640**热电堆传感器,能够测量物体表面温度.并通过由表面温度形成的温度梯度，生成热成像图片.(图片分辨率为**32 x 24**) -**MLX90640** 红外（IR）传感器阵列具备了高分辨率与在恶劣环境中可靠工作的能力.与昂贵的高端热像仪相比，Hat-Thermal是一个高性价比的替代方案.相对一般的微测辐射热计，该传感器优势在于，不需要频繁重复校准,从而确保了检测的连续性并降低了系统维护成本.视场角提供标准版（55°×35° ）与广角版（110°×75°）两种模式.（视场角模式可以通过修改程序进行更改） +**MLX90640** 红外（IR）传感器阵列具备了高分辨率与在恶劣环境中可靠工作的能力.与昂贵的高端热像仪相比，Hat-Thermal是一个高性价比的替代方案.相对一般的微测辐射热计，该传感器优势在于，不需要频繁重复校准,从而确保了检测的连续性并降低了系统维护成本.视场角提供广角版（110°×75°）. -该 Unit 与 M5Core 通过 Grove A 接口通信，I2C 地址为**0x33**. +I2C 地址为**0x33**.(GOIO 0/26) ## 产品特性 +- 兼容M5StickC - 工作电压: 3V ~ 3.6V - 工作电流: 23mA - 视场角: 55°x35° @@ -48,21 +49,32 @@ - **[官方论坛](http://forum.m5stack.com/)** -- **[PAM8303 数据手册](https://pdf1.alldatasheet.com/datasheet-pdf/view/790820/DIODES/PAM8303C.html)** +- **[MLX90640 Datasheet](https://github.com/m5stack/M5-Schematic/blob/master/datasheet/MLX90640-Datasheet-Melexis.pdf)** - +>2.下载软件后，双击运行应用程序，将M5设备通过数据线连接至电脑,选择端口参数，点击 **"Burn"** 即可开始烧录 ### 管脚映射 -
M5StickCGPIO0GPIO263.3VGND
HAT ThermalSDASCL-3.3VGND
\ No newline at end of file + + +## 例程 + +- **[Arduino](https://github.com/m5stack/M5StickC/tree/master/examples/Hat/MLX90640)** + + +## 相关视频 + + \ No newline at end of file diff --git a/docs/zh_CN/module/lora.md b/docs/zh_CN/module/lora.md index 4632a34b..4eafc07f 100644 --- a/docs/zh_CN/module/lora.md +++ b/docs/zh_CN/module/lora.md @@ -1,6 +1,6 @@ # Module LORA {docsify-ignore-all} - + *** diff --git a/docs/zh_CN/quick_start/m5stickv/m5stickv_quick_start.md b/docs/zh_CN/quick_start/m5stickv/m5stickv_quick_start.md index f3f90107..df32e733 100644 --- a/docs/zh_CN/quick_start/m5stickv/m5stickv_quick_start.md +++ b/docs/zh_CN/quick_start/m5stickv/m5stickv_quick_start.md @@ -2,7 +2,7 @@ ## 目录 -**[1. 准备工作](#准备工作)** +**[1. 下载固件](#下载固件)** **[2. 烧录固件](#烧录固件)** @@ -16,44 +16,43 @@ +## 下载固件 -## 准备工作 ->1.下载固件文件，访问PASSSSSSS，根据你的需求下载相应的固件文件，下方为固件类型基本介绍. + -
- -
## 烧录固件 +>1.点击下方对应自己操作系统的 Kflash_GUI烧录工具进行下载. ->1.下载固件烧录工具[Kflash_GUI](https://github.com/sipeed/kflash_gui/releases). +
+

Kflash_GUI:

+

+ Windows + MacOS + Linux

+
+ +>2.将设备通过Tpye-C数据线连接至电脑，双击打开烧录工具**Kflash_GUI**应用程序,选择对应的设备端口、固件程序、波特率. 点击下载，开始烧录 . ->2.将设备通过Tpye-C数据线连接至电脑，双击打开烧录工具**Kflash_GUI**应用程序,选择对应的设备端口、固件程序、波特率. 点击下载，开始烧录. （固件文件与模型文件可分开烧录，二者不冲突） ### Kflash ->1.对于习惯使用命令行操作的用户来说还可以选择Kflash作为固件烧录工具.[点击此处查看详情](https://github.com/kendryte/kflash.py) +>3.对于习惯使用命令行操作的用户来说还可以选择Kflash作为固件烧录工具.[点击此处查看详情](https://github.com/kendryte/kflash.py) ## 串口调试工具 -### For Windows +>1.编程M5StickV需要使用到串口调试工具，您可以使用Putty作为串口调试工具, [点击此处](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html)访问Putty资源页面，选择对应自己操作系统Putty进行下载，并安装. ->[点击此处](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html)访问Putty资源页面，选择对应自己操作系统Putty进行下载，并安装. +>2.运行Putty后，将M5StickV通过Tpye-C数据线连接至电脑端口，在Putty中设置相应的端口号与波特率，点击"open"，开始连接. （你可以通过查看设备管理器得到M5StickV所使用的端口号） -> MaixPy 的交互界面. +> 连接成功后，将自动进入，MaixPy 的交互界面. 此时设备正在运行着默认程序，您可以通过按下快捷键"Ctrl+C"中断其运行，并进入命令行. @@ -93,7 +92,8 @@ lcd.draw_string(100, 100, "hello world", lcd.RED, lcd.BLACK) >[uPyLoader](https://github.com/BetaRavener/uPyLoader) 是一款开源软件，使用它可以方便地连接 MaixPy 并且上传、下载、执行文件，同时监控输出等等功能，功能比较完善 -[下载uPyLoader](https://github.com/BetaRavener/uPyLoader/releases) + + ### 运行文件 @@ -123,7 +123,19 @@ with open("hello.py") as f: - ## 程序库 ->1.[查看更多程序案例](https://github.com/sipeed/kflash_gui/releases). \ No newline at end of file + + + + + + \ No newline at end of file diff --git a/docs/zh_CN/sidebar.md b/docs/zh_CN/sidebar.md index 376011cd..1108cda0 100644 --- a/docs/zh_CN/sidebar.md +++ b/docs/zh_CN/sidebar.md @@ -1,8 +1,279 @@ -- [产品列表](zh_CN/) + + +
+ » 产品文档 +
+
+
+ +
+ +
+ +
+
+
+ +
+ +
+
+
+ +
+ +
+
+
+ +
+
+
+ Camera +
+
+
+ ESP32CAM + M5Camera + M5CameraF + M5CameraX +
+
+
+
+
+ Sensor +
+
+
+ ENV + EARTH + LIGHT + PIR + NCIR + THERMAL + COLOR + TOF + HEART + ADC + MAKEY + GPS + FINGER + WEIGHT + TRACE + ACCEL + OP.90 + OP.180 +
+
+
+
+
+ HMI +
+
+
+ ANGLE + BUTTON + Dual-BUTTON + JOYSTICK + CardKB +
+
+
+
+ +
+ Communication +
+
+
+ IR + RS485 + RFID + +
+
+
+
+
+ C-HAT +
+
+
+ ENV + PIR + SPK + PROTO + NCIR + Thermal + +
+
+
+
+
+ Visual +
+
+
+ RGB LED + CatEar + HEX + NeoFlash + BUTTERFLY + RGB +
+
+
+
+
+
+
+
+ +
+ +
+
+
+ +
+ +
+
+
+ +
+ +
+
+
+ +
+ +
+
+
+
+
+ + + » Arduino API + » M5Stack 案例 + » 相关文档 + » 常见问题解答 +
+ + + - **Links** diff --git a/docs/zh_CN/unit/accel.md b/docs/zh_CN/unit/accel.md index 4d25ea8a..2b304a3b 100644 --- a/docs/zh_CN/unit/accel.md +++ b/docs/zh_CN/unit/accel.md @@ -4,7 +4,7 @@ *** -:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**       :electric_plug:**[原理图](#原理图)**       🛒**[购买链接](https://m5stack.com/collections/m5-unit/products/3-axis-analog-accelerometer-unitadx345)**   **[EasyLoader](#EasyLoader)** +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**       :electric_plug:**[原理图](#原理图)**       🛒**[购买链接](https://m5stack.com/products/3-axis-digital-accelerometer-unit-adxl345)**   **[EasyLoader](#EasyLoader)** ## 描述 @@ -20,9 +20,19 @@ ## 产品特性 -- 体积小 -- 低功耗 -- 3轴加速度计 +- 测量范围：±16g +- 用户可选的分辨率: + 10位固定分辨率 + 分辨率随g范围提高而提高，±16 g时高达13位 (在所有g范围内保持4 mg/LSB的比例系数) +- 电源电压范围：2.0 V至3.6 V +- 低功耗：VS = 2.5 V时(典型值)，测量模式下低至23 µA，待 机模式下为0.1 µA +- 单振/双振检测 +- 活动/非活动监控 +- 自由落体检测 +- I/O电压范围：1.7 V至VS +- I2C数字接口 +- 宽温度范围(−40°C至+85℃) + ## 套件清单 @@ -63,8 +73,7 @@ ## 相关链接 -- **[-数据手册](https://github.com/m5stack/M5-Schematic/blob/master/datasheet/ADXL345_cn.pdf)** - +- Datasheet - **[ADXL345](https://github.com/m5stack/M5-Schematic/blob/master/datasheet/ADXL345_cn.pdf)** ### 管脚映射 @@ -79,3 +88,5 @@ + + diff --git a/docs/zh_CN/unit/hex.md b/docs/zh_CN/unit/hex.md index 3cab7bbb..61a125cf 100644 --- a/docs/zh_CN/unit/hex.md +++ b/docs/zh_CN/unit/hex.md @@ -1,6 +1,6 @@ # Unit HEX {docsify-ignore-all} - + *** diff --git a/docs/zh_CN/unit/laser-rx.md b/docs/zh_CN/unit/laser-rx.md new file mode 100644 index 00000000..67938afb --- /dev/null +++ b/docs/zh_CN/unit/laser-rx.md @@ -0,0 +1,24 @@ +# Unit LASER RX {docsify-ignore-all} + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://m5stack.com/collections/m5-unit/products/light-sensor-unit)**      :clapper:**[相关视频](#相关视频)**   **[EasyLoader](#EasyLoader)** + + + + + + + + + + + + + +## Schematic + + + diff --git a/docs/zh_CN/unit/laser-tx.md b/docs/zh_CN/unit/laser-tx.md new file mode 100644 index 00000000..5801996e --- /dev/null +++ b/docs/zh_CN/unit/laser-tx.md @@ -0,0 +1,28 @@ +# Unit LASER TX {docsify-ignore-all} + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://m5stack.com/collections/m5-unit/products/light-sensor-unit)**      :clapper:**[相关视频](#相关视频)**   **[EasyLoader](#EasyLoader)** + + + + + + + + + + + + + + + + + +## Schematic + + + diff --git a/docs/zh_CN/unit/mini-proto.md b/docs/zh_CN/unit/mini-proto.md new file mode 100644 index 00000000..6e15ff9f --- /dev/null +++ b/docs/zh_CN/unit/mini-proto.md @@ -0,0 +1,30 @@ +# Unit MINI PROTO {docsify-ignore-all} + + + +*** + +:memo:**[描述](#描述)**      :octocat:**[例程](#例程)**      :electric_plug:**[原理图](#原理图)**      🛒**[购买链接](https://m5stack.com/collections/m5-unit/products/light-sensor-unit)**      :clapper:**[相关视频](#相关视频)**   **[EasyLoader](#EasyLoader)** + + + + + + + + + + + + + + + + + + + + +## Schematic + + \ No newline at end of file diff --git a/docs/zh_CN/unit/thermal.md b/docs/zh_CN/unit/thermal.md index ba95f36e..f63907fb 100644 --- a/docs/zh_CN/unit/thermal.md +++ b/docs/zh_CN/unit/thermal.md @@ -10,7 +10,7 @@ **THERMAL** 是一款人体红外成像 Unit.内置**MLX90640**热电堆传感器,能够测量物体表面温度.并通过由表面温度形成的温度梯度，生成热成像图片.(图片分辨率为**32 x 24**) -**MLX90640** 红外（IR）传感器阵列具备了高分辨率与在恶劣环境中可靠工作的能力.与昂贵的高端热像仪相比，该 Unit 是一个高性价比的替代方案.相对一般的微测辐射热计，该传感器优势在于，不需要频繁重复校准,从而确保了检测的连续性并降低了系统维护成本.视场角提供标准版（55°×35° ）与广角版（110°×75°）两种模式.（视场角模式可以通过修改程序进行更改） +**MLX90640** 红外（IR）传感器阵列具备了高分辨率与在恶劣环境中可靠工作的能力.与昂贵的高端热像仪相比，该 Unit 是一个高性价比的替代方案.相对一般的微测辐射热计，该传感器优势在于，不需要频繁重复校准,从而确保了检测的连续性并降低了系统维护成本.视场角提供广角版（110°×75°）. 该 Unit 与 M5Core 通过 Grove A 接口通信，I2C 地址为**0x33**.