From fbda09275cb056711fe51b541ba2ed16e5db5bd9 Mon Sep 17 00:00:00 2001 From: Mori Naoyuki Date: Thu, 2 May 2019 14:29:39 +0900 Subject: [PATCH] fix: remove {docsify-ignore-all} tag (commutil.md) --- docs/en/api/commutil.md | 2 +- docs/ja/api/commutil.md | 22 +++++++++++++++++++--- docs/zh_CN/api/commutil.md | 2 +- 3 files changed, 21 insertions(+), 5 deletions(-) diff --git a/docs/en/api/commutil.md b/docs/en/api/commutil.md index 02b6e343..8b20a16f 100644 --- a/docs/en/api/commutil.md +++ b/docs/en/api/commutil.md @@ -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(). diff --git a/docs/ja/api/commutil.md b/docs/ja/api/commutil.md index d0ade5ba..e5a73427 100644 --- a/docs/ja/api/commutil.md +++ b/docs/ja/api/commutil.md @@ -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 | uint8_t |スレーブアドレス | | subAddress | uint8_t |機能アドレス | **戻り値:** + | 値 |説明 | |true|送信成功。| |false|送信失敗。| @@ -36,6 +38,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。 パラメータ１つある場合に使います。 **引数** + | 引数 |型 |説明 | | --- | --- | --- | | address | uint8_t |スレーブアドレス | @@ -43,6 +46,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。 | data | uint8_t |パラメータ | **戻り値:** + | 値 |説明 | | --- | --- | |true|送信成功。| @@ -61,6 +65,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。 パラメータが複数ある場合に使います。 **引数** + | 引数 |型 |説明 | | --- | --- | --- | | address | uint8_t |スレーブアドレス | @@ -69,6 +74,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。 | length | uint8_t |パラメータ長 | **戻り値:** + | 値 |説明 | | --- | --- | |true|送信成功。| @@ -86,13 +92,15 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。 読み込み前に送信するデータがなく、返答が1バイトの場合に使います。 **引数** + | 引数 |型 |説明 | | --- | --- | --- | | address | uint8_t |スレーブアドレス | | result | uint8_t * |結果格納先 | -**戻り値: -**| 値 |説明 | +**戻り値:** + +| 値 |説明 | | --- | --- | |true|読込成功。| |false|読込失敗。| @@ -108,6 +116,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。 読み込み前に送信するデータが機能アドレスのみで、返答が1バイトの場合に使います。 **引数** + | 引数 |型 |説明 | | --- | --- | --- | | address | uint8_t |スレーブアドレス | @@ -115,6 +124,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。 | result | uint8_t * |結果格納先 | **戻り値:** + | 値 |説明 | | --- | --- | |true|読込成功。| @@ -132,6 +142,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。 読み込み前に送信するデータがなく、返答が複数ある場合に使います。 **引数** + | 引数 |型 |説明 | | --- | --- | --- | | address | uint8_t |スレーブアドレス | @@ -139,6 +150,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。 | result | uint8_t * |結果格納先 | **戻り値:** + | 値 |説明 | | --- | --- | |true|読込成功。| @@ -155,6 +167,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。 読み込み前に送信するデータが機能アドレスのみで、返答が複数ある場合に使います。 **引数** + | 引数 |型 |説明 | | --- | --- | --- | | address | uint8_t |スレーブアドレス | @@ -163,6 +176,7 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。 | result | uint8_t * |結果格納先 | **戻り値:** + | 値 |説明 | | --- | --- | |true|読込成功。| @@ -179,11 +193,13 @@ M5StackのGrove-Aポート(I2C)を制御するクラスです。 I2Cバス上のデバイス存在確認をおこないます。 **引数** + | 引数 |型 |説明 | | --- | --- | --- | | result | bool * |結果格納先 (128バイト) | **戻り値:** + | 値 |説明 | | --- | --- | |true|読込成功。| diff --git a/docs/zh_CN/api/commutil.md b/docs/zh_CN/api/commutil.md index ebec58c7..1552f4ca 100644 --- a/docs/zh_CN/api/commutil.md +++ b/docs/zh_CN/api/commutil.md @@ -1,4 +1,4 @@ -# I2C {docsify-ignore-all} +# I2C 这是一个控制M5Stack的Grove-A端口（I2C）的类。 需要通过M5.Begin()预先初始化I2C通信。