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

fix:Correct the broken table

Browse Source
This commit is contained in:
Mori Naoyuki
2019-05-02 14:24:19 +09:00
parent e0a0d5a5ec
commit df4e7effc4
6 changed files with 221 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api/commutil.md
+18 -1
View File
@@ -14,12 +14,14 @@ Write to the specified address.
Used when there are no parameters.
**Function argument**
| Function argument |Type |Description |
| --- | --- | --- |
| address | <code>uint8_t</code> |Slave Address |
| subAddress | <code>uint8_t</code> |function address |
**Function return value**
| Value |Description |
| --- | --- |
|true|Write success|
@@ -37,6 +39,7 @@ Write to the specified address.
Used when there is one parameter.
**Function argument**
| Function argument |Type |Description |
| --- | --- | --- |
| address | <code>uint8_t</code> |Slave Address |
@@ -44,6 +47,7 @@ Used when there is one parameter.
| data | <code>uint8_t</code> |parameter |
**Function return value**
| Value |Description |
| --- | --- |
|true|Write success|
@@ -62,6 +66,7 @@ Write to the specified address.
Use when there are multiple parameters.
**Function argument**
| Function argument |Type |Description |
| --- | --- | --- |
| address | <code>uint8_t</code> |Slave Address |
@@ -70,6 +75,7 @@ Use when there are multiple parameters.
| length | <code>uint8_t</code> | length of data |
**Function return value**
| Value |Description |
| --- | --- |
|true|Write success|
@@ -87,12 +93,14 @@ Read from the specified address.
It is used when there is no data to send before reading and the response is 1 byte.
**Function argument**
| Function argument |Type |Description |
| --- | --- | --- |
| address | <code>uint8_t</code> |Slave Address |
| result | <code>uint8_t *</code> | stored memory |
**Function return value**
| Value |Description |
| --- | --- |
|true|Read success|
@@ -110,13 +118,15 @@ Read from the specified address.
It is used when the data to be sent before reading is only the functional address and the response is 1 byte.
**Function argument**
| Function argument |Type |Description |
| --- | --- | --- |
| address | <code>uint8_t</code> |Slave Address |
| subAddress | <code>uint8_t</code> |機能アドレス |
| subAddress | <code>uint8_t</code> |function address |
| result | <code>uint8_t *</code> |stored memory|
**Function return value**
| Value |Description |
| --- | --- |
|true|Read success|
@@ -134,6 +144,7 @@ Read from the specified address.
Use when there is no data to send before reading and there are multiple responses.
**Function argument**
| Function argument |Type |Description |
| --- | --- | --- |
| address | <code>uint8_t</code> |Slave Address |
@@ -141,7 +152,9 @@ Use when there is no data to send before reading and there are multiple response
| result | <code>uint8_t *</code> |stored memory|
**Function return value**
| Value |Description |
| --- | --- |
|true|Read success|
|false|Read failure|
@@ -156,6 +169,7 @@ Read from the specified address.
It is used when the data to be sent before reading is only the functional address and there are multiple responses.
**Function argument**
| argument |Typer |Description |
| --- | --- | --- |
| address | <code>uint8_t</code> |Slave Address |
@@ -165,6 +179,7 @@ It is used when the data to be sent before reading is only the functional addres
**Function return value**
| Value |Description |
| --- | --- |
|true|Read success|
@@ -181,11 +196,13 @@ It is used when the data to be sent before reading is only the functional addres
Perform device presence check on I2C bus.
**Function argument**
| Function argument |Type |Description |
| --- | --- | --- |
| result | <code>bool *</code> |stored memory(128bytes) |
**Function return value**
| Value |Description |
| --- | --- |
|true|Read success|
docs/en/api/power.md
+60
View File
@@ -46,11 +46,15 @@ The power does not turn off when connected via USB.
**Function argument**
| Param | Description |
| --- | --- |
|true|Press and hold to turn on / off.|
|false|Turn on / off with two short presses.|
**Function return value**
| Param | Description |
| --- | --- |
|true|Control success.|
|false|Control failure. |
@@ -67,11 +71,15 @@ The power does not turn off when connected via USB.
**Function argument**
| Param | Description |
| --- | --- |
|true| ON / OFF in one short press.|
|false| Follow the setPowerBoostOnOff () method.|
**Function return value**
| Param | Description |
| --- | --- |
|true|Control success.|
|false|Control failure. |
@@ -88,11 +96,15 @@ Decide whether to turn on the power again.
**Function argument**
| Param | Description |
| --- | --- |
|true|The power will be turned on again. |
|false|The power will not be turned on again. |
**Function return value**
| Param | Description |
| --- | --- |
|true|Control success.|
|false|Control failure. |
@@ -109,11 +121,15 @@ In addition, IP5306 of M5GO is not wired and can not be controlled by this funct
**Function argument**
| Param | Description |
| --- | --- |
|true| Turn on the LED with two short presses|
|false| Turn on the LED with Press and hold|
**Function return value**
| Param | Description |
| --- | --- |
|true|Control success.|
|false|Control failure. |
@@ -135,11 +151,15 @@ If the power is not supplied, the power can not be turned on.
**Function argument**
| Param | Description |
| --- | --- |
|true| Accept power operation.|
|false| Does not accept power control.|
**Function return value**
| Param | Description |
| --- | --- |
|true|Control success.|
|false|Control failure. |
@@ -156,6 +176,8 @@ Set the waiting time until IP5306 makes the energy saving judgment and the power
**Function argument**
| Param | Description |
| --- | --- |
|ShutdownTime::SHUTDOWN_8S | wait at 8sec.|
|ShutdownTime::SHUTDOWN_16S | wait at 16sec.|
|ShutdownTime::SHUTDOWN_32S | wait at 32sec.|
@@ -163,6 +185,8 @@ Set the waiting time until IP5306 makes the energy saving judgment and the power
**Function return value**
| Param | Description |
| --- | --- |
|true|Control success.|
|false|Control failure. |
@@ -179,11 +203,15 @@ This function sets/unsets always boost output mode.
**Function argument**
| Param | Description |
| --- | --- |
|true| Always output power.|
|false| not Always output power.|
**Function return value**
| Param | Description |
| --- | --- |
|true|Control success.|
|false|Control failure. |
@@ -200,11 +228,15 @@ This function sets/unsets to disable the automatic shutdown.
**Function argument**
| Param | Description |
| --- | --- |
|true| When the current is too small, IP5306 will *not* automatically shutdown, |
|false| When the current is too small, IP5306 will automatically shutdown. |
**Function return value**
| Param | Description |
| --- | --- |
|true|Control success.|
|false|Control failure. |
@@ -222,11 +254,15 @@ Set the power saving automatic shutdown function.
**Function argument**
| Param | Description |
| --- | --- |
|true|Enable energy saving shutdown function.|
|false|Disable energy saving shutdown function.|
**Function return value**
| Param | Description |
| --- | --- |
|true|Control success.|
|false|Control failure. |
@@ -243,11 +279,15 @@ Set whether to automatically start when power consumption occurs on the secondar
**Function argument**
| Param | Description |
| --- | --- |
|true|Enable the auto start function.|
|false|Disable auto start function.|
**Function return value**
| Param | Description |
| --- | --- |
|true|Control success.|
|false|Control failure. |
@@ -266,11 +306,15 @@ try set charge enable->disable->enable, It can be recharged.
**Function argument**
| Param | Description |
| --- | --- |
|true|Start charging, |
|false| Stop charging. |
**Function return value**
| Param | Description |
| --- | --- |
|true|Control success.|
|false|Control failure. |
@@ -290,6 +334,8 @@ No argument.
**Function return value**
| Param | Description |
| --- | --- |
|true|Full charged, |
|false|Not full charged. |
@@ -310,6 +356,8 @@ No argument.
**Function return value**
| Param | Description |
| --- | --- |
|true|Battery controller is found, |
|false|Battery controller is not found. |
@@ -330,6 +378,8 @@ No argument.
**Function return value**
| Param | Description |
| --- | --- |
|true|In charging, |
|false| Not in charging.|
@@ -366,6 +416,8 @@ Sets the signal port to monitor when waking from sleep.
**Function argument**
| Param | Description |
| --- | --- |
|button| number of port. |
**Function return value**
@@ -413,6 +465,8 @@ No argument,
**Function return value**
| Param | Description |
| --- | --- |
|true| By software reset|
|false| For other reasons|
@@ -432,6 +486,8 @@ No argument,
**Function return value**
| Param | Description |
| --- | --- |
|true | By watchdog|
|false| For other reasons|
@@ -451,6 +507,8 @@ No argument,
**Function return value**
| Param | Description |
| --- | --- |
|true | after deepSleep()|
|false| For other reasons|
@@ -470,6 +528,8 @@ No argument,
**Function return value**
| Param | Description |
| --- | --- |
|true | By PowerSwitch|
|false| For other reasons|