🐇 Hops

Hops is a Meshtastic bot that responds to dot commands.

Commands

.help

Get information on the bot (sends you here) Synonyms:.info, .?

.whoami

Node info as hops sees it

.ping

Sends a short ack.

.hello

Say hello! Synonyms:.👋🏼

.message

Send a message to a user. The user can be specified by their short or long name.

.mail

Retrieve your most recent 5 mail messages.

.post Your message for the BBS

Add an item to the global BBS

.bbs

List the most recent 5 BBS messages

Building and Running

Start by cloning the repository and setting up a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`

Then, install the required packages:

pip install -r requirements.txt

Then, you can run the bot using the following command:

python main.py --help

Tests can be run with:

python -m unittest discover

You can install the bot via

pip install .

and once installed run it via

hops --help

Running hops

Hops expects to have access via the serial interface or via TCP. It does not run via BLE.

To run via the serial interface,

hops --serial

and via TCP,

hops --tcp <ip_address>

By default hops will create a sqlite database db.sqlite in the current directory. Alternatively you can specify a different database file with the --db option:

hops --serial --db /path/to/db.sqlite