Skip to content

This project implements a bridge between a Meshtastic node and a Telegram group chat, allowing for the exchange of messages and locations between the two platforms.

Notifications You must be signed in to change notification settings

gretel/meshgram

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Repository files navigation

🌐 Meshgram: Bridging Meshtastic and Telegram πŸš€

Connect your Meshtastic mesh network with Telegram group chats! πŸ“‘πŸ’¬

🌟 Features

  • πŸ”Œ Supports serial and TCP connections
  • πŸ”„ Automatic reconnection
  • 🚦 Rate limiting
  • πŸ”” Regular updates
  • βœ… Read receipts
  • πŸ“ Optional syslog logging

πŸ›  Requirements

  • Python 3.11+ 🐍
  • Dependencies:
    • envyaml πŸ“„
    • meshtastic πŸ“‘
    • python-telegram-bot πŸ€–

πŸš€ Quick Start

  1. Clone the repo:

    git clone https://github.com/gretel/meshgram.git
    cd meshgram
  2. Set up a virtual environment:

    python3 -m venv venv
    source venv/bin/activate
  3. Install dependencies:

    pip install -U -r requirements.txt
  4. Configure the project: Create a config.yaml file in the config directory:

    telegram:
      bot_token: "your_bot_token_here"
      chat_id: -1001234567890
      authorized_users:
        - 123456789
    
    meshtastic:
      connection_type: "serial"
      device: "/dev/ttyUSB0"
      default_node_id: "!abcdef12"
    
    logging:
      level: "info"
  5. Run Meshgram:

    python src/meshgram.py

🀝 Contributing

We love contributions! πŸ’– Please open an issue or submit a pull request.

πŸ“œ License

This project is licensed under the MIT License. See the LICENSE file for details.

Happy meshing! πŸŽ‰

About

This project implements a bridge between a Meshtastic node and a Telegram group chat, allowing for the exchange of messages and locations between the two platforms.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages