Skip to content

MapTheMesh/meshtastic-node-transmit-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Meshtastic Node Transmit Client


Description

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.

Requirements

Installation

  1. Clone the repository
  2. Install the required python packages
pip install -r requirements.txt
  1. Install jq (use the package manager of your choice, examples below)
    • Ubuntu
    sudo apt-get install jq
    • MacOS
    brew install jq
  2. Copy the .env.example file to .env and fill in the required information
  3. Run the script
bash run.sh

Configuration

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

Usage

Running the script against a USB connected Meshtastic device

API_KEY=your_api run.sh

Running the script against a Bluetooth connected Meshtastic device

API_KEY=your_api MESHTASTIC_BLE=BLUETOOTH_MAC_HERE run.sh

Running the script against a HTTP connected Meshtastic device

API_KEY=your_api MESHTASTIC_HOST=HTTP_URL_HERE run.sh

Run the script and do not send the config YAML to the server

API_KEY=your_api MESHTASTIC_NO_INFO=true run.sh

The key part here is the MESHTASTIC_NO_INFO=true environment variable.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgements

Disclaimer

This project is not affiliated with or endorsed by the Meshtastic project.

About

This is the client script for uploading your mesh data to the server

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 2

  •  
  •