meshing-around  by SpudGunMan

Meshtastic bot for network testing and BBS activities

Created 1 year ago
297 stars

Top 89.4% on SourcePulse

GitHubView on GitHub
Project Summary

This project provides a Python-based bot for Meshtastic networks, offering advanced messaging, network testing, data lookup, and interactive features. It targets Meshtastic users, including ham radio operators and emergency communicators, seeking to enhance their mesh network's utility and functionality.

How It Works

The bot operates by connecting to Meshtastic devices via serial, TCP, or BLE. It processes incoming messages, parses commands, and interacts with various APIs for data retrieval (weather, NOAA, Wikipedia, satellite passes) and AI (Ollama LLM). Key features include store-and-forward messaging, scheduled broadcasts, asset tracking, and integration with external tools like Hamlib for radio monitoring.

Quick Start & Requirements

  • Install: git clone https://github.com/spudgunman/meshing-around followed by install.sh or pip install -r requirements.txt.
  • Prerequisites: Python 3.8+ (3.13 for Docker), Meshtastic protobuf API modules, meshtastic, pubsub, pyephem, requests, geopy, maidenhead, beautifulsoup4, dadjokes, schedule, wikipedia, googlesearch-python. Optional: Hamlib, Ollama, Noto Color Emoji fonts.
  • Configuration: Edit config.ini to set interface type (serial, TCP, BLE), port, hostname, or MAC address.
  • Docs: Configuration Guide

Highlighted Details

  • Supports monitoring up to nine Meshtastic networks simultaneously.
  • Integrates NOAA EAS/FEMA IPAWS alerts and USGS volcano/river flow data.
  • Includes built-in games like DopeWars, Blackjack, and an FCC/ARRL quiz bot.
  • Features Ollama LLM integration for AI-powered queries and responses.

Maintenance & Community

The project acknowledges contributions from various individuals and the Meshtastic Discord community. Further details on community engagement and development can be found on GitHub.

Licensing & Compatibility

Meshtastic software components are released under various licenses. The project is provided without warranty and is intended for use at the user's own risk. Commercial use compatibility is not explicitly detailed but relies on the underlying Meshtastic licenses.

Limitations & Caveats

The project is primarily developed and tested on Linux (Raspberry Pi) and may have limited reliability with BLE and TCP interfaces compared to serial. It handles Personally Identifiable Information (PII) and requires responsible usage according to local regulations.

Health Check
Last Commit

1 day ago

Responsiveness

Inactive

Pull Requests (30d)
9
Issues (30d)
1
Star History
42 stars in the last 30 days

Explore Similar Projects

Starred by Sourabh Bajaj Sourabh Bajaj(Cofounder of Uplimit), Chip Huyen Chip Huyen(Author of "AI Engineering", "Designing Machine Learning Systems"), and
3 more.

NextChat by ChatGPTNextWeb

0.1%
86k
AI assistant for web, iOS, MacOS, Android, Linux, and Windows
Created 2 years ago
Updated 3 days ago
Feedback? Help us improve.