diff --git a/docs/assets/img/product_pics/accessory/battery_base/battery_base_01.jpg b/docs/assets/img/product_pics/accessory/battery_base/battery_base_01.jpg new file mode 100755 index 00000000..22adaaf3 Binary files /dev/null and b/docs/assets/img/product_pics/accessory/battery_base/battery_base_01.jpg differ diff --git a/docs/assets/img/product_pics/accessory/battery_base/battery_base_02.jpg b/docs/assets/img/product_pics/accessory/battery_base/battery_base_02.jpg new file mode 100755 index 00000000..9a2a668e Binary files /dev/null and b/docs/assets/img/product_pics/accessory/battery_base/battery_base_02.jpg differ diff --git a/docs/assets/img/product_pics/accessory/battery_base/battery_base_05.jpg b/docs/assets/img/product_pics/accessory/battery_base/battery_base_05.jpg new file mode 100755 index 00000000..91ebf1f9 Binary files /dev/null and b/docs/assets/img/product_pics/accessory/battery_base/battery_base_05.jpg differ diff --git a/docs/assets/img/product_pics/accessory/battery_base/battery_base_06.jpg b/docs/assets/img/product_pics/accessory/battery_base/battery_base_06.jpg new file mode 100755 index 00000000..4883bc1d Binary files /dev/null and b/docs/assets/img/product_pics/accessory/battery_base/battery_base_06.jpg differ diff --git a/docs/assets/img/product_pics/accessory/battery_base/battery_base_07.jpg b/docs/assets/img/product_pics/accessory/battery_base/battery_base_07.jpg new file mode 100755 index 00000000..a5764dc9 Binary files /dev/null and b/docs/assets/img/product_pics/accessory/battery_base/battery_base_07.jpg differ diff --git a/docs/en/accessory/battery_base.md b/docs/en/accessory/battery_base.md new file mode 100644 index 00000000..64223f2d --- /dev/null +++ b/docs/en/accessory/battery_base.md @@ -0,0 +1,34 @@ +# Accessory BATTERY-BASE {docsify-ignore-all} + + + +*** + +:memo:**[Description](#Description)**      🛒**[Purchase](https://m5stack.com/collections/m5-unit/products/m5stickc-adc-hat)** + +## Description +This is a battery base for 3 types of M5Cameras: M5Camera, M5Camera_X, M5Camera_F. It is a 400mAh Lipo battery.
+You can wire it with the battery interface on M5camera board. Pay attention to the polarity. You can get extra power back up for your M5Camera. +- red (positive) +- black(Negative) +


+       + +## Product Features + +- Dimension: 8mmX20mmX30mm， +- Capacity: 400mAh +- Poly Lithium Battery + +## Include + +- 1x BATTERY-BASE + +## Application + +- Power back up + + + + + diff --git a/docs/en/core/m5stickv.md b/docs/en/core/m5stickv.md index 57ecaf76..c4ee1e57 100644 --- a/docs/en/core/m5stickv.md +++ b/docs/en/core/m5stickv.md @@ -1,11 +1,12 @@ -# Core M5SticV {docsify-ignore-all} +# Core M5StickV {docsify-ignore-all} - + + *** -:memo:**[Description](#Description)**      :electric_plug:**[Schematic](#Schematic)**      :octocat:**[Code](#Code)**      **[EasyLoader](#EasyLoader)**       🛒**[Purchase](https://m5stack.com/collections/m5-unit/products/m5stickc-adc-hat)** +:memo:**[Description](#Description)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://m5stack.com/collections/m5-unit/products/m5stickc-adc-hat)** ## Description @@ -19,7 +20,11 @@ M5stick-V AI Camera features its integration with machine vision capabilities, f The module comes with the OmniVision OV7740 sensor, using the OmniPixel®3-HS technology, providing a best-in-class low light sensitivity, making it ideal for machine vision. In addition to an OV7740 sensor, M5stick-V features more hardware resources such as a speaker with built-in I2S Class-D DAC, MEMS Microphone, IPS screen, 6-axis IMU, 200mAh Li-po battery, and more.

