node rfm9x

導入

node.jsモジュールrfm9x loraワイヤレスモジュールとのインターフェース。 Adafruit Radio Bonnetsで使用することを目的としています。

このコードはRaspberry PIでのみテストされていますが、技術的にはOnoffおよびSPI-Deviceによってサポートされている他のボードでも動作する可能性があります。

謝辞

• CircuitPython RFM9Xモジュールは、ほとんどのロジックのテンプレートとして使用されました。
• FivdiによるSPI-DeviceおよびOnoffモジュールは、ハードウェアとのインターフェースを非常に簡単にしました。

例

データの受信と送信の簡単な例についてはexample/pingpong.js参照してください。

API

モジュールは、単一のクラスRFM9xをエクスポートします。

クラスRFM9x

LORAモジュールを表すクラス。コンストラクターには引数は必要ありません。

 const rfm9x = require ( 'rfm9x' ) ;
const module = new rfm9x ( ) ;

await module . init ( { ... } ) ;

---

プロパティ

• debug - 出力SPIデバッグ情報

debug

このプロパティをtrueに設定して、すべてのSPI通信をコンソールに印刷します。

注： console.log()呼び出しはほとんどの状況で同期しているため、タイミングに影響を与える可能性があります。たとえば、他のノードからの応答を見逃すのに十分なほど遅くなるように、送信から受信モードへの切り替えを引き起こす可能性があります。

---

方法

• init(options) - モジュールとLORAの設定を初期化します
• startReceive() - loraモジュールを受信モードにし、 receiveイベントを有効にします
• stopReceive() - ロラモジュールをスタンバイモードにして、パケットの受信を停止します
• send(payload) - lora経由でパケットを送信します
• getVersion() - モジュールからチップバージョン番号を取得します

init(options)

• options - オプションオブジェクト（以下を参照）。すべてのプロパティはオプションであり、省略するとデフォルト値が使用されます。

モジュールとLORAの設定を初期化します。いずれかの無線関数を使用する前に、呼び出す必要があります。

価値なしに解決する約束を返します。

次のオプションがサポートされています。

• frequencyMhz MHzの基本周波数、デフォルト： 915
• preambleLength -LORAプリアンブル長のバイト、デフォルト： 8
• bandwidthHz -HzのLora帯域幅、デフォルト： 500000
• codingRate -LORAコーディングレート、有効な値は5 （4/5）から8 （4/8）、デフォルト： 5
• spreadingFactor -lora spreading係数、有効な値12 6 、デフォルト： 7
• enableCrcChecking着信パケットでCRCチェックを有効にするかどうか、デフォルト： false
• txPowerDb -DBの送信機電源、有効な値は5 23 （現在は高出力モードのみがサポートされています）、デフォルト： 23
• enableAgc自動ゲイン制御を有効にするかどうか、デフォルト： false
• resetPin -rfm9xリセットラインが接続されているgpioピンの数、デフォルト： 25
• dio0Pin -rfm9x dio0ラインが接続されているgpioピンの数、デフォルト： 22
• dio1Pin現在使用されていません。 RFM9X DIO1ラインが接続されているGPIOピンの数、デフォルト： 23
• dio2Pin現在使用されていません。 RFM9X DIO2ラインが接続されているGPIOピンの数、デフォルト： 24
• spiSpeedHz -HzでのSPI通信の速度、デフォルト： 100000
• txTimeoutMsパケット送信が終了するのを待つためのミリ秒単位での最大時間、デフォルト： 2000

startReceive()

LORAモジュールを受信モードに配置し、 receiveイベントを有効にします。

価値なしに解決する約束を返します。

stopReceive()

LORAモジュールをスタンバイモードにして、パケットの受信を停止します。

価値なしに解決する約束を返します。

send(payload)

• payload - 最大255バイトのBuffer

Lora経由でパケットを送信します。

トランスミッションが終了した後、値なしで解決する約束を返します。

注：パケットを送信した後、モジュールは自動的にスタンバイモードに切り替わります。送信後にパケットを受信し続ける場合は、送信が完了したらstartReceive()に電話する必要があります。

getVersion()

モジュールからチップバージョン番号を取得します。

バージョン番号（1バイト整数）で解決する約束を返します。

---

イベント

• receive(packet) - ロラパケットが受信されたときに放出されます
• receiveError() - 無効なLoraパケットが受信されたときに放出されます

receive(packet)

Loraパケットを受信したときに放出されるイベント。

packetは、次のプロパティを含むオブジェクトです。

• payload - パケットコンテンツを含むBuffer
• rssiDb -dbのパケットのrssi
• snrDb -DBのパケットのSNR

receiveError()

ロラパケットを受信したときに放出されるが、エラーを受信したため廃棄されたイベント（例えば、CRCチェックが失敗しました）。