https://github.com/markmybytes/rpi-paper-eta
Display ETAs with Raspberry Pi and E-paper.
https://github.com/markmybytes/rpi-paper-eta
epaper eta python raspberry-pi
Last synced: about 2 months ago
JSON representation
Display ETAs with Raspberry Pi and E-paper.
- Host: GitHub
- URL: https://github.com/markmybytes/rpi-paper-eta
- Owner: markmybytes
- License: gpl-2.0
- Created: 2023-10-02T09:32:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-12T04:39:08.000Z (over 1 year ago)
- Last Synced: 2025-02-13T08:51:22.600Z (over 1 year ago)
- Topics: epaper, eta, python, raspberry-pi
- Language: Python
- Homepage:
- Size: 74.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
rpi-paper-eta
Display ETAs with Raspberry Pi and E-paper with a comprehensive web management interface.
Report Bug
·
Request Feature
## 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](https://data.gov.hk/en/).
### Built With
[
](https://alpinejs.dev/)
[
](https://getbootstrap.com/)
[
](https://flask.palletsprojects.com/)
[
](https://htmx.org/)
## 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.
* [Waveshare](https://www.waveshare.com/wiki/Main_Page#e-Paper)
### Installation
#### Setup
1. Clone the repo
```sh
git clone https://github.com/markmybytes/rpi-paper-eta.git
```
2. Install Pip packages
```sh
pip install -r requirments.txt
```
#### Deploy
* Development
```sh
flask run
```
* Production
```sh
gunicorn
```
## 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 |
[contributors-shield]: https://img.shields.io/github/contributors/markmybytes/rpi-paper-eta.svg?style=for-the-badge
[contributors-url]: https://github.com/markmybytes/rpi-paper-eta/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/markmybytes/rpi-paper-eta.svg?style=for-the-badge
[forks-url]: https://github.com/markmybytes/rpi-paper-eta/network/members
[stars-shield]: https://img.shields.io/github/stars/markmybytes/rpi-paper-eta.svg?style=for-the-badge
[stars-url]: https://github.com/markmybytes/rpi-paper-eta/stargazers
[issues-shield]: https://img.shields.io/github/issues/markmybytes/rpi-paper-eta.svg?style=for-the-badge
[issues-url]: https://github.com/markmybytes/rpi-paper-eta/issues
[license-shield]: https://img.shields.io/github/license/markmybytes/rpi-paper-eta.svg?style=for-the-badge
[license-url]: https://github.com/markmybytes/rpi-paper-eta/blob/master/LICENSE.txt