updated readme

This commit is contained in:
mia 2025-05-15 09:49:37 +02:00
parent b0dc457977
commit 387052d389
3 changed files with 36 additions and 17 deletions

View file

@ -1,27 +1,34 @@
# Goal # Project Name
## Milestone 1 ## Milestones
### Milestone 1
The Goal is to display and visualize data received/measured from a Raspberry Pi on a webinterface. The Goal is to display and visualize data received/measured from a Raspberry Pi on a webinterface.
## Milestone 2 ### Milestone 2
The Raspberry Pi should be integratable to a Home Assistant Server and be used as as sensor input and opitionally logic level output. The Raspberry Pi should be integratable to a Home Assistant Server and be used as as sensor input and opitionally logic level output.
## Milestone 3 ### Milestone 3
Data should be sent and received via MQTT to an ESP32. The Pi acts as a sensor gateway. Data should be sent and received via MQTT to an ESP32. The Pi acts as a sensor gateway.
# Ausführung ## Tech Stack
- **Programmiersprache**: Python - **Raspberry Pi model**:
- **Libraries**: - **Programming languages**: Python
- **Sensoren**: - **Frameworks/tools/Libraries**: (e.g., Flask, GPIO Zero)
## Hardware Requirements
- Raspberry Pi with [model/specs]
- **Sensors**:
- LER (Lichtsensor) - LER (Lichtsensor)
- Temperatur und Luftfeuchtigkeit - Temperatur und Luftfeuchtigkeit
- ... - ...
# Docs ## Docs
- `requirements.txt` - `requirements.txt`
This file holds the requirements for pip This file holds the requirements for pip
@ -30,9 +37,17 @@ Data should be sent and received via MQTT to an ESP32. The Pi acts as a sensor g
- `main.py` - `main.py`
The main file for the project The main file for the project
# Arbeitsaufträge / Aufgabeneinteilung ### Git Help
## Zu Vergeben ![A Git Cheatsheet](gitHelp.png "Git Cheatsheet")
### MarkDown Help
![A MarkDown Cheatsheet](mdHelp.png "MarkDown Cheatsheet")
## Arbeitsaufträge / Aufgabeneinteilung
### Zu Vergeben
- Präsentation - Präsentation
- Programme: - Programme:
@ -40,12 +55,16 @@ Data should be sent and received via MQTT to an ESP32. The Pi acts as a sensor g
- Daten an einem Webserver anzeigen - Daten an einem Webserver anzeigen
| Kieler | Chiara | | Kieler | Chiara |
| -------------- | ------ | | ------ | ------ |
| Everything Git | | | Git | |
| | | | Readme | |
| | | | | |
# Credits ### Acknowledgments
[Chiara](https://git.miaig.dev/chiara) [Chiara](https://git.miaig.dev/chiara)
[Kieler](https://git.miaig.dev/mia) [Kieler](https://git.miaig.dev/mia)
### License
MIT

BIN
gitHelp.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 521 KiB

BIN
mdHelp.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 215 KiB