Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bennerlukas/libcap
LibCap - Library Capacity Measurement System
https://github.com/bennerlukas/libcap
esp32 flask iot python
Last synced: about 1 month ago
JSON representation
LibCap - Library Capacity Measurement System
- Host: GitHub
- URL: https://github.com/bennerlukas/libcap
- Owner: BennerLukas
- License: agpl-3.0
- Created: 2021-11-19T09:38:29.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-11T19:05:38.000Z (almost 3 years ago)
- Last Synced: 2024-11-29T00:19:52.267Z (2 months ago)
- Topics: esp32, flask, iot, python
- Language: Python
- Homepage:
- Size: 207 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
LibCap - Library Capacity Measurement System
## Usage
You need to have docker installed and execute the docker-compose.yml by doing the following:
```bash
docker compose up --build --force-recreate
```
or
```bash
docker compose up
```
## Manual Testing
For testing Mosquitto broker locally use this docker container:
```bash
docker run -ti -p 1883:1883 -p 9001:9001 toke/mosquitto
```
after that adapt the IP Address in the code to your own.
**For setting it up permanently** install Mosquitto per apt-install on your Raspberry Pi and create a ```.conf``` file`.
(see internet for that)
```bash
touch custom_mosquitto.conf
```
write the following inside the file
```bash
listener 1883
allow_anonymous true
```
Start the Mosquitto service again with your own config-file.
```bash
Mosquitto -c custom_mosquitto.conf
```
## Idea
The idea behind LibCap is a Library-Capacity-Measurement-System that detects the occupancy of workstations passively, without user interventions. With this system, visitors can find free places easily and can check whether a trip to a library is worth it.
## Tools
Numerous new state of the art technologies were implemented in this project; ranging from database over containerization to messaging brokers. The following technologies have been used:
## Team
The team consists of 4 People. The planing and brainstorming was done in team-meetings with the help of Github's KANBAN Boards.
We collaborated on all fields and worked together to achieve our goal. Nevertheless we decided on splitting the responsibilities in 4 areas as follows:
- Alina Buss (Research & Theory)
- Ayman Madhour (Middleware & Timeseries)
- Phillip Lange (Frontend & Container)
- Lukas Benner (Hardware & Design)
# Implementation
LibCap is a fully functional System on a docker-stack. It can be easily deployed on minimal hardware requirements.
The system is designed in such way, that the frontend, middleware and hardware can work independently of each other.
This is possible due to the use of a MQTT-Broker between the Middleware and the hardware,
as well as on strictly not making a direct connection between the frontend and middleware. All communication is over the database.
Therefore, the system is easily scalable and the components can be switched or enhanced without much hassle.
For a quick demonstration see here: https://youtu.be/ml8fKBpgCN8
## Documentation and Assignment
The presentation and the assignment as well as the OnePager for the Project-Documentation is stored within the "Docs"-Folder. There you can also see the the Live-Demo and the Teaser-Video and the brand logos.