シリアル通信アプリ 書式モード（アスキー）の 0xDB コマンド
書式モード（アスキー）におけるインタラクティブモードを使用しない設定機能
シリアル通信アプリの書式モード（アスキー形式）
送受信双方の出力にヘッダを付加するモード（アスキー形式）
書式モードは、送受信双方の出力にヘッダを付加します。アスキー形式では、データを16進数の文字列で表します。
概要
送信側の端末へ特定の書式に従ったデータを入力すると、受信側の端末も特定の書式に従ったデータを出力します。
データは16進数のアスキー文字列で表現します。
| 送信側の入力 | 受信側の出力 | |
|---|---|---|
| 簡易形式／拡張形式のデータ | → | 簡易形式／拡張形式のデータ |
- TWELITE UART では、
SETピンをGNDへ接続して起動すると書式モード（アスキー）が有効となります。 - TWELITE / TWELITE DIP では、
EX1ピンをGNDへ接続して起動すると書式モード（バイナリ）が有効となります。
扱うことのできる書式の形式は2種類あります。
- 簡易形式：論理デバイスIDだけを使用する。超簡単！標準アプリのUART伝送機能と互換性あり
- 拡張形式：論理デバイスIDに加えて、シリアルIDや再送回数などの送信オプションを使用できる
例えば、5バイトのバイナリデータ 0x48 0x45 0x4C 0x4C 0x4F は、簡易形式を使って次のように送信できます。
【送信側】
:000148454C4C4F8B <- 入力
:DBA1800103 <- 出力
【受信側】
:780148454C4C4F13 <- 出力
基本の書式
基本形式や拡張形式で表現したデータ列を送信するときは、アスキー文字列（0-9,A-F）へ変換します。
書式は超簡単！標準アプリ（App_Twelite）や親機・中継機アプリ（App_Wings）の親機の出力と同様に、:で始まりCRLFで終わります。
| ヘッダ | ペイロード | チェックサム | フッタ |
|---|---|---|---|
: | 00-FFの繰り返し | ペイロードのLRC8 | CRLF |
- すべて ASCII 文字
- 先頭は
:(0x3A) - チェックサムはペイロードの合計の2の補数
- 末端は CRLF (
\r\n/0x0D 0x0A) - ビッグエンディアン
例えば、バイナリデータ 0x00 0x11 0x22 0x33 0xAA 0xBB 0xCC は次のように表現します。
:00112233AABBCC69<CR><LF>
親機と子機の区別
書式モードは、親機と子機を区別します。
親子間では、アプリケーションIDと周波数チャネルを合わせる必要があります。
送信元の判別
書式モードでは、受信したデータから送信元を判別できます。
簡易形式の書式では論理デバイスIDを、拡張形式の書式では論理デバイスIDに加えて拡張アドレスを利用します。
拡張アドレスは、TWELITE 本体に記載された7ビットのシリアルIDの先頭へ
0x8を付加したものです。簡易形式の書式
書式モードの簡易形式を利用する場合は、次の書式に従います。
送信側の入力
| # | データ | 内容 | 備考 |
|---|---|---|---|
char | ヘッダ | :のみ | |
| 0 | uint8 | 送信先の論理デバイスID | 親機0x00,子機0x01-0x64,全子機0x78 |
| 1 | uint8 | コマンド番号 | 0x80未満の任意の値 |
| 2 | [uint8] | 任意のデータ | 長さ\(N\)のバイト列（\(N\leqq80\)を推奨） |
uint8 | チェックサム | LRC8 | |
char | フッタ | CR (0x0D/'\r') | |
char | フッタ | LF (0x0A/'\n') |
超簡単！標準アプリの
0x01コマンドの上位互換です。受信側の出力
| # | データ | 内容 | 備考 |
|---|---|---|---|
char | ヘッダ | :のみ | |
| 0 | uint8 | 送信元の論理デバイスID | 親機0x00,子機0x01-0x64,未設定子機0x78 |
| 1 | uint8 | コマンド番号 | 送信側で指定した0x80未満の値 |
| 2 | [uint8] | 任意のデータ | 長さ\(N\)のバイト列 |
uint8 | チェックサム | LRC8 | |
char | フッタ | CR (0x0D/'\r') | |
char | フッタ | LF (0x0A/'\n') |
超簡単！標準アプリの
0x01コマンドの上位互換です。送信側の出力（応答メッセージ）
| # | データ | 内容 | 備考 |
|---|---|---|---|
char | ヘッダ | :のみ | |
| 0 | uint8 | 送信元の論理デバイスID | 0xDBのみ：自身を示す |
| 1 | uint8 | コマンド番号 | 0xA1のみ |
| 2 | uint8 | 応答ID | 128-255(0x80-0xFF)の範囲で続き番号を示す |
| 3 | uint8 | 処理結果 | 成功1,失敗0 |
uint8 | チェックサム | LRC8 | |
char | フッタ | CR (0x0D/'\r') | |
char | フッタ | LF (0x0A/'\n') |
使用例
親機から全子機に対してバイト列 0x11 0x22 0x33 0xAA 0xBB 0xCC を送信する例を示します。
【送信側：親機】
:7801112233AABBCCF0<CR><LF> <- 入力
:DBA1800103<CR><LF> <- 出力
末尾の
0xF0はチェックサム：0x78から0xCCまでの合計の2の補数のLSBから8ビット。
【受信側：全子機】
:0001112233AABBCC68<CR><LF> <- 出力
末尾の
0x68はチェックサム：0x00から0xCCまでの合計の2の補数のLSBから8ビット。
拡張形式の書式
書式モードの拡張形式を利用する場合は、次の書式に従います。
送信側の入力
送信先の指定に論理デバイスIDを使用する場合
| # | データ | 内容 | 備考 |
|---|---|---|---|
char | ヘッダ | :のみ | |
| 0 | uint8 | 送信先の論理デバイスID | 親機0x00,子機0x01-0x64,全子機0x78 |
| 1 | uint8 | コマンド番号 | 0xA0のみ |
| 2 | uint8 | 応答ID | 任意の値 |
| 3 | [uint8] | オプション | 長さ\(N\)のオプション列 |
| 3+\(N\) | [uint8] | 任意のデータ | 長さ\(M\)のバイト列（\(M\leqq80\)を推奨） |
uint8 | チェックサム | LRC8 | |
char | フッタ | CR (0x0D/'\r') | |
char | フッタ | LF (0x0A/'\n') |
送信先の指定に拡張アドレスを使用する場合
| # | データ | 内容 | 備考 |
|---|---|---|---|
char | ヘッダ | :のみ | |
| 0 | uint8 | 拡張アドレスの指定 | 0x80のみ |
| 1 | uint8 | コマンド番号 | 0xA0のみ |
| 2 | uint8 | 応答ID | 任意の値 |
| 3 | uint32 | 送信先の拡張アドレス | シリアルIDの先頭へ0x8を加えた値 |
| 7 | [uint8] | オプション | 長さ\(N\)のオプション列 |
| 7+\(N\) | [uint8] | 任意のデータ | 長さ\(M\)のバイト列（\(M\leqq80\)を推奨） |
uint8 | チェックサム | LRC8 | |
char | フッタ | CR (0x0D/'\r') | |
char | フッタ | LF (0x0A/'\n') |
オプション列の詳細
拡張形式では、オプション列を指定することで細かな設定を行うことができます。
オプション列は、オプションのIDと引数の繰り返しで表現します。終端は 0xFF とします。
オプションを指定しない場合は
0xFFの1バイトだけを指定します。| ID | 引数 | 初期値 | 内容 |
|---|---|---|---|
0x01 | なし | 無効 | MAC ACKの有効化 |
0x02 | uint8 | 0x00 | アプリケーション再送の有効化 |
0x03 | uint16 | 0x0000 | 初回送信の遅延の最小値 |
0x04 | uint16 | 0x0000 | 初回送信の遅延の最大値 |
0x05 | uint16 | 10 | アプリケーション再送の間隔 |
0x06 | なし | 無効 | 平行要求の許可 |
0x07 | なし | 無効 | 応答メッセージの無効化 |
0x08 | なし | 無効 | 送信後スリープ |
入力後1秒が経過すると、送信処理はタイムアウトします。また、内部のバッファが処理待ちで埋まってしまい、新しい要求を受け付けることができない場合があります。アプリケーション再送や遅延を設定する場合は、極端な値に設定しないように注意してください。
0x01：MAC ACKの有効化
MAC層のACK（確認応答）を有効化します。
頻繁にデータを送信する場合には適しませんが、信頼性を向上できる場合があります。
中継機は利用できません。また、送信先を全子機（
0x78）とするときは利用できません。0x02：アプリケーション再送の有効化
MAC ACK を使用するときは、0x00-0x0Fを指定します。送信に成功するまで、それぞれ0-16回の再送を行います。
MAC ACK を使用しないときは、0x81-0x8Fを指定します。必ず1-16回の再送を行います。
応答メッセージは、すべての再送が終了してから出力します。
0x03：初回送信の遅延の最小値
初回送信までの遅延の最小値をミリ秒で指定できます。
0x04：初回送信の遅延の最大値
初回送信までの遅延の最大値をミリ秒で指定できます。
0x05：アプリケーション再送の間隔
アプリケーション再送を有効化した際の再送間隔をミリ秒で指定します。
0x06：平行要求の許可
平行要求を許可します。
平行要求を許可すると、要求を完了するまでブロックせず、次の要求処理を受け付けることができるようになります。
例えば 0.5 秒の遅延を設定した要求を3回連続して入力した場合、初期状態では 0.5 秒後、1.0秒後、1.5秒後と順番に処理します。ところが、平行要求を許可した場合は、0.5秒後に順不同で送信要求を処理します。なおパケット分割を必要とする場合は使用できません。
受信側の端末は、常に新しいデータを採用します。平行要求を許可していると、新しいデータのあとに古いデータが届き、古いデータが無視されてしまうことがあります。
0x07：応答メッセージの無効化
送信側へデータを入力した際に出力される応答メッセージを無効とします。
0x08：送信後スリープ
送信後、速やかに本体をスリープさせます。
RXが立ち上がりエッジを検知すると、スリープから復帰します。何か1バイトのデータを入力してください。
スリープ復帰後、UART の初期化が終わると入力を受け付けます。
受信側の出力
| # | データ | 内容 | 備考 |
|---|---|---|---|
char | ヘッダ | :のみ | |
| 0 | uint8 | 送信元の論理デバイスID | 親機0x00,子機0x01-0x64,未設定子機0x78 |
| 1 | uint8 | コマンド番号 | 0xA0のみ |
| 2 | uint8 | 応答ID | 送信側で指定した値 |
| 3 | uint32 | 送信元の拡張アドレス | シリアルIDの先頭へ0x8を加えた値 |
| 7 | uint32 | 送信先の拡張アドレス | 論理デバイスID使用時は0xFFFFFFFF |
| 11 | uint8 | LQI | 受信時の電波通信品質 |
| 12 | uint16 | 続くバイト列の長さ | バイト数\(M\)を表す |
| 14 | [uint8] | 任意のデータ | 長さ\(M\)のバイト列 |
uint8 | チェックサム | LRC8 | |
char | フッタ | CR (0x0D/'\r') | |
char | フッタ | LF (0x0A/'\n') |
送信側の出力（応答メッセージ）
| # | データ | 内容 | 備考 |
|---|---|---|---|
char | ヘッダ | :のみ | |
| 0 | uint8 | 送信元の論理デバイスID | 0xDBのみ：自身を示す |
| 1 | uint8 | コマンド番号 | 0xA1のみ |
| 2 | uint8 | 応答ID | 入力時に指定した値 |
| 3 | uint8 | 処理結果 | 成功1,失敗0 |
uint8 | チェックサム | LRC8 | |
char | フッタ | CR (0x0D/'\r') | |
char | フッタ | LF (0x0A/'\n') |
使用例
親機から子機に対してバイト列 0x11 0x22 0x33 0xAA 0xBB 0xCC を送信する例を示します。
論理デバイスIDを指定する例
親機から論理デバイスID0x42の子機へ送信する例を示します。
- 応答IDは
0x01 - オプションなし
- 親機の拡張アドレスは
0x81000000（シリアルID0x1000000）
【送信側：親機】
:42A001FF112233AABBCC87<CR><LF> <- 入力
:DBA1010182<CR><LF> <- 出力
末尾の
0x87はチェックサム：0x42から0xCCまでの合計の2の補数のLSBから8ビット。
【受信側：子機】
:00A00181000000FFFFFFFFC80006112233AABBCC7D<CR><LF> <- 出力
末尾の
0x7Dはチェックサム：最初の0x00から0xCCまでの合計の2の補数のLSBから8ビット。
拡張アドレスを指定する例
親機から拡張アドレス0x81000001（シリアルID0x1000001）の子機へ送信する例を示します。
- 応答IDは
0x01 - オプションなし
- 親機の拡張アドレスは
0x81000000（シリアルID0x1000000）
【送信側：親機】
:80A00181000001FF112233AABBCCC7<CR><LF> <- 入力
:DBA1010182<CR><LF> <- 出力
末尾の
0xC7はチェックサム：0x80から0xCCまでの合計の2の補数のLSBから8ビット。
【受信側：子機】
:00A0018100000081000001C80006112233AABBCCF7<CR><LF> <- 出力
末尾の
0xF7はチェックサム：最初の0x00から0xCCまでの合計の2の補数のLSBから8ビット。
MAC ACKを使用する例
親機から論理デバイスID0x42の子機へ MAC ACK を使用して送信する例を示します。
- 応答IDは
0x01 - オプションは
0x01：MAC ACKの有効化を指定 - 親機の拡張アドレスは
0x81000000（シリアルID0x1000000）
【送信側：親機】
:42A00101FF112233AABBCC86<CR><LF> <- 入力
:DBA1010182<CR><LF> <- 出力
末尾の
0x86はチェックサム：0x42から0xCCまでの合計の2の補数のLSBから8ビット。
【受信側：子機】
:00A00181000000FFFFFFFFC80006112233AABBCC7D<CR><LF> <- 出力
末尾の
0x7Dはチェックサム：0x00から0xCCまでの合計の2の補数のLSBから8ビット。
遅延を設ける例
親機から論理デバイスID0x42の子機へ 768ms の遅延を設けて送信する例を示します。
- 応答IDは
0x01 - オプションは
0x03：初回送信の遅延の最小値を指定 - 親機の拡張アドレスは
0x81000000（シリアルID0x1000000）
【送信側：親機】
:42A001030300FF112233AABBCC81<CR><LF> <- 入力
:DBA1010182<CR><LF> <- 出力
末尾の
0x81はチェックサム：0x42から0xCCまでの合計の2の補数のLSBから8ビット。
【受信側：子機】
:00A00181000000FFFFFFFFC80006112233AABBCC7D<CR><LF> <- 出力
末尾の
0x7Dはチェックサム：0x00から0xCCまでの合計の2の補数のLSBから8ビット。
0xDB コマンド
インタラクティブモードの設定を行う代わりに、UART から 0xDB コマンドを入力することでモジュールの操作や設定を行うことができます。