REST API for the E-Ink-Displays System Webapp. Communicates with Ardunios over WIFI HTTP to send images and make state requests.
Created with Spring BootFramework, Hibernate and PostgreSQL with Flyway DB Version control system. The API can do CRUD operations on Displays, Locations and Templates. Templates are predefined Images that can be modified and loaded on the Displays.
Table of Contents
Get a copy of the repository:
git clone https://github.com/noi-techpark/it.bz.opendatahub.epaper.api.gitChange directory:
cd it.bz.opendatahub.epaper.apiRun MainApplicationClass.java in your IDE and Spring Boot will start, Flyway create tables in your database and the the API is ready to use! Enjoy!
Install PostgreSQL on your machine (tested and developed on PSQL 12.5) Create Database named edisplays with user edisplay-user
CREATE DATABASE epaper;
CREATE USER epaper;Make sure that a default schema called public exists, and that the owner is epaper.
Copy the file src/main/resources/application.properties to src/main/resources/application-local.properties and adjust the variables that get their values from environment variables. You can take a look at the .env.example for some help.
Build the project:
mvn -Dspring.profiles.active=local clean installRun the project:
mvn -Dspring.profiles.active=local spring-boot:runThe service will be available at localhost and your specified server port.
Copy the file .env.example to .env and adjust the configuration parameters.
Then you can start the application using the following command:
docker-compose upThe service will be available at localhost and your specified server port.
You can show events info from today.noi.bz.it on displays. To do so enable in .env file following values NOI_EVENTS_ENABLED enables the service NOI_CRON_EVENTS is the cron job that fetches the events periodically from the OpenDataHub NOI_CRON_LOCATIONS is the cron job that fetches the locations periodically from the OpenDataHub
NOI_EVENTS_ENABLED=false
NOI_CRON_EVENTS=0 0 0/12 * * ?
NOI_CRON_LOCATIONS=0 0/10 6-24 * * ?
NOTE: The cron jobs annotations don't need to be modified. Just if you prefer other update times.
The scheduler cron annotation works as follows:
┌───────────── second (0 - 59)
│ ┌───────────── minute (0 - 59)
│ │ ┌───────────── hour (0 - 23)
│ │ │ ┌───────────── day of the month (1 - 31)
│ │ │ │ ┌───────────── month (1 - 12) (or JAN-DEC)
│ │ │ │ │ ┌───────────── day of the week (0 - 7)
│ │ │ │ │ │ (or MON-SUN -- 0 or 7 is Sunday)
│ │ │ │ │ │
* * * * * *
Where */10 means every 10 seconds/minutes/, whereas 0/10 means every 10
seconds/minutes/... but starting from 0. For example, for minutes that would be
8:00, 8:10 etc. See this spring.io
blogpost
for details.
- Start the API
- Set up a physical display by following the README of the backend
- Follow the next steps in the README of the webapp to use the webapp to send the image
Swagger can be reached under http://localhost:8080/swagger-ui.html#/ and uses OAuth for verification.
Tests can be created with JUnit and there are already some simple Tests for
All JPARepositories can be tested with JPA Data Tests. Examples can be found in test folder.
The E-Display Backend is free software. It is licensed under GNU GENERAL PUBLIC LICENSE Version 3 from 29 June 2007. More info can be found here
This project is REUSE compliant, more information about the usage of REUSE in NOI Techpark repositories can be found here.
Since the CI for this project checks for REUSE compliance you might find it useful to use a pre-commit hook checking for REUSE compliance locally. The pre-commit-config file in the repository root is already configured to check for REUSE compliance with help of the pre-commit tool.
Install the tool by running:
pip install pre-commitThen install the pre-commit hook via the config file by running:
pre-commit install