Skip to content

Latest commit

 

History

History
69 lines (51 loc) · 1.83 KB

README.md

File metadata and controls

69 lines (51 loc) · 1.83 KB
Raw

Sourceful Energy Telegram Bot

A Telegram bot for monitoring Sourceful Energy gateways in real-time. Get instant notifications when your gateways go online or offline, and monitor power production from your DERs (Distributed Energy Resources).

Current version: 0.1.4

Features

  • Real-time gateway status monitoring
  • Instant notifications on state changes (online/offline)
  • Power production monitoring
  • Multiple gateway support
  • Easy subscription management
  • Gateway statistics
  • Automatic state detection based on data points
  • User-configurable status thresholds
  • Docker support for easy deployment

Commands

  • /start - Initialize the bot and get welcome message
  • /status - Check current gateway status
  • /subscribe - Monitor a gateway
  • /unsubscribe - Stop monitoring
  • /threshold - Set status check interval (1-60 minutes)
  • /stats - View bot statistics
  • /help - Show help information

Status Information

  • 🟢 ONLINE - Gateway has reported data within user's threshold (default: 5 minutes)
  • 🔴 OFFLINE - No data received for longer than threshold
  • Power production in watts
  • Last data point timestamp
  • DER information (name, make, nominal power)

Setup

  1. Clone the repository
  2. Copy .env.example to .env and configure: 
    TELEGRAM_TOKEN=your_bot_token
API_URL=https://api.srcful.dev/
CHECK_INTERVAL=60
  3. Run with Docker: 
    docker-compose up -d

Docker Support

The bot runs in a Docker container with:

  • Persistent storage for database
  • Automatic restart on failure
  • Log rotation
  • Volume mounts for data and logs

Version History

See CHANGELOG.md for version history and changes.

Author

Created by Fredrik Ahlgren as a hobby project.

License

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