Home Display 🏠

This project aims to provide timings for nearby bus stop, meteo information and currency information. It is intended to run on a controlled environment on a raspberry-pi.

Organisation 🛠️

The Tauri app is used to display & interact with the results from the APIs (cached in redis). It serves as a desktop application that displays (~in real time) the data of the different APIs. It relies on an external redis storage to cache results.

App 💻

To run the tauri application run cargo tauri dev from the root of the project. This will build the app and start it in development mode. In order to be able to use the APIs directly, some variables need to be set. See the configuration section for more information.

The frontend is built with rust using the Yew framework.

TUI 📟

A TUI version is available for lower-end devices (e.g. raspberrypi-3b) or devices without a graphical interface. The TUI is a simple text interface that displays the same information as the GUI. In order to build the tui, run cargo build --release --bin hd-tui.

gif generated using VHS (vhs .github/tui.tape).

Compile for ARM 🛠️

This project is intended to run on a raspberryPi. The script arm_comp.sh serve to compile and build a .deb package for raspbian. Only ubuntu is supported as of now.

APIs 🌐

• openweathermap For weather information
• openexchangerate For currency conversion
• sl.se (through trafiklab.se) For real-time transports information in Stockholm

Configuration 🛠

In order to configure the application, the following environment variables need to be set:

export OWM_API_KEY=<Your api key for openweathermap>
export OER_API_KEY=<Your api key for openexchangerate>
export REDIS_HOST=<The host of the redis server>
export REDIS_PORT=<The port of the redis server>

Additionally, the following environment variables can be set to configure the location and currency conversions:

Latitude and longitude of the point to watch the weather for

export OWM_LAT=<latitude of the point>
export OWM_LON=<longitude of the point>

Currency conversion, from and to (Use the currency codes)

export OER_FROM=<Base currency code>  # e.g. EUR
export OER_TO=<Currency to convert to>  # e.g. SEK

Stop names for the bus stops to watch for

export SL_PLACE_BUS_STOPS=<stop 1>,<stop 2>,...

⚠️ Sometimes multiple stops are available for the same name. All the matches will be displayed.