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/ja/api/gpio.md
+1
View File
@@ -13,6 +13,7 @@
端子の状態を読み取ります。`
**引数**
| 引数 |型 |説明 |
| --- | --- | --- |
| pin | <code>uint8</code> |ピン番号 |
docs/ja/api/power.md
+63 -3
View File
@@ -43,11 +43,15 @@ USB接続時は電源をOFFにできません。
**引数**
| 値 |説明 |
| --- |--- |
|true|長押しでON/OFFします。|
|false|短押し2回でON/OFFします。 |
**戻り値**
| 値 |説明 |
| --- |--- |
|true|制御成功。|
|false|制御失敗。|
@@ -64,11 +68,15 @@ USB接続時は電源をOFFにできません。
**引数**
| 引数 |説明 |
| --- |--- |
|true|短押し1回でON/OFFします。|
|false|setPowerBoostOnOff()の方法に従います。 |
**戻り値**
| 値 |説明 |
| --- |--- |
|true|制御成功|
|false|制御失敗|
@@ -85,11 +93,15 @@ USBなどからの電源供給が途切たとき、
**引数**
| 値 |説明 |
| --- |--- |
|true|電源を再投入します。|
|false|電源を再投入しません。 |
**戻り値**
| 値 |説明 |
| --- |--- |
|true|制御成功|
|false|制御失敗|
@@ -107,11 +119,15 @@ USBなどからの電源供給が途切たとき、
**引数**
| 値 |説明 |
| --- |--- |
|true|短押し2回でLEDをつけます|
|false|長押しでLEDをつけます|
**戻り値**
| 値 |説明 |
| --- |--- |
|true|制御成功|
|false|制御失敗|
@@ -130,11 +146,15 @@ USBなどからの電源供給が途切たとき、
**引数**
| 値 |説明 |
| --- |--- |
|true|電源操作を受け付けます。|
|false|電源操作を受け付けません。|
**戻り値**
| 値 |説明 |
| --- |--- |
|true|制御成功|
|false|制御失敗|
@@ -151,6 +171,8 @@ IP5306が省エネ判断をして電源OFFするまでの待ち時間を設定
**引数**
| 値 |説明 |
| --- |--- |
|ShutdownTime::SHUTDOWN_8S |8秒待ちます。|
|ShutdownTime::SHUTDOWN_16S|16秒待ちます。|
|ShutdownTime::SHUTDOWN_32S|32秒待ちます。|
@@ -158,6 +180,8 @@ IP5306が省エネ判断をして電源OFFするまでの待ち時間を設定
**戻り値**
| 値 |説明 |
| --- |--- |
|true|制御成功|
|false|制御失敗|
@@ -174,11 +198,15 @@ IP5306が省エネ判断をして電源OFFするまでの待ち時間を設定
**引数**
| 値 |説明 |
| --- |--- |
|true|電源供給を常に保ちます。 （IP5306スリープ無効）|
|false| 電源供給はIP5306が判断します。（IP5306スリープ有効）|
**戻り値**
| 値 |説明 |
| --- |--- |
|true|制御成功|
|false|制御失敗|
@@ -196,11 +224,15 @@ IP5306が省エネ判断をして電源OFFするまでの待ち時間を設定
**引数**
| 値 |説明 |
| --- |--- |
|true| 軽負荷時に自動シャットダウンしません。 |
|false| 軽負荷時に自動シャットダウンします。 |
**戻り値**
| 値 |説明 |
| --- |--- |
|true|制御成功|
|false|制御失敗|
@@ -218,11 +250,15 @@ IP5306が省エネ判断をして電源OFFするまでの待ち時間を設定
**引数**
| 値 |説明 |
| --- |--- |
|true|省エネシャットダウン機能を有効にします。|
|false|省エネシャットダウン機能を無効にします。|
**戻り値**
| 値 |説明 |
| --- |--- |
|true|制御成功|
|false|制御失敗|
@@ -238,11 +274,15 @@ IP5306の2次側に電力消費が発生した場合に自動起動するかを
**引数**
| 値 |説明 |
| --- |--- |
|true|自動起動機能を有効にします。|
|false|自動起動機能を無効にします。|
**戻り値**
| 値 |説明 |
| --- |--- |
|true|制御成功|
|false|制御失敗|
@@ -259,11 +299,15 @@ IP5306の2次側に電力消費が発生した場合に自動起動するかを
**引数**
| 値 |説明 |
| --- |--- |
|true|充電開始指示。|
|false|充電中止指示。|
**戻り値**
| 値 |説明 |
| --- |--- |
|true|制御成功|
|false|制御失敗|
@@ -284,6 +328,8 @@ IP5306の2次側に電力消費が発生した場合に自動起動するかを
**戻り値**
| 値 |説明 |
| --- |--- |
|true|満充電。 |
|false|満充電ではない。 |
@@ -306,6 +352,8 @@ IP5306の2次側に電力消費が発生した場合に自動起動するかを
**戻り値**
| 値 |説明 |
| --- |--- |
|true|電源コントローラーを制御可能。|
|false|電源コントローラーを制御不可能。|
@@ -326,6 +374,8 @@ IP5306の2次側に電力消費が発生した場合に自動起動するかを
**戻り値**
| 値 |説明 |
| --- |--- |
|true|充電中。|
|false|充電中ではない。|
@@ -362,7 +412,9 @@ IP5306の2次側に電力消費が発生した場合に自動起動するかを
**引数**
button: ポート番号
| 値 |説明 |
| --- |--- |
|button| ポート番号 |
**戻り値**
@@ -409,8 +461,10 @@ CPUをリセットし、再起動します。
**戻り値**
true : ソフトウェアリセットによるもの
false: それ以外によるもの
| 値 |説明 |
| --- |--- |
|true| ソフトウェアリセットによるもの|
|false| それ以外によるもの|
## isResetbyWatchdog()
@@ -428,6 +482,8 @@ false: それ以外によるもの
**戻り値**
| 値 |説明 |
| --- |--- |
|true|ウォッチドッグによるもの|
|false|それ以外によるもの|
@@ -447,6 +503,8 @@ false: それ以外によるもの
**戻り値**
| 値 |説明 |
| --- |--- |
|true|deepSleep()後の起動|
|false|それ以外によるもの|
@@ -466,6 +524,8 @@ false: それ以外によるもの
**戻り値**
| 値 |説明 |
| --- |--- |
|true|パワーSWからの電源投入後の起動|
|false|それ以外によるもの|