This branch is 11 commits behind shihaam/starlink_status:main
2023-11-22 17:54:07 +05:00
2023-11-11 23:18:19 +05:00
2023-11-22 17:54:07 +05:00
2023-11-21 06:24:31 +05:00
2023-11-21 11:27:18 +05:00
2023-11-12 00:18:50 +05:00
2023-11-12 15:29:05 +05:00
2023-11-12 18:17:35 +05:00

Starlink Performance Monitoring Bot

Introduction

This project provides a performance monitoring solution for Starlink internet service. It utilizes an IP camera to capture images of the sky, fetches weather data, conducts speed tests through multiple platforms, and uploads the results to a specified Telegram chat.

Screenshot of chat

Features

  • Sky Image Capture: Uses an IP camera's RTSP feed to take a picture of the sky.
  • Weather Data Fetching: Retrieves weather information using Open-Meteo API.
  • Speed Tests: Conducts internet speed tests using Ookla Speedtest, LibreSpeed, and Fast.com.
  • Telegram Integration: Automatically uploads the results to a Telegram chat.

Requirements

  • Docker or Podman
  • A Telegram bot and chat ID
  • An IP camera with RTSP support
  • Internet connection

Setup

  1. Create Telegram Bot: Use Telegram's BotFather to create a new bot and get the API token.
  2. Find Telegram Chat ID: Identify your user, group, supergroup, or channel ID. Add "-100" if it's a supergroup or channel.
  3. Configure IP Camera: Ensure the camera's RTSP feed is accessible.

Configuration

Create a .env file with the following variables:

  • copy env.example to .env and configure it. Replace the placeholder values with your actual data.

Installation

  1. Clone Repository: Clone this repository to your local machine or server.
  2. Run with Docker/Podman:
    • Use docker compose up -d or podman compose up -d to start the service.

Usage

Once set up, the bot will operate automatically. It will capture sky images, perform speed tests, fetch weather data, and send updates to the configured Telegram chat every 30 minutes.

Troubleshooting

  • Bot Not Responding: Ensure that the .env file is correctly set up and that the bot has the necessary permissions in your Telegram chat.
  • Camera Issues: Verify that the RTSP URL is correct and that the camera is accessible from your network.

Contributing

Contributions to improve this project are welcome. Please submit pull requests with your proposed changes.

Description
Telegram bot to picture of sky, speed test and latency of Starlink.
Readme 15 MiB
Languages
Shell 93.7%
Dockerfile 6.3%