💡 IoT management 💡

This is an implementation of platform to management IoT sensors.

Contents

• Quick Start
• General Info
  • Frontend Application
  • Modules
  • Security
  • Environment
• Technologies Used
• Features
• Configuration
• Testing

Quick Start

To start the application, execute the following command:

docker-compose up

*if you are working on windows run in Git Bash first:

dos2unix test-env/sql/init_schema.sh

General Information

🚀 Frontend Application 🚀

Frontend application is developed on the following repository:
https://github.com/rogowski-piotr/iot-management-vue

📁 Modules 📁

• client-api - Provide Web API for client applications. Also allow performing CRUD operation
• model - Shared module containing all application models and database configuration
• sensor-management - Provides executing measurements on sensors
• sensors - Contains documentation and code for each of the available sensors to be configured on the ESP8266 or ESP32 platform
• test-env - Contains documentation and automation scripts to configure continuous integration on Raspberry pi environment

🔐 Security 🔐

• Access control to API by providing login and password by basic authentication.
• Security of stored passwords is ensured using MD55 hashing algorithm.

▶️ Environment ▶️

Currently, platform runs in the docker layer on the Raspberry pi platform.
Each sensor based on platform esp8266 or esp32 with support wireless WiFi connection.
Main platform communicates with sensors using the TCP network protocol.

Technologies used

• Raspberry Pi
• Docker
• Arduino
• Postgres
• Java 11
  • Spring Boot
  • Spring Security
  • Lombok
  • JPA (Hibernate)
  • JUnit

Features

• Access to the platform requires authorization.
• The system use Role-based access control.
• The platform triggers measurements on sensors, depending on the configuration, it can perform them with different frequency.
• All communication of the platform with the sensors takes place using the TCP / IP protocol.
• The platform automatically decides on sensor availability to reduce unnecessary requests.
• Depending on the configuration, the platform requesting inactive sensors to determine their availability.

Configuration

1. Follow THIS instruction to run application on Raspberry Pi.
2. Follow THIS to chose and configure sensors IoT.

Testing

• Manual testing REST API by Postman.
  Prepared collection available: here
• Automatic tests are provided by GitHub actions and a configured CI pipeline for launching JUnit tests using Maven triggered on every push changes.