Skip to content

Latest commit

 

History

History
117 lines (88 loc) · 12.2 KB

File metadata and controls

117 lines (88 loc) · 12.2 KB

User Manual

Homepage

1 Product Overview

1.1 Short Description

The dashboard is a user-friendly, customizable, and practical device that displays real-time data for current date and time, weather for a selected location in Germany (DE), and fuel prices for three custom gas stations in Germany (DE). The device features fail-safe mechanisms and user-friendly error messages to operate autonomously without any interaction except initial setup.

In short:
You live in Germany. This display is for answering the following questions:

  • What is the date and time right now?
  • How is the weather like?
  • What is the current fuel price at my favorite gas stations?

Once configured, never touch it again.

1.2 Package Contents

  • 1x Dashboard
  • 1x Touch stylus
  • 1x USB-C cable
  • 1x SD card
  • 1x SD card to USB-C adapter
  • 2x screws

1.3 Intended Usage and Safety Warnings

This device has only informative character and should not be used in critical applications or scenarios. Please use device as intended - Hanging peacefully on a wall in a room with human-friendly conditions, meaning:

  • Not too cold
  • Not too hot
  • Not too wet
  • Not too radioactive
  • Not too much sun exposure

Please keep the device and its components away from children and animals - for the well-being of both the device and the fauna.

Please, do not become the reason this chapter needs to be extended.

2 Dashboard Configuration

2.1 SD Card Setup

All configurations are stored on the SD card. If you have received an SD card together with the product, please skip to 2.2. To set up the SD card, plug it into your computer (with the adapter) and format it to FAT32 filesystem format. The following animation demonstrates how to format the SD card on a Windows 11 machine:


Correct SD card formatting option

After this, simply copy all contents from this folder to the root directory of your SD card.

2.2 Obtain Tankerkoenig API Key

To be able to display fuel prices and gas station statuses you must obtain your personal API key here for free. Fill out the form and you will receive your API key via email.

2.3 Find Gas Station ID's

To find the station ID of a particular gas station you can use this tool. It is an interactive map that allows you to find a station and copy its station ID for later usage in station_ids list.

2.4 Configuration Values

All configuration values are stored in the configuration.json file. If not done yet, plug your SD card (with the adapter) into your computer. Open the configuration file with an editor of your choice. In the following table every single configuration value is briefly described. You can set the values according to your preferences.

Name Description Necessity Configuration Type Value Type Constraints
wlan_ssid WLAN name that the dashboard will connect to Mandatory Single value Text - Max length: 32 characters
wlan_psk WLAN password required to connect Mandatory Single value Text - Min length: 8 characters
- Max length: 63 characters
tankerkoenig_api_key API key for gas station information access Mandatory Single value Text - Format: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
station_ids List of gas station IDs Mandatory List Text - Format: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
- All IDs must be unique
station_labels List of station icon names and labels Optional List of lists Text - Dimension: 3×3 text values
- Each triplet:
  • Icon file name
  • Station label (≤21 chars)
  • Fuel name (≤21 chars)
fuel_type Fuel type that the price is displayed for Mandatory Single value Text - One of: e5, e10, diesel
weather_lat Geographical latitude for weather data Mandatory Single value Decimal number - Must be between -90 and 90
weather_long Geographical longitude for weather data Mandatory Single value Decimal number - Must be between -180 and 180
automatic_updates Flag for automatic firmware updates Mandatory Single value Boolean - Value must be true or false

3 Custom Station Icons

3.1 Selection from Existing Station Icons

This repository provides a selection of station icons for well-known brands in Germany such as ARAL or SHELL. You can find the selection here. Copy the desired station icons (maximum three) into the station_icons folder on your SD card. Make sure that you use the corresponding names in station_labels, e.g., if the icon is named aral.rgb666, you enter aral in your configuration.

3.2 Create Custom Station Icons

