taiyo yuden subghz module standard application ......taiyo yuden standard application specification...
TRANSCRIPT
TAIYO YUDEN Standard Application Specification
1 / 47
TAIYO YUDEN CO., LTD.
TAIYO YUDEN SubGHz Module
Standard Application Specification
For SYSFCSAXX Module
July-2018
In case you adopt this module and design some appliance, please ask for the
latest specifications from the local sales office.
We wish the customer to request the Specification Report when the design
for the mass production begins because the content of this Data Report might
change without a previous notice to the customer.
TAIYO YUDEN Standard Application Specification
2 / 47
TAIYO YUDEN CO., LTD.
改版履歴
バージョン 日付 内容
Ver.1.0 2017.10.25 製品版
Ver.1.1 2018.04.10 ZSEND データ受信監視タイマの記述変更
ページ構成の一部変更(記述内容に変更なし)
動作モード、PAN-ID、チャンネル番号、データレート、送信パワー、
UART 設定についての初期値一覧を追加
Ver.1.2 2018.07.23 ZSAVE コマンドの注意点記述追加
TAIYO YUDEN Standard Application Specification
3 / 47
TAIYO YUDEN CO., LTD.
Copyright Information:
-TAIYO YUDEN CO., LTD. Command Interface Specification Documentation-
This software is owned by TAIYO YUDEN CO., LTD.
You and your company shall conform following:
(1) The software image may not be made a copy from TAIYO YUDEN CO., LTD.’s module.
(2) The software image provided by TAIYO YUDEN CO., LTD. Must not be loaded to
another vendor’s module or chipset, and can be copied only for backup.
(3) The software image may not be provided to anyone.
(4) The software image may not be analyzed by reverse engineering, decompile, and
disassemble.
(5) This document may not be provided to anyone without the prior written agreement
with TAIYO YUDEN CO., LTD.
TAIYO YUDEN CO., LTD. Is not responsible for any damage caused by this software.
Copyright Year 2017-
TAIYO YUDEN Standard Application Specification
4 / 47
TAIYO YUDEN CO., LTD.
<Contens>
1. 概要 ··········································································································· 6
2. IEEE802.15.4 g/e MAC & PHY 仕様 ·························································· 9
3. ホストインターフェイス・UART 仕様 ···································································· 11
3.1 シリアルインターフェイス(UART)設定 ································································· 11
3.2 コマンド入力について ······················································································· 12
3.3 IO インターフェイス仕様 ·················································································· 13
4. 初期値 ······································································································· 14
5. コマンド/レスポンス ························································································· 15
5.1 基本フォーマット ···························································································· 15
5.2 コマンド/レスポンス一覧 ··················································································· 16
5.3 データ通信モード コマンド/レスポンス詳細 ···························································· 17
5.3.1 VERS ······································································································· 17
5.3.2 INFO ········································································································ 18
5.3.3 OPMD ······································································································ 19
5.3.4 PNID ······································································································· 21
5.3.5 CHAN ······································································································· 22
5.3.6 RATE ········································································································ 23
5.3.7 TXPW ······································································································ 24
5.3.8 SPCF ········································································································ 25
5.3.9 SAVE ········································································································ 27
5.3.10 SEND ······································································································· 29
5.3.11 RECV ······································································································· 33
5.3.12 SRST ········································································································ 34
5.3.13 SLEP ········································································································ 35
5.3.14 RMAC ······································································································· 36
5.3.15 TIME ········································································································ 37
5.3.16 NRST ······································································································· 38
5.3.17 NPAR ······································································································· 39
5.3.18 RSSI ········································································································ 40
6. 通知 ·········································································································· 41
6.1 起動時の通知 ······························································································ 41
6.2 データの受信通知(RECV) ·············································································· 41
6.3 モジュール間の接続通知(NCON) ····································································· 41
6.4 モジュール間の切断通知(NDCO) ····································································· 42
7. 動作シーケンス ····························································································· 43
7.1 起動時 ······································································································· 43
7.2 コマンドのやりとり ··························································································· 44
TAIYO YUDEN Standard Application Specification
5 / 47
TAIYO YUDEN CO., LTD.
7.3 接続(マルチホップモードのみ) ············································································ 45
7.4 切断(マルチホップモードのみ) ············································································ 46
7.5 送信/受信 ·································································································· 47
TAIYO YUDEN Standard Application Specification
6 / 47
TAIYO YUDEN CO., LTD.
1. 概要
本ファームウェアは弊社 SubGHz モジュール(SYSF**)に搭載される標準ソフトウェアです。
Figure1 にその構成図を示します。
ユーザインターフェイスとして太陽誘電(株)独自の UART シリアルインターフェイスを用いたコマンド群が用意されてい
ます。
このインターフェイスを介して、シングルホップモード、マルチホップモードのデータ送受信を行うことが可能です。
シングルホップネットワーク マルチホッフネットワーク
Commmand Interface (UART)
Simple Network UDP
6LoWPAN RPL
IEEE802.15.4 g/e MAC
IEEE802.15.4 g PHY
Figure 1 ファームウェア構成図
なお、本書ではそれぞれのモジュールを下記の様に表現しています。
■シングルホップモード時
全てのモジュールをエンドデバイスと表現しています。
■マルチホップモード時
親機モジュールをコーディネーターと表現しています。
子機モジュール(中継機含む)をエンドデバイスと表現しています。
TAIYO YUDEN Standard Application Specification
7 / 47
TAIYO YUDEN CO., LTD.
1.1 シングルホップモード
シングルホップモードは、Simple Network プロトコルスタックを利用して 1 対 1、もしくは 1 対多(最大 31 台)のエ
ンドデバイス同士の通信が可能です。
送信先を指定するユニキャスト通信と、送信先を指定せず全てのモジュールに送信するブロードキャスト通信をサ
ポートしています。
Figure 2 シングルホップモード通信
1.2 マルチホップモード
マルチホップモードは、最大 32 台のツリー構造で、1 台のコーディネーターと最大 31 台のエンドデバイスとの通信が
可能です。
プロトコルスタックは 6LoWPAN、RPL、UDP を利用しています。
エンドデバイスの送信先はコーディネーターのみであり、コーディネーターは送信先エンドデバイスを指定するユニキャス
ト通信と、送信先を指定せずすべてのエンドデバイスに送信するマルチキャスト通信をサポートしています。
Figure 3 マルチホップモード通信
また、電源を入れると自動的にツリー構造ネットワークを構築し、通信品質が悪化した場合には、動的に経路変更
を行います。
周りの全てのモジュールとの通信品質が悪化している場合は、接続/切断を繰り返し、頻繁に接続先が変わる場合
もあります。
エンドデバイス A エンドデバイス B
コーディネーター エンドデバイス A エンドデバイス C
エンドデバイス B エンドデバイス D
TAIYO YUDEN Standard Application Specification
8 / 47
TAIYO YUDEN CO., LTD.
■マルチホップルーティングについて
RPL(Routing Protocol for Low power and Lossy Networks)はマルチホップルーティングを実現する仕
組みになります。
RPL の概要は以下の通りです。
(1) ネットワークに参加したいエンドデバイスは近隣モジュールに対して存在確認要求を送信します。(DIS)
(2) この要求を受信したモジュールは応答を送信します。(DIO)
この応答には、コーディネーターのアドレス、rank 情報等を含んでいます。
(3) 応答を受信したエンドデバイスは、rank 情報から優先親、親候補情報を作成し、より良い接続先選択の判
断に用います。
この後、エンドデバイスは自身の親情報をコーディネーターに送信します。(DAO)
(4) 親情報には優先親や親候補情報が記載されており、コーディネーターは各々のエンドデバイスの優先親を辿る
ことで下り経路を確立します。
* 外略図を以下に記します。
● ルーティング外略図
コーディネーター エンドデバイス
DIS
DIO
DAO
TAIYO YUDEN Standard Application Specification
9 / 47
TAIYO YUDEN CO., LTD.
2. IEEE802.15.4 g/e MAC & PHY 仕様
IEEE802.15.4 g/e MAC & PHY 仕様を Table1 に示します。
Table 1 IEEE802.15.4g/e MAC & PHY 仕様
仕様
周波数帯域 920MHz (ARIB T-108)
データレート 100k bps
ロジカル
チャンネル数 100k bps:27 チャンネル(922.7MHz~927.9MHz)
チャンネルスペース 400kHz(100kbps)
送信出力 20mW(13dBm)
変調方式 GFSK(Operating Mode#1、#2 に相当)
最大送信
データサイズ 255 バイト
また、ロジカルチャンネル番号に対応する中心周波数の表を Table2 に示します。
TAIYO YUDEN Standard Application Specification
10 / 47
TAIYO YUDEN CO., LTD.
Table 2 ロジカルチャンネル番号に対応する中心周波数
データレート 100kbps
帯域幅 400kHz
ロジカル CH 番号 単位CH番号 中心周波数(MHz)
11 34,35 922.7
12 35,36 922.9
13 36,37 923.1
14 37,38 923.3
15 38,39 923.5
16 39,40 923.7
17 40,41 923.9
18 41,42 924.1
19 42,43 924.3
20 43,44 924.5
21 44,45 924.7
22 45,46 924.9
23 46,47 925.1
24 47,48 925.3
25 48,49 925.5
26 49,50 925.7
27 50,51 925.9
28 51,52 926.1
29 52,53 926.3
30 53,54 926.5
31 54,55 926.7
32 55,56 926.9
33 56,57 927.1
34 57,58 927.3
35 58,59 927.5
36 59,60 927.7
37 60,61 927.9
*単位 CH(単位チャンネル)は、ARIB T-108 で規定されているものです。
TAIYO YUDEN Standard Application Specification
11 / 47
TAIYO YUDEN CO., LTD.
3. ホストインターフェイス・UART 仕様
3.1 シリアルインターフェイス(UART)設定
シリアルインターフェイス仕様は以下の通りです。
Table 3 シリアルパラメータ設定値
パラメータ 設定値
ボーレート 115.2kbps / 38.4kbps / 19.2kbps / 9600bps
データビット 8 ビット
ストップビット 1 ビット
パリティ odd / even / パリティなし
フロー制御 なし
TAIYO YUDEN Standard Application Specification
12 / 47
TAIYO YUDEN CO., LTD.
3.2 コマンド入力について
コマンド入力動作について以下に記します。
(1) 0x0D(CR)、0x0A(LF)が入力された時点でコマンド入力完了と認識します。
(2) 入力されるコマンドは完全一致で目的のコマンドとして認識します。
例えば「ZINFO」コマンドの場合、「abcZINFO」「ZINFOabc」の入力は「NAK」が返ります。
さらに完全一致するコマンドでも「ZINFOZVERS」の様に有効なコマンドを連続入力した場合も「NAK」が
返ります。
(3) 存在しないコマンドを入力した場合は「NAK」が返ります。
(4) 必要とするパラメータが少ない場合は「NAK」が返ります。
(5) 必要以上にパラメータが付加された場合は「NAK」が返ります。
例えば「ZINFO」コマンドの場合、このコマンド自体にパラメータはありませんが、「ZINFO,1」と入力すると
「NAK」が返ります。
(6) 「ZSEND」コマンド時、ZSEND コマンドを認識してデータ長が取得できた時点で入力間隔時間の監視を行
います。データ受信間隔タイムアウトが発生した場合は「NAK6」が返ります。
TAIYO YUDEN Standard Application Specification
13 / 47
TAIYO YUDEN CO., LTD.
3.3 IO インターフェイス仕様
スリープ状態からの復帰は、モジュール(SYSF***)の外部端子 PAD21 の信号レベルによって制御されます。
(1) スリープモード状態からの復帰
信号レベルが HIGH から LOW への遷移で復帰します。
コマンド入力でSleepモードに入り、21ピンに入力される信号がHigh_Lowの遷移後、モジュールはSleep
モードから復帰します。
TAIYO YUDEN Standard Application Specification
14 / 47
TAIYO YUDEN CO., LTD.
4. 初期値
以下に設定値の初期値を記します。
コマンド コマンドの意味 値 値の意味
OPMD 動作モード 1 シングルホップ
PNID PAN ID 0000 -
CHAN チャンネル番号 11 -
RATE データレート 1 100Kbps
TXPW 送信パワー 36 -
SPCF UART 設定
115200 115200bps
N パリティ無し
TAIYO YUDEN Standard Application Specification
15 / 47
TAIYO YUDEN CO., LTD.
5. コマンド/レスポンス
5.1 基本フォーマット
無線モジュールへ発行するコマンド及び、無線モジュールから返されるレスポンスの基本フォーマットは以下となります。
(1) コマンドフォーマット:
“Z”
コマンドコード
(4byte) “,”
コマンド
パラメータ 1 “,”
コマンド
パラメータ 2 “,”
コマンド
パラメータ N “\r” “\n”
先頭 1 バイトは”Z”(0x5A) ・パラメータ間はカンマ文字“,”(0x2C)で区切る。 (0x0D) (0x0A)
Figure 4 基本コマンドフォーマット
(2) レスポンスフォーマット:
“Z”
レスポンスコード
(4byte) “,”
レスポンス
パラメータ 1 “,”
レスポンス
パラメータ 2 “,”
レスポンス
パラメータ N “\r” “\n”
先頭 1 バイトは”Z”(0x5A) ・パラメータ間はカンマ文字“,”(0x2C)で区切る。 (0x0D) (0x0A)
Figure 5 基本レスポンスフォーマット
レスポンスパラメータ 1 が、コマンド入力の成功/失敗のみを表す場合、レスポンスコードとし、種別として次の
コードを返します。
“ACK”(ASCII) … 成功
“NAK”(ASCII) … 失敗
TAIYO YUDEN Standard Application Specification
16 / 47
TAIYO YUDEN CO., LTD.
5.2 コマンド/レスポンス一覧
Table 4 使用できるコマンド/レスポンス
No コマンド/
レスポンスコード 機能
1 VERS ソフトウェアのバージョン情報取得
2 INFO 各パラメータ情報の一括取得
3 OPMD 動作モード設定/取得
4 PNID PAN-ID 設定/取得
5 CHAN チャンネル設定/取得
6 RATE 無線通信データレート設定/取得
7 TXPW 送信パワー設定/取得
8 SPCF シリアルポートパラメータ設定/取得
9 SAVE 本コマンド発行まで設定したパラメータ全てを不揮発メモリへ保存
10 SEND データ送信
11 RECV データ受信
12 SRST ソフトウェアリセット
13 SLEP スリープモードへの移行
14 RMAC MAC アドレス取得
15 TIME 時刻設定/取得
16 NRST マルチホップモード時のネットワーク接続再構築
17 NCON マルチホップネットワーク時の接続応答
18 NDCO マルチホップネットワーク時の切断応答
19 NPAR マルチホップモード時の接続先コーディネーター、又はエンドデバイスの表示
20 RSSI RSSI 値の取得
TAIYO YUDEN Standard Application Specification
17 / 47
TAIYO YUDEN CO., LTD.
5.3 データ通信モード コマンド/レスポンス詳細
5.3.1 VERS
ファームウェアのバージョン情報の取得を行います。
コマンド :
Z VERS \r \n
レスポンス (成功):
Z VERS , バージョン \r \n
バージョン(ASCII): XX.YY.ZZ (Ver.XX.YY.ZZ)
レスポンス (失敗) :
Z VERS , NAK \r \n
* NAK の要因として、コマンドのフォーマット誤り等が考えられます。
<Example>
> ZVERS<CR><LF>
< ZVERS,00.04.00<CR><LF>
TAIYO YUDEN Standard Application Specification
18 / 47
TAIYO YUDEN CO., LTD.
5.3.2 INFO
各パラメータ情報の一括取得を行います。
コマンド :
Z INFO \r \n
レスポンス (成功):
Z INFO , PID , MAC , CH , DR , PWR \r \n
次のパラメータ値を一括でリストアップされます。
・PID(ASCII) : PAN-ID
・MAC(ASCII) : MAC アドレス
・CH(ASCII) : ロジカルチャンネル番号
・DR(ASCII) : データレート
・PWR(ASCII) : 送信パワー値
レスポンス (失敗) :
Z INFO , NAK \r \n
* NAK の要因として、コマンドのフォーマット誤り等が考えられます。
<Example>
> ZINFO<CR><LF>
< ZINFO,0001,AFFFFFFF00000001.11,1,36<CR><LF>
TAIYO YUDEN Standard Application Specification
19 / 47
TAIYO YUDEN CO., LTD.
5.3.3 OPMD
動作モードの設定/取得を行います。
設定コマンド実行後、設定値は RAM 上に保持されるだけで不揮発メモリには保存されません。
不揮発メモリに保存するには SAVE コマンドを実行して下さい。(保存せずに電源を OFF すると設定値は失われ
ます)
また、設定コマンド実行後は再起動を行って下さい。(再起動を行わない場合、その後の動作は保証できません)
(1) 設定
コマンド :
Z OPMD , モード \r \n
モード(ASCII) :
“1” : シングルホップモード
“2” : マルチホップモード(コーディネーター)
“3” : マルチホップモード(エンドデバイス)
レスポンス :
Z OPMD , レスポンスコード \r \n
レスポンスコード(ASCII) :
“ACK” : 成功
“NAK” : 失敗
* NAK の要因として、コマンドのフォーマット誤りや設定範囲外等が考えられます。
<Example>
> ZOPMD,1<CR><LF>
< ZOPMD,ACK<CR><LF>
TAIYO YUDEN Standard Application Specification
20 / 47
TAIYO YUDEN CO., LTD.
(2) 取得
コマンド :
Z OPMD \r \n
レスポンス (成功) :
Z OPMD , モード \r \n
モード(ASCII) :
“1” : シングルホップモード
“2” : マルチホップモード(コーディネーター)
“3” : マルチホップモード(エンドデバイス)
“0”,”4”~”255” : Reserved
レスポンス (失敗) :
Z OPMD , NAK \r \n
* NAK の要因として、コマンドのフォーマット誤り等が考えられます。
<Example>
> ZOPMD<CR><LF>
< ZOPMD,1<CR><LF>
TAIYO YUDEN Standard Application Specification
21 / 47
TAIYO YUDEN CO., LTD.
5.3.4 PNID
PAN-ID の設定/取得を行います。
設定コマンド実行後、設定値は RAM 上に保持されるだけで不揮発メモリには保存されません。
不揮発メモリに保存するには SAVE コマンドを実行して下さい。(保存せずに電源を OFF すると設定値は失われ
ます)
また、設定コマンド実行後は再起動を行って下さい。(再起動を行わない場合、その後の動作は保証できません)
(1) 設定
コマンド :
Z PNID , PAN-ID \r \n
PAN-ID(ASCII) : PAN-ID “0000”~”FFFD”
レスポンス :
Z PNID , レスポンスコード \r \n
レスポンスコード(ASCII) :
“ACK” : 成功
“NAK” : 失敗
* NAK の要因として、コマンドのフォーマット誤りや設定範囲外等が考えられます。
(2) 取得
コマンド :
Z PNID \r \n
レスポンス (成功):
Z PNID , PAN-ID \r \n
PAN-ID(ASCII) : PAN-ID “0000”~”FFFD”
レスポンス (失敗) :
Z PNID , NAK \r \n
* NAK の要因として、コマンドのフォーマット誤り等が考えられます。
<Example>
> ZPNID,CAFE<CR><LF>
< ZPNID,ACK<CR><LF>
<Example>
> ZPNID<CR><LF>
< ZPNID,CAFE<CR><LF>
TAIYO YUDEN Standard Application Specification
22 / 47
TAIYO YUDEN CO., LTD.
5.3.5 CHAN
ロジカルチャンネル番号の設定/取得を行います。
設定コマンド実行後、設定値は RAM 上に保持されるだけで不揮発メモリには保存されません。
不揮発メモリに保存するには SAVE コマンドを実行して下さい。(保存せずに電源を OFF すると設定値は失われ
ます)
また、設定コマンド実行後は再起動を行って下さい。(再起動を行わない場合、その後の動作は保証できません)
(1) 設定
コマンド :
Z CHAN , ロジカルチャンネル番号 \r \n
ロジカルチャンネル番号(ASCII) : “11”~”37”
レスポンス :
Z CHAN , レスポンスコード \r \n
レスポンスコード(ASCII) :
“ACK” : 成功
“NAK” : 失敗
* NAK の要因として、コマンドのフォーマット誤りや設定範囲外等が考えられます。
(2) 取得
コマンド :
Z CHAN \r \n
レスポンス (成功):
Z CHAN , ロジカルチャンネル番号 \r \n
ロジカルチャンネル番号(ASCII) : “11”~”37”
レスポンス (失敗) :
Z CHAN , NAK \r \n
* NAK の要因として、コマンドのフォーマット誤り等が考えられます。
<Example>
> ZCHAN,15<CR><LF>
< ZCHAN,ACK<CR><LF>
<Example>
> ZCHAN<CR><LF>
< ZCHAN,15<CR><LF>
TAIYO YUDEN Standard Application Specification
23 / 47
TAIYO YUDEN CO., LTD.
5.3.6 RATE
データレートの取得を行います。
(1) 取得
コマンド :
Z RATE \r \n
レスポンス (成功):
Z RATE , データレート \r \n
データレート(ASCII) :
“1” : 100kbps
レスポンス (失敗) :
Z RATE , NAK \r \n
* NAK の要因として、コマンドのフォーマット誤り等が考えられます。
<Example>
> ZRATE<CR><LF>
< ZRATE,1<CR><LF>
TAIYO YUDEN Standard Application Specification
24 / 47
TAIYO YUDEN CO., LTD.
5.3.7 TXPW
送信パワーの設定/取得を行います。
初期設定値は 36 になります。
設定の変更は、設定変更者の責任でお願いいたします。
設定コマンド実行後、設定値は RAM 上に保持されるだけで不揮発メモリには保存されません。
不揮発メモリに保存するには SAVE コマンドを実行して下さい。(保存せずに電源を OFF すると設定値は失われ
ます)
また、設定コマンド実行後は再起動を行って下さい。(再起動を行わない場合、その後の動作は保証できません)
(1) 設定
コマンド :
Z TXPW , 送信パワー \r \n
送信パワー(ASCII) : “0”~”42”
レスポンス :
Z TXPW , レスポンスコード \r \n
レスポンスコード(ASCII):
“ACK” : 成功
“NAK” : 失敗
* NAK の要因として、コマンドのフォーマット誤りや設定範囲外等が考えられます。
(2) 取得
コマンド :
Z TXPW \r \n
レスポンス (成功):
Z TXPW , 送信パワー \r \n
送信パワー(ASCII) : “0”~”42”
レスポンス (失敗) :
Z TXPW , NAK \r \n
* NAK の要因として、コマンドのフォーマット誤り等が考えられます。
<Example>
> ZTXPW,42<CR><LF>
< ZTXPW,ACK<CR><LF>
<Example>
> ZTXPW<CR><LF>
< ZTXPW,42<CR><LF>
TAIYO YUDEN Standard Application Specification
25 / 47
TAIYO YUDEN CO., LTD.
5.3.8 SPCF
UART シリアルインターフェースのボーレート、及びパリティの設定/取得を行うことができます。
設定コマンド実行後、設定値は RAM 上に保持されるだけで不揮発メモリには保存されません。
不揮発メモリに保存するには SAVE コマンドを実行して下さい。(保存せずに電源を OFF すると設定値は失われ
ます)
また、設定コマンド実行後は再起動を行って下さい。(再起動を行わない場合、その後の動作は保証できません)
(1) 設定
コマンド :
Z SPCF , ボーレート , パリティ \r \n
ボーレート(ASCII) :
115200 / 38400 / 19200 / 9600
パリティ(ASCII) :
O : odd / E : Even / N : 設定なし
レスポンス:
Z SPCF , レスポンスコード \r \n
レスポンスコード(ASCII) :
“ACK” : 成功
“NAK” : 失敗
* NAK の要因として、コマンドのフォーマット誤りや設定範囲外等が考えられます。
<Example>
> ZSPCF,38400,O<CR><LF>
< ZSPCF,ACK<CR><LF>
TAIYO YUDEN Standard Application Specification
26 / 47
TAIYO YUDEN CO., LTD.
(2) 取得
コマンド :
Z SPCF \r \n
レスポンス (成功):
Z SPCF , ボーレート , パリティ \r \n
ボーレート(ASCII) :
115200 / 38400 / 19200 / 9600
パリティ(ASCII):
O : odd / E : Even / N : 設定なし
レスポンス (失敗) :
Z SPCF , NAK \r \n
* NAK の要因として、コマンドのフォーマット誤り等が考えられます。
<Example>
> ZSPCF<CR><LF>
< ZSPCF,115200,N<CR><LF>
TAIYO YUDEN Standard Application Specification
27 / 47
TAIYO YUDEN CO., LTD.
5.3.9 SAVE
不揮発メモリへの各パラメータ情報書き込みを行います。
コマンド:
Z SAVE \r \n
レスポンス :
Z SAVE , レスポンスコード \r \n
レスポンスコード(ASCII) :
“ACK” : 成功
“NAK” : 失敗
* NAK の要因として、コマンドのフォーマット誤り等が考えられます。
本コマンド発行までに設定した各パラメータ値を不揮発メモリへ書き込みます。
本コマンド発行後、次回からのパワーオン・リセットにてデフォルト値として反映されます。
書き込まれるパラメータ :
ロジカルチャンネル番号、PAN-ID、送信パワー、データレート、シリアル設定
<Example>
> ZSAVE<CR><LF>
< ZSAVE,ACK<CR><LF>
TAIYO YUDEN Standard Application Specification
28 / 47
TAIYO YUDEN CO., LTD.
■ 注意点
ここでの不揮発メモリとは、フラッシュメモリを指します。
フラッシュメモリのデータ書き込みは、書き込みたいブロックを一旦消去した後に書き込みを行う動作になります。
この一連の動作を本コマンド内で行っています。
本コマンド実行中に電源断が発生すると、フラッシュメモリに対して正しくアクセスできない場合があり、
結果的にデータや、ファームウェア、無線の諸設定値が消える可能性があります。(下図参照)
本コマンドは、安定した電源供給時に、使用するようにしてください。
本製品を使用しての設計においては、上記状況を回避できるように注意をお願いします。
ZSAVEコマンド フラッシュメモリ
ブロック消去
消去完了
データ書き込み
書き込み完了
この間に電源断が発生すると、
ブロックは消去されたままの
状態になる。
TAIYO YUDEN Standard Application Specification
29 / 47
TAIYO YUDEN CO., LTD.
5.3.10 SEND
データ送信を行います。
コマンド :
Z SEND , 送信先
アドレス オプション データ長 送信データ
送信先アドレス(バイナリ 8 バイト) : 64 ビット MAC アドレス (ロングアドレス)
0xFFFFFFFFFFFFFFFF : ブロードキャスト用/ マルチキャスト用
その他 : ユニキャスト用
オプション(バイナリ 1 バイト) : 1 … ACK あり、0 … ACK なし
* シングルホッフモードのユニキャスト時のみ設定有効
データ長(バイナリ 2 バイト) : 1-255
* 上記データ長以外を指定した場合は NAK が返ります
* 指定データ長以上に送信データが存在する場合は、指定データ長分が
送信され、それ以上のデータは無視されます。
送信データ(バイナリ 1-255 バイト): 送信するデータ
レスポンス :
Z SEND , レスポンスコード \r \n
レスポンスコード(ASCII) :
“ACK” : 成功
* 本コマンドは他コマンドと違い、ACK の意味に種類があります。
( ACK の意味については次ページ以降に記します)
“NAKx” : 失敗
* 本コマンドは他コマンドと違い、NAK に種別があります。
(NAK の種別については次ページ以降に記します)
TAIYO YUDEN Standard Application Specification
30 / 47
TAIYO YUDEN CO., LTD.
■ACK の意味
(1) シングルホップモード ブロードキャスト通信の場合は、送信成功を意味します。
(2) シングルホップモード ACK なしユニキャスト通信の場合は、送信成功を意味します。
(3) シングルホップモード ACK ありユニキャスト通信の場合は、送信先モジュールからの ACK パケット受信を意味し
ます。
(4) マルチホップモード マルチキャスト通信の場合は、送信成功を意味します。
(5) マルチホップモード ユニキャスト通信の場合は、送信先モジュールからの ACK パケット受信を意味します。
ただし、この場合の ACK は、送信先として指定した MAC アドレスのモジュールからの ACK ではなく、実際の送
信先となったモジュールからの ACK になります。
以下に、図を用いた概略説明を記します。
① コーディネーターからエンドデバイス B にユニキャスト送信を実行します。
② コーディネーターは、エンドデバイス A からの ACK バケットを受信します。
③ コーディネーターから送信したデータはエンドデバイス B で受信します。
しかし、ACK パケットを受信しても、指定送信先のエンドデバイス B から ACK では無いので、エンド
デバイス B に送信したデータが届いているかどうかは判りません。
コーディネーター エンドデバイス A エンドデバイス B
TAIYO YUDEN Standard Application Specification
31 / 47
TAIYO YUDEN CO., LTD.
■NAK の種別
(1) NAK1 : CCA によるキャリア検出
(2) NAK2 : ACK 応答なし
(3) NAK4 : その他のエラー
(4) NAK5 : 累積送信時間オーバーエラー
(5) NAK6 : シリアルインターフェースエラー
(6) NAK7 : コマンドパラメータエラー
(7) NAK9 : 宛先 MAC アドレス指定誤りエラー (マルチホップモード時のみ発生)
■各 NAK が返る要因
(1) NAK1 : 送信時、他に送信中のモジュールが存在した場合に返すエラー
(2) NAK2 : 送信先モジュールからの応答が無い場合に返すエラー
(3) NAK4 : 分類されないその他のエラー
(4) NAK5 : 累積送信時間を超過した場合に返すエラー
(5) NAK6 : UART により送信したコマンドの処理が、何等かの理由(データ抜け等)により完了できなった場合、
一定時間(通信レートとデータサイズに依存)でのタイムアウトが発生した。 (*次ページの図参照)
(6) NAK7 : コマンドのパラメータに誤りがあった場合に返すエラー
(7) NAK9 : 未接続時(ZNCON 通知~ZNDCN 通知間以外)に送信を実行した場合に返すエラー
■累積送信時間について
サブギガの仕様として時間単位の累積送信時間が決められています。
本ファームウェアでは 30 分間で、30 分の 9%である 162 秒を超過すると NAK5 が返ります。
本時間は 30 分毎にリセットされます。
なお、ルーティング動作のデータ送信もこの累積時間に含まれます。
■マルチホップモード時の送信動作と接続/切断の関係について
ZSEND が実行可能なのは宛先モジュールと接続されている時のみです。
具体的には、そのモジュールとの ZNCON~ZNDCO 通知間にのみ ZSEND が可能で、その間以外に ZSEND
を実行した場合は NAK9 が返ります。
ZNCON/ZNDCO 通知については下記を参照して下さい。
・「6.3 モジュール間の接続通知(NCON)」
・「6.4 モジュール間の切断通知(NDCO)」
TAIYO YUDEN Standard Application Specification
32 / 47
TAIYO YUDEN CO., LTD.
■NAK6 について
ホスト モジュール
ZSEND コマンド送
信
NAK6 受信
ZSEND コマンド受
信
NAK6 送信
ZSEND コマンド内のデータ長分のデータを受
信完了するまでをタイマ監視。
タイマ値はボーレート、データ長から算出。
タイムアウトした場合に NAK6 と判断。
UART
UART
TAIYO YUDEN Standard Application Specification
33 / 47
TAIYO YUDEN CO., LTD.
5.3.11 RECV
データ受信を通知します。
レスポンス:
Z RECV , 送信元
アドレス RSSI 値 データ長 受信データ
送信元アドレス(バイナリ 8 バイト) : 64 ビット MAC アドレス (ロングアドレス)
0xFFFFFFFFFFFFFFFF : ブロードキャスト用 / マルチキャスト用
その他 : ユニキャスト用
RSSI 値(バイナリ 符号付き 1 バイト) : シングルホップモード パケット受信時の RSSI 値
* マルチホップモード時は 0 固定
データ長(バイナリ 2 バイト) : 1-255
受信データ(バイナリ 1-255 バイト) : 受信したデータ
TAIYO YUDEN Standard Application Specification
34 / 47
TAIYO YUDEN CO., LTD.
5.3.12 SRST
ソフトウェアリセットを行います。
コマンド:
Z SRST \r \n
レスポンス (成功):
Z SRST , レスポンスコード \r \n
レスポンスコード(ASCII):
“ACK” : 成功
“NAK” : 失敗
* NAK の要因として、コマンドのフォーマット誤り等が考えられます。
<Example>
> ZSRST<CR><LF>
< ZSRST,ACK<CR><LF>
TAIYO YUDEN Standard Application Specification
35 / 47
TAIYO YUDEN CO., LTD.
5.3.13 SLEP
スリープモードへの移行を行います。
外部端子 PAD21 への GPIO 信号入力により復帰します。
コマンド :
Z SLEP \r \n
レスポンス(コマンド入力時) :
Z SLEP , レスポンスコード \r \n
レスポンスコード(ASCII) :
“ACK” : 成功
“NAK” : 失敗
* NAK の要因として、コマンドのフォーマット誤り等が考えられます。
レスポンス(復帰時):
Z SLEP , WAKEUP \r \n
レスポンスコード(ASCII) : ”WAKEUP”
<Example>
> ZSLEP<CR><LF>
< ZSLEP,ACK<CR><LF>
< ZSLEP,WAKEUP<CR><LF>
<<
TAIYO YUDEN Standard Application Specification
36 / 47
TAIYO YUDEN CO., LTD.
5.3.14 RMAC
MAC アドレスの取得を行います。
MAC アドレスは出荷時、個々のモジュールに固有値を書き込み済みです。
コマンド :
Z RMAC \r \n
レスポンス (成功):
Z RMAC , MAC アドレス \r \n
MAC アドレス(ASCII) : MAC アドレス(64 ビットロングアドレス)
レスポンス (失敗) :
Z RMAC , NAK \r \n
* NAK の要因として、コマンドのフォーマット誤り等が考えられます。
<Example>
> ZRMAC<CR><LF>
< ZRMAC,1122334455667788<CR><LF>
TAIYO YUDEN Standard Application Specification
37 / 47
TAIYO YUDEN CO., LTD.
5.3.15 TIME
時刻設定/取得を行います。
(1) 設定
コマンド :
Z TIME , UNIX TIME \r \n
UNIXTIME(ASCII) : UNIXTIME 時刻 (10 進数表現)
0 ~ 4294967294
レスポンス :
Z TIME , レスポンスコード \r \n
レスポンスコード(ASCII):
“ACK” : 成功
“NAK” : 失敗
* NAK の要因として、コマンドのフォーマット誤りや設定範囲外等が考えられます。
(2) 取得
コマンド :
Z TIME \r \n
レスポンス (成功):
Z TIME , UNIX TIME \r \n
UNIXTIME(ASCII) : UNIXTIME 時刻
レスポンス (失敗) :
Z TIME , NAK \r \n
* NAK の要因として、コマンドのフォーマット誤り等が考えられます。
<Example>
> ZTIME,1451574000<CR><LF>
< ZTIME,ACK<CR>LF>
<Example>
> ZTIME<CR><LF>
< ZTIME,1451574000<CR>LF>
TAIYO YUDEN Standard Application Specification
38 / 47
TAIYO YUDEN CO., LTD.
5.3.16 NRST
マルチホップネットワークの構成をリセットします
エンドデバイスでは使用できません、コーディネーターでのみ使用できるコマンドになります。
コマンド :
Z NRST \r \n
レスポンス :
Z NRST , レスポンスコード \r \n
レスポンスコード(ASCII) :
“ACK” : 成功
“NAK” : 失敗
* NAK の要因として、コマンドのフォーマット誤り、エンドデバイスで実行した等が考えられます。
<Example>
> ZNRST<CR><LF>
< ZNRST,ACK<CR><LF>
TAIYO YUDEN Standard Application Specification
39 / 47
TAIYO YUDEN CO., LTD.
5.3.17 NPAR
マルチホップ通信で上位接続先となる接続相手の MAC アドレスを取得します。
エンドデバイスでのみ有効なコマンドになります。(コーディネーターで実行した場合は NAK が返ります)
コマンド :
Z NPAR \r \n
レスポンス (成功) :
Z NPAR , MAC アドレス , 情報 1 , 情報 2 \r \n
MAC アドレス(ASCII) :
上位接続先の MAC アドレス(64 ビットロングアドレス)
情報 1(ASCII) :
上位接続先のランク情報
情報 2(ASCII) :
自身のランク情報
レスポンス (失敗) :
Z NPAR , NAK \r \n
* NAK の要因として、コマンドのフォーマット誤り等が考えられます。
<Example>
> ZNPAR<CR><LF>
< ZNPAR,AFFFFFFF00000001,256,512<CR><LF>
TAIYO YUDEN Standard Application Specification
40 / 47
TAIYO YUDEN CO., LTD.
5.3.18 RSSI
RSSI 値を取得します。
取得できる RSSI 値は、上位接続先との値になります。
値は、上位接続先からのデータ受信を行うたびに更新されます。
値としては、シングルホップモード時の RECV レスポンスで取得できる RSSI 値と同じです。
マルチホップ通信モード時のエンドデバイスでのみ有効なコマンドになります。
シングルホップモードで本コマンドを実行すると NAK が返ります。
コーディネーターで本コマンドを実行すると NAK が返ります。
上位接続先となる接続相手が存在しない場合(未接続状態)に本コマンドを実行すると NAK が返ります。
コマンド :
Z RSSI \r \n
レスポンス (成功) :
Z RSSI , RSSI 値 \r \n
RSSI 値(バイナリ 符号付き 1 バイト) :
レスポンス (失敗) :
Z RSSI , NAK \r \n
<Example>
> ZRSSI<CR><LF>
< ZNRST, <E0><CR><LF>
TAIYO YUDEN Standard Application Specification
41 / 47
TAIYO YUDEN CO., LTD.
6. 通知
非同期に通知される情報について以下に記します。
6.1 起動時の通知
起動時には、次の情報をこの順番に通知します。
(1) 本ファームウェアのバージョン情報(VERS)
(2) 各パラメータ情報の一括取得(INFO)
(3) 動作モード取得(OPMD)
6.2 データの受信通知(RECV)
データ受信時に受信したデータを通知します。
詳細は「5.3.11 RECV」を参照して下さい。
6.3 モジュール間の接続通知(NCON)
マルチホップモード時にのみ通知されます。
コーディネーターではネットワーク内にエンドデバイスが接続された時に接続通知が出力されます。
エンドデバイスでは接続先(コーディネーター/エンドデバイス)に接続した時に接続通知が出力されます。
接続通知(コーディネーター) :
Z NCON , エンドデバイス MAC アドレス \r \n
接続通知(エンドデバイス) :
Z NCON , 接続先 MAC アドレス \r \n
TAIYO YUDEN Standard Application Specification
42 / 47
TAIYO YUDEN CO., LTD.
6.4 モジュール間の切断通知(NDCO)
マルチホップモード時にのみ通知されます。
コーディネーターではネットワーク内からエンドデバイスが切断された時に切断通知が出力されます。
エンドデバイスでは接続先(コーディネーター/エンドデバイス)から切断した時に切断通知が出力されます。
切断通知(コーディネーター) :
Z NDCO , エンドデバイス MAC アドレス \r \n
切断通知(エンドデバイス) :
Z NDCO , 接続先 MAC アドレス \r \n
ファームウェア内のルーティング動作で規定時間の間にデータのやり取りが無かった場合、今まで接続先として存在し
ていた相手は存在しなくなったと判断し切断通知を行います。
内部規定時間の間を監視しているので、実際の切断状況と差異が生じる場合があります。(例えば、接続先モ
ジュールの電源を OFF にしても、瞬時に切断通知はされず、内部規定時間経過後に通知されます)
TAIYO YUDEN Standard Application Specification
43 / 47
TAIYO YUDEN CO., LTD.
7. 動作シーケンス
以下にコマンド/レスポンス、通知動作のシーケンス例を記します。
7.1 起動時
モジュール ホスト
【電源 ON】
ZVERS 通知
ZINFO 通知
ZOPMD 通知
TAIYO YUDEN Standard Application Specification
44 / 47
TAIYO YUDEN CO., LTD.
7.2 コマンドのやりとり
モジュール ホスト
ZCHAN レスポンス
ZCHAN コマンド
ZRATE レスポンス
ZRATE コマンド
ZPNID レスポンス
ZPNID コマンド
ZTXPW レスポンス
ZTXPW コマンド
ZOPMD レスポンス
ZOPMD コマンド
ZSAVE レスポンス
ZSAVE コマンド
TAIYO YUDEN Standard Application Specification
45 / 47
TAIYO YUDEN CO., LTD.
7.3 接続(マルチホップモードのみ)
コーディネーター ホスト ホスト エンドデバイス
ZNCON 通知
ZNCON 通知
ルーティング動作
接続先のコーディネーター検出
接続元のエンドデバイス検出
TAIYO YUDEN Standard Application Specification
46 / 47
TAIYO YUDEN CO., LTD.
7.4 切断(マルチホップモードのみ)
コーディネーター ホスト ホスト エンドデバイス
ZNDCO 通知
ZNDCO 通知
ルーティング動作
接続先コーディネーターからの通信が途絶える
接続元エンドデバイスからの通信が途絶える
TAIYO YUDEN Standard Application Specification
47 / 47
TAIYO YUDEN CO., LTD.
7.5 送信/受信
コーディネーター ホスト ホスト エンドデバイス
ZSEND コマンド データ送信
ZRECV 通知
ACK
ZSEND コマンド データ送信
ZRECV 通知
ACK