SmartDisplay Server

⚠ ⚠ ⚠ This project is no longer in development. Please use AWTRIX 3 ⚠ ⚠ ⚠

Demo

Description

Use in combination with SmartDisplay Controller.
The server controlls the display with Apps.

You can easily add own app. All logic for the display is in the SmartDisplayController.ts.

Whats the different to AWTRIX Server?

The SmartDisplay Controller is a fork of the original AWTRIX. We have some API changes and incompatible with the original project (SmartDisplay Server only works in combination with the SmartDisplay Controller).

We are inspired by the AWTRIX project but we don’t like that the server is closed source, so you can’t extend it.
Second: We think many users use AWTRIX servers on a raspberry pi with limitited RAM. Every Java application is very wasteful so that we try to save memory with our server.

SmartDisplay isn’t compatible with AWTRIX anymore!

Features

• open source (MIT licence) 😍
• RAM optimized (designed for run on a Raspberry Pi) 🚀
• auto standby mode if no client is connected 🔌⚡
• easy extendable (only implement a TypeScript interface) 👩‍💻
• modern and platform independent architecture (nodejs) 🐧
• multiplatform Docker support 🐳

Included apps

• time: display the current time
• date: display the currend day and month
• roomWeather: display the current room temperature (by integrated DHT22 from the controller)
• cityWeather: display the current city temperature (by openweathermap API call or from Home Assistant)
• CO2 Warner (via Home Assistant)

Architecture

Setup

Create OpenWeatherMap account (free, optional)

1. signup at https://home.openweathermap.org/users/sign_up
2. copy your API key from https://home.openweathermap.org/api_keys
3. find ID of your city: https://openweathermap.org/find

Standalone

1. install nodejs (example for Ubuntu/Raspbian)
2. checkout repository
3. change settings in .env file (see “Environment Variables” table in Docker part for detail info)
4. run npm install
5. run npm run start
6. connect SmartDisplay Controller with Server (set server IP)
7. setup a systemd service for autorestart, restart after errors (see prepared service config file in “/systemd/smartdisplay.service”)

Docker

1. Ensure Docker Compose is already installed
2. Overwrite environment variables in docker-compose.yml file
3. Open command-line and switch to folder containing the docker-compose.yml file
4. Create container and run with docker-compose up -d

Environment Variables

Overwrite following environment variables to setup your container: