https://github.com/jamro/train-ping
Track internet quality when travelling by train
https://github.com/jamro/train-ping
Last synced: 12 months ago
JSON representation
Track internet quality when travelling by train
- Host: GitHub
- URL: https://github.com/jamro/train-ping
- Owner: jamro
- License: mit
- Created: 2024-08-21T15:57:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-21T21:05:14.000Z (almost 2 years ago)
- Last Synced: 2025-02-24T14:57:54.115Z (over 1 year ago)
- Language: Python
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Train-Ping
Train-Ping is a Python app designed to help train travelers monitor internet connection quality during their journeys. Unreliable connectivity can be a challenge on trains, especially when you need to stay productive. Train-Ping measures and logs the quality of your internet connection and maps it to your train timetable, helping you identify when and where you can expect stable internet access. **Train-Ping** helps you manage your expectations for internet connectivity on train journeys, ensuring you can plan your work or activities with confidence.
## Features
- **Track Internet Quality**: Measures and logs the quality of your internet connection at regular intervals.
- **Integrate with Timetable**: Maps connectivity data against a train timetable to identify connectivity patterns.
- **Visualize Connectivity**: Provides a visual summary of connectivity quality over time.
## Requirements
- Python 3.x
## Installation
**Clone the Repository:**
```bash
git clone https://github.com/yourusername/train-ping.git
cd train-ping
```
## Usage
### 1. Tracking Internet Quality
Use the `train-ping-tracker.py` script to track and log your internet connection quality.
```bash
./train-ping-tracker.py -t -o
```
**Arguments:**
- `-t`, `--timetable`: Path to the timetable file (default: `timetable.txt`).
- `-o`, `--output`: Path to the output CSV file where ping logs will be saved (default: `ping_log.csv`).
**Example:**
```bash
./train-ping-tracker.py -t timetable.txt -o ping_log.csv
```
### 2. Viewing Ping Summary
Use the `train-ping-viewer.py` script to view a summary of the collected ping data.
```bash
./train-ping-viewer.py -t -i -s
```
**Arguments:**
- `-t`, `--timetable`: Path to the timetable file (default: `timetable.txt`).
- `-i`, `--input`: Path to the input CSV file containing ping logs (default: `ping_log.csv`).
- `-s`, `--segment`: Length of a segment in seconds for summarizing ping data (default: `60`).
**Example:**
```bash
./train-ping-viewer.py -t timetable.txt -i ping_log.csv -s 60
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.