It is possible to create your own custom station icons. Download or create a PNG file with the station icon. Resize the image to 64x64 pixels. You can use this online tool for free. In your terminal, navigate with cd to the scripts folder and run the following command:

    python convert png_to_rgb666.py your_icon.png your_icon.rgb666

If you want to add a custom background color, append the color to the previous command in brackets, e.g., for a red background, you will use:

    python convert png_to_rgb666.py your_icon.png your_icon.rgb666 (255, 0, 0)

The resulting icons can be then copied to the station_icons folder. Use the file names in the station_labels configuration list, as described in 3.1.

3.3 Request a Station Icon

If you do not want to create your own custom icons, you can create a station icon request here. The icon will be then available in the icon selection folder of this repository. However, there is no guarantee that the station icon will be made immediately, so if you want to avoid waiting times, consider following the instructions from 3.2.

4 Finalization and Installation

Insert the SD card into the dashboard. Make two marks on the wall where you want to hang the dashboard. The marks should be 6cm apart each other. Install the two screws that come with the dashboard or use any suitable screws or nails of your choice. Please note that the mounting holes have a diameter of ~7mm. Adjust the screw positions such that the dashboard hangs horizontally. Last step is to plug in the USB-C cable, attach the dashboard to the screws on the wall, and plug in the other end of the cable into a 5V electricity source (e.g., phone charger). The dashboard should light up immediately and try to connect to the WLAN that you have configured. After that, if the Tankerkoenig API key and station IDs are valid, you should see the dashboard displaying everything as expected.

5 Troubleshooting

In case of errors the dashboard will always display an error message and a QR code. If you scan the QR code with your smartphone, you will be redirected to one of the error pages. There you will find more details on why the error appeared and how to resolve it. The error codes have the following structure:

  • The error code always has four digits, e.g., 1207
  • First digit is either 1 or 2, where:
    • 1 stands for user action required, the error will disappear after user touches the display screen
    • 2 stands for automatic restart of system after error appeared
  • Second digit is a number from 1 to 6, where:
    • 1 stands for SD card and file-related errors
    • 2 stands for configuration-related errors
    • 3 stands for wireless connection errors
    • 4 stands for internet connection errors
    • 5 stands for time synchronization errors
    • 6 stands for update-related errors
  • Third and fourth digit are the error number; they have no specific meaning and are only for error identification

If we take the example 1207 from above, we can conclude that the error needs manual user confirmation that the error was seen, and it is a configuration-related error. Also, a concise description is always displayed on-screen, which helps the user most of the time without the necessity to scan the QR code and read the error page. Under some circumstances, there is a small chance that the error 1000 might appear. This requires further investigation by the maintainer of this project. In that case, take a photo of the error screen as it might include a valuable hint to the error origin and create a new Error 1000 Report if no similar issue already exists.

6 Firmware Updates

In case you set the automatic_updates flag to false, your firmware will stay unchanged. It is strongly recommended to keep this flag on true as the device will receive improvements and bug fixes automatically. There is no user action required for a firmware update. The device checks the server for updates once a day at 03:00 local time, when the user is most likely sleeping. If there is an update (or rollback) available, the device will download it from this repository, validate the contents, and install the new firmware in a matter of less than five minutes. After this, the device will restart and operate as usual. This process is visually displayed on the screen. In case anything goes wrong and an unexpected error occurs; the device will activate deep sleep mode and requires manual maintenance. In this case, feel free to raise a new issue here.

7 Disposal

Please adhere to current disposal regulations of the German Federal Environment Agency. As this is not a commercial product, the responsibility is delegated to the user.

8 Warranty and Legal Remarks

This project is provided “as is”, without any express or implied warranties, and with no guarantee of support or updates. Since this is a non-commercial project, the author assumes no legal responsibility for any damage, malfunction, or loss resulting from the use or misuse of the hardware, software, or documentation.

By using or implementing this project, you acknowledge that you do so at your own risk.

Unscroll this page