rn2903 lora™ モジュールコマンドリファレンス...

2016 Microchip Technology Inc. Advance Information DS40001811A_JP

RN2903 LoRa™ テクノロジ

モジュールコマンド

リファレンスユーザガイド

注意 : この日本語版文書は参考資料としてご利用ください。最新情報は必ずオリジナルの英語版をご参照願います。

Microchip 社製デバイスのコード保護機能に関して以下の点にご注意ください。

• Microchip 社製品は、該当する Microchip 社データシートに記載の仕様を満たしています。

• Microchip 社では、通常の条件ならびに仕様に従って使用した場合、Microchip 社製品のセキュリティレベルは、現在市場に

流通している同種製品の中でも最も高度であると考えています。

• しかし、コード保護機能を解除するための不正かつ違法な方法が存在する事もまた事実です。弊社の理解では、こうした手法

は Microchip 社データシートにある動作仕様書以外の方法で Microchip 社製品を使用する事になります。このような行為は知

的所有権の侵害に該当する可能性が非常に高いと言えます。

• Microchip 社は、コードの保全性に懸念を抱いているお客様と連携し、対応策に取り組んでいきます。

• Microchip 社を含む全ての半導体メーカーで、自社のコードのセキュリティを完全に保証できる企業はありません。コード保

護機能とは、Microchip 社が製品を「解読不能」として保証するものではありません。

コード保護機能は常に進歩しています。Microchip 社では、常に製品のコード保護機能の改善に取り組んでいます。Microchip 社の

コード保護機能の侵害は、デジタルミレニアム著作権法に違反します。そのような行為によってソフトウェアまたはその他の著作

物に不正なアクセスを受けた場合、デジタルミレニアム著作権法の定めるところにより損害賠償訴訟を起こす権利があります。

本書に記載されているデバイスアプリケーション等に関する

情報は、ユーザの便宜のためにのみ提供されているものであ

り、更新によって無効とされる事があります。お客様のアプ

リケーションが仕様を満たす事を保証する責任は、お客様に

あります。Microchip 社は、明示的、暗黙的、書面、口頭、法

定のいずれであるかを問わず、本書に記載されている情報に

関して、状態、品質、性能、商品性、特定目的への適合性を

はじめとする、いかなる類の表明も保証も行いません。

Microchip 社は、本書の情報およびその使用に起因する一切の

責任を否認します。生命維持装置あるいは生命安全用途に

Microchip 社の製品を使用する事は全て購入者のリスクとし、

また購入者はこれによって発生したあらゆる損害、クレーム、

訴訟、費用に関して、Microchip 社は擁護され、免責され、損

害を受けない事に同意するものとします。暗黙的あるいは明

示的を問わず、Microchip 社が知的財産権を保有しているライ

センスは一切譲渡されません。

DS40001811A_JP - p. 2 Advance Info

商標

Microchip 社の名称とロゴ、Microchip ロゴ、dsPIC、FlashFlex、flexPWR、JukeBlox、KEELOQ、KEELOQlogo、Kleer、LANCheck、MediaLB、MOST、MOST logo、MPLAB、OptoLyzer、PIC、PICSTART、PIC32　logo、RightTouch、SpyNIC、SST、SSTLogo、SuperFlash および UNI/O は米国およびその他の国に

おける Microchip Technology Incorporated の登録商標です。

Embedded Control Solutions Company、mTouch は米国に

おける Microchip Technology Incorporated の登録商標です。

Analog-for-the-Digital Age、BodyCom、chipKIT、chipKIT logo、CodeGuard、dsPICDEM、dsPICDEM.net、ECAN、In-Circuit SerialProgramming、ICSP、Inter-Chip Connectivity、KleerNet、KleerNetlogo、MiWi、motorBench、MPASM、MPF、MPLAB Certified logo、MPLIB、MPLINK、MultiTRAK、NetDetach、Omniscient CodeGeneration、PICDEM、PICDEM.net、PICkit、PICtail、RightTouchlogo、REAL ICE、SQI、Serial Quad I/O、Total Endurance、TSHARC、USBCheck、VariSense、ViewSpan、WiperLock、Wireless DNA、および ZENA は米国およびその他の MicrochipTechnology Incorporated の商標です。

SQTP は米国における Microchip Technology Incorporated の

サービスマークです。

Silicon Storage Technology は他の国における MicrochipTechnology Inc. の登録商標です。

GestIC は Microchip Technology Inc. の子会社である MicrochipTechnology Germany II GmbH & Co. & KG 社の他の国における

登録商標です。

その他本書に記載されている商標は各社に帰属します。

© 2016, Microchip Technology Incorporated, All Rights Reserved.

ISBN: 978-1-5224-0260-2

rmation 2016 Microchip Technology Inc.

Microchip 社では、Chandler および Tempe ( アリゾナ州 )、Gresham ( オレゴン州 ) の本部、設計部およびウェハー製造工場そしてカリフォルニア州とインドのデザインセンターが ISO/TS-16949:2009 認証を取得しています。Microchip 社の品質システムプロセスおよび手順は、PIC® MCU および dsPIC® DSC、KEELOQ® コードホッピングデバイス、シリアル EEPROM、マイクロペリフェラル、不揮発性メモリ、アナログ製品に採用されています。さらに、開発システムの設計と製造に関する Microchip 社の品質システムは ISO 9001:2000 認証を取得しています。

RN2903 LoRa™ テクノロジモジュールコマンド


目次

序章 ................................................................................................................................. 6第 1 章はじめに

1.1 概要 .............................................................................................................. 101.2 特長 .............................................................................................................. 111.3 設定 .............................................................................................................. 111.4 UART インターフェイス .............................................................................. 12

第 2 章コマンドリファレンス

2.1 コマンドの構文 ............................................................................................ 132.2 コマンドの構成 ............................................................................................ 132.3 システムコマンド ......................................................................................... 14

2.3.1 sys sleep <length> .................................................................................... 142.3.2 sys reset .................................................................................................... 142.3.3 sys eraseFW ............................................................................................. 142.3.4 sys factoryRESET ..................................................................................... 152.3.5 システム設定コマンド .............................................................................. 15

2.3.5.1 sys set nvm <address> <data> ................................................. 152.3.5.2 sys set pindig <pinName> <pinState> ....................................... 152.3.5.3 sys set pinmode <pinname> <pinmode> ................................... 16

2.3.6 システム取得コマンド .............................................................................. 162.3.6.1 sys get ver ................................................................................. 162.3.6.2 sys get nvm <address> ............................................................. 162.3.6.3 sys get vdd ................................................................................ 172.3.6.4 sys get hweui ............................................................................. 172.3.6.5 sys get pindig <pinname> .......................................................... 172.3.6.6 sys get pinana <pinname> ........................................................ 17

2.4 MAC (Media Access Controller) コマンド .................................................... 182.4.1 mac reset ................................................................................................... 182.4.2 mac tx <type> <portno> <data> ................................................................ 192.4.3 mac join <mode> ....................................................................................... 202.4.4 mac save ................................................................................................... 212.4.5 mac forceENABLE .................................................................................... 212.4.6 mac pause ................................................................................................. 222.4.7 mac resume ............................................................................................... 222.4.8 MAC 設定コマンド ................................................................................... 23

2.4.8.1 mac set devaddr <address> ...................................................... 232.4.8.2 mac set deveui <devEUI> ........................................................ 242.4.8.3 mac set appeui <appEUI> ......................................................... 242.4.8.4 mac set nwkskey <nwkSessKey> ............................................. 242.4.8.5 mac set appskey <appSessKey> .............................................. 252.4.8.6 mac set appkey <appKey> ........................................................ 252.4.8.7 mac set pwridx <pwrIndex> ....................................................... 25

2016 Microchip Technology Inc. Advance Information DS40001811A_JP - p.3

RN2903 LoRa™ テクノロジモジュールコマンドリファレンスユーザガイド

2.4.8.8 mac set dr <dataRate> ..............................................................262.4.8.9 mac set adr <state> ...................................................................262.4.8.10 mac set bat <level> ..................................................................262.4.8.11 mac set retx <reTxNb> ............................................................262.4.8.12 mac set linkchk <linkCheck> ....................................................272.4.8.13 mac set rxdelay1 <rxDelay> ....................................................272.4.8.14 mac set ar <state> ...................................................................272.4.8.15 mac set rx2 <dataRate> <frequency> ......................................282.4.8.16 mac set sync <syncWord> .......................................................282.4.8.17 mac set upctr <uplinkcounter> .................................................282.4.8.18 mac set dnctr <downlinkCounter> ..........................................282.4.8.19 MAC チャンネル設定コマンド ................................................29

2.4.9 MAC 取得コマンド ....................................................................................302.4.9.1 mac get devaddr ........................................................................312.4.9.2 mac get deveui ...........................................................................312.4.9.3 mac get appeui ..........................................................................312.4.9.4 mac get dr ..................................................................................312.4.9.5 mac get pwridx ...........................................................................312.4.9.6 mac get adr ................................................................................312.4.9.7 mac get retx ...............................................................................322.4.9.8 mac get rxdelay1 ........................................................................322.4.9.9 mac get rxdelay2 ........................................................................322.4.9.10 mac get ar ................................................................................322.4.9.11 mac get rx2 ..............................................................................322.4.9.12 mac get dcycleps .....................................................................322.4.9.13 mac get mrgn ...........................................................................332.4.9.14 mac get gwnb ...........................................................................332.4.9.15 mac get status ..........................................................................332.4.9.16 mac get sync ............................................................................332.4.9.17 mac get upctr ...........................................................................342.4.9.18 mac get dnctr ...........................................................................342.4.9.19 MAC チャンネル取得コマンド ................................................35

2.5 無線コマンド ................................................................................................ 362.5.1 radio rx <rxWindowSize> ...........................................................................372.5.2 radio tx <data> ..........................................................................................372.5.3 radio cw <state> .........................................................................................382.5.4 無線設定コマンド .....................................................................................38

2.5.4.1 radio set bt <gfBT> ....................................................................382.5.4.2 radio set mod <mode> ...............................................................392.5.4.3 radio set freq <frequency> .........................................................392.5.4.4 radio set pwr <pwrOut> ..............................................................392.5.4.5 radio set sf <spreadingFactor> ..................................................392.5.4.6 radio set afcbw <autoFreqBand> ...............................................392.5.4.7 radio set rxbw <rxBandwidth> ....................................................402.5.4.8 radio set bitrate <fskBitrate> ......................................................402.5.4.9 radio set fdev <freqDev> ............................................................402.5.4.10 radio set prlen <preamble> .....................................................402.5.4.11 radio set crc < crcHeader > .....................................................402.5.4.12 radio set iqi <iqInvert> .............................................................402.5.4.13 radio set cr <codingRate> ........................................................412.5.4.14 radio set wdt <watchDog> .......................................................41

DS40001811A_JP - p.4 Advance Information 2016 Microchip Technology Inc.

2.5.4.15 radio set sync <syncWord> ..................................................... 412.5.4.16 radio set bw <bandWidth> ...................................................... 41

2.5.5 無線取得コマンド ...................................................................................... 422.5.5.1 radio get bt ................................................................................. 422.5.5.2 radio get mod ............................................................................. 422.5.5.3 radio get freq ............................................................................. 422.5.5.4 radio get pwr .............................................................................. 432.5.5.5 radio get sf ................................................................................. 432.5.5.6 radio get afcbw .......................................................................... 432.5.5.7 radio get rxbw ............................................................................ 432.5.5.8 radio get bitrate .......................................................................... 432.5.5.9 radio get fdev ............................................................................. 432.5.5.10 radio get prlen .......................................................................... 442.5.5.11 radio get crc ............................................................................. 442.5.5.12 radio get iqi ............................................................................. 442.5.5.13 radio get cr ............................................................................... 442.5.5.14 radio get wdt ............................................................................ 442.5.5.15 radio get bw ............................................................................. 442.5.5.16 radio get snr ............................................................................. 452.5.5.17 radio get sync .......................................................................... 45

補遺 A 現在のファームウェア機能と修正点

各国の営業所とサービス................................................................................................ 49




序章

はじめに

序章には、RN2903を使い始める前に知っておくと便利な一般情報を記載しています。以下の内容について説明します。

• 本書の構成

• 本書の表記規則