More than the visioning, M5stick-V also features the embedded APU - Audio Processor. With its hardware beam-forming support and dual 512-point FFT units, the M5stick-V is also capable of a series of machine hearing works like voice wake-up to speech recognition. -

+


+    +    +
+ ### Features: - Dual-Core 64-bit RISC-V RV64IMAFDC (RV64GC) CPU / 400Mhz(Normal) - Dual Independent Double Precision FPU @@ -44,7 +49,11 @@ More than the visioning, M5stick-V also features the embedded APU - Audio Proces - External storage: TF card/Micro SD - Microphone: MSM261S4030HOR. - Gyro: MPU6886. - - Interface: CONNEXT . + - Interface: CONNEXT. + +### Package Includes +- M5Stick-V +- USB cable ### FUNCTIONAL DESCRIPTION @@ -170,6 +179,8 @@ The triple-axis MEMS accelerometer in MPU-6886 includes a wide range of features - **Web page** - [sipeed](https://maixpy.sipeed.com/en/) - **Quick Start Guide** - [sipeed](https://maixpy.sipeed.com/en/) +## Schematic + diff --git a/docs/en/hat/hat-adc.md b/docs/en/hat/hat-adc.md index f3146161..e0ef2d25 100644 --- a/docs/en/hat/hat-adc.md +++ b/docs/en/hat/hat-adc.md @@ -14,9 +14,7 @@ The ADS1100 consists of a delta-sigma A/D converter core with adjustable gain, a
ADS1100 itself is able to accept a differential input from -5 ~ +5 V, but we have limited the input to 0~12V by adding on the peripheral circuit design of this IC. -


- - +
### Product Features - M5StickC Compatible diff --git a/docs/en/hat/hat-dac.md b/docs/en/hat/hat-dac.md index 175b4511..9378cf05 100644 --- a/docs/en/hat/hat-dac.md +++ b/docs/en/hat/hat-dac.md @@ -15,9 +15,7 @@ Packed with a DAC converter chip MCP4725, which is low-power, high accuracy, sin The DAC input and configuration data can be programmed to the non-volatile memory (EEPROM) by the user using the I2C interface command. I2C address: 0x60 -


- - +
## Product Features - M5StickC Compatible diff --git a/docs/en/hat/hat-rs485.md b/docs/en/hat/hat-rs485.md index 1e7ee2de..db372ca6 100644 --- a/docs/en/hat/hat-rs485.md +++ b/docs/en/hat/hat-rs485.md @@ -17,9 +17,7 @@ RS485 is a standard defining the electrical characteristics of drivers and recei

It is used to convert the TTL standard to the RS485 standard. If the outside serial device is RS485 standard, you can attach this hat on top of stickc, therefore, to implement the communication with RS485 device by TTL protocol. -


- - +
## Product Features diff --git a/docs/en/quick_start/m5stickv/m5stickv_quick_start.md b/docs/en/quick_start/m5stickv/m5stickv_quick_start.md index df32e733..e4bac769 100644 --- a/docs/en/quick_start/m5stickv/m5stickv_quick_start.md +++ b/docs/en/quick_start/m5stickv/m5stickv_quick_start.md @@ -1,30 +1,30 @@ -# M5StickV 上手指南 {docsify-ignore-all} +# M5StickV Quick Start {docsify-ignore-all} -## 目录 +## CONTENT -**[1. 下载固件](#下载固件)** +**[1. Download Firmware](#Download)** -**[2. 烧录固件](#烧录固件)** +**[2. Flash Firmware](#Flash)** -**[3. 串口调试工具](#串口调试工具)** +**[3. Serial Debugging Tool](#Serial-Tool)** **[4. Hello World](#Hello-World)** -**[5. 编辑与运行文件](#编辑与运行文件)** +**[5. Edit and Run the Code](#Edit-and-Run-the-Code)** -**[6. 程序库](#程序库)** +**[6. Library](#Library)** -## 下载固件 +## Download - + -## 烧录固件 +## Flash ->1.点击下方对应自己操作系统的 Kflash_GUI烧录工具进行下载. +>1. Flash tool Kflash_GUI.

Kflash_GUI:

@@ -34,32 +34,31 @@ Linux

