Refactor + documentation

This commit is contained in:
Maximilian Giller 2025-01-10 11:51:29 +01:00
parent 32853a0e7c
commit f9fdffbdbd
6 changed files with 11 additions and 2 deletions

View file

@ -1,10 +1,10 @@
# Max' Smart Home - MaSH
Should be a very simple **server** implementation of what is required in Max's smart home. Trying not to overcomplicate things and thereby ruin motivation to work on this.
Should be a (very simple?) **server** implementation of what is required in Max's smart home. Trying not to overcomplicate things and thereby ruin motivation to work on this.
## Sensors
- [ToF People Counter](https://github.com/mgfcf/mash-sensor-tof-pc)
- [ToF People Counter](https://github.com/mgfcf/mash-sensor-tof-pc)
## ToDo
@ -12,3 +12,12 @@ Should be a very simple **server** implementation of what is required in Max's s
- Daylight Adjustment (E.g. No ceiling lights during daytime)
- Save scene when turning off, to reapply same scene when turning on
- Detect fast flickering of light state, indicating an issue, and disable the system for a few minutes
## Structure
- `src/` - All code
- `main.py` - Entry point for execution
- `new_syntax_example.py` - Not in use, just noting some ideas about a potential syntax
- `core/` - Contains more abstract framework definitions
- `bridges/` - Contains latest code that manages connections to other services/devices
- `endpoints/` - Contains API routes and older handlers/bridges