• 推奨参考資料

• Microchip 社のウェブサイト

• 開発システムのお客様向け変更通知サービス

• カスタマサポート

• 改訂履歴

本書の構成

このコマンドリファレンスユーザガイドでは RN2903 低消費電力長距離 LoRa™テクノロジトランシーバモジュールの設定について説明します。また、通信の説明とコマンドリファレンスも収めています。本書の構成は以下の通りです。

• 第 1 章「はじめに」 – 第 1 章には、RN2903 モジュールの紹介と機能の概要を記載しています。

• 第 2 章「コマンドリファレンス」 – この章には、RN2903 モジュールの設定に使うコマンドの情報と例を記載しています。

お客様へのご注意

どのような文書でも内容は時間が経つにつれ古くなります。本書も例外ではありません。Microchip 社の製品は、お客様のニーズを満たすために常に改良を重ねており、実際のダイアログやツールが本書の内容とは異なる場合があります。最新文書は Microchip 社のウェブサイト (www.microchip.com)をご覧ください。

文書は「DS」番号によって識別します。この識別番号は各ページのフッタのページ番号の前に表記しています。DS 番号「DSXXXXXXXXA」の「XXXXXXXX」は文書番号、「A」は文書のリビジョンレベルを表します。

開発ツールの最新情報は、MPLAB IDE のオンラインヘルプをご覧ください。[Help] メニューから[Topics] を選択すると、オンラインヘルプファイルのリストが表示されます。


http://www.microchip.com

序章

本書の表記規則

本書では以下の表記規則を適用します。

本書の表記規則

表記適用例

Arial、MS ゴシックフォント

二重かぎカッコ : 『』参考資料『MPLAB® IDE ユーザガイド』

太字テキストの強調 ... は唯一のコンパイラです ...角カッコ : [ ] ウィンドウ名 [Output] ウィンドウ

ダイアログ名 [Settings] ダイアログ

メニューの選択肢 [Enable Programmer] を選択

かぎカッコ : 「」ウィンドウまたはダイアログのフィールド名

「Save project before build」

右山カッコ (>) で区切り角カッコで囲んだテキスト

メニュー項目の選択 [File] > [Save]

角カッコ ([ ]) で囲んだ太字のテキスト

ダイアログのボタン [OK] をクリックする

タブ [Power] タブをクリックする

N‘Rnnnn Verilog形式の数値 (Nは総桁数、R は基数、n は各桁の値 )

4‘b0010, 2‘hF1

山カッコ (< >) で囲んだテキスト

キーボードのキー <Enter>、<F1> を押す

Courier New フォント

標準書体の Courier New サンプルソースコード #define STARTファイル名 autoexec.batファイルパス c:\mcc18\hキーワード _asm, _endasm, staticコマンドラインオプション -Opa+, -Opa-ビット値 0, 1定数 0xFF, ‘A’

斜体の Courier New 変数の引数 file.o (fileは有効な任意のファイル名 )

角カッコ : [ ] オプションの引数 mcc18 [options] file [options]

中カッコとパイプ文字 : { | } どちらかの引数を選択する場合 (OR 選択 )

errorlevel {0|1}

省略記号 : ... 繰り返されるテキスト var_name [, var_name...]

ユーザが定義するコード void main (void){ ...}



推奨参考資料

本書には RN2903 モジュールの設定方法を記載しています。本モジュールのデータシートにはモジュール仕様の最新情報を記載しています。参考資料として、Microchip社が提供する以下の文書を推奨します。

RN2903 データシート『Low-Power Long Range LoRa™ Technology Transceiver Module』(DS50002390)

このデータシートには RN2903 モジュールの詳細仕様を記載しています。

LoRa™ Alliance:『LoRaWAN™ Specification』本書では、バッテリ駆動のエンドデバイス向けに最適化された LoRaWAN™ プロトコルについて説明します。この仕様書は LoRa Alliance のウェブサイト(www.lora-alliance.org) で入手できます。

Microchip社の文書はMicrochip社のウェブサイト (www.microchip.com)で提供しています。

Microchip 社のウェブサイト

Microchip 社は、自社が運営するウェブサイト (www.microchip.com) を通してオンラインサポートを提供しています。このウェブサイトを通じて、お客様はファイルと情報を簡単に入手できます。インターネットブラウザから以下の内容がご覧になれます。

• 製品サポート – データシートとエラッタ、アプリケーションノートとサンプルプログラム、設計リソース、ユーザガイドとハードウェアサポート文書、最新のソフトウェアと過去のソフトウェア

• 一般的技術サポート – よく寄せられる質問 (FAQ)、技術サポートのご依頼、オンラインディスカッショングループ、Microchip 社のコンサルタントプログラムメンバーの一覧

• Microchip 社の事業 – プロダクトセレクタガイドとご注文案内、プレスリリース、セミナーとイベントの一覧、営業所の一覧


http://lora-alliance.org/


序章

開発システムのお客様向け変更通知サービス

Microchip 社のお客様向け変更通知サービスは、お客様に Microchip 社製品の最新情報をお届けするサービスです。ご興味のある製品ファミリまたは開発ツールに関する変更、更新、リビジョン、エラッタ情報をいち早くメールにてお知らせします。

Microchip 社のウェブサイト (www.microchip.com) にアクセスし、[Customer ChangeNotification] からご登録ください。

以下の開発システム製品カテゴリが選べます。

• コンパイラ – Microchip 社の C コンパイラ、アセンブラ、リンカ、その他の言語ツールの最新情報を提供します。これには MPLAB C コンパイラ全製品、MPLABアセンブラ全製品 (MPASM™ アセンブラを含む )、MPLAB リンカ全製品(MPLINK™オブジェクトリンカを含む)、MPLABライブラリアン全製品(MPLIB™オブジェクトライブラリアンを含む ) が含まれます。

• エミュレータ – Microchip 社のインサーキットエミュレータの最新情報を提供します。これには MPLAB REAL ICE™ と MPLAB ICE 2000 インサーキットエミュレータが含まれます。

• インサーキットデバッガ – Microchip社のインサーキットデバッガに関する最新情報を提供します。これには MPLAB ICD 3 インサーキットデバッガと PICkit™3 Debug Express が含まれます。

• MPLAB® IDE – Microchip 社の MPLAB IDE( 開発システムツール向け Windows®

統合開発環境 ) の最新情報を提供します。これには MPLAB IDE、MPLAB IDEプロジェクトマネージャ、MPLAB エディタ、MPLAB SIM シミュレータと一般的な編集 / デバッグ機能が含まれます。

• プログラマ – Microchip 社のプログラマに関する最新情報を提供します。これにはMPLAB REAL ICE インサーキットエミュレータ、MPLAB ICD 3 インサーキットデバッガ、MPLAB PM3 デバイスプログラマ等の量産プログラマが含まれます。また、PICSTART® Plus や PICkit 2/3 等、量産向けではない開発用プログラマも含まれます。

カスタマサポート

Microchip 社製品をお使いのお客様は、以下のチャンネルからサポートをご利用頂けます。

• 販売代理店

• 弊社営業所

• 技術サポート

サポートは販売代理店にお問い合わせください。各地の営業所もご利用頂けます。本書の最後のページには各国営業所の一覧を記載しています。

技術サポートは以下のウェブページからもご利用になれます。

http://www.microchip.com/support

改訂履歴

リビジョン A (2015 年 8 月 )本書は初版です。






第 1 章はじめに

1.1 概要

Microchip 社の RN2903 モジュールを使うと、シンプルな UART インターフェイスでLoRaWAN™ プロトコル接続が可能です。本モジュールは、LoRaWAN プロトコルを処理し、ホストとの最適化されたテキストコマンド /応答インターフェイスを提供します。本書では、LoRaWAN プロトコルの実装について説明します。LoRaWAN プロトコルの用語の詳細は『LoRaWAN Specification』(LoRa Alliance (www.lora-alliance.org) から入手可能 ) に記載されています。従って、RN2903 モジュールを使い始める前に『LoRaWANSpecification』を確認する事を推奨します。

LoRa™ テクノロジネットワークにアクセスするために必要な設定はわずかであり、これらのパラメータはモジュールの EEPROM に保存できます。従って、パラメータを工場で設定する事で、ホストシステムの要件を低減できると同時にシステムのセキュリティも向上させる事ができます。本モジュールは、UART インターフェイスを介して設定できる GPIO ピンを備えています。

図 1-1 に、簡単な使用事例を示します。この例では、センサを読み出すホスト MCUを内蔵するエンドデバイスが、LoRa ネットワーク経由でセンサの読み値を送信するように RN2903 に対してコマンドを発行します。RN2903 はデータを暗号化し、1 つまたは複数のゲートウェイがその無線パケットを受信します。ゲートウェイはそれをネットワークサーバに転送します。ネットワークサーバは、アプリケーションデータの復号キーを持つアプリケーションサーバにそのデータを送ります。同様に、UARTで PC に直接接続した RN2903 で開発プラットフォームを構成する事もできます。この場合、PC がホストシステムとなります。この場合、ユーザはターミナルプログラムを使ってモジュールにコマンドを発行できます。

図 1-1: シンプルな LoRaWAN™ ネットワークのブロック図

エンドデバイスがデータを生成し、ネットワーク上でデータが転送される様子を観測できます。

Network Server

RN2903

UART

LoRaTM end device

UARTPC with terminal software

Sensor

Sensor reading: 0x23A5 mac tx uncnf 30 23A5 40340120030000001EADBCE2ABFFDA Encrypted data

IP Connection

Application Server

[…]1E[…]ADBC[…]

IP Connection

Application

Port: 30Data: 23A5

Development platform

These devices deal with plaintext application data

These entities hold secret keys that can encrypt/decrypt application data

These devices relay encrypted application data without being able to decrypt it

)))

LoRaTM Gateway

(((

RN2903Host MCU

)))


http://lora-alliance.org/

はじめに

1.2 特長

• LoRaWAN プロトコル準拠

• FSK、GFSK、LoRa テクノロジのトランシーバを内蔵しているため、これらのプロトコルを使ったカスタムパケットを送信可能

• グローバルに一意の 64 ビット識別子 (EUI-64™)• 設定可能な GPIO• プログラマブル / オンデマンド復帰機能を備えたインテリジェント低消費電力モード

• ファームウェアアップグレードのためのブートローダ

• 簡単な ASCII コマンドを使って UART 経由で全ての設定と制御を実行

モジュールのハードウェア仕様の詳細は RN2903 データシート『Low-Power LongRange LoRa™ Technology Transceiver Module』(DS50002390) を参照してください。

1.3 設定

図 1-2 に、RN2903 モジュールのアーキテクチャをコマンドインターフェイスの観点から示します。使えるコマンドタイプには 3 種類があり、それぞれモジュールの異なる機能にアクセスできます。

• macコマンドグループ - LoRaWAN の設定と制御

• radioコマンドグループ - 無線の設定と制御

• sysコマンドグループ - その他のモジュール機能

図 1-2: RN2903 コマンドインターフェイス ( 黄 ) とモジュール内の構成要素との関係

用意されているコマンドを使う事で、LoRaWAN プロトコル層、無線ドライバ、システム周辺機能を設定および制御できます。

LoRa ネットワークで通信するためには、パラメータを設定する必要があります。デバイスがネットワークに参加するのに 2 種類の方法があるため、これらの方法それぞれに異なるパラメータが必要です。

• 無線による有効化 (OTAA) - デバイスがネットワークに参加する際に、ネットワーク暗号化キーを取り決めます。このために、デバイス EUI、アプリケーション EUI、アプリケーションキーを設定する必要があります。その後で OTAA 手順を開始できます。

• パーソナライズによる有効化 (ABP) - デバイスがあらかじめネットワークキーを備えており、ただちにネットワークで通信を開始できます。このタイプの初期化には、デバイスアドレス、ネットワークセッションキー、アプリケーションセッションキーを設定するだけで十分です。

Command Interface

Radio driver

LoRaWANTM Protocolmac

commands

radiocommands

Hardware (GPIO, System timer, etc.)

syscommands

Radio hardware



セキュリティ向上のため、製造工程でこれらのパラメータをモジュールの EEPROMに格納する事ができます。従ってホストシステムは、デバイスが起動するたびにUARTインターフェイス経由でキーを送る必要はありません。