->2.将设备通过Tpye-C数据线连接至电脑，双击打开烧录工具**Kflash_GUI**应用程序,选择对应的设备端口、固件程序、波特率. 点击下载，开始烧录 . - +>2.Connect the device to your computer via Type-C cable, double click to open up flash tool **Kflash_GUI**, choose the right com number, firmware, bandrate and click download to start it. ### Kflash ->3.对于习惯使用命令行操作的用户来说还可以选择Kflash作为固件烧录工具.[点击此处查看详情](https://github.com/kendryte/kflash.py) +>3.For people who are used to operate by shell command, you can choose Kfalsh as your firmware falshing tool .[click for more detail](https://github.com/kendryte/kflash.py) -## 串口调试工具 +## Serial-Tool ->1.编程M5StickV需要使用到串口调试工具，您可以使用Putty作为串口调试工具, [点击此处](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html)访问Putty资源页面，选择对应自己操作系统Putty进行下载，并安装. +>1. You will need a serial debugging tool for programming M5StickV, you can use Putty [in here](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html),for download and information. ->2.运行Putty后，将M5StickV通过Tpye-C数据线连接至电脑端口，在Putty中设置相应的端口号与波特率，点击"open"，开始连接. （你可以通过查看设备管理器得到M5StickV所使用的端口号） +>2. Run Putty, connect M5StickV to your PC, in Putty, set com number, baudrate, click "open", by now the connect process should started.(you can check the com number in device manager on your PC) -> 连接成功后，将自动进入，MaixPy 的交互界面. 此时设备正在运行着默认程序，您可以通过按下快捷键"Ctrl+C"中断其运行，并进入命令行. +> When connected, it will automatically enter Maixpy UI. Now the device is runing the default code, you can terminate it by "Ctrl+C". ## Hello World ->在命令行输入下方代码，M5StickV屏幕将显示"hello world". +>Type in the following code, a display "hello world" will show on the screen . ``` import lcd @@ -70,46 +69,50 @@ lcd.draw_string(100, 100, "hello world", lcd.RED, lcd.BLACK) ``` -## 编辑与运行文件 +## Edit and Run the Code -### 编辑文件 - ->在交互解释器（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 并且上传、下载、执行文件，同时监控输出等等功能，功能比较完善 - - +### Editting -### 运行文件 +> The language shell programm(REPL) is good for instant code validatation, it can be used at short code programming and validation. In real project where we will have massive amount of code, in that case we will need a Code Editor for better orgnization of the code files. -使用 `os.chdir()` 切换当前目录到文件的目录，比如 `os.chdir("/flash")` -#### 方法一： `import` +>Inside MaixPy，integrates a open source Editor [Micropython Editor(pye)](https://github.com/robert-hh/Micropython-Editor)，which is convenient for us to manage the code. -然后执行 `import hello` +function `os.listdir()` is for checking the files in current directory. -即可看到输出 `hello maixpy` -使用此方法简单易用，但是需要注意的是， 目前 `import` 只能使用一次， 如果第二次 `import`， 则文件不会再执行， 如果需要多次执行，建议使用下面的方法 +With function `pye("hello.py")`, you can create new files and enter editing mode(if file exist, only enter editting mode)[click for more](https://github.com/robert-hh/Micropython-Editor/blob/master/Pyboard%20Editor.pdf) -#### 方法二： `exec()` +If editing finished, you can do `Ctrl+S` > `Enter` to save the script. `Ctrl+Q` to exit edit mode. -使用 `exec()` 函数来执行 + +**Notice**： This editor have some requiremnt on the Serial tool, KEY `BackSpace` have to set as `DEL` function，or `BackSpace` will implement the same function as `Ctrl+H`(charater replacement) + +### Upload File + +> Although inner editor of MaixPy can help us manage the file, for better experience and efficiency we recommend using other editors and upload the project after finish editing. + +>[uPyLoader](https://github.com/BetaRavener/uPyLoader) is opensource, which is pretty full-function and gives you the permit to upload, download, file excution, output monitoring, etc. + + + + +### File Execution + +Function `os.chdir()` is used for switch current directory to a certain directory, for example `os.chdir("/flash")` + +#### Solution 1： `import` + +Run `import hello` + +You can see the output: `hello maixpy` + +In this way, it is simple and handy, but thers something worth your attention, `import` can only be utilized once, the second time `import` won't work. If you need to use `import` mutiple times, please refers to solution 2 below + +#### Solution 2： `exec()` + +Use `exec()` function: ```python with open("hello.py") as f: @@ -117,16 +120,15 @@ with open("hello.py") as f: ``` -### 开机自动运行脚本 - -系统会在 `/flash` 或者 `/sd` 目录创建 `boot.py` 文件， 开机会自动先执行这个脚本， 编辑这个脚本的内容即可实现开机自启 +### AutoRun after Power On +System will create a `boot.py` file at directory `/flash` or `/sd` , it will run this script after power on, modify this file will realize the AutoRun. -## 程序库 +## Library - + diff --git a/docs/en/unit/laser-rx.md b/docs/en/unit/laser-rx.md index 9c599229..548885a4 100644 --- a/docs/en/unit/laser-rx.md +++ b/docs/en/unit/laser-rx.md @@ -16,10 +16,7 @@ Two parallel beams are needed, one for transmission and one for reception. There

Port type of this unit is PORTB. -


- - - +
## Product Features - Laser receiver diff --git a/docs/en/unit/laser-tx.md b/docs/en/unit/laser-tx.md index 3930c9eb..5c356bbf 100644 --- a/docs/en/unit/laser-tx.md +++ b/docs/en/unit/laser-tx.md @@ -13,12 +13,10 @@ This is one of the communication devices among M5Units, a Laser emitter with ad

Laser communications devices are wireless connections through the atmosphere. They work similarly to fiber-optic links, except the beam is transmitted through free space. While the transmitter and receiver must require line-of-sight conditions, they have the benefit of eliminating the need for broadcast rights and buried cables. Laser communications systems can be easily deployed since they are inexpensive, small, low power and do not require any radio interference studies. Two parallel beams are needed, one for transmission and one for reception. Therefore we have a LASER.RX parallelly. -

+
Port type of this unit is PORTB. - -


- - +

+*warning!!! laser is dangerous for human being, Don’t aim a laser pointer towards a person’s head. This is to prevent the beam from getting in their eyes, possibly causing eye damage. Remember that people can move unexpectedly, so keeping away from their heads is a good idea* ## Product Features diff --git a/docs/en/unit/mini-proto.md b/docs/en/unit/mini-proto.md index 18681cf5..14d9fa7a 100644 --- a/docs/en/unit/mini-proto.md +++ b/docs/en/unit/mini-proto.md @@ -3,7 +3,7 @@ *** -:memo:**[Description](#Description)**      :electric_plug:**[Schematic](#Schematic)**      :octocat:**[Code](#Code)**      **[EasyLoader](#EasyLoader)**       🛒**[Purchase](https://m5stack.com/collections/m5-unit/products/m5stickc-adc-hat)** +:memo:**[Description](#Description)**      :electric_plug:**[Schematic](#Schematic)**      🛒**[Purchase](https://m5stack.com/collections/m5-unit/products/m5stickc-adc-hat)** ## Description @@ -50,7 +50,7 @@ For different CONNEXT ports, you will be able to interact with different pins th M5 PORTAGPIO22GPIO215VGND M5 PORTBGPIO36GPIO265VGND M5 PORTCGPIO16GPIO175VGND - MINI.PROTOP1-1P1-25VGND + MINI.PROTOP1-1P1-25VGND diff --git a/docs/index.md b/docs/index.md index 38655cfc..379e44fb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -46,7 +46,7 @@ M5Stick QuickStart     M5StickC QuickStart     - + M5StickV QuickStart **M5Stick** @@ -66,7 +66,7 @@
- +

M5StickV

@@ -735,7 +735,7 @@
- +

Vibrator-Motor

@@ -772,14 +772,14 @@
- +

LASER-RX

- +

LASER-TX

@@ -838,7 +838,7 @@
- +

RS485

@@ -848,14 +848,14 @@
- +

ADC

- +

DAC

@@ -1023,6 +1023,13 @@

Frame

+## BATTERY-BASE +
+ + + +

BATTERY-BASE

+
***