Introduction

CircuitPython helper to decode LoRa mesh packets.

Dependencies

This driver depends on:

• Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-meshfruit

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_meshfruit

Usage Example

import adafruit_rfm9x
import board
import digitalio

import adafruit_meshfruit

FREQUENCY = 906.875
CHANNEL_HASH = 0x08
SYNC_WORD_REG = 0x39
SYNC_WORD = 0x2B

rfm9x = adafruit_rfm9x.RFM9x(
    board.SPI(),
    digitalio.DigitalInOut(board.D11),
    digitalio.DigitalInOut(board.D12),
    FREQUENCY,
)
rfm9x.signal_bandwidth = 250000
rfm9x.spreading_factor = 11
rfm9x.coding_rate = 5
rfm9x.preamble_length = 16
rfm9x.enable_crc = True
rfm9x._write_u8(SYNC_WORD_REG, SYNC_WORD)  # noqa: SLF001

mesh = adafruit_meshfruit.Meshtastic()

print("listening on", FREQUENCY, "MHz")

while True:
    raw = rfm9x.receive(with_header=True, timeout=5.0)
    if raw is None:
        continue
    if len(raw) <= adafruit_meshfruit.HEADER_LEN:
        continue

    packet = mesh.decode(raw)
    if packet.channel_hash != CHANNEL_HASH:
        continue

    if packet.portnum == adafruit_meshfruit.PORT_TEXT_MESSAGE and packet.payload:
        print(packet.sender_id, packet.text)

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.