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

Merge branch 'master' of github.com:m5stack/m5-docs

Browse Source
This commit is contained in:
ali-admin
2021-01-18 16:06:53 +08:00
parent f6275ccaa6 0f091e32b0
commit 968438a854
4 changed files with 817 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/mpy/mpy_api_list.md
+73
View File
@@ -0,0 +1,73 @@
<div class="container uiflow_banner">
<div>
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/home_page/mpy_homepage.webp">
</div>
<div style="margin-top:30px">
<h1 class="jumbotron-heading">UIFlow MicroPython API</h1>
<p class="lead text-muted">API List</p>
</div>
</div>
<div id='arduino_home_page' v-cloak>
<el-card class="box-card" v-for="(item,index) in list" :key="index" style="margin-bottom:20px" :id="item.id">
<div slot="header" class="clearfix">
<span>{{item.title}}</span>
<i class="el-icon-s-management" style="float: right;"></i>
</div>
<div v-for="(href,name) in item.item" :key="name" style="margin: 0px 10px 10px 0px ;display:inline-block;">
<a :href='href'><el-tag>{{name}}</el-tag></a>
</div>
</el-card>
</div>
<script>
const quickstart = {
'title':"快速上手/固件烧录",
'item':{
'BASIC / M5GO / FIRE / FACES':'#/en/arduino/arduino_development',
'M5StickC':'#/en/arduino/arduino_development',
'M5Stick':'#/en/arduino/arduino_development',
'ATOM Lite / Matrix':'#/en/arduino/arduino_development',
'M5Core2':'#/en/arduino/arduino_core2_development'
},
"id":"quickstart"
};
const unit = {
'title':"Unit I2C Class",
'item':{
'Ultrasonic':'#/en/mpy/unit?id=ultrasonic',
'Heart':'#/en/mpy/unit?id=heart',
'ENV/ENV II':'#/en/mpy/unit?id=envenv-ii',
'ADC':'#/en/mpy/unit?id=adc',
'ACCEL':'#/en/mpy/unit?id=accel',
'DAC':'#/en/mpy/unit?id=dac',
'NCIR':'#/en/mpy/unit?id=ncir',
'Joystick':'#/en/mpy/unit?id=joystick',
'ToF':'#/en/mpy/unit?id=tof',
'COLOR':'#/en/mpy/unit?id=color',
'EXT.IO':'#/en/mpy/unit?id=extio',
'RFID':'#/en/mpy/unit?id=rfid',
'EXT.IO':'#/en/mpy/unit?id=extio',
'CardKB':'#/en/mpy/unit?id=cardkb',
'Tracker':'#/en/mpy/unit?id=track',
'Makey':'#/en/mpy/unit?id=makey'
},
"id":"unit_api"
};
var arduino_home_page = new Vue({
el:'#arduino_home_page',
data() {
return {
list: {
quickstart: quickstart,
unit: unit
}
};
}
})
</script>
docs/en/mpy/unit.md
+579
View File
File diff suppressed because it is too large Load Diff
docs/zh_CN/mpy/mpy_api_list.md
+73
View File
@@ -0,0 +1,73 @@
<div class="container uiflow_banner">
<div>
<img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/m5-docs_homepage/home_page/mpy_homepage.webp">
</div>
<div style="margin-top:30px">
<h1 class="jumbotron-heading">UIFlow MicroPython API</h1>
<p class="lead text-muted">API List</p>
</div>
</div>
<div id='arduino_home_page' v-cloak>
<el-card class="box-card" v-for="(item,index) in list" :key="index" style="margin-bottom:20px" :id="item.id">
<div slot="header" class="clearfix">
<span>{{item.title}}</span>
<i class="el-icon-s-management" style="float: right;"></i>
</div>
<div v-for="(href,name) in item.item" :key="name" style="margin: 0px 10px 10px 0px ;display:inline-block;">
<a :href='href'><el-tag>{{name}}</el-tag></a>
</div>
</el-card>
</div>
<script>
const quickstart = {
'title':"快速上手/固件烧录",
'item':{
'BASIC / M5GO / FIRE / FACES':'#/zh_CN/arduino/arduino_development',
'M5StickC':'#/zh_CN/arduino/arduino_development',
'M5Stick':'#/zh_CN/arduino/arduino_development',
'ATOM Lite / Matrix':'#/zh_CN/arduino/arduino_development',
'M5Core2':'#/zh_CN/arduino/arduino_core2_development'
},
"id":"quickstart"
};
const unit = {
'title':"Unit I2C Class",
'item':{
'Ultrasonic':'#/zh_CN/mpy/unit?id=ultrasonic',
'Heart':'#/zh_CN/mpy/unit?id=heart',
'ENV/ENV II':'#/zh_CN/mpy/unit?id=envenv-ii',
'ADC':'#/zh_CN/mpy/unit?id=adc',
'ACCEL':'#/zh_CN/mpy/unit?id=accel',
'DAC':'#/zh_CN/mpy/unit?id=dac',
'NCIR':'#/zh_CN/mpy/unit?id=ncir',
'Joystick':'#/zh_CN/mpy/unit?id=joystick',
'ToF':'#/zh_CN/mpy/unit?id=tof',
'COLOR':'#/zh_CN/mpy/unit?id=color',
'EXT.IO':'#/zh_CN/mpy/unit?id=extio',
'RFID':'#/zh_CN/mpy/unit?id=rfid',
'EXT.IO':'#/zh_CN/mpy/unit?id=extio',
'CardKB':'#/zh_CN/mpy/unit?id=cardkb',
'Tracker':'#/zh_CN/mpy/unit?id=track',
'Makey':'#/zh_CN/mpy/unit?id=makey'
},
"id":"unit_api"
};
var arduino_home_page = new Vue({
el:'#arduino_home_page',
data() {
return {
list: {
quickstart: quickstart,
unit: unit
}
};
}
})
</script>
docs/zh_CN/mpy_api/unit.md → docs/zh_CN/mpy/unit.md
+92 -59
View File
@@ -11,28 +11,74 @@ def get(unit, port, *arg)
```
- 引入模块
```python
```python
unit.get(unit.JOYSTICK, unit.PORTA)
```
- 卸载模块
```python
```python
unit.deinit()
```
## I2C
### ENV
### Ultrasonic
- *[查看产品详情](zh_CN/unit/env)*
- [查看产品详情](zh_CN/unit/sonic)
- 设备类型：I2C
- Chip: **RCWL-9600**
- Chip: **dht12, bmp280**
- Addr: **0x57**
- Addr: ***0x5c***, ***0x76***
```python
Ultrasonic0 = unit.get(unit.ULTRASONIC, unit.PORTA)
#读取测距信息
distance = Ultrasonic0.distance
```
### Heart
- [查看产品详情](zh_CN/unit/heart)
- Chip: **RCWL-9600**
- Addr: **0x57**
```python
heart0 = unit.get(unit.HEART, unit.PORTA)
#设置传感器工作模式 0x02为心率模式 | 0x03为心率血氧模式
heart0.setMode(mode)
#调整传感器LED电流，RED为血氧测试LED电流，IR为心率测试LED电流。
heart0.setLedCurrent(red, ir)
#读取心率
HeartRate = heart0.getHeartRate()
#读取血氧
SpO2 = heart0.getSpO2()
```
### ENV/ENV II
- [查看产品详情](zh_CN/unit/env)
- ENV
- Chip: **dht12**, **bmp280**
- Addr: **0x5c**, **0x76**
-----------------------
- ENV II
- Chip: **sht30**, **bmp280**
- Addr: **0x44**, **0x76**
```python
# init --- Effective IO: PORTA | PORTC
@@ -48,11 +94,11 @@ pre = unit_env.pressure
### ADC
- *[查看产品详情](zh_CN/unit/adc)*
- [查看产品详情](zh_CN/unit/adc)
- Chip: **ADS1100**
- Addr: ***0x48***
- Addr: **0x48**
``` python
# init --- Effective IO: PORTA | PORTC
@@ -62,11 +108,9 @@ unit_adc = unit.get(unit.ADC, unit.PORTA)
vol = unit_adc.voltage
```
### ACCEL Unit
### ACCEL
- *[查看产品详情](zh_CN/unit/accel)*
- 设备类型：I2C
- [查看产品详情](zh_CN/unit/accel)
- Chip: **ADXL345**
@@ -82,11 +126,11 @@ z = accel0.acceleration[2]
### DAC
- *[查看产品详情](zh_CN/unit/dac)*
- [查看产品详情](zh_CN/unit/dac)
- Chip: **ADS1100**
- Addr: ***0x48***
- Addr: **0x48**
```python
# init --- Effective IO: PORTA
@@ -100,13 +144,13 @@ unit_dac.writeData(data, save=False)
unit_dac.setVoltage(vol, save=False)
```
### Ncir
### NCIR
- *[查看产品详情](zh_CN/unit/ncir)*
- [查看产品详情](zh_CN/unit/ncir)
- Chip: **MLX90614**
- Addr: ***0x5a***
- Addr: **0x5a**
```python
# init --- Effective IO: PORTA | PORTC
@@ -117,9 +161,7 @@ tmp = unit_ncir.temperature
### Joystick
- *[查看产品详情](zh_CN/unit/joystick)*
- 设备类型：I2C
- [查看产品详情](zh_CN/unit/joystick)
- Chip: **ATmega328P**
@@ -140,9 +182,9 @@ y = unit_joystick.InvertY
press = unit_joystick.Press
```
### Tof
### ToF
- *[查看产品详情](zh_CN/unit/tof)*
- [查看产品详情](zh_CN/unit/tof)
- Chip: **VL53L0X**
@@ -157,7 +199,7 @@ distance = unit_tof.distance
### Color
- *[查看产品详情](zh_CN/unit/color)*
- [查看产品详情](zh_CN/unit/color)
- Chip: **TCS3472**
@@ -180,7 +222,7 @@ unit_color.blue
### Extend IO
- *[查看产品详情](zh_CN/unit/extio)*
- [查看产品详情](zh_CN/unit/extio)
- Chip: **PCA9554PW**
@@ -209,7 +251,7 @@ unit_extIO.digitWrite(pin, value)
### RFID
- *[查看产品详情](zh_CN/unit/rfid)*
- [查看产品详情](zh_CN/unit/rfid)
- Chip: **MFRC522**
@@ -232,7 +274,7 @@ dataStr = unit_rfid.readBlockStr(block)
### CardKB
- *[查看产品详情](zh_CN/unit/cardkb)*
- [查看产品详情](zh_CN/unit/cardkb)
- Chip: **ATmega328P**
@@ -252,7 +294,7 @@ unit_cardKB = unit.get(unit.CARDKB, unit.PORTA)
### Tracker
- *[查看产品详情](zh_CN/unit/track)*
- [查看产品详情](zh_CN/unit/track)
- Chip: **ATmega328P**
@@ -274,7 +316,7 @@ value = unit_track.getDigitalValue(pos)
### Makey
- *[查看产品详情](zh_CN/unit/makey)*
- [查看产品详情](zh_CN/unit/makey)
- Chip: **ATmega328P**
@@ -289,13 +331,11 @@ data = unit_makey.value
---------------------------------------
## IO
## IO/ADC/DAC
### PIR
- *[查看产品详情](zh_CN/unit/pir)*
- 设备类型：IO
- [查看产品详情](zh_CN/unit/pir)
```python
# init --- Effective IO: PORTA | PORTB | PORTC
@@ -305,11 +345,9 @@ state = pir.state
```
## Button
### Button
- *[查看产品详情](zh_CN/unit/button)*
- 设备类型：IO
- [查看产品详情](zh_CN/unit/button)
``` python
# init --- Effective IO: PORTA | PORTB | PORTC
@@ -343,11 +381,9 @@ unit_btn.wasDoublePress(on_doublePress)
unit_btn.pressFor(1.2, on_pressFor)
```
## Dual Button
### Dual Button
- *[查看产品详情](zh_CN/unit/button)*
- 设备类型：IO
- [查看产品详情](zh_CN/unit/button)
```python
# init --- Effective IO: PORTA | PORTB | PORTC
@@ -358,9 +394,9 @@ btnRed = unit_dualButton.btnBlue
```
## Relay
### Relay
- *[查看产品详情](zh_CN/unit/relay)*
- [查看产品详情](zh_CN/unit/relay)
```python
# init --- Effective IO: PORTA | PORTB | PORTC
@@ -372,9 +408,9 @@ unit_relay.off()
```
## IR
### IR
- *[查看产品详情](zh_CN/unit/ir)*
- [查看产品详情](zh_CN/unit/ir)
```python
# init --- Effective IO: PORTA | PORTB | PORTC
@@ -388,9 +424,9 @@ value = unit.rxStatus()
```
## Angle
### Angle
Analog Device ( *[查看产品详情](zh_CN/unit/angle)*
Analog Device ( [查看产品详情](zh_CN/unit/angle)
``` python
# init --- Effective IO: PORTB
@@ -405,7 +441,7 @@ filterValue = unit_angle.read()
### Light
- *[查看产品详情](zh_CN/unit/light)*
- [查看产品详情](zh_CN/unit/light)
```python
# init --- Effective IO: PORTB
@@ -418,7 +454,7 @@ digitalValue = unit_light.digitalValue
### Earth
- *[查看产品详情](zh_CN/unit/light)*
- [查看产品详情](zh_CN/unit/light)
```python
# init --- Effective IO: PORTB
@@ -431,9 +467,7 @@ digitalValue = unit_earth.digitalValue
### Neopixel
- *[查看产品详情](zh_CN/unit/neopixel)*
- 设备类型：GPIO
- [查看产品详情](zh_CN/unit/neopixel)
- Chip: **SK6812**
@@ -452,11 +486,9 @@ unit_Neopixel.setColorAll(color)
unit_Neopixel.setBrightness(brightness)
```
### RGB
- *[查看产品详情](zh_CN/unit/rgb)*
- [查看产品详情](zh_CN/unit/rgb)
- Chip: **SK6812**
@@ -475,10 +507,9 @@ unit_Rgb.setColorAll(color)
unit_Rgb.setBrightness(brightness)
```
### Weight
- *[查看产品详情](zh_CN/unit/Servo)*
- [查看产品详情](zh_CN/unit/Servo)
- Chip: **HX711**
@@ -495,7 +526,7 @@ unit_weight.zero()
### Servo
Analog Device ( *[查看产品详情](zh_CN/unit/Servo)*
- [查看产品详情](zh_CN/unit/Servo)
```python
# init --- Effective IO: PORTA | PORTB | PORTC
@@ -510,9 +541,10 @@ unit_servo.write_angle(degrees)
## UART
### Finger
- *[查看产品详情](zh_CN/unit/finger)*
- [查看产品详情](zh_CN/unit/finger)
- Chip: **FPC1020A**
@@ -544,3 +576,4 @@ unit_finger.removeUser(user_id)
# remove all user data
unit_finger.removeAllUser()
```