fix: remove {docsify-ignore-all} tag (commutil.md)

This commit is contained in:
Mori Naoyuki
2019-05-02 14:29:39 +09:00
parent df4e7effc4
commit fbda09275c
3 changed files with 21 additions and 5 deletions
+1 -1
View File
@@ -1,4 +1,4 @@
# I2C {docsify-ignore-all}
# I2C
This is a class to control M5Stack's Grove-A port (I2C).
I2C communication needs to be initialized in advance by M5.Begin().
+19 -3
View File
@@ -1,4 +1,4 @@
# I2C {docsify-ignore-all}
# I2C
M5StackのGrove-Aポート(I2C)を制御するクラスです。
あらかじめ M5.Begin()でI2C通信が初期化されている必要があります。
@@ -14,12 +14,14 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。
パラメータがない場合に使います。
**引数**
| 引数 |型 |説明 |
| --- | --- | --- |
| address | <code>uint8_t</code> |スレーブアドレス |
| subAddress | <code>uint8_t</code> |機能アドレス |
**戻り値:**
| 値 |説明 |
|true|送信成功。|
|false|送信失敗。|
@@ -36,6 +38,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。
パラメータ1つある場合に使います。
**引数**
| 引数 |型 |説明 |
| --- | --- | --- |
| address | <code>uint8_t</code> |スレーブアドレス |
@@ -43,6 +46,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。
| data | <code>uint8_t</code> |パラメータ |
**戻り値:**
| 値 |説明 |
| --- | --- |
|true|送信成功。|
@@ -61,6 +65,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。
パラメータが複数ある場合に使います。
**引数**
| 引数 |型 |説明 |
| --- | --- | --- |
| address | <code>uint8_t</code> |スレーブアドレス |
@@ -69,6 +74,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。
| length | <code>uint8_t</code> |パラメータ長 |
**戻り値:**
| 値 |説明 |
| --- | --- |
|true|送信成功。|
@@ -86,13 +92,15 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。
読み込み前に送信するデータがなく、返答が1バイトの場合に使います。
**引数**
| 引数 |型 |説明 |
| --- | --- | --- |
| address | <code>uint8_t</code> |スレーブアドレス |
| result | <code>uint8_t *</code> |結果格納先 |
**戻り値:
**| 値 |説明 |
**戻り値:**
| 値 |説明 |
| --- | --- |
|true|読込成功。|
|false|読込失敗。|
@@ -108,6 +116,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。
読み込み前に送信するデータが機能アドレスのみで、返答が1バイトの場合に使います。
**引数**
| 引数 |型 |説明 |
| --- | --- | --- |
| address | <code>uint8_t</code> |スレーブアドレス |
@@ -115,6 +124,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。
| result | <code>uint8_t *</code> |結果格納先 |
**戻り値:**
| 値 |説明 |
| --- | --- |
|true|読込成功。|
@@ -132,6 +142,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。
読み込み前に送信するデータがなく、返答が複数ある場合に使います。
**引数**
| 引数 |型 |説明 |
| --- | --- | --- |
| address | <code>uint8_t</code> |スレーブアドレス |
@@ -139,6 +150,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。
| result | <code>uint8_t *</code> |結果格納先 |
**戻り値:**
| 値 |説明 |
| --- | --- |
|true|読込成功。|
@@ -155,6 +167,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。
読み込み前に送信するデータが機能アドレスのみで、返答が複数ある場合に使います。
**引数**
| 引数 |型 |説明 |
| --- | --- | --- |
| address | <code>uint8_t</code> |スレーブアドレス |
@@ -163,6 +176,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。
| result | <code>uint8_t *</code> |結果格納先 |
**戻り値:**
| 値 |説明 |
| --- | --- |
|true|読込成功。|
@@ -179,11 +193,13 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。
I2Cバス上のデバイス存在確認をおこないます。
**引数**
| 引数 |型 |説明 |
| --- | --- | --- |
| result | <code>bool *</code> |結果格納先 (128バイト) |
**戻り値:**
| 値 |説明 |
| --- | --- |
|true|読込成功。|
+1 -1
View File
@@ -1,4 +1,4 @@
# I2C {docsify-ignore-all}
# I2C
这是一个控制M5Stack的Grove-A端口(I2C)的类。
需要通过M5.Begin()预先初始化I2C通信。