Skip to content

Latest commit

 

History

History
181 lines (127 loc) · 6.5 KB

README.md

File metadata and controls

181 lines (127 loc) · 6.5 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

rpi-paper-eta

Display ETAs with Raspberry Pi and E-paper with a comprehensive web management interface.

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This is a ETA display hardware gadget that provide ETA information for various transport within Hong Kong using a Raspberry Pi and a E-paper display.

Unlike most of the similar project, minimal setup is required without any of the configuration file modification, command entering or steep learning curve. Most of the configuration can be done via a web management interface.

The data source of ETAs are DATA.GOV.HK.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

  • Python >= 3.10

Dependening on the E-paper display you are using, the required dependency will be different. Please refer to the instruction from your display manufacturer.

Installation

Setup

  1. Clone the repo 
    git clone https://github.com/SuperDumbTM/rpi-paper-eta.git
  2. Install Pip packages 
    pip install -r requirments.txt

Deploy

  • Development 
    flask run
  • Production 
    gunicorn

(back to top)

Usage

Web Management Interface

  • Route Bookmarking
  • Display Refresh Scheduling

Customisation

Some of the default behaviour or storage path can be altered with a .env file (recommanded) or OS environment variable. The setting is intended not to be able to configure via the web interface.

The details is as follow:

Variable Description
BABEL_DEFAULT_LOCALE A local code for the default displaying language of the CMS.
BABEL_DEFAULT_TIMEZO A local code for the default time zone of the CMS (only used for translation-related needs).
DIR_STORAGE The directory name for the CMS to store the data (cache, logs, temporary files) into.
DIR_SCREEN_DUMP The directory name for the CMS to store the screen dump images.
DIR_LOG The directory name for the CMS to store logs.
SECRET_KEY The key for the CMS to sing for security related needs such as session cookie

(back to top)