This project is the client script that will be used to transmit your meshtastic node information and seen nodes to the server.
Run the script as a service on a Linux/Unix based client, suggested be run every 30 minutes.
This will transmit the node information and seen nodes to the server, to be stored in a the and displayed on the web page.
- Python 3.6+
- Pip
- .jq (a lightweight and flexible command-line JSON processor)
- Meshtastic device
- Meshtastic Python CLI
- Meshtastic device connected to the client (USB, Bluetooth, or via HTTP)
- Clone the repository
- Install the required python packages
pip install -r requirements.txt
- Install jq (use the package manager of your choice, examples below)
- Ubuntu
sudo apt-get install jq
- MacOS
brew install jq
- Copy the
.env.example
file to.env
and fill in the required information - Run the script
bash run.sh
The configuration is done in the .env
file.
The only required configuration option is your API key, which can be found here - Meshtastic Node Transmit Server
API_KEY=your_api run.sh
API_KEY=your_api MESHTASTIC_BLE=BLUETOOTH_MAC_HERE run.sh
API_KEY=your_api MESHTASTIC_HOST=HTTP_URL_HERE run.sh
API_KEY=your_api MESHTASTIC_NO_INFO=true run.sh
The key part here is the MESHTASTIC_NO_INFO=true
environment variable.
This project is licensed under the MIT License - see the LICENSE file for details
This project is not affiliated with or endorsed by the Meshtastic project.