Скачать pyrak811 - pyrak811 исходный код скачать

RAK811 Python 3 библиотека для Raspberry Pi

О

RAK811 Python 3 Библиотека и интерфейс командной строки для использования с шляпой Raspberry Pi Lora (P).

Библиотека разоблачает модуль RAK811 в командах, как описано в следующих документах:

RAK811 LORA в руководстве командного пользователя v1.5 для модулей с прошивкой v2.0.x.
RAK811 в руководстве по команде v1.0 для модулей с прошивкой v3.0.x.

Интерфейс командной строки раскрывает все вызовы API в командную строку.

Требования

Raspberry Pi!
Модуль RAK811 LORA (Pisupply IOT LORA Node Phat для Raspberry Pi / Rak811 Wisnode - Lora)
На Raspberry Pi должен быть включен аппаратный последовательный порт, а последовательная консоль отключена (используйте raspi-config )
Пользователь, запускающий приложение, должен находиться в группах dialout и gpio (это по умолчанию для пользователя pi )

Установите пакет RAK811

Пакет установлен из PYPI:

sudo pip3 install rak811

Команда pip3 является частью пакета python3-pip . Если он отсутствует в вашей системе, запустите:

sudo apt-get install python3-pip

Pisupply предоставляет подробные инструкции для настройки вашего Raspberry Pi.

Использование

Быстрый старт с сетью вещей

Определите свое устройство

Если вы не знаете уровень прошивки модуля, запустите следующие команды:

rak811 hard-reset
rak811 version

Для прошивки v2.0.x используйте команду rak811 и модуль Python, для V3.0.x Используйте команду rak811v3 и модуль Python rak811_v3 .

Зарегистрируйте свое устройство

Зарегистрируйте устройство на TheThingsNetwork, используя уникальный идентификатор вашего модуля RAK811 (Device EUI).
Вы можете получить свое устройство EUI с помощью следующей команды (v2.0.x):

rak811 hard-reset
rak811 get-config dev_eui

ПРИМЕЧАНИЕ . Команда rak811 hard-reset необходима только один раз после (re) загрузки вашего малинового PI для активации модуля.

или (v3.0.x):

rak811v3 set-config lora:join_mode:0
rak811v3 get-config lora:status | grep DevEui

Привет, мир

Отправьте свое первое сообщение Lorawan с следующим фрагментом кода 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 : демо большинство вызовов API v2.0.x
otaa.py / otaa_v3.py : otaa пример
otaa_v3_class_c.py : пример OTAA с устройством в режиме класса C
abp.py / abp_v3.py : пример ABP
p2p.py / p2p_v3.py : пример P2P
p2p.sh / p2p_v3.sh : пример P2P на основе интерфейса командной строки (см. Ниже)

Чтобы запустить примеры, сначала скопируйте ttn_secrets_template.py to ttn_secrets.py и введите свои ключи Lorawan theThingsnetwork.

Примечание . Вам не нужно hard_reset модуль каждый раз, когда вы запускаете сценарий. Однако вы должны сделать это в первый раз после (re) загрузки для активации модуля.

Balenacloud

Пример кода для использования библиотеки с Balenacloud: базовый пример RAK811 с Balenacloud (прошивка v2.0.x).

Интерфейс командной строки

V2.0.x Прошивка

Команда 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

Примечание . Для вашего первого сеанса после загрузки вам нужно будет сделать hard-reset вместо команды reset lora для активации модуля.

V3.0.x Прошивка

Команда 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