Train Countdown Timer

This project is a Python-based countdown timer for train departures in Melbourne Australia, designed to run on a Raspberry Pi with an e-ink display. The timer fetches live train schedule data from the PTV (Public Transport Victoria) API and displays the time remaining until the next train departs from any station (configured by you) towards Flinders Street.

Features

• Real-time Train Schedules: Retrieves and updates train schedules via the PTV API.
• Clear E-ink Display: Displays departure time in hours and minutes, ideal for low-power usage.
• Automated Updates: Refreshes the countdown periodically without heavy screen flicker.
• Robust Operation: Automatically retries failed API requests to handle occasional connection issues.

Requirements

• Hardware:

  • Raspberry Pi Zero with header (tested on Pi Zero WH)
  • 2.13-inch Touch E-Paper Display and case from Waveshare

• Software:

  • Python 3
  • Requests
  • Pillow

Build

• Assemble the Raspberry Pi Zero, case and screen as per the waveshare instructions.
• Create an SD card image for your Pi and boot it up connected to a mouse, keyboard and screen.

Get an API Key

Send an email to [email protected] with the following information in the subject line of the email: “PTV Timetable API – request for key” This takes some time but they will eventually respond with your dev_id and API key

Installation

1. Clone the Repository:

   git clone https://github.com/Chojins/Train-Countdown-Timer.git
   cd Train-Countdown-Timer

2. Install Required Libraries:

   pip install -r requirements.txt

3. Configure the config.py:

   • Create a file config.py using the sample file config.sample.py
   • fill in the fields DEV_ID, API_KEY with your info from PTV.
   • See train_stop_ids.txt for a list of stop ids - the count down will be for the next train departing towards Flinders Street.

4. Configure System Service:

   • To run the script as a background service, copy the provided train_countdown.service to /etc/systemd/system/.
   • Enable and start the service:

     sudo systemctl enable train_countdown.service
     sudo systemctl start train_countdown.service

Usage

Start the service manually

sudo systemctl start train_countdown.service

monitor the system service with

journalctl -u train_countdown.service -f