Skip to content

A Python app to communicate with Black Lager devices. Send and receive messages, see data packets decoded in real time on a text based window built with curses.

License

Notifications You must be signed in to change notification settings

black-lager/client

 
 

Repository files navigation

Black Lager

A Secure Radio Mesh Text Messaging App

Black Lager is a Python application that allows you to send and receive signed or unsigned text messages. The messages are decoded and displayed in a text based interface created with Curses.

Supported hardware

  • LILYGO Lora v2.1-1.6
  • LILYGO T-Beam

Note: Other models listed at https://meshtastic.org/docs/supported-hardware may also work, but they have not been tested with the Black Lager firmware or application

Connect to device

Connect your computer to a radio device flashed with the Black Lager firmware via USB cable. For more information on hardware and firmware, see: https://github.com/black-lager/firmware

Installation

Black Lager Python library

git clone [email protected]:meshtastic/python.git then pip3 install ./python

Client dependencies

pip3 install -r requirements.txt

Running the app

python3 black_lager.py

Commands

Help is here!

Screen Layout

The screen has 5 areas of scrolling text.

Top Row

Top Row

The top row has basic information messages from the system, a debug area that shows the currently executing function, and a spot to show incoming messages.

Decoded Packets

Decoded Packets

Each packet that is intercepted will be displayed here in, decoded. Some fields such as RAW are not supported yet. This type of window is using a wrap around function to display the new lines.

Extended Info

Just the Keys

This is a curses text pad that scrolls upwards as new lines are entered. In this example I am displaying the connected nodes in the mesh.

This is a curses text pad that scrolls upwards as new lines are entered. In this example I am displaying the connected nodes in the mesh.

Send Messages

Press S to send a signed message or U to send an unsigned message. Press control+g when you are finished typing the message.

Viewing Messages

Messages

As both signed and unsigned messages are sent or received, they are displayed in the Messages text box.

About

A Python app to communicate with Black Lager devices. Send and receive messages, see data packets decoded in real time on a text based window built with curses.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.3%
  • Shell 0.7%