diff --git a/README.md b/README.md index fe304df..7b225c1 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/src/fritzbox/__init__.py b/src/bridges/fritzbox/__init__.py similarity index 100% rename from src/fritzbox/__init__.py rename to src/bridges/fritzbox/__init__.py diff --git a/src/fritzbox/fritzbox_bridge.py b/src/bridges/fritzbox/fritzbox_bridge.py similarity index 100% rename from src/fritzbox/fritzbox_bridge.py rename to src/bridges/fritzbox/fritzbox_bridge.py diff --git a/src/z2m/__init__.py b/src/bridges/z2m/__init__.py similarity index 100% rename from src/z2m/__init__.py rename to src/bridges/z2m/__init__.py diff --git a/src/z2m/entities/contact_sensor_z2m.py b/src/bridges/z2m/entities/contact_sensor_z2m.py similarity index 100% rename from src/z2m/entities/contact_sensor_z2m.py rename to src/bridges/z2m/entities/contact_sensor_z2m.py diff --git a/src/z2m/zigbee2mqtt_bridge.py b/src/bridges/z2m/zigbee2mqtt_bridge.py similarity index 100% rename from src/z2m/zigbee2mqtt_bridge.py rename to src/bridges/z2m/zigbee2mqtt_bridge.py