Refactor + documentation
This commit is contained in:
parent
32853a0e7c
commit
f9fdffbdbd
6 changed files with 11 additions and 2 deletions
11
README.md
11
README.md
|
@ -1,6 +1,6 @@
|
||||||
# Max' Smart Home - MaSH
|
# 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
|
## Sensors
|
||||||
|
|
||||||
|
@ -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)
|
- Daylight Adjustment (E.g. No ceiling lights during daytime)
|
||||||
- Save scene when turning off, to reapply same scene when turning on
|
- 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
|
- 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
|
||||||
|
|
Loading…
Reference in a new issue