1.4 UART インターフェイス

RN2903 モジュールの全ての設定とコマンドは、ASCII インターフェイスを使ってUART 経由で転送されます。全てのコマンドは <CR><LF>で終わる必要があります。また、全ての応答も同じです。

UART インターフェイスの既定値の設定は 57600 bps、8 ビット、パリティなし、1 ストップビット、フロー制御なしです。転送速度は、モジュールの自動速度検出シーケンスをトリガする事で変更できます。これを行うには、ホストシステムからモジュールにブレーク条件を送信し、その後で 0x55キャラクタを新しい転送速度で送信する必要があります。自動速度検出機能をスリープ中にトリガしてモジュールを復帰させる事もできます。

Note: 1 文字全体を送信する時間より長い間 UART_RX ピンを Low に保持する事で、ブレーク条件がモジュールに送信されます。例えば、既定値の転送速度 (57600 bps) の場合、UART_RX ピンを 938 s の間 Low にするとブレーク条件が有効になります。一方、9600 bps では 0x00 キャラクタとみなされます。従ってブレーク条件は、現在使用中の転送速度で有効とみなされるのに十分な長さにする必要があります。




第 2 章コマンドリファレンス

RN2903 LoRa テクノロジモジュールは、設定のための各種コマンドをサポートしています。本セクションでは、これらのコマンドの詳細を説明し、例を示します。

2.1 コマンドの構文

RN2903 モジュールにコマンドを発行するには、キーワードの後に追加パラメータを送ります。コマンド ( キーワード ) は、大文字と小文字を区別します。また、パラメータの中でスペースは使えません。16 進入力データは、大文字と小文字を区別しません。OTAA 等のネットワーク参加手順に使う文字列データは、大文字と小文字を区別しません。パラメータの簡略表記法はサポートしていません。

コマンドによって、パラメータは 10 進と 16 進のどちらかの形式の値とする必要があります。どちらの形式にすべきかはコマンドの説明を参照してください。例えば周波数を設定する場合、コマンドはHzで表した10進値 (例 : 923300000 (923.3 MHz))を必要とします。一方 LoRaWAN デバイスアドレスを設定する場合、16 進値 ( 例 :aabbccdd) での指定が必要です。16 進値を入力するには、その値を直接使います。例えば、16 進値 0xFF は FF と入力します。

2.2 コマンドの構成

表 2-1 に示すように、コマンドは 3 つに大別できます。

LoRaWAN プロトコルの設定が完了すると、その設定を保存する必要があります。そうしないと、再起動またはリセットの際に設定は無効になります。

表 2-1: コマンドタイプ

コマンドタイプキーワード説明

システム <sys> システムレベル挙動操作の発行、ファームウェアおよびハードウェアバージョンに関するステータス情報の収集、モジュールのユーザEEPROM メモリへのアクセスを行います。

LoRaWAN™ プロトコル <mac> LoRaWAN プロトコルネットワーク通信の挙動、操作、設定コマンドを発行します。

トランシーバコマンド <radio> 無線特有の設定を発行する事で、トランシーバ設定に直接アクセスして更新します。

Note: コマンドの受信に成功すると、モジュールは以下のいずれか 1 つで応答します。

• ok • invalid_param • 要求された情報

• 説明を含むエラーメッセージ



2.3 システムコマンド

システムコマンドはシステムキーワード <sys>で始まり、表 2-2、表 2-3、表 2-4 に示すカテゴリに大別できます。

2.3.1 sys sleep <length><length>: システムをスリープさせる時間の長さ (ms) を表す 10 進数 (100 ～

4294967296) です。

応答 : ok - システムがスリープから復帰しました。

invalid_param - 時間の長さが無効です。

このコマンドは、システムを指定された時間 (ms) の間スリープに移行させます。モジュールは、新規通信レートでブレーク条件に続けて 0x55キャラクタを送る事で、スリーブから復帰させる事ができます。

例 : sys sleep 120 // Puts the system to Sleep for 120 ms.

2.3.2 sys reset応答 : RN2903 X.Y.Z MMM DD YYYY HH:MM:SS (X.Y.Z はファームウェアのバージョン、MMM は月、DD は日、HH:MM:SS は時、分、秒です。フォーマット : [ ハードウェア ][ ファームウェア ] [ 日付 ] [ 時間 ])。[ 日付 ] と [ 時間 ] は、ファームウェアのリリースを示します。

このコマンドは、RN2903 モジュールをリセット、再起動します。再起動時には、保存されている内部設定が自動的に読み込まれます。

例 : sys reset // Resets and restarts the RN2903 module.

2.3.3 sys eraseFW応答 : なし

このコマンドは、RN2903 モジュールの現在のアプリケーションファームウェアを削除し、モジュールをファームウェアアップグレードに備えさせます。RN2903モジュールのブートローダは新規ファームウェアを書き込む準備を整えます。

例 : sys eraseFW // Deletes the current RN2903 module application firmware.

Note: アプリケーションと LoRaWAN MAC との無線共有は mac pauseおよびmac resumeコマンドを参照してください。sysコマンドとその他のタイプのコマンドとの間に共有は存在しないため、pause コマンドを追加する必要はありません。

表 2-2: システムコマンド

パラメータ説明

sleep システムを一定時間 (ms) スリープに移行させます。

reset RN2903 モジュールをリセット、再起動します。

eraseFW RN2903 モジュールの現在のアプリケーションファームウェアを削除します。RN2903 モジュールのブートローダは新規ファームウェアを書き込む準備を整えます。

factoryRESET RN2903モジュールの設定データとユーザEEPROMを工場出荷時の既定値にリセットし、RN2903 モジュールを再起動します。

set(1)指定されたシステムパラメータ値を設定します。

get(1)指定されたシステムパラメータ値を取得します。

Note 1: システムコマンド(<set>, <get>)のまとめは、表2-3と表2-4を参照してください。


コマンドリファレンス

2.3.4 sys factoryRESET応答 : RN2903 X.Y.Z MMM DD YYYY HH:MM:SS (X.Y.Z はファームウェアのバージョン、MMM は月、DD は日、HH:MM:SS は時、分、秒です。フォーマット : [ ハードウェア ][ ファームウェア ] [ 日付 ] [ 時間 ])。[ 日付 ] と [ 時間 ] は、ファームウェアのリリースを示します。

このコマンドは、モジュールの設定データと EEPROM を工場出荷時の既定値にリセットし、モジュールを再起動します。factoryRESET を実行すると、RN2903モジュールは自動的にリセットされ、全ての設定パラメータが工場出荷時の既定値に戻ります。

例 : sys factoryRESET // Restores factory default values.

2.3.5 システム設定コマンド

2.3.5.1 sys set nvm <address> <data><address>: ユーザ EEPROM アドレスを表す 16 進数 (300 ～ 3FF) です。

<data>: データを表す 16 進数 (00 ～ FF) です。

応答 : ok - パラメータ ( アドレス、データ ) が有効です。

invalid_param - パラメータ ( アドレス、データ ) が無効です。

このコマンドを使うと、ユーザ EEPROM の <address> のアドレス位置を <data>の値に変更できます。<address> と <data> はどちらも 16 進値で入力する必要があります。ユーザ EEPROM メモリは、モジュール上の MCU 内部にあります。

例 : sys set nvm 300 A5 // Stores the value 0xA5 at user EEPROM address 0x300.

2.3.5.2 sys set pindig <pinname> <pinstate><pinname>: ピンを表す文字列です。パラメータ値は以下の通りです。

GPIO0～ GPIO13, UART_CTS, UART_RTS, TEST0, TEST1<pinstate>: 状態を表す 10 進数です。パラメータ値は以下の通りです。0, 1応答 : ok - パラメータ (<pinname>, <pinstate>) が有効です。

invalid_param - パラメータ (<pinname>, <pinstate>) が無効です。

このコマンドを使うと、モジュールで利用可能な未使用ピンを変更できます。選択された <pinname>のピンを、指定された <pinstate>に応じて High または Low に駆動します。

既定値 : GPIO0 ～ GPIO13、UART_CTS、UART_RTS、TEST0、TEST1 が Low( 値 0)に駆動されます。

例 : sys set pindig GPIO5 1 // Drives GPIO5 high 1, VDD.

表 2-3: システム設定コマンド


nvm ユーザ EEPROM の <address>のアドレス位置に <data>を格納します。

pindig デジタルピンをセットまたはクリアします。

pinmode ピンの状態をデジタル出力、デジタル入力、アナログのいずれかとして設定できます。



2.3.5.3 sys set pinmode <pinname> <pinmode>

<pinname>: ピンを表す文字列です。パラメータ値は以下の通りです。GPIO0～ GPIO13, UART_CTS, UART_RTS, TEST0, TEST1

<pinmode>: モードを表す文字列です。パラメータ値は以下の通りです。digout, digin, ana

応答 : ok - パラメータ (<pinname>, <pinmode>) が有効です。 invalid_param - パラメータ (<pinname>, <pinmode>) が無効です。

このコマンドを使うと、モジュールの未使用ピンをデジタル出力、デジタル入力、アナログのいずれかとして設定できます。

既定値 : GPIO0～ GPIO14、UART_CTS、UART_RTS、TEST0、TEST1が出力ピンになり、Low( 値 0) に駆動されます。

例 : sys set pinmode GPIO5 ana //Sets pin GPIO5 as analog pin

2.3.6 システム取得コマンド

2.3.6.1 sys get ver応答 : RN2903 X.Y.Z MMM DD YYYY HH:MM:SS (X.Y.Z はファームウェアのバージョン、MMM は月、DD は日、HH:MM:SS は時、分、秒です。フォーマット : [ ハードウェア ][ ファームウェア ] [ 日付 ] [ 時間 ])。[ 日付 ] と [ 時間 ] は、ファームウェアのリリースを示します。

このコマンドは、ハードウェアプラットフォーム、ファームウェアバージョン、リリース日付、ファームウェアのタイムスタンプ情報を返します。

例 : sys get ver // Returns version-related information.

2.3.6.2 sys get nvm <address><address>: ユーザ EEPROM アドレスを表す 16 進数 (300 ～ 3FF) です。

応答 : 00 ～ FF (00 ～ FF の 16 進値 ) - アドレスが有効です。

invalid_param - アドレスが無効です。

このコマンドは、RN2903 モジュールのユーザ EEPROM のアドレス <address> に格納されているデータを返します。

例 : sys get nvm 300 // Returns the 8-bit hex value stored at 300.

Note: GPIO0 ～ GPIO3、GPIO5 ～ GPIO13 ピンのみがアナログピンに設定できます。

表 2-4: システム取得コマンド


ver ハードウェアプラットフォーム、ファームウェアバージョン、リリース日付を返します。

nvm ユーザEEPROMのアドレス<address>に格納されているデータを返します。

vdd 計測電圧 (mV) を返します。

hweui 書き込み済みの EUI ノードアドレスを返します。

pindig ピンの状態 (「0」(Low) または「1」(High)) を返します。



2.3.6.3 sys get vdd応答 : 0 ～ 3600 (0 ～ 3600 の 10 進値 )このコマンドは、VDD の A/D 変換を RN2903 モジュールに要求します。計測値は電圧(mV) に変換して返します。

例 : sys get vdd // Returns mV measured on the VDD module.

2.3.6.4 sys get hweui応答 : 書き込み済みの EUI ノードアドレスを表す 16 進数

このコマンドは、書き込み済みの EUI ノードアドレスを RN2903 モジュールから読み出します。このコマンドで返される値は、Microchip 社が提供する一意の数です。

例 : sys get hweui // Reads the preprogrammed EUI node address.

2.3.6.5 sys get pindig <pinname><pinname>: ピンを表す文字列です。パラメータ値は以下の通りです。

GPIO0～ GPIO13, UART_CTS, UART_RTS, TEST0, TEST1応答 : ピンの状態を表すビット (「0」(Low) または「1」(High)) - <pinname>

のピンが有効です。invalid_param - <pinname>のピンが無効です。

このコマンドは、問い合わせたピンの状態 (「0」(Low) または「1」(High)) を返します。

例 : sys get pindig GPIO5// Returns the state of GPIO5.

2.3.6.6 sys get pinana <pinname>

<pinname>: ピンを表す文字列です。パラメータ値は以下の通りです。 GPIO0～ GPIO3, GPIO5～ GPIO13

応答 : 10 ビットのアナログ値を表す 10 進数 (0 ～ 1023) - <pinname>のピン

が有効です。invalid_param - <pinname>のピンが無効です。

このコマンドは、問い合わせたピンの 10 ビットのアナログ値を返します (0 が 0 V を

表し、1023 が VDD を表します )。VDD ピンの A/D 変換は、コマンド sys get vddを使う事で実行できます。

例 : sys get pinana GPIO0 // Returns the state of GPIO0.

Note: この上限値は、本モジュールの最大電源電圧の検討のためにのみ提供されます。本モジュールの最大電源電圧を超えた場合、このコマンドの応答は実際の電源電圧を示します (3600 より大きくなります )。

Note: 書き込み済みの EUI ノードアドレスは読み出し専用であり、変更も消去もできません。mac set deveuiコマンドでこの値を使ってデバイス EUIを設定できます ( セクション 2.4.8.2 参照 )。



2.4 MAC (Media Access Controller) コマンド

LoRaWAN プロトコルコマンドはシステムキーワード macで始まり、表 2-5 ～表 2-9に示すカテゴリに大別できます。

2.4.1 mac reset応答 : okこのコマンドは、ソフトウェア LoRaWAN スタックを自動的にリセットし、選択されたバンド向けのパラメータで初期化します。

例 : mac reset

表 2-5: MAC コマンド


reset RN2903 モジュールをリセットし、ほとんどの LoRaWAN パラメータに既定値を設定します。

tx 指定されたポート番号にデータ文字列を送ります。

join 設定されたネットワークに参加する事をRN2903モジュールに知らせます。 save LoRaWAN 設定パラメータをユーザ EEPROM に保存します。

forceENABLE エンドデバイスがただちにサイレントになるように LoRaWAN ネットワークサーバがコマンドを発行した後、RN2903 モジュールを有効にします。

pause LoRaWAN スタック機能を一時停止し、トランシーバ ( 無線 ) 設定を可能にします。

resume LoRaWAN スタック機能を復元します。

set 特定の MAC 関連パラメータにアクセスし変更します。

get 現在の MAC 関連パラメータをモジュールから読み出します。

Note: このコマンドは、ほとんどのLoRaWAN™パラメータに既定値を設定します。このコマンド以前の設定値は全て消去され、既定値に戻ります。暗号化キーも 0 に設定されます。



2.4.2 mac tx <type> <portno> <data><type>: アップリンクペイロードのタイプを表す文字列 (cnfまたは uncnf)です

(cnf – 確認必要、uncnf – 確認不要 )。<portno>: ポート番号を表す 10 進数 (1 ～ 223) です。

<data>: 16 進値です。送信できる <data>バイトの長さは、設定データレートで決まります (『LoRaWAN™ Specification』参照 )。応答 : このコマンドは 2 つの応答を返す場合があります。最初の応答は、コマンドを入力した直後に返されます。コマンドが有効な場合 (okの応答を受信した場合 )、2 番目の応答はデータ転送終了後に返されます。詳細は『LoRaWAN™ Specification』を参照してください。

コマンド入力後の応答は以下の通りです。

• ok – パラメータと設定が有効です。パケットが送信のため無線トランシーバに転送されました。

• invalid_param – パラメータ (<type> <portno> <data>) が無効です。

• not_joined – ネットワークに参加していません。

• no_free_ch – 利用できるチャンネルがありません。 • silent – モジュールが即時サイレント状態です。

• frame_counter_err_rejoin_needed – フレームカウンタがロールオーバーしました。

• busy – MAC がアイドル状態ではありません。 • mac_paused – MAC が一時停止し、再開していません。

• invalid_data_len – アプリケーションのペイロード長が、現在のデータレートの最大ペイロード長を超えています。

アップリンク転送後の応答は以下の通りです。

• mac_tx_ok – アップリンク転送に成功しました。しかし、サーバからダウンリンクデータを受け取っていません。

• mac_rx <portno> <data> – 転送に成功しました (<portno>: ポート番号(1 ～ 223)、<data>: サーバから受け取った 16 進値 )。

• mac_err – 転送に成功しました。しかし、サーバからACKを受け取っていません。

• invalid_data_len – アプリケーションのペイロード長が、現在のデータレートに応じた最大ペイロード長より長いです。

確認必要メッセージは、サーバからの肯定応答 (ACK) を待機します。ACK が返されない場合、コマンド mac set retx <value>で示した回数メッセージを再送信します。一方、確認不要メッセージはサーバからの ACK を期待しません。詳細は

『LoRaWAN™ Specification』を参照してください。

ポート番号を使う事で、複数のデータストリームを同一リンク上で多重化できます。例えばエンドデバイスは、あるポート番号の計測値と別のポート番号の設定データを送る事ができます。この場合サーバアプリケーションは、2 種類のデータをポート番号に基づいて識別できます。

例 : mac tx cnf 4 5A5B5B // Sends a confirmed frame on port 4 with application payload 5A5B5B.



自動返信機能が有効で、サーバがフレーム保留ビットをセットする場合、またはダウンリンク確認必要転送を開始する場合、モジュールがダウンリンクパケットを受信するたびに複数の応答が表示されます。この場合の代表的なシナリオを以下に示します( 必要条件 : 未使用の LoRaWAN チャンネルがある、かつ自動返信機能が有効 )• モジュールは、アプリケーションペイロード 0xAB と共にポート 4 にパケットを送ります。

• 無線送信が成功した場合、モジュールは最初の応答 (ok) を表示します。

• サーバは、2 つのダウンリンク確認必要パケットを以下のデータと共にポート 1 に返送する必要があります。0xAC、次に 0xAF 最初のデータ (0xAC) を送信すると、サーバはフレーム保留ビットをセットします。モジュールは2番目の応答mac_rx1 ACを表示します。

• ダウンリンク転送でフレーム保留ビットがセットされているため、モジュールは、アプリケーションペイロードを持たない自動アップリンク確認不要転送を開始します。

• サーバは、2 番目の確認必要パケット (0xAF) を返します。モジュールは 3 番目の応答 mac_rx 1 AFを返します。

• 直前のダウンリンク転送が確認され、サーバが ACK を必要としているため、モジュールは、アプリケーションペイロードを持たない自動確認不要転送を開始します。

• サーバからの応答がない場合、2 番目の受信ウィンドウ終了後にモジュールは以下に示す 4 番目の応答を表示します。mac_tx_ok

• このシナリオの後、有効なチャンネルが 1 つ以上空いている場合、パケットを送る事ができます。

このシナリオに基づいて、mac tx cnf 4 ABコマンド実行後、モジュールは以下の応答を表示します。

• ok• mac_rx 1 AC• mac_rx 1 AF• mac_tx_ok

2.4.3 mac join <mode><mode>: 参加手順のタイプを表す文字列 (otaaまたはabp、大文字と小文字の区別

なし )です (otaa – 無線による有効化、abp – パーソナライズによる有効化 )。応答 : このコマンドは 2 つの応答を返す場合があります。最初の応答は、コマンドを入力した直後に返されます。コマンドが有効な場合 (okの応答を受信した場合 )、2 番目の応答は参加手順終了後に返されます。詳細は『LoRaWAN™ Specification』を参照してください。


• ok – パラメータと設定が有効です。参加要求パケットが送信のため無線トランシーバに転送されました。

• invalid_param – <mode>が無効です。

• keys_not_init – 参加モードに対応するキー (otaa または abp) が設定されていません。

• no_free_ch – 利用できるチャンネルがありません。 • silent – デバイスが即時サイレント状態です。

• busy – MAC がアイドル状態ではありません。 • mac_paused – MAC が一時停止し、再開していません。



参加手順後の応答は以下の通りです。

• denied – 参加手順が失敗しました ( モジュールがネットワークへの参加を試み、拒否されました )。

• accepted – 参加手順が成功しました。

このコマンドは、設定されたネットワークに参加しようとしている事を RN2903モジュールに知らせます。モジュールの有効化タイプを <mode>で選択します。パラメータ値には、otaa( 無線による有効化 ) または abp( パーソナライズによる有効化 ) を選択できます。<mode> パラメータは大文字と小文字を区別しません。ネットワークに参加する前に、各有効化タイプ特有のパラメータを設定する必要があります ( 無線による有効化の場合 : デバイス EUI、アプリケーション EUI、アプリケーションキー、パーソナライズによる有効化の場合 : デバイスアドレス、ネットワークセッションキー、アプリケーションセッションキー )。例 : mac join otaa // Attempts to join the network using

over-the-air activation.

2.4.4 mac save応答 : okmac saveコマンドは、mac set <cmd>コマンドで設定パラメータを入力した後で発行する必要があります。このコマンドは、LoRaWAN プロトコル設定パラメータをEEPROM に保存します。システムをリセットすると、LoRaWAN プロトコル設定は最後に保存したパラメータで初期化されます。システムは、パワーサイクル、MCLRピンへのパルス印可、sys resetコマンドのいずれかでリセットします。

LoRaWAN プロトコル設定の保存可能なパラメータは以下の通りです。

• deveui: エンドデバイス識別子

• appeui: アプリケーション識別子

• appkey: アプリケーションキー

• nwkskey: ネットワークセッションキー

• appskey: アプリケーションセッションキー

• devaddr: エンドデバイスアドレス

• ch: チャンネルパラメータ

- drrange: データレートレンジ

- status: ステータス

• upctr: アップリンクカウンタ

• dnctr: ダウンリンクカウンタ

• adr:アドレス状態

• rx2: RX ウィンドウ 2 パラメータ

例 : mac save // Saves the LoRaWAN protocol configuration parameters to the user EEPROM.

2.4.5 mac forceENABLE応答 : okネットワークは、特定のコマンド ( パラメータ 255 を持つデューティサイクル要求フレーム ) を発行できます。このコマンドが発行されると、RN2903 モジュールはただちにサイレントになる必要があります。これはモジュールの通信を全て無効にし、モジュールをネットワークから切り離します。このネットワークコマンドが受信された後で mac forceENABLE を発行すると、データを送信できるようになりモジュールの接続が復元されます。

例 : mac forceENABLE // Disables the Silent Immediately state.



2.4.6 mac pause応答 : 0 ～ 4294967295 (MAC が一時停止できる時間 (ms) を表す 10 進数 )このコマンドは LoRaWAN スタック機能を一時停止し、トランシーバ ( 無線 ) を設定できるようにします。mac pauseを使う事で、LoRaWAN プロトコルアップリンクアプリケーション (mac txコマンド ) と LoRaWAN プロトコル受信ウィンドウ (mactxコマンドに対する2番目の応答)の間に無線コマンドを発生させる事ができます。このコマンドは、LoRaWAN 機能に影響を与えずにトランシーバを使える期間 (ms) を返します。LoRaWAN スタック機能がアイドル状態にあり、トランシーバが制限なく使える場合、常に最大値 (4294967295) を返します。LoRaWAN スタック機能を一時停止できない場合、「0」を返します。無線設定が完了した後、mac resume コマンドを使って LoRaWAN プロトコルコマンドに戻る必要があります。

例 : mac pause // Pauses the LoRaWAN stack functionality if the response is different from 0.

2.4.7 mac resume応答 : okこのコマンドは、一時停止後に通常動作を続けるために LoRaWAN スタック機能を再開します。

例 : mac resume // Resumes the LoRaWAN stack functionality.

Note: ネットワークに参加済みの場合、無線パラメータの設定または無線送受信の開始の前に、このコマンドを呼び出す必要があります。

Note: 全ての無線コマンドを発行し、全ての対応する非同期メッセージが返された後で、このコマンドを呼び出す必要があります。



2.4.8 MAC 設定コマンド

2.4.8.1 mac set devaddr <address><address>: デバイスアドレスを表す4バイトの16進数(00000000～FFFFFFFF)です。

応答 : ok - アドレスが有効です。


このコマンドは、4 バイトの一意のネットワークデバイスアドレス <address> でモジュールを設定します。<address> は現在のネットワークで一意である必要があります。これは、デバイスのパーソナライズによる有効化だけのために直接設定する必要があります。無線での有効化を行う際は、このパラメータは参加プロセスが終了すると上書きされるため、ネットワーク参加の前に設定してはいけません。例 : mac set devaddr ABCDEF01

表 2-6: MAC 設定コマンド


devaddr RN2903 モジュールに一意のネットワークデバイスアドレスを設定します。

deveui RN2903 モジュールにグローバルに一意な識別子を設定します。

appeui RN2903 モジュールにアプリケーション識別子を設定します。

nwkskey RN2903 モジュールにネットワークセッションキーを設定します。

appskey RN2903 モジュールにアプリケーションセッションキーを設定します。 appkey RN2903 モジュールにアプリケーションキーを設定します。 pwridx 次の送信に使う出力を設定します。 dr 次の送信に使うデータレートを設定します。

adr 適応データレートを有効にするか無効にするかを設定します。 bat デバイスステータス回答フレームコマンドの応答に必要なバッテリレベル

を設定します。 retx アップリンク確認必要パケットに使う再送信回数を設定します。

linkchk リンク確認プロセスをトリガする期間を設定します。 rxdelay1 最初の受信ウィンドウ遅延に使う値を設定します。

ar 自動返信の状態を設定します。 rx2 2 番目の受信ウィンドウに使うデータレートと周波数を設定します。 sync 現在の同期ワードを設定します。

upctr 現在のアップリンクカウンタを設定します。

dnctr 現在のダウンリンクカウンタを設定します。

ch チャンネルに関連するパラメータの変更を可能にします。

Note: mac saveコマンドを発行する事でユーザ EEPROM に前もってこのパラメータを保存済みの場合、その値の変更後、mac saveコマンドを再度呼び出す必要があります。



2.4.8.2 mac set deveui <devEUI><devEUI>: デバイス EUI を表す 8 バイトの 16 進数です。



このコマンドは、モジュールに一意なデバイス識別子を設定します。この識別子は、ホスト MCU が設定する必要があります。本モジュールには、sys get hweuiコマンドを使って取得できる一意の EUI を書き込み済みです ( セクション 2.3.6.4 参照 )。代わりに、mac set deveuiコマンドを使ってユーザ独自の EUI を設定する事もできます。例 : mac set deveui 0004A30B001A55ED

2.4.8.3 mac set appeui <appEUI>

<appEUI>: アプリケーション EUI を表す 8 バイトの 16 進数です。



このコマンドは、モジュールのアプリケーション識別子を設定します。アプリケーション識別子は、ネットワーク内のデバイスタイプ ( 例 : センサデバイス、照明デバイス ) を指定するのに使います。

例 : mac set appeui FEDCBA9876543210

2.4.8.4 mac set nwkskey <nwksesskey><nwkSessKey>:ネットワークセッションキーを表す 16 バイトの 16 進数です。



このコマンドは、モジュールのネットワークセッションキーを設定します。このキーは 16 バイト長であり、モジュールとネットワークとの間の各セッションで変更されます。デバイス間の通信セッション終了するまで、このキーは同じままです。

例 : mac set nwkskey 1029384756AFBECD5647382910DACFEB






2.4.8.5 mac set appskey <appSesskey><appSessKey>: アプリケーションセッションキーを表す 16 バイトの 16 進数です。



このコマンドは、モジュールのアプリケーションセッションキーを設定します。このキーは一意であり、アプリケーションが行う操作をネットワークが要求した場合、通信の発生ごとに生成されます。

例 : mac set appskey AFBECD56473829100192837465FAEBDC

2.4.8.6 mac set appkey <appKey>

<appKey>: アプリケーションキーを表す 16 バイトの 16 進数です。



このコマンドは、モジュールのアプリケーションキーを設定します。アプリケーションキーを使って、同一または類似のタスクを実行する、モジュールユニットのグループを識別します。例 : mac set appkey 00112233445566778899AABBCCDDEEFF

2.4.8.7 mac set pwridx <pwrIndex>

<pwrIndex>: 出力のインデックス値を表す 10 進数です。有効値 : 5, 7, 8, 9, 10 応答 : ok - 出力インデックスが有効です。

invalid_param - 出力インデックスが無効です。

このコマンドは、次の送信に使う出力を設定します。<pwrIndex> に対応する出力は『LoRaWAN™ Specification』を、実際の無線出力レンジは RN2903 データシート『Low-Power Long Range LoRa™ Technology Transceiver Module』(DS50002390) を参照してください。

例 : mac set pwridx 10 // Sets the TX output power to index 10 (refer to the LoRaWAN™ Specification for the output power corresponding to the index).





2.4.8.8 mac set dr <dataRate><dataRate>: データレートを表す10進数 (0～ 4、ただし定義したチャンネルのデータ

レートレンジの制限内の値 ) です。

応答 : ok - データレートが有効です。

invalid_param - データレートが無効です。

このコマンドは、次の送信に使うデータレートを設定します。データレートの説明と対応する拡散率は『LoRaWAN™ Specification』を参照してください。

例 : mac set dr 02.4.8.9 mac set adr <state><state>: 状態を表す文字列値 (onまたは off) です。

応答 : ok - 状態が有効です。

invalid_param - 状態が無効です。

このコマンドは、適応データレート (ADR) を有効にするか無効にするかを設定します。サーバは、アップリンクデータパケットの ADR フィールドからアップリンクフレームを受信する事で、モジュールの ADR のステータスを取得します。ADR が有効な場合、サーバはネットワークから収集した情報に基づいてモジュールのデータレートと送信出力を最適化します。

例 : mac set adr on // This will enable the ADR mechanism.

2.4.8.10 mac set bat <level><level>: バッテリレベルを表す10進数 (0～255)です。0は外部電源、1は低レベル、

254 は高レベルを表します。255 はエンドデバイスがバッテリレベルを計測できなかった事を表します。

応答 : ok - バッテリレベルが有効です。

invalid_param – バッテリレベルが無効です。

このコマンドは、LoRaWAN プロトコルに使うデバイスステータス回答フレームに必要なバッテリレベルを設定します。例 : mac set bat 127 // Battery is set to ~50%.

2.4.8.11 mac set retx <reTxNb><reTxNb>: アップリンク確認必要パケットの再送信回数を表す10進数 (0～255)です。

応答 : ok - <retx>が有効です。

invalid_param - <retx>が無効です。

このコマンドは、サーバからダウンリンクの肯定応答を受け取っていない場合のアップリンク確認必要パケットに使う再送信回数を設定します。

例 : mac set retx 5 // The number of retransmissions made for an uplink confirmed packet is set to 5.



2.4.8.12 mac set linkchk <linkCheck><linkCheck>: リンク確認プロセスの期間 (s) を設定する 10 進数 (0 ～ 65535) です。

応答 : ok - 期間が有効です。

invalid_param - 期間が無効です。

このコマンドは、リンク確認プロセスを周期的にトリガするための期間を設定します。<value>が「0」の場合、リンク確認プロセスを無効にします。この期間が経過すると、サーバに送られる次のアプリケーションパケットにリンク確認MACコマンドが含まれます。リンク確認 MAC コマンドの詳細は『LoRaWAN™ Specification』を参照してください。

例 : mac set linkchk 600 // The module will attempt a link check process at 600-second intervals.

2.4.8.13 mac set rxdelay1 <rxDelay>

<rxDelay>: 送信と最初の受信ウィンドウとの間の遅延 (ms) を表す 10 進数 (0 ～65535) です。

応答 : ok - <rxDelay>が有効です。

invalid_param - <rxDelay>が無効です。

このコマンドは、送信と最初の受信ウィンドウとの間の遅延 (ms) を <rxDelay> に設定します。送信と 2 番目の受信ウィンドウとの間の遅延は、( 送信と最初の受信ウィンドウとの間の遅延 )+1000 (ms) のようにソフトウェアで計算されます。

例 : mac set rxdelay1 1000 // Set the delay between the transmission and the first Receive window to 1000 ms.

2.4.8.14 mac set ar <state><state>: 状態を表す文字列値 (onまたは off) です。



このコマンドは、自動返信の状態を設定します。自動返信機能を有効にすると、確認必要ダウンリンクの受信直後、またはサーバがフレーム保留ビットをセット済みの場合、モジュールはペイロードを持たないパケットを送信します。OFF に設定した場合、自動返信は行われません。

例 : mac set ar on // Enables the automatic reply process inside the module.

Note: mac reset コマンドが発行された場合、リンク確認プロセスは無効に設定されます。

Note: 自動返信機能が有効で、サーバがフレーム保留ビットをセットする、または確認必要ダウンリンク転送を開始する場合、RN2903 モジュールは、アプリケーションペイロードを持たない自動転送を開始します。自動転送が完了するまでアップリンク転送を開始できません。



2.4.8.15 mac set rx2 <dataRate> <frequency><dataRate>: データレートを表す 10 進数 (8 ～ 13) です。

<frequency>: 周波数 (Hz) を表す 10 進数 (923300000 ～ 927500000) です。

応答 : ok - パラメータが有効です。

invalid_param - パラメータが無効です。

このコマンドは、2 番目の受信ウィンドウに使うデータレートと周波数を設定します。受信ウィンドウのパラメータの設定はサーバの設定と一致している必要があります。

例 : mac set rx2 10 923300000 // Receive window 2 is configured with SF10/500 kHz data rate with a center frequency of 923 MHz.

2.4.8.16 mac set sync <syncWord><syncWord>: 同期ワードを表す 16 進数 (0x00 ～ 0xFF) です。

応答 : ok - <syncWord>が有効です。

invalid_param - <syncWord>が無効です。

このコマンドは、通信中に使う現在の同期ワードを設定します。

例 : mac set sync 34 // Sets the current synchronization word to 0x34.

2.4.8.17 mac set upctr <uplinkcounter><uplinkCounter>: アップリンクカウンタを表す 10 進数 (0 ～ 4294967295) です。

応答 : ok - <uplinkCounter>が有効です。

invalid_param - <uplinkCounter>が無効です。

このコマンドは、通信中に使う現在のアップリンクカウンタを設定します。これを使って、アップリンクカウンタを、サーバが保存した値に同期させる事ができます( パーソナライズによる有効化で必要なため )。例 : mac set upctr 22 // Sets the current uplink counter to 22

2.4.8.18 mac set dnctr <downlinkCounter><downlinkCounter>: ダウンリンクカウンタを表す10進数(0～4294967295)です。

応答 : ok - <downlinkCounter>が有効です。

invalid_param - <downlinkCounter>が無効です。

このコマンドは、通信中に使う現在のダウンリンクカウンタを設定します。これを使って、ダウンリンクカウンタを、サーバが保存した値に同期させる事ができます( パーソナライズによる有効化で必要なため )。例 : mac set dnctr 20 // Sets the current downlink counter to 20





2.4.8.19 MAC チャンネル設定コマンド

2.4.8.19.1 mac set ch drrange <channelID> <minRange> <maxRange><channelId>: チャンネル番号を表す 10 進数 (0 ～ 63) です。

<minRange>: 最小データレートを表す 10 進数 (0 ～ 3) です。

<maxRange>: 最大データレートを表す 10 進数 (0 ～ 3) です。



このコマンドは、指定された <channelId>の動作データレートレンジ (Min. ～ Max.)を設定します。このコマンドを発行する事で、モジュールは指定された <channelId>のデータレートを <minRange>と <maxRange>の間で変更できます。データレートの実際の値と対応する拡散率 (SF) は『LoRaWAN™ Specification』を参照してください。

例 : mac set ch drrange 13 0 2 // On channel 13 the data rate can range from 0 (SF10/125 kHz) to (SF8/125 kHz) as required.

2.4.8.19.2 mac set ch status <channel ID> <status><channelId>: チャンネル番号を表す 10 進数 (0 ～ 71) です。 <status>: onまたは offの状態を表す文字列値です。



このコマンドは、指定された <channelId>の動作の有無を設定します。例 : mac set ch status 4 off// Channel ID 4 is disabled from use.

表 2-7: MAC チャンネル設定コマンド


drrange モジュールの指定されたチャンネル ID の許容データレートレンジ (Min. ～Max.) を設定します。

status 指定されたチャンネル番号のチャンネルの使用の有無を設定します。

Note: mac saveコマンドを発行する事でユーザEEPROMに前もってこのパラメータを保存済みの場合、その値の変更後、mac saveコマンドを再度呼び出す必要があります。

Note: mac saveコマンドを発行する事でユーザEEPROMに前もってこのパラメータを保存済みの場合、その値の変更後、mac saveコマンドを再度呼び出す必要があります。



2.4.9 MAC 取得コマンド

表 2-8: MAC 取得コマンド


devaddr 指定されたエンドデバイスの、現在保存されている一意のネットワークデバイスアドレスを取得します。

deveui 指定されたエンドデバイスの、現在保存されているグローバルに一意の識別子を取得します。

appeui エンドデバイスのアプリケーション識別子を取得します。

dr 次の送信に使うデータレートを取得します。

pwridx 出力インデックス値を取得します。 adr デバイスの適応データレートの状態を取得します。

retx アップリンク確認必要パケットに使う再送信回数を取得します。

rxdelay1 rxdelay1として保存されている遅延値を取得します。

rxdelay2 rxdelay2として保存されている遅延値を取得します。

ar 自動返信の状態を取得します。

rx2 2 番目の受信ウィンドウに使うデータレートと周波数を取得します。 dcycleps サーバのみが設定できるデューティサイクルプリスケーラを取得します。 mrgn 直前のリンク確認回答フレームで受信した復調マージンを取得します。

gwnb 直前のリンク確認必要要求フレームで受信に成功したゲートウェイ数を取得します。

status RN2903 モジュールの現在の状態を取得します。 sync 現在の同期ワードを返します。

upctr 現在のアップリンクカウンタを返します。

dnctr 現在のダウンリンクカウンタを返します。

ch チャンネルの動作と挙動に関連するパラメータの情報を取得します。



2.4.9.1 mac get devaddr応答 : デバイスアドレスを表す 4 バイトの 16 進数 (00000000 ～ FFFFFFFF)このコマンドは、モジュールの現在のエンドデバイスアドレスを返します。既定値 : 00000000例 : mac get devaddr2.4.9.2 mac get deveui応答 : デバイス EUI を表す 8 バイトの 16 進数

このコマンドは、モジュールのグローバルに一意のデバイス識別子を設定します。既定値 : 0000000000000000例 : mac get deveui2.4.9.3 mac get appeui応答 : アプリケーション EUI を表す 8 バイトの 16 進数

このコマンドは、モジュールのアプリケーション識別子を返します。

アプリケーション識別子とは、ネットワークがデバイスに与える値です。既定値 : 0000000000000000例 : mac get appeui2.4.9.4 mac get dr応答 : 現在のデータレートを表す 10 進数

このコマンドは、現在のデータレートを返します。既定値 : 3例 : mac get dr2.4.9.5 mac get pwridx

応答 : 現在の出力インデックス値を表す10進数戻り値は以下の通りです。5, 7, 8, 9, 10このコマンドは、現在の出力インデックス値を返します。既定値 : 8例 : mac get pwridx

2.4.9.6 mac get adr

応答 : 適応データレート機能の状態を表す文字列 (onまたは off)このコマンドは、適応データレート機能の状態を返します。応答は、要求されたデバイスの ADR が onか offかを示します。

既定値 : off例 : mac get adr



2.4.9.7 mac get retx応答 : 再送信回数を表す 10 進数 (0 ～ 255)ダウンリンク応答が受信されない場合、確認要アップリンク通信のためにデバイスは再送信を試みます。このコマンドは、現在設定されている再送信回数を返します。既定値 : 7例 : mac get retx2.4.9.8 mac get rxdelay1

応答 : rxdelay1の遅延 (ms) を表す 10 進数 (0 ～ 65535)このコマンドは、rxdelay1の遅延 (ms) を返します。既定値 : 1000 例 : mac get rxdelay12.4.9.9 mac get rxdelay2

応答 : rxdelay2の遅延 (ms) を表す 10 進数 (0 ～ 65535)このコマンドは、rxdelay2の遅延 (ms) を返します。既定値 : 2000 例 : mac get rxdelay22.4.9.10 mac get ar

応答 : 自動返信の状態を表す文字列 (onまたは off)このコマンドは、自動返信 (AR) パラメータの現在の状態を返します。応答は、AR がonか offかを示します。

既定値 : off例 : mac get ar2.4.9.11 mac get rx2

応答 : 2 番目の受信ウィンドウのために設定した、データレートを表す 10 進数 (8 ～13) と周波数 (Hz) を表す 10 進数 (923300000 ～ 927500000)このコマンドは、2 番目の受信ウィンドウに使うように設定したデータレートと周波数を返します。既定値 : 8 923300000例 : mac get rx22.4.9.12 mac get dcycleps

応答 : プリスケーラ値を表す 10 進数 (0 ～ 65535)このコマンドはデューティサイクルプリスケーラを返します。プリスケーラの値は、デューティサイクル要求フレームを使ってサーバのみが設定できます。サーバからこのコマンドを受け取ると、全ての有効なチャンネルに対してデューティサイクルプリスケーラが変更されます。

既定値 : 1例 : mac get dcycleps



2.4.9.13 mac get mrgn

応答 : 復調マージンを表す 10 進数 (0 ～ 255)このコマンドは、直前のリンク確認回答フレームで受信した復調マージンを返します。これらの値の説明は『LoRaWAN™ Specification』を参照してください。

既定値 : 255例 : mac get mrgn2.4.9.14 mac get gwnb

応答 : ゲートウェイ数を表す 10 進数 (0 ～ 255)このコマンドは、直前のリンク確認回答で受信した、直前のリンク確認必要要求フレームコマンドの受信に成功したゲートウェイ数を返します。既定値 : 0例 : mac get gwnb2.4.9.15 mac get status

応答 : モジュールの現在のステータスを表す 2 バイトの 16 進数

このコマンドは、モジュールの現在のステータスを返します。戻り値は 16 進形式のビットマスクです。このビットマスクの意味は図 2-1 を参照してください。

既定値 : 0000例 : mac get status2.4.9.16 mac get sync

応答 : 現在の同期ワードを表す 16 進数 (0x00 ～ 0xFF)このコマンドは現在の同期ワードを返します。

既定値 : 34例 : mac get sync



図 2-1: MAC ステータスビットマップレジスタ (1)

2.4.9.17 mac get upctr応答 : アップリンクカウンタを表す 10 進数 (0 ～ 4294967295)このコマンドは、モジュールの現在のアップリンクカウンタを返します。

既定値 : 0例 : mac get upctr // Returns the current uplink counter

2.4.9.18 mac get dnctr 応答 : ダウンリンクカウンタを表す 10 進数 (0 ～ 4294967295)このコマンドは、モジュールの現在のダウンリンクカウンタを返します。

既定値 : 0例 : mac get dnctr // Returns the current downlink counter

015 14 13 12 11 10 123456789

参加ステータス (「0」 – ネットワークに参加していない、

MAC の状態 (2)

自動返信ステータス (「0」 – 無効、「1」 – 有効 )

ADR ステータス (「0」 – ADR は無効、「1」 – ADR は有効 )

即時サイレントステータス (「0」 – 無効、「1」 – 有効 )

MAC 一時停止ステータス (「0」 – MAC は一時停止していない、

RFU

リンク確認ステータス (「0」 – リンク確認は無効、「1」 – リンク確認は有効 )

チャンネルの更新 (「0」 – 更新されていない、「1」 – NewChannelReq MAC コマンドで更新されている )

出力電力の更新 (「0」 – 更新されていない、「1」 – LinkADRReq MAC コマンドで更新されている )

NbRep の更新 (「0」 – 更新されていない、「1」 – LinkADRReq MAC コマンドで更新されている )

プリスケーラの更新 (「0」 – 更新されていない、「1」 – DutyCycleReq MAC コマンドで更新されている )

2 番目の受信ウィンドウのパラメータの更新 (「0」 – 更新されていない、「1」 – RX ParamSetupReq コマンドで

TX タイミング設定の更新 (「0」 – 更新されていない、「1」 – RX TimingSetupReq MAC コマンドで更新されている )

Note 1: bit 10( チャンネルの更新 )、11( 出力電力の更新 )、12 (NbRep の更新 )、13( プリスケーラの更新 )、14 (2 番目の受信ウィンドウのパラメータの更新 )、15 (TX タイミング設定の更新 ) は「mac getstatus」コマンド発行後クリアされます。

2: MAC の状態 :0 – アイドル ( 送信可能 ) です。

1 – 送信中です。

2 – 受信ウィンドウ 1 が開いていません。

3 – 受信ウィンドウ 1 が開いています。

4 – 受信ウィンドウ 1 は閉じました。しかし、受信ウィンドウ 2 はまだ開いていません。

5 – 受信ウィンドウ 2 が開いています。

6 – Ack_timeout です (Ack_timeout の詳細は『LoRaWAN™ Specification』参照 )。

3: NbRep は、確認不要パケットの繰り返し回数です ( 詳細は『LoRaWAN™ Specification』参照 )。

「1」 – ネットワークに参加している )

「1」 – MAC は一時停止している )

更新されている )



2.4.9.19 MAC チャンネル取得コマンド

2.4.9.19.1 mac get ch freq <ChannelId><channelId>: チャンネル番号を表す 10 進数 (0 ～ 71) です。

応答 : チャンネルの周波数 (Hz) を表す 10 進数 (923300000 ～ 914900000)このコマンドは、要求された <channelId>の周波数を 10 進値で返します。

既定値 : 表 2-10 参照

例 : mac get ch freq 02.4.9.19.2 mac get ch drrange <channelId><channelId>: チャンネル番号を表す 10 進数 (0 ～ 71) です。

応答 : 指定されたチャンネルの最小データレートを表す 10 進数 (0 ～ 4) と、指定されたチャンネルの最大データレートを表す 10 進数 (0 ～ 4)このコマンドは、要求された <channelId>の 10 進形式のデータレートインデックスの許容レンジを返します。<minRate> と <maxRate> の値は 10 進形式で返され、インデックス値を示します。データレートの説明と対応する拡散率は『LoRaWAN™Specification』を参照してください。


例 : mac get ch drrange 02.4.9.19.3 mac get ch status <channelId><channelId>: チャンネル番号を表す 10 進数 (0 ～ 71) です。

応答 : チャンネルの状態を表す文字列 (onまたは off)このコマンドは、<channelId> が現在有効化されているかどうかを返します。<channelId>は 10 進形式で入力されており、応答は on( チャンネルは有効 ) またはoff( チャンネルは無効 ) です。


例 : mac get ch status 2

表 2-9: MAC チャンネル取得コマンド


freq モジュールの指定されたチャンネル ID の動作周波数を取得します。 drrange モジュールの指定されたチャンネル ID に許された有効なデータレートレンジ

(Min. ～ Max.) を取得します。

status 指定されたチャンネル ID が有効化されているかどうかを示すステータスを取得します。

表 2-10: チャンネルの既定値のパラメータ

チャンネル番号パラメータ既定値

チャンネル 0 ～ 63 周波数 (Hz) 902300000 + 200000 * channelIndexデータレートレンジ(Min. ～ Max.)

0 ～ 3

ステータス ONチャンネル 64 ～ 71 周波数 (Hz) 903000000 + 1600000 * channelIndex

データレートレンジ(Min. ～ Max.)

4 ～ 4

ステータス ON



2.5 無線コマンド

表 2-11: 無線コマンド (1)


rx このコマンドは、事前の設定に従って基本的な無線パケットを受信するように無線部を設定します。

tx このコマンドは、事前の設定に従って基本的な無線パケット転送を設定します。

cw このコマンドは、システムの調整または認証のためにモジュールを連続波(CW) モードに移行させます。

set このコマンドを使うと、無線設定を直接変更できます。このコマンドを使うと、モジュールのタイプによる帯域の制限内で無線動作の方法を変更できます。

get このコマンドを使うと、現在設定されている無線設定を読み出す事ができます。

Note 1: mac pauseコマンドは、まだ MAC 動作が開始していない場合でも、全ての無線

送受信の前に呼び出す必要があります。

表 2-12: 各種動作の無線パラメータの有無

コマンド無線取得無線設定LoRa™ 変調向けの

パラメータFSK 変調向けの

パラメータ

bt √ √ — √mod √ √ √ √freq √ √ √ √pwr √ √ √ √sf √ √ √ —afcbw √ √ — √rxbw √ √ — √bitrate √ √ — √fdev √ √ — √prlen √ √ — √crc √ √ √ √iqi √ √ √ —cr √ √ √ —wdt √ √ √ √sync √ √ √ √bw √ √ √ —snr √ — √ —



2.5.1 radio rx <rxWindowSize>

<rxWindowSize>: LoRa変調のシンボル数、またはFSK変調のレシーバのタイムアウト(ms) を表す 10 進数 (0 ～ 65535) です。連続受信モードを有効にするには、<rxWindowSize> を「0」に設定します。有効なパケットを受信すると、連続受信モードは終了します。

応答 : このコマンドは 2 つの応答を返す場合があります。最初の応答は、コマンドを入力した直後に返されます。コマンドが有効な場合 (okの応答を受信した場合 )、2 番目の応答は、パケット受信後またはタイムアウト発生後に返されます。


• ok – パラメータが有効で、かつトランシーバが受信モードに設定されています。

• invalid_param – パラメータが無効です。

• busy – トランシーバがビジー状態です。受信プロセス後の応答は以下の通りです。

• radio_rx <data>> – 受信に成功しました (<data>: 受信した 16 進値 )。• radio_err – 受信に失敗し、受信タイムアウトが発生しました。

例 : radio rx 0 // Puts the radio into continuous Receive mode.

2.5.2 radio tx <data><data>:送信するデータを表す16進値(LoRa変調: 0～255バイト、FSK変調: 0～64バイト ) です。

応答 : このコマンドは 2 つの応答を返す場合があります。最初の応答は、コマンドを入力した直後に返されます。コマンドが有効な場合 (okの応答を受信した場合 )、2 番目の応答は有効な送信後に返されます。


• ok – パラメータが有効で、かつトランシーバが送信モードに設定されています。

• invalid_param – パラメータが無効です。

• busy – トランシーバがビジー状態です。

有効な送信後の応答は以下の通りです。

• radio_tx_ok – 送信に成功しました。

• radio_err – 送信に失敗しました ( 無線ウォッチドッグタイマのタイムアウトで割り込まれました )。

このコマンドは、送信に成功した <data>を転送します。例 : radio tx 48656c6C6F // Transmits a packet of

[0x48][0x65][0x6c][0x6C][0x6F]; Hello.

Note: 無線ウォッチドッグタイマのタイムアウトが受信ウィンドウサイズより長い事を確認します。

Note: mac pauseコマンドは、まだ MAC 動作が開始していない場合でも、全ての無線送受信の前に呼び出す必要があります。

Note: mac pauseコマンドは、まだ MAC 動作が開始していない場合でも、全ての無線送受信の前に呼び出す必要があります。



2.5.3 radio cw <state>

<state>: 連続波 (CW) モードの状態を表す文字列 (onまたは off) です。

応答 : ok - 状態は onです。

RN2903 X.Y.Z MMM DD YYYY HH:MM:SS (X.Y.Z はファームウェアのバージョン、MMM は月、DD は日、HH:MM:SS は時、分、秒です。フォーマット : [ ハードウェア ] [ ファームウェア ] [ 日付 ] [ 時間 ])。状態が offの場合、[ 日付 ] と [ 時間 ] は、ファームウェアのリリースを示します。


このコマンドは、モジュールの CW モードを有効 (on) または無効 (off) にします。CWモードにすると、トランシーバを送信モードに移行させる事で、生成した信号を観察できます。無線設定を変更すると、送信レベルの変化を観察できます。

例 : radio cw on

2.5.4 無線設定コマンド

2.5.4.1 radio set bt <gfBT>

<gfBT>: GFSK 変調を可能にする正規分布ベースバンドデータシェーピングを表す文字列です。パラメータ値は以下の通りです。none, 1.0, 0.5, 0.3応答 : ok - データシェーピングが有効です。

invalid_param - データシェーピングが無効です。

このコマンドは、FSK 送信に適用するデータシェーピングを変更します。none以外の任意の <gfBT>を入力すると、FSK モードの送信に正規分布フィルタ BT が適用されます。例 : radio set bt none // Data shaping in FSK mode is disabled or null.

Note: radio cw offは sys resetと同じ意味であるため、このコマンドを使うとモジュールがリセットされる事に注意が必要です。

表 2-13: 無線設定コマンド


bt 周波数シフトキーイング (FSK) 変調のタイプとしてデータシェーピングを設定します。

mod モジュールの変調モードを設定します。 freq 無線の現在の動作周波数を設定します。

pwr 送信中に無線が使う出力電力レベルを設定します。

sf 送信中に使う要求拡散率 (SF) を設定します。 afcbw 自動周波数補正帯域幅で使う値を設定します。 rxbw 受信帯域幅を設定します。

bitrate 周波数シフトキーイング (FSK) のビットレートを設定します。 fdev エンドデバイスが許容する周波数偏差を設定します。

prlen 送信中に使うプリアンブル長を設定します。 crc CRC ヘッダの使用有無を設定します。 iqi IQ 反転の使用有無を設定します。 cr 無線が使うコーディングレートを設定します。

wdt 無線ウォッチドッグタイマのタイムアウト制限を設定します。

sync 使用する同期ワードを設定します。 bw 無線帯域幅として使う値を設定します。



2.5.4.2 radio set mod <mode>

<mode>: 変調方法を表す文字列 (loraまたは fsk) です。

応答 : ok - 変調が有効です。

invalid_param - 変調が無効です。

このコマンドは、モジュールが使う変調方法を変更します。動作モードの変更は、設定済みのパラメータ、変数、レジスタには影響しません。データシェーピングが有効な場合、FSK モードでも GFSK 送信が可能です。

例 : radio set mod lora2.5.4.3 radio set freq <frequency><frequency>: 周波数 (Hz) を表す 10 進数 (902000000 ～ 928000000) です。

応答 : ok - 周波数が有効です。

invalid_param – 周波数が無効です。

このコマンドは、無線トランシーバの通信周波数を変更します。

例 : radio set freq 9233000002.5.4.4 radio set pwr <pwrout><pwrOut>: トランシーバの出力電力を表す符号付き 10 進数 (2 ～ 20) です。

応答 : ok - 出力電力が有効です。

invalid_param - 出力電力が無効です。

このコマンドは、トランシーバの出力電力を変更します。規制基準を超えて出力電力を設定する事もできます。この出力設定を使う事で、ケーブルまたは伝送線路の損失を補償できます。出力の詳細は RN2903 データシート『Low-Power Long RangeLoRa™ Technology Transceiver Module』(DS50002390) を参照してください。

実際の無線出力レンジは 2 ～ 17 dBm または 2 ～ 20 dBm です。

例 : radio set pwr 142.5.4.5 radio set sf <spreadingFactor><spreadingFactor>: 拡散率を表す文字列です。パラメータ値は以下の通りです。

sf7, sf8, sf9, sf10, sf11, sf12応答 : ok - 拡散率が有効です。

invalid_param - 拡散率が無効です。

このコマンドは、送信中に使う拡散率を設定します。

例 : radio set sf sf72.5.4.6 radio set afcbw <autoFreqBand>

<autoFreqBand>: 自動周波数補正 (kHz) を表す浮動小数点数です。パラメータ値は以下の通りです。250, 125, 62.5, 31.3, 15.6, 7.8, 3.9, 200, 100,50, 25, 12.5, 6.3, 3.1, 166.7, 83.3, 41.7, 20.8, 10.4, 5.2, 2.6

応答 : ok - 自動周波数補正が有効です。

invalid_param - 自動周波数補正が無効です。

このコマンドは、送受信の自動周波数補正の帯域幅を変更します。例 : radio set afcbw 125



2.5.4.7 radio set rxbw <rxBandwidth>

<rxBandwidth>: 信号帯域幅 (kHz)を表す浮動小数値です。パラメータ値は以下の通りです。250, 125, 62.5, 31.3, 15.6, 7.8, 3.9, 200, 100, 50, 25, 12.5,6.3, 3.1, 166.7, 83.3, 41.7, 20.8, 10.4, 5.2, 2.6

応答 : ok - 信号帯域幅が有効です。

invalid_param - 信号帯域幅が無効です。

このコマンドは、受信の信号帯域幅を設定します。

例 : radio set rxbw 250 // Signal bandwidth for receiving is 250 kHz.

2.5.4.8 radio set bitrate <fskBitrate><fskBitRate>: FSK ビットレート値を表す 10 進数 (1 ～ 300000) です。

応答 : ok - ビットレートが有効です。

invalid_param - ビットレートが無効です。

このコマンドは、FSK ビットレート値を設定します。

例 : radio set bitrate 5000 // FSK bit rate is set to 5 kb/s.

2.5.4.9 radio set fdev <freqDev>

<freqDev>: 周波数偏差を表す 10 進数 (0 ～ 200000) です。

応答 : ok - 周波数偏差が有効です。

invalid_param - 周波数偏差が無効です。

このコマンドは、動作中の周波数偏差を設定します。

例 : radio set fdev 5000 // Frequency deviation is 5 kHz.

2.5.4.10 radio set prlen <preamble>

<preamble>: プリアンブル長を表す 10 進数 (0 ～ 65535) です。

応答 : ok - プリアンブル長が有効です。

invalid_param - プリアンブル長が無効です。

このコマンドは、送受信のプリアンブル長を設定します。

例 : radio set prlen 8 // Preamble length is 8.

2.5.4.11 radio set crc < crcHeader >

<crcHeader>: CRC ヘッダの状態を表す文字列 (onまたは off) です。



このコマンドは、通信の CRC ヘッダを有効または無効にします。

例 : radio set crc on // Enables the CRC header.

2.5.4.12 radio set iqi <iqInvert>

<iqInvert>: IQ 反転の状態を表す文字列 (onまたは off) です。



このコマンドは、通信の IQ 反転を有効または無効にします。

例 : radio set iqi on // Invert IQ is enabled.



2.5.4.13 radio set cr <codingRate>

<codingRate>: コーディングレートを表す文字列です。パラメータ値は以下の通りです。4/5, 4/6, 4/7, 4/8応答 : ok - コーディングレートが有効です。

invalid_param - コーディングレートが無効です。

現在無線が使っているコーディングレートを変更します。

例 : radio set cr 4/7 // The coding rate is set to 4/7.

2.5.4.14 radio set wdt <watchDog><watchDog>: ウォッチドッグタイマのタイムアウト時間を表す 10 進数 (0 ～

4294967295) です。この機能は無効にするには「0」に設定します。

応答 : ok - ウォッチドッグタイマのタイムアウト時間が有効です。

invalid_param - ウォッチドッグタイマのタイムアウト時間が無効です。

このコマンドは、無線ウォッチドッグタイマのタイムアウト時間 (ms) を更新します。この機能が有効な場合、トランシーバの送受信のたびにウォッチドッグタイマが開始します。実行中の動作が完了すると、ウォッチドッグタイマは停止します。

例 : radio set wdt 2000 // The Watchdog Timer is configured for 2000 ms.

2.5.4.15 radio set sync <syncWord>

<syncWord>: 通信中の同期ワードを表す16進数です。LoRa変調には1バイトを使います。FSK 変調には最大 8 バイトを入力できます。

応答 : ok - 同期ワードが有効です。

invalid_param - 同期ワードが無効です。

このコマンドは、通信中に使う同期ワードを設定します。例 : radio set sync 12 // LoRa modulation in use.

2.5.4.16 radio set bw <bandWidth>

<bandWidth>: 動作無線帯域幅(kHz)を表す10進数です。パラメータ値は以下の通りです。125, 250, 500

応答 : ok - 帯域幅が有効です。

invalid_param - 帯域幅が無効です。

このコマンドは、LoRa 動作の動作無線帯域幅を設定します。

例 : radio set bw 250 // The operating bandwidth is 250 kHz.

Note: ウォッチドッグタイマ向けに設定した値が無線設定と一致している事を確認します。例えば、無線連続受信中にこの機能を無効にするには、<watchDog>値を「0」に設定します。



2.5.5 無線取得コマンド

2.5.5.1 radio get bt

応答 : データシェーピングの設定を表す文字列パラメータ値は以下の通りです。none, 1.0, 0.5, 0.3このコマンドは、FSK 送信に適用するデータシェーピングの現在の設定を読み出します。

既定値 : 0.5例 : radio get bt // Reads the current data shaping FSK

configuration.

2.5.5.2 radio get mod

応答 : モジュールの現在の動作モードを表す文字列 (loraまたは fsk)このコマンドは、モジュールの現在の動作モードを読み出します。

既定値 : lora例 : radio get mod // Reads if module is modulating in LoRa or

FSK.

2.5.5.3 radio get freq

応答 : 周波数 (Hz) を表す 10 進数 (902000000 ～ 928000000)このコマンドは、モジュールの現在の動作周波数を読み出します。

既定値 : 923300000例 : radio get freq // Reads back the current frequency the

transceiver communicates on.

表 2-14: 無線取得コマンド


bt 周波数シフトキーイング (FSK) 変調のタイプとしてデータシェーピングを取得します。

mod モジュールの変調モードを取得します。 freq 無線の現在の動作周波数を取得します。

pwr 送信中に無線が使う出力電力レベルを取得します。

sf 送信中に使う要求拡散率 (SF) を取得します。 afcbw 自動周波数補正帯域幅で使う値を取得します。 rxbw 受信信号帯域幅を取得します。

bitrate 周波数シフトキーイング (FSK) のビットレートを取得します。 fdev エンドデバイスが許容する周波数偏差を取得します。

prlen 送信中に使うプリアンブル長を取得します。 crc CRC ヘッダの使用有無を取得します。 iqi IQ 反転の使用有無を取得します。 cr 無線が使うコーディングレートを取得します。

wdt ウォッチドッグタイマのタイムアウト制限を取得します。

bw 無線帯域幅として使う値を取得します。

snr 直前の受信パケットの信号 / ノイズ比 (SNR) を取得します。 sync 無線の現在の同期ワードを返します。



2.5.5.4 radio get pwr

応答 : 現在の出力電力レベルを表す符号付き 10 進数 (2 ～ 20)このコマンドは、現在の動作時出力電力レベル設定を読み出します。

既定値 : 2例 : radio get pwr // Reads back the current transmit output

power.

2.5.5.5 radio get sf

応答 : 現在の拡散率を表す文字列

このコマンドは、トランシーバが使う現在の拡散率を読み出します。パラメータ値は以下の通りです。sf7, sf8, sf9, sf10, sf11, sf12既定値 : sf12例 : radio get sf // Reads back the current spreading factor

settings.

2.5.5.6 radio get afcbw

応答 : 自動周波数補正帯域 (kHz)を表す浮動小数点数パラメータ値は以下の通りです。250, 125, 62.5, 31.3, 15.6, 7.8, 3.9, 200, 100, 50, 25, 12.5, 6.3, 3.1, 166.7, 83.3, 41.7,20.8, 10.4, 5.2, 2.6

このコマンドは、自動周波数補正帯域幅のステータスを読み出します。

既定値 : 41.7例 : radio get afcbw // Reads back the current automatic

frequency correction bandwidth.

2.5.5.7 radio get rxbw

応答 : 信号帯域幅 (kHz)を表す浮動小数点数パラメータ値は以下の通りです。250, 125,62.5, 31.3, 15.6, 7.8, 3.9, 200, 100, 50, 25, 12.5, 6.3, 3.1, 166.7, 83.3, 41.7, 20.8, 10.4,5.2, 2.6

このコマンドは、受信信号帯域幅を読み出します。

既定値 : 25例 : radio get rxbw // Reads back the receive signal bandwidth.

2.5.5.8 radio get bitrate

応答 : 設定済みのビットレートを表す符号付き 10 進数 (1 ～ 300000)このコマンドは、FSK 通信の設定済みのビットレートを読み出します。

既定値 : 50000例 : radio get bitrate // Reads back the current FSK bit rate

setting.

2.5.5.9 radio get fdev応答 : 周波数偏差設定を表す符号付き 10 進数 (0 ～ 200000)このコマンドは、トランシーバの周波数偏差設定を読み出します。

既定値 : 25000例 : radio get fdev // Reads back current configured frequency

deviation setting.



2.5.5.10 radio get prlen

応答 : プリアンブル長を表す符号付き 10 進数 (0 ～ 65535)このコマンドは、通信に使う現在のプリアンブル長を読み出します。

既定値 : 8例 : radio get prlen // Reads back the preamble length used by

the transceiver.

2.5.5.11 radio get crc

応答 : CRC ヘッダの状態を表す文字列 (onまたは off)このコマンドは、CRC ヘッダの状態を読み出します。これにより動作中の CRC ヘッダの有無を判断できます。

既定値 : on例 : radio get crc // Reads back if the CRC header is enabled

for use.

2.5.5.12 radio get iqi応答 : IQ 反転機能のステータスを表す文字列 (onまたは off)このコマンドは、IQ 反転機能のステータスを読み出します。

既定値 : off例 : radio get iqi // Reads back the status of the Invert IQ

functionality.

2.5.5.13 radio get cr

応答 : コーディングレートに使う現在の値の設定を表す文字列パラメータ値は以下の通りです。4/5, 4/6, 4/7, 4/8 このコマンドは、通信中のコーディングレートに使う現在の値の設定を読み出します。

既定値 : 4/5例 : radio get cr // Reads back the current coding rate

transceiver settings.

2.5.5.14 radio get wdt

応答 : ウォッチドッグタイマのタイムアウト時間を表す 10 進数 (0 ～ 4294967295)このコマンドは、ウォッチドッグタイマのタイムアウト時間 (ms) を読み出します。

既定値 : 15000例 : radio get wdt // Reads back the current time-out value

applied to the Watchdog Timer

2.5.5.15 radio get bw

応答 : 現在の動作無線帯域幅 (kHz) を表す 10 進数パラメータ値は以下の通りです。125, 250, 500

このコマンドは、トランシーバが使う現在の動作無線帯域幅を読み出します。

既定値 : 125例 : radio get bw // Reads back the current operational

bandwidth applied to transmissions.



2.5.5.16 radio get snr

応答 : 信号 / ノイズ比 (SNR) を表す符号付き 10 進数 (-128 ～ 127)このコマンドは、直前の受信パケットの信号 / ノイズ比 (SNR) を読み出します。

既定値 : -128例 : radio get snr // Reads back the measured SNR for the

previously packet reception.

2.5.5.17 radio get sync

応答 : 同期ワードを表す最大 8 バイトの 16 進数このコマンドは、無線の現在の同期ワードを読み出します。同期ワードは、radioset mod <mode>コマンドで設定した変調方法で決まります。

既定値 : 34例 : radio get sync // Reads back the current synchronization

word.



NOTE:




補遺 A 現在のファームウェア機能と修正点

RN2903 のファームウェアの最新版は Microchip 社ウェブページ

(www.microchip.com/lora) で提供しています。

A.1. バージョン未定

本ファームウェアは最初のリリースです。


http://www.microchip.com/pagehandler/en-us/technology/personalareanetworks/technology/lora.html

http://www.microchip.com/pagehandler/en-us/technology/personalareanetworks/technology/lora.html


NOTE:



北米本社2355 West Chandler Blvd.Chandler, AZ 85224-6199Tel: 480-792-7200 Fax: 480-792-7277技術サポート : http://www.microchip.com/supportURL: www.microchip.comアトランタDuluth, GA Tel: 678-957-9614 Fax: 678-957-1455オースティン、TXTel: 512-257-3370 ボストンWestborough, MATel: 774-760-0087 Fax: 774-760-0088シカゴItasca, ILTel: 630-285-0071 Fax: 630-285-0075クリーブランドIndependence, OHTel: 216-447-0464Fax: 216-447-0643ダラスAddison, TXTel: 972-818-7423 Fax: 972-818-2924デトロイトNovi, MI Tel: 248-848-4000ヒューストン、TXTel: 281-894-5983インディアナポリスNoblesville, INTel: 317-773-8323Fax: 317-773-5453ロサンゼルスMission Viejo, CATel: 949-462-9523 Fax: 949-462-9608ニューヨーク、NY Tel: 631-435-6000サンノゼ、CATel: 408-735-9110カナダ - トロント

Tel: 905-673-0699 Fax: 905-673-6509

アジア / 太平洋アジア太平洋支社Suites 3707-14, 37th FloorTower 6, The GatewayHarbour City, KowloonHong KongTel: 852-2943-5100Fax: 852-2401-3431オーストラリア - シドニー

Tel: 61-2-9868-6733Fax: 61-2-9868-6755中国 - 北京

Tel: 86-10-8569-7000Fax: 86-10-8528-2104中国 - 成都

Tel: 86-28-8665-5511Fax: 86-28-8665-7889中国 - 重慶

Tel: 86-23-8980-9588Fax: 86-23-8980-9500中国 - 東莞

Tel: 86-769-8702-9880中国 - 杭州

Tel: 86-571-8792-8115Fax: 86-571-8792-8116中国 - 香港 SARTel: 852-2943-5100 Fax: 852-2401-3431中国 - 南京

Tel: 86-25-8473-2460Fax: 86-25-8473-2470中国 - 青島

Tel: 86-532-8502-7355Fax: 86-532-8502-7205中国 - 上海

Tel: 86-21-5407-5533Fax: 86-21-5407-5066中国 - 瀋陽

Tel: 86-24-2334-2829Fax: 86-24-2334-2393中国 - 深圳

Tel: 86-755-8864-2200 Fax: 86-755-8203-1760中国 - 武漢

Tel: 86-27-5980-5300Fax: 86-27-5980-5118中国 - 西安

Tel: 86-29-8833-7252Fax: 86-29-8833-7256

アジア / 太平洋中国 - 厦門

Tel: 86-592-2388138 Fax: 86-592-2388130中国 - 珠海

Tel: 86-756-3210040 Fax: 86-756-3210049インド - バンガロール

Tel: 91-80-3090-4444 Fax: 91-80-3090-4123インド - ニューデリー

Tel: 91-11-4160-8631Fax: 91-11-4160-8632インド - プネ

Tel: 91-20-3019-1500日本 - 大阪

Tel: 81-6-6152-7160Fax: 81-6-6152-9310日本 - 東京

Tel: 81-3-6880-3770 Fax: 81-3-6880-3771韓国 - 大邱

Tel: 82-53-744-4301Fax: 82-53-744-4302韓国 - ソウル

Tel: 82-2-554-7200Fax: 82-2-558-5932 または

82-2-558-5934マレーシア - クアラルンプール

Tel: 60-3-6201-9857Fax: 60-3-6201-9859マレーシア - ペナン

Tel: 60-4-227-8870Fax: 60-4-227-4068フィリピン - マニラ

Tel: 63-2-634-9065Fax: 63-2-634-9069シンガポールTel: 65-6334-8870Fax: 65-6334-8850台湾 - 新竹

Tel: 886-3-5778-366Fax: 886-3-5770-955台湾 - 高雄

Tel: 886-7-213-7830台湾 - 台北

Tel: 886-2-2508-8600 Fax: 886-2-2508-0102タイ - バンコク

Tel: 66-2-694-1351Fax: 66-2-694-1350

ヨーロッパオーストリア - ヴェルス

Tel: 43-7242-2244-39Fax: 43-7242-2244-393デンマーク - コペンハーゲン

Tel: 45-4450-2828 Fax: 45-4485-2829フランス - パリ

Tel: 33-1-69-53-63-20 Fax: 33-1-69-30-90-79ドイツ - デュッセルドルフ

Tel: 49-2129-3766400 ドイツ - カールスルーエ

Tel: 49-721-625370ドイツ - ミュンヘン

Tel: 49-89-627-144-0 Fax: 49-89-627-144-44イタリア - ミラノ Tel: 39-0331-742611 Fax: 39-0331-466781イタリア - ヴェニス

Tel: 39-049-7625286 オランダ - ドリューネン

Tel: 31-416-690399 Fax: 31-416-690340ポーランド - ワルシャワ

Tel: 48-22-3325737 スペイン - マドリッド

Tel: 34-91-708-08-90Fax: 34-91-708-08-91スウェーデン - ストックホルム

Tel: 46-8-5090-4654イギリス - ウォーキンガム

Tel: 44-118-921-5800Fax: 44-118-921-5820

各国の営業所とサービス

07/14/15



rn2903 lora™ モジュール コマンド リファレンス...

Documents

rn2903 lora™ モジュールコマンドリファレンス...