Skip to content

Arkadia is a project to monitor home environment conditions like temperature, pressure, humidity, and air quality

Notifications You must be signed in to change notification settings

malonge/Arkadia

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 

Repository files navigation

Arkadia

Arkadia is a project to monitor home environment conditions like temperature, pressure, humidity, and air quality. The goal is to practice working with sensors and various software architecture patterns. All services and sensors are currently running on a single Raspberry Pi 5.

Arkadia is named after the base camp of the Skaikru people in the TV show "The 100".

Getting Started

cd services
docker compose up

Services

Unit tests are available for most services by adding -tests to the service name. For example, docker compose run tph-tests will run the unit tests for the tph service.

tph

This service measures temperature, prressure and humidity using a BME280 sensor and a Raspberry Pi. It periodically samples sensor data and stores the median values in a Redis cache.

docker compose run tph

data

This service is a simple FastAPI application that exposes sensor data via a REST API.

docker compose run data

The API documentation is available at http://localhost:8000/docs. There is currently only one endpoint — the endpoint that retrieves tph data.

web

This service is a React application that displays sensor data.

docker compose run web

An example screenshot of the web application:

Web Application Screenshot

About

Arkadia is a project to monitor home environment conditions like temperature, pressure, humidity, and air quality

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published