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

..

Browse Source
This commit is contained in:
LiHuashen
2019-03-01 18:57:09 +08:00
parent 33f856dd97
commit c6be20e879
28 changed files with 92 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/assets/img/product_pics/unit/unit_m5camera_05.png
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 483 KiB

After

Width:  |  Height:  |  Size: 482 KiB

docs/assets/img/product_pics/unit/unit_m5camera_f_02.png
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 601 KiB

After

Width:  |  Height:  |  Size: 604 KiB

docs/en/api/button.md
+4 -12
View File
@@ -4,9 +4,7 @@
**Syntax:**
```arduino
uint8_t read();
```
<mark>uint8_t read();</mark>
**Description:**
@@ -32,9 +30,7 @@ void loop() {
**Syntax:**
```arduino
uint8_t isPressed();
```
<mark>uint8_t isPressed();</mark>
**Description:**
@@ -64,9 +60,7 @@ void loop() {
**Syntax:**
```arduino
uint8_t wasPressed();
```
<mark>uint8_t wasPressed();</mark>
**Description:**
@@ -96,9 +90,7 @@ void loop() {
**Syntax:**
```arduino
uint8_t pressedFor(uint32_t ms);
```
<mark>uint8_t pressedFor(uint32_t ms);</mark>
**Description:**
docs/en/api/lcd.md
+11 -33
View File
@@ -6,9 +6,7 @@
**Syntax:**
```arduino
fillScreen(uint16_t color);
```
<mark>fillScreen(uint16_t color);</mark>
**Function: Fill the entire screen with the specified color.**
@@ -39,9 +37,7 @@ lcd.fillScreen(lcd.RED)
**Syntax:**
```arduino
setTextColor(uint16_t color, uint16_t backgroundcolor);
```
<mark>setTextColor(uint16_t color, uint16_t </mark>backgroundcolor);
**Function: Set the foreground color and background color of the displayed text.**
@@ -74,9 +70,7 @@ lcd.setTextColor(lcd.ORANGE, lcd.DARKCYAN)
**Syntax:**
```arduino
setCursor(uint16_t x0, uint16_t y0);
```
<mark>setCursor(uint16_t x0, uint16_t y0);</mark>
<!-- ```arduinosetCursor(x0, y0)</mark> # for micropython -->
@@ -104,9 +98,7 @@ lcd.drawPixel(22,22,lcd.RED)
**Syntax:**
```arduino
drawPixel(int16_t x, int16_t y, uint16_t color);
```
<mark>drawPixel(int16_t x, int16_t y, uint16_t color);</mark>
**Function: Draw a point at position (x, y).**
@@ -137,9 +129,7 @@ lcd.drawPixel(22,22,lcd.RED)
**Syntax:**
```arduino
drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color);
```
<mark>drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t </mark>y1, uint16_t color);
**Function: Draw the line from point (x,y) to point (x1,y1).**
@@ -170,9 +160,7 @@ lcd.drawLine(0,0,12,12,lcd.WHITE)
**Syntax:**
```arduino
drawTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);
```
<mark>drawTriangle(int16_t x0, int16_t y0, int16_t x1, </mark>int16_t y1, int16_t x2, int16_t y2, uint16_t color);
**Function: Draw the triangel between points (x,y), (x1,y1) and (x2,y2).**
@@ -203,9 +191,7 @@ lcd.drawLine(0,0,12,12,lcd.WHITE)
**Syntax:**
```arduino
fillTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);
```
<mark>fillTriangle(int16_t x0, int16_t y0, int16_t x1, </mark>int16_t y1, int16_t x2, int16_t y2, uint16_t color);
**Function: Fill the triangel between points (x,y), (x1,y1) and (x2,y2).**
@@ -236,9 +222,7 @@ lcd.drawLine(0,0,12,12,lcd.WHITE)
**Syntax:**
```arduino
drawRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);
```
<mark>drawRect(int16_t x, int16_t y, int16_t w, int16_t h, </mark>uint16_t color);
**Function: Draw the rectangle from the upper left point at (x,y) and width and height.**
@@ -271,9 +255,7 @@ lcd.drawLine(0,0,12,12,lcd.WHITE)
**Syntax:**
```arduino
fillRect(int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);
```
<mark>fillRect(int16_t x, int16_t y, int16_t w, int16_t h, </mark>uint16_t color);
**Function: Fill the rectangle from the upper left point at (x,y) and width and height.**
@@ -306,9 +288,7 @@ lcd.drawLine(0,0,12,12,lcd.WHITE)
**Syntax:**
```arduino
drawRoundRect(int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color);
```
<mark>drawRoundRect(int16_t x0, int16_t y0, int16_t w, </mark>int16_t h, int16_t radius, uint16_t color);
**Function: Draw the rectangle with rounded corners from the upper left point at (x,y) and width and height. Corner radius is given by radius argument.**
@@ -342,9 +322,7 @@ lcd.drawLine(0,0,12,12,lcd.WHITE)
**Syntax:**
```arduino
print();
```
<mark>print();</mark>
**Function: Start printing text at the current position of the screen.**
docs/en/api/mpu9250.md
+6 -18
View File
@@ -6,9 +6,7 @@
**Syntax:**
```arduino
void initMPU9250();
```
<mark>void initMPU9250();</mark>
**Description:**
@@ -36,9 +34,7 @@ void loop() {
**Syntax:**
```arduino
void initAK8963(float * destination);
```
<mark>void initAK8963(float * destination);</mark>
**Description:**
@@ -82,9 +78,7 @@ void loop() {
**Syntax:**
```arduino
void calibrateMPU9250(float * gyroBias, float * accelBias);
```
<mark>void calibrateMPU9250(float * gyroBias, float * accelBias);</mark>
**Description:**
@@ -133,9 +127,7 @@ void loop() {
**Syntax:**
```arduino
uint8_t readByte(uint8_t address, uint8_t subAddress);
```
<mark>uint8_t readByte(uint8_t address, uint8_t subAddress)</mark>;
**Description:**
@@ -170,9 +162,7 @@ void loop() {
**Syntax:**
```arduino
void readGyroData(int16_t * destination);
```
<mark>void readGyroData(int16_t * destination);</mark>
**Description:**
@@ -224,9 +214,7 @@ void loop() {
**Syntax:**
```arduino
void readAccelData(int16_t * destination);
```
<mark>void readAccelData(int16_t * destination);</mark>
**Description:**
docs/en/api/speaker.md
+1 -3
View File
@@ -4,9 +4,7 @@
**Syntax:**
```arduino
tone(uint16_t freq, [uint32_t duration]);
```
<mark>tone(uint16_t freq, [uint32_t duration]);</mark>
**Description: Set the pitch of speaker.**
docs/en/api/system.md
+3 -9
View File
@@ -4,9 +4,7 @@
**Syntax:**
```arudino
void begin(bool LCDEnable=true, bool SDEnable=true, bool SerialEnable=true);
```
<mark>void begin(bool LCDEnable=true, bool SDEnable=true, bool SerialEnable=true);</mark>
**Description:**
@@ -48,9 +46,7 @@ void setup() {
**Syntax:**
```arduino
void update();
```
<mark>void update();</mark>
**Description:**
@@ -89,9 +85,7 @@ void loop() {
**Syntax:**
```arduino
void powerOFF();
```
<mark>void powerOFF();</mark>
**Description:**
docs/en/api/tf.md
+2 -6
View File
@@ -4,9 +4,7 @@
**Syntax:**
```arduino
boolean begin(uint8_t cspin);
```
<mark>boolean begin(uint8_t cspin);</mark>
**Description:**
@@ -30,9 +28,7 @@ void setup() {
**Syntax:**
```arduino
File open(const char *filename, uint8_t mode = FILE_READ);
```
<mark>File open(const char *filename, uint8_t mode = FILE_READ);</mark>
**Description:**
docs/en/quick_start/m5camera/m5camera_quick_start.md
+5 -3
View File
@@ -34,13 +34,15 @@ ESP32Cam/M5Camera AP only can connect with one device at a time.
## Firmware
ESP32Cam Firmware: https://github.com/m5stack/m5stack-cam-psram/tree/normal
ESP32Cam Firmware: https://github.com/m5stack/m5stack-cam-psram/tree/NoPsram
M5Camera(A model default) Firmware: https://github.com/m5stack/m5stack-cam-psram/tree/master
M5Camera(A model) Firmware: https://github.com/m5stack/m5stack-cam-psram/tree/master
M5Camera(B model) Firmware: https://github.com/m5stack/m5stack-cam-psram/tree/master
M5CameraX Firmware: https://github.com/m5stack/m5stack-cam-psram/tree/master
M5CameraF Firmware: https://github.com/m5stack/m5stack-cam-psram/tree/master
M5CameraF Firmware: https://github.com/m5stack/m5stack-cam-psram/tree/FishEye
## Video Tutorial
docs/en/unit/esp32cam.md
+1 -1
View File
@@ -148,7 +148,7 @@ Because the module can generate WIFI hotspot AP, So you can use your mobile phon
### Firmware
- **[ESP32CAM Firmware](https://github.com/m5stack/m5stack-cam-psram/tree/normal)**
- **[ESP32CAM Firmware](https://github.com/m5stack/m5stack-cam-psram/tree/NoPsram)**
<!-- ## Schematic
docs/en/unit/m5camera.md
+5 -3
View File
@@ -157,13 +157,15 @@ This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and h
### Firmware
- **[M5Camera Firmware](https://github.com/m5stack/m5stack-cam-psram/tree/master)**
- [A Model](https://github.com/m5stack/m5stack-cam-psram/tree/ModeA)
- [B Model](https://github.com/m5stack/m5stack-cam-psram/tree/master)
### Example
- **[Color recognition](https://github.com/m5stack/Applications-cam)**
- [Color recognition](https://github.com/m5stack/Applications-cam)
- **[Face recognition](https://github.com/m5stack/esp-who)**
- [Face recognition](https://github.com/m5stack/esp-who)
<!-- ## Related Video
docs/en/unit/m5camera_f.md
+1 -1
View File
@@ -156,7 +156,7 @@ This Unit reserves the weld of the 9-axis gyroscope (MPU6050), Temperature and h
### Firmware
- **[M5Camera Firmware](https://github.com/m5stack/m5stack-cam-psram/tree/master)**
- **[M5Camera Firmware](https://github.com/m5stack/m5stack-cam-psram/tree/FishEye)**
<img src="assets/img/product_pics/unit/unit_m5camera_f_06.png" width="50%" height="50%">
docs/en/unit/ncir.md
+1 -1
View File
@@ -8,7 +8,7 @@
## Description
**<mark>NCIR</mark>** is a unit can measure body temperature or be applicated for movement detection which integrates **MLX90614** (an infrared thermometer designed for non-contact temperature sensing).
**<mark>NCIR</mark>** is a unit can measure body temperature or be applicated for movement detection which integrates **MLX90614** (an infrared thermometer designed for non-contact temperature sensing). The difference between it and the **[Thermal Unit](en/unit/thermal)** is mainly the NCIR Unit for surface single point temperature measurement, and the Thermal Unit for large area temperature measurement.
The unit comunicates with M5Core with I2C. And It's I2C address is 0x5A.
docs/ja/api/button.md
+4 -12
View File
@@ -8,9 +8,7 @@
**構文:**
```arduino
uint8_t read();
```
<mark>uint8_t read();</mark>
**使用例:**
@@ -36,9 +34,7 @@ void loop() {
**構文:**
```arduino
uint8_t isPressed();
```
<mark>uint8_t isPressed();</mark>
**使用例:**
@@ -64,9 +60,7 @@ void loop() {
**構文:**
```arduino
uint8_t wasPressed();
```
<mark>uint8_t wasPressed();</mark>
**説明:**
@@ -96,9 +90,7 @@ void loop() {
**構文:**
```arduino
uint8_t pressedFor(uint32_t ms);
```
<mark>uint8_t pressedFor(uint32_t ms);</mark>
**説明:**
docs/ja/api/lcd.md
+11 -33
View File
@@ -10,9 +10,7 @@
**構文:**
```arduino
fillScreen(uint16_t color);
```
<mark>fillScreen(uint16_t color);</mark>
| 引数 | 説明 | 型 |
| --- | --- | -- |
@@ -35,9 +33,7 @@ M5.Lcd.fillScreen(RED);
**構文:**
```arduino
setTextColor(uint16_t color, [uint16_t backgroundcolor]);
```
<mark>setTextColor(uint16_t color, [uint16_t backgroundcolor]);</mark>
| 引数 | 説明 | 型 |
| --- | --- | -- |
@@ -61,9 +57,7 @@ M5.Lcd.setTextColor(RED);
**構文:**
```arduino
setCursor(uint16_t x, uint16_t y);
```
<mark>setCursor(uint16_t x, uint16_t y);</mark>
| 引数 | 説明 | 型 |
| --- | --- | -- |
@@ -88,9 +82,7 @@ M5.Lcd.print("Hello");
**構文:**
```arduino
drawPixel(int16_t x, int16_t y, [uint16_t color]);
```
<mark>drawPixel(int16_t x, int16_t y, [uint16_t color]);</mark>
| 引数 | 説明 | 型 |
| --- | --- | -- |
@@ -115,9 +107,7 @@ M5.Lcd.drawPixel(22, 22, RED);
**構文:**
```arduino
drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, [uint16_t color]);
```
<mark>drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, [uint16_t color]);</mark>
| 引数 | 説明 | 型 |
| --- | --- | -- |
@@ -144,9 +134,7 @@ M5.Lcd.drawLine(0, 0, 12, 12, WHITE);
**構文:**
```arduino
drawTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, [uint16_t color]);
```
<mark>drawTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, [uint16_t color]);</mark>
| 引数 | 説明 | 型 |
| --- | --- | -- |
@@ -175,9 +163,7 @@ M5.Lcd.drawTriangle(22, 22, 69, 98, 51, 22, RED);
**構文:**
```arduino
fillTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, [uint16_t color]);
```
<mark>fillTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, [uint16_t color]);</mark>
| 引数 | 説明 | 型 |
| --- | --- | -- |
@@ -206,9 +192,7 @@ M5.Lcd.fillTriangle(22, 22, 69, 98, 51, 22, RED);
**構文:**
```arduino
drawRect(int16_t x, int16_t y, int16_t w, int16_t h, [uint16_t color]);
```
<mark>drawRect(int16_t x, int16_t y, int16_t w, int16_t h, [uint16_t color]);</mark>
| 引数 | 説明 | 型 |
| --- | --- | -- |
@@ -235,9 +219,7 @@ M5.Lcd.drawRect(180, 12, 122, 10, BLUE);
**構文:**
```arduino
fillRect(int16_t x, int16_t y, int16_t w, int16_t h, [uint16_t color]);
```
<mark>fillRect(int16_t x, int16_t y, int16_t w, int16_t h, [uint16_t color]);</mark>
| 引数 | 説明 | 型 |
| --- | --- | -- |
@@ -264,9 +246,7 @@ M5.Lcd.fillRect(180, 12, 122, 10, BLUE);
**構文:**
```arduino
drawRoundRect(int16_t x, int16_t y, int16_t w, int16_t h, int16_t r, [uint16_t color]);
```
<mark>drawRoundRect(int16_t x, int16_t y, int16_t w, int16_t h, int16_t r, [uint16_t color]);</mark>
| 引数 | 説明 | 型 |
| --- | --- | -- |
@@ -294,9 +274,7 @@ M5.Lcd.fillRoundRect(180, 70, 122, 10, 4, BLUE);
**構文:**
```arduino
print("表示する文字列");
```
<mark>print("表示する文字列");</mark>
**使用例:**
docs/ja/api/mpu9250.md
+6 -18
View File
@@ -6,9 +6,7 @@
**構文:**
```arduino
void initMPU9250();
```
<mark>void initMPU9250();</mark>
**説明:**
@@ -36,9 +34,7 @@ void loop() {
**構文:**
```arduino
void initAK8963(float * destination);
```
<mark>void initAK8963(float * destination);</mark>
**説明:**
@@ -82,9 +78,7 @@ void loop() {
**構文:**
```arduino
void calibrateMPU9250(float * gyroBias, float * accelBias);
```
<mark>void calibrateMPU9250(float * gyroBias, float * accelBias);</mark>
**説明:**
@@ -133,9 +127,7 @@ void loop() {
**構文:**
```arduino
uint8_t readByte(uint8_t address, uint8_t subAddress);
```
<mark>uint8_t readByte(uint8_t address, uint8_t subAddress);</mark>
**説明:**
@@ -170,9 +162,7 @@ void loop() {
**構文:**
```arduino
void readGyroData(int16_t * destination);
```
<mark>void readGyroData(int16_t * destination);</mark>
**説明:**
@@ -224,9 +214,7 @@ void loop() {
**構文:**
```arduino
void readAccelData(int16_t * destination);
```
<mark>void readAccelData(int16_t * destination);</mark>
**説明:**
docs/ja/api/speaker.md
+1 -3
View File
@@ -8,9 +8,7 @@
**構文:**
```arduino
tone(uint16_t freq, [uint32_t duration]);
```
<mark>tone(uint16_t freq, [uint32_t duration]);</mark>
| 引数 | 説明 | 型 |
| --- | --- | -- |
docs/ja/api/system.md
+4 -10
View File
@@ -8,9 +8,7 @@ LCD、TFカード、シリアルポートの有効化/無効化を設定しま
**構文:**
```arudino
void begin(bool LCDEnable=true, bool SDEnable=true, bool SerialEnable=true);
```
<mark>void begin(bool LCDEnable=true, bool SDEnable=true, bool SerialEnable=true);</mark>
**定義:**
@@ -52,9 +50,7 @@ void setup() {
**構文:**
```arduino
void update();
```
<mark>void update();</mark>
**定義:**
@@ -89,14 +85,12 @@ void loop() {
**構文:**
<mark>void powerOFF();</mark>
**説明:**
M5の電源をオフします。
```arduino
void powerOFF();
```
**定義:**
```arduino
docs/ja/api/tf.md
+2 -6
View File
@@ -8,9 +8,7 @@ TFカード機能が使用可能になります。
**構文:**
```arduino
boolean begin(uint8_t cspin);
```
<mark>boolean begin(uint8_t cspin);</mark>
| 引数 | 説明 | 型 |
| --- | --- | -- |
@@ -34,9 +32,7 @@ void setup() {
**構文:**
```arduino
File open(const char *filename, uint8_t mode = FILE_READ);
```
<mark>File open(const char *filename, uint8_t mode = FILE_READ);</mark>
| 引数 | 説明 | 型 |
| --- | --- | -- |
docs/ja/quick_start/m5camera/m5camera_quick_start.md
+4 -2
View File
@@ -28,10 +28,12 @@ ESP32Cam/M5Cameraの映像がブラウザにリアルタイムに表示されま
## コード
ESP32Cam: https://github.com/m5stack/m5stack-cam-psram/tree/normal
ESP32Cam: https://github.com/m5stack/m5stack-cam-psram/tree/NoPsram
M5Camera (A model): https://github.com/m5stack/m5stack-cam-psram/tree/master
M5Camera (B model): https://github.com/m5stack/m5stack-cam-psram/tree/master
M5CameraX : https://github.com/m5stack/m5stack-cam-psram/tree/master
M5CameraF : https://github.com/m5stack/m5stack-cam-psram/tree/master
M5CameraF : https://github.com/m5stack/m5stack-cam-psram/tree/FishEye

Some files were not shown because too many files have changed in this diff Show More