Updated readme and development environments
This commit is contained in:
parent
9bf8f089b6
commit
879c5eb881
3 changed files with 27 additions and 25 deletions
45
README.md
45
README.md
|
@ -17,18 +17,31 @@ Data should be sent and received via MQTT to an ESP32. The Pi acts as a sensor g
|
||||||
## Tech Stack / Hardware Requirements
|
## Tech Stack / Hardware Requirements
|
||||||
|
|
||||||
- **Raspberry Pi**: Model 4
|
- **Raspberry Pi**: Model 4
|
||||||
- **Programming languages**: Python, jinja2
|
- **Programming languages**: Python, jinja, HTML, CSS, JavaScript
|
||||||
- **Frameworks/tools/Libraries**:
|
- **Frameworks/tools/Libraries**:
|
||||||
- Webserver:
|
- Webserver:
|
||||||
- Flask
|
- flask
|
||||||
- Json
|
- json
|
||||||
- Sensors: Temperature,
|
- matplotlib
|
||||||
|
- hashlib
|
||||||
|
- socket
|
||||||
|
- threading
|
||||||
|
- os
|
||||||
|
- datetime
|
||||||
|
- Sensors:
|
||||||
|
- datetime
|
||||||
|
- time
|
||||||
|
- json
|
||||||
|
- os
|
||||||
|
- board
|
||||||
|
- adafruit_dht
|
||||||
|
- digitalio
|
||||||
|
- RPI.GPIO
|
||||||
|
|
||||||
- **Sensors**:
|
- **Sensors**:
|
||||||
- LDR (Lightsensor)
|
- LDR (Lightsensor)
|
||||||
- Sound Detector
|
- Sound Detector
|
||||||
- Temperature
|
|
||||||
- Temperature and humidity
|
- Temperature and humidity
|
||||||
- ...
|
|
||||||
|
|
||||||
## Docs
|
## Docs
|
||||||
|
|
||||||
|
@ -72,18 +85,13 @@ Data should be sent and received via MQTT to an ESP32. The Pi acts as a sensor g
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
- `requirements.txt`
|
|
||||||
This file holds the requirements for pip
|
|
||||||
- `shell.nix`
|
- `shell.nix`
|
||||||
This file is only used on nixos and for the nix packagemananger
|
This file is only used for the nix packagemananger to set up a development environment for the Webserver only
|
||||||
- `.envrc`
|
- `.envrc`
|
||||||
This is also a bit of linuz nixos magic to automatically set up the development environment using direnv
|
This is also a bit of linux nixos magic to automatically set up the development environment using direnv
|
||||||
- `main.py`
|
- `main.py`
|
||||||
The main file for the project
|
The main file for the project
|
||||||
|
|
||||||
- `The Graphs`
|
|
||||||
https://ron.sh/creating-real-time-charts-with-fastapi/
|
|
||||||
|
|
||||||
### Git Help
|
### Git Help
|
||||||
|
|
||||||

|

|
||||||
|
@ -111,25 +119,22 @@ Data should be sent and received via MQTT to an ESP32. The Pi acts as a sensor g
|
||||||
|
|
||||||
## Arbeitsaufträge / Aufgabeneinteilung
|
## Arbeitsaufträge / Aufgabeneinteilung
|
||||||
|
|
||||||
### Zu Vergeben
|
|
||||||
|
|
||||||
- Präsentation
|
| Mia | Chiara |
|
||||||
|
|
||||||
| Kieler | Chiara |
|
|
||||||
| --------------------------------- | --------------------------------------------- |
|
| --------------------------------- | --------------------------------------------- |
|
||||||
| Git | Daten von RPI erfassen und sauber abspeichern |
|
| Git | Daten von RPI erfassen und sauber abspeichern |
|
||||||
| Readme | |
|
| Readme | Präsentation |
|
||||||
| Daten an einem Webserver anzeigen | |
|
| Daten an einem Webserver anzeigen | |
|
||||||
|
|
||||||
### Acknowledgments
|
### Acknowledgments
|
||||||
|
|
||||||
[Chiara](https://git.miaig.dev/chiara)
|
[Chiara](https://git.miaig.dev/chiara)
|
||||||
[Kieler](https://git.miaig.dev/mia)
|
[Mia](https://git.miaig.dev/mia)
|
||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
PiWebSense
|
PiWebSense
|
||||||
Copyright (C) 2025 Kieler, Chiara
|
Copyright (C) 2025 Mia, Chiara
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
This program is free software: you can redistribute it and/or modify
|
||||||
it under the terms of the GNU Affero General Public License Version 3.0 as published by
|
it under the terms of the GNU Affero General Public License Version 3.0 as published by
|
||||||
|
|
2
main.py
2
main.py
|
@ -1,4 +1,4 @@
|
||||||
# Copyright 2025 Kieler, Chiara
|
# Copyright 2025 Mia, Chiara
|
||||||
#
|
#
|
||||||
# Licensed under the AGPLv3.0 (the "License");
|
# Licensed under the AGPLv3.0 (the "License");
|
||||||
# You may not use this file except in compliance with the License.
|
# You may not use this file except in compliance with the License.
|
||||||
|
|
|
@ -6,10 +6,7 @@ pkgs.mkShell {
|
||||||
matplotlib
|
matplotlib
|
||||||
numpy
|
numpy
|
||||||
flask
|
flask
|
||||||
|
rpi-gpio
|
||||||
]))
|
]))
|
||||||
];
|
];
|
||||||
# shellHook = ''
|
|
||||||
# export SHELL=${pkgs.zsh}/bin/zsh
|
|
||||||
# exec ${pkgs.zsh}/bin/zsh
|
|
||||||
# '';
|
|
||||||
}
|
}
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue