RAK811 Python 3ライブラリとコマンドラインインターフェイスは、Raspberry Pi Lora(P)Hatで使用しています。
ライブラリは、次のドキュメントで説明されているように、コマンドでRAK811モジュールを公開します。
コマンドラインインターフェイスは、すべてのAPI呼び出しをコマンドラインに公開します。
raspi-configを使用)dialoutおよびgpioグループにある必要があります(これはpiユーザーのデフォルトです) パッケージはPypiからインストールされています。
sudo pip3 install rak811 pip3コマンドはpython3-pipパッケージの一部です。システムに欠落している場合は、実行してください。
sudo apt-get install python3-pipPisupplyは、Raspberry Piを構成するための詳細な指示を提供します。
モジュールのファームウェアレベルがわからない場合は、次のコマンドを実行します。
rak811 hard-reset
rak811 version v2.0.xファームウェアの場合、 rak811コマンドとpythonモジュールを使用し、v3.0.xにはrak811v3コマンドとrak811_v3 pythonモジュールを使用します。
RAK811モジュール(デバイスEUI)の一意のIDを使用して、デバイスを登録します。
次のコマンド(v2.0.x)でデバイスEUIを取得できます。
rak811 hard-reset
rak811 get-config dev_eui注: rak811 hard-resetコマンドは、モジュールをアクティブにするためにRaspberry Piを起動した後に1回だけ必要です。
または(v3.0.x):
rak811v3 set-config lora:join_mode:0
rak811v3 get-config lora:status | grep DevEui次のPythonコードスニペットとの最初のロラワンメッセージを送信してください。
(アプリEUIとアプリのキーは、TTNコンソールから逐語的にコピーされます)
#!/usr/bin/env python3
# V2.0.x firmware
from rak811 . rak811 import Mode , Rak811
lora = Rak811 ()
lora . hard_reset ()
lora . mode = Mode . LoRaWan
lora . band = 'EU868'
lora . set_config ( app_eui = '70B3D5xxxxxxxxxx' ,
app_key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' )
lora . join_otaa ()
lora . dr = 5
lora . send ( 'Hello world' )
lora . close () #!/usr/bin/env python3
# V3.0.x firmware
from rak811 . rak811_v3 import Rak811
lora = Rak811 ()
lora . set_config ( 'lora:work_mode:0' )
lora . set_config ( 'lora:join_mode:0' )
lora . set_config ( 'lora:region:EU868' )
lora . set_config ( 'lora:app_eui:70B3D5xxxxxxxxxx' )
lora . set_config ( 'lora:app_key:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' )
lora . join ()
lora . set_config ( 'lora:dr:5' )
lora . send ( 'Hello world' )
lora . close ()最初のメッセージはTTNコンソールに表示されます!
GitHubの例のディレクトリを参照してください。
api_demo.py V2.0.x API呼び出しのほとんどotaa.py / otaa_v3.pyの例otaa_v3_class_c.py :クラスCモードのデバイスを備えたOTAA例abp.py / abp_v3.pyの例p2p.py / p2p_v3.pyの例p2p.sh / p2p_v3.sh :コマンドラインインターフェイスに基づくP2P例(以下を参照)例を実行するには、最初にttn_secrets_template.py ttn_secrets.pyにコピーして、lorawan thethingsnetworkキーを入力します。
注:スクリプトを実行するたびにモジュールhard_reset必要はありません。ただし、モジュールをアクティブにするために(再)起動した後に初めて実行する必要があります。
サンプルコードは、BalenaCloudでライブラリを使用します:BalenaCloud(v2.0.xファームウェア)を使用した基本Rak811例。
rak811コマンドは、すべてのライブラリコールをコマンドラインに公開します。
$ rak811 --help
Usage: rak811 [OPTIONS] COMMAND [ARGS]...
Command line interface for the RAK811 module.
Options:
-v, --verbose Verbose mode
--help Show this message and exit.
Commands:
abp-info Get ABP info.
band Get/Set LoRaWan region.
clear-radio-status Clear radio statistics.
dr Get/set next send data rate.
get-config Get LoraWan configuration.
hard-reset Hardware reset of the module.
join-abp Join the configured network in ABP mode.
join-otaa Join the configured network in OTAA mode.
link-cnt Get up & downlink counters.
mode Get/Set mode to LoRaWan or LoRaP2P.
radio-status Get radio statistics.
recv-ex RSSI & SNR report on receive.
reload Set LoRaWan or LoRaP2P configurations to default.
reset Reset Module or LoRaWan stack.
send Send LoRaWan message and check for downlink.
set-config Set LoraWAN configuration.
signal Get (RSSI,SNR) from latest received packet.
sleep Enter sleep mode.
version Get module version.
wake-up Wake up.セッション例:
$ rak811 -v reset lora
LoRa reset complete.
$ rak811 -v set-config app_eui=70B3D5xxxxxxxxxx app_key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
LoRaWan parameters set
$ rak811 -v join-otaa
Joined in OTAA mode
$ rak811 -v dr
5
$ rak811 -v dr 4
Data rate set to 4.
$ rak811 -v send Hello
Message sent.
No downlink available.
$ rak811 -v send --port 4 --binary ' 01020211 '
Message sent.
Downlink received:
Port: 1
RSSI: -56
SNR: 31
Data: 123456注:ブート後の最初のセッションでは、モジュールをアクティブにするためにreset lora代わりにhard-resetを実行する必要があります。
rak811v3コマンドは、次のライブラリ呼び出しをコマンドラインに公開します。
$ rak811v3 --help
Usage: rak811v3 [OPTIONS] COMMAND [ARGS]...
Command line interface for the RAK811 module.
Options:
-v, --verbose Verbose mode
-d, --debug Debug mode
--version Show the version and exit.
--help Show this message and exit.
Commands:
get-config Execute get_config RAK811 command.
hard-reset Hardware reset of the module.
help Print module help.
join Join the configured network.
receive-p2p Get LoraP2P message.
run Exit boot mode and enter normal mode.
send Send LoRaWan message and check for downlink.
send-p2p Send LoRa P2P message.
send-uart Send data to UART.
set-config Execute set_config RAK811 command.
version Get module version.セッション例:
$ rak811v3 -v set-config lora:work_mode:0
Configuration done
LoRa (R) is a registered trademark or service mark of Semtech Corporation or its affiliates. LoRaWAN (R) is a licensed mark.
RAK811 Version:3.0.0.14.H
UART1 work mode: RUI_UART_NORMAL, 115200, N81
UART3 work mode: RUI_UART_NORMAL, 115200, N81
LoRa work mode:LoRaWAN, join_mode:OTAA, MulticastEnable: false, Class: A
$ # The following is not necessary as in this case the module is already in OTAA mode!
$ rak811v3 -v set-config lora:join_mode:0
Configuration done
$ rak811v3 -v set-config lora:app_eui:70B3D5xxxxxxxxxx
Configuration done
$ rak811v3 -v set-config lora:app_key:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Configuration done
$ rak811v3 -v join
Joined!
$ rak811v3 get-config lora:status | grep ' Current Datarate '
Current Datarate: 4
$ rak811v3 -v set-config lora:dr:5
Configuration done
$ rak811v3 -v send ' Hello '
Message sent.
No downlink available.
$ rak811v3 -v set-config lora:confirm:1
Configuration done
$ rak811v3 -v send --port 4 --binary ' 01020211 '
Message sent.
Send confirmed.
RSSI: -66
SNR: 6