diff --git a/docs/alexa.md b/docs/alexa.md new file mode 100644 index 0000000..32505f4 --- /dev/null +++ b/docs/alexa.md @@ -0,0 +1 @@ +Dokumentation wird noch erstellt... \ No newline at end of file diff --git a/docs/bsh.md b/docs/bsh.md new file mode 100644 index 0000000..d75a8f3 --- /dev/null +++ b/docs/bsh.md @@ -0,0 +1,7 @@ +# BoschSmartHome System +Dokumentation wird noch erstellt... + +## Geräte + + +## bsh2mqtt Adapter \ No newline at end of file diff --git a/docs/fhem.md b/docs/fhem.md new file mode 100644 index 0000000..32505f4 --- /dev/null +++ b/docs/fhem.md @@ -0,0 +1 @@ +Dokumentation wird noch erstellt... \ No newline at end of file diff --git a/docs/floorheating.md b/docs/floorheating.md new file mode 100644 index 0000000..32505f4 --- /dev/null +++ b/docs/floorheating.md @@ -0,0 +1 @@ +Dokumentation wird noch erstellt... \ No newline at end of file diff --git a/docs/garagedoor.md b/docs/garagedoor.md new file mode 100644 index 0000000..32505f4 --- /dev/null +++ b/docs/garagedoor.md @@ -0,0 +1 @@ +Dokumentation wird noch erstellt... \ No newline at end of file diff --git a/docs/gardencontrol.md b/docs/gardencontrol.md new file mode 100644 index 0000000..32505f4 --- /dev/null +++ b/docs/gardencontrol.md @@ -0,0 +1 @@ +Dokumentation wird noch erstellt... \ No newline at end of file diff --git a/docs/icon.png b/docs/icon.png new file mode 100644 index 0000000..22f6e86 Binary files /dev/null and b/docs/icon.png differ diff --git a/docs/index.md b/docs/index.md index 000ea34..cd3e31e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,28 @@ -# Welcome to MkDocs +# Home Automation Dokumentation -For full documentation visit [mkdocs.org](https://www.mkdocs.org). +In dieser Dokumententation wird das HomeAutomation System in unserem Haus dokumentiert: -## Commands +Hohe Str. 1/3 -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. +71711 Steinheim an der Murr -## Project layout +Deutschland - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +## Bestandteile +Das HomeAutomation System besteht aus HW und SW Teilen von verschiedenen Herstellern und auch aus selbstentwickelter Hardware und Software. + +Alle Teile sind über das Alexa Sprachsystem bedienbar. +Hierzu wird unter anderem eine HueBridge Emulation in NodeRed benutzt um eigene Geräte einzubinden. + +Ebenso wird es eine Bedienoberfläche für alle Funktionen in OpenHAB geben. + +Alles Teile sind in der Lage über MQTT zu kommunizieren. + +Für die Geräte, die von Hause aus keine solche Schnittstelle liefern, sind eigene Adapter/Services implementiert worden, wie z.B. für Tuya & BSH Geräte. + +Das System wird permanent erweitert und überarbeitet. + +## Offene Punkte + +- [ ] Dokumentation vervollständigen +- [ ] Garagentorsteuerung: Kommunikation überarbeiten \ No newline at end of file diff --git a/docs/mobilealerts.md b/docs/mobilealerts.md new file mode 100644 index 0000000..0d8bf05 --- /dev/null +++ b/docs/mobilealerts.md @@ -0,0 +1,10 @@ +# Mobile Alerts +Mobile Alerts ist ein System für verschiedene Sensoren, dass von ELV vertrieben wird. Es verfügt über eine eigene EthernetBridge, um die Sensoren an ein Netzwerk anzubinden. + +Wir setzen die folgenden Sensor-Typen ein: + +- Temperatur/Luftfeuchte-Sensor +- Temperatur/Luftfeuchte-Sensor mit Historie +- Aussentemperatursensor +- Windsensor +- Regensensor \ No newline at end of file diff --git a/docs/mqtt.md b/docs/mqtt.md new file mode 100644 index 0000000..32505f4 --- /dev/null +++ b/docs/mqtt.md @@ -0,0 +1 @@ +Dokumentation wird noch erstellt... \ No newline at end of file diff --git a/docs/network.md b/docs/network.md new file mode 100644 index 0000000..91cd988 --- /dev/null +++ b/docs/network.md @@ -0,0 +1,22 @@ +# Netzwerk Übersicht + +## Port Freigaben + +## ThinkCentre Computer + +### Windows 10 Professional - host with WSL2/Ubuntu 20.04 + +#### Docker + +##### Docker-Swag & Nginx Container +##### Fhem Container +##### OpenHub Container +##### Mosquitto Container +##### Nextcloud Container +##### Gitea Container + +#### Ubuntu 20.04 VM running on Hyper-V + +##### Node-Red +Für die Hue-Bridge Emulation wird ein System mit freiem Port 80 benötigt, dass ebenso auf Multi-Casts reagieren kann. +Daher habe ich Node-Red in einer Ubuntu VM installiert, die vollen Netzwerkzugriff innerhalt des lokalen Netzwerkes hat, damit Alexa und die andere Devices die emulierte Hue-Bridge erreichen können und neue Devices automatisch in der Gerätesuche erkennen. diff --git a/docs/nodered.md b/docs/nodered.md new file mode 100644 index 0000000..32505f4 --- /dev/null +++ b/docs/nodered.md @@ -0,0 +1 @@ +Dokumentation wird noch erstellt... \ No newline at end of file diff --git a/docs/openhab.md b/docs/openhab.md new file mode 100644 index 0000000..32505f4 --- /dev/null +++ b/docs/openhab.md @@ -0,0 +1 @@ +Dokumentation wird noch erstellt... \ No newline at end of file diff --git a/docs/openhabgui.md b/docs/openhabgui.md new file mode 100644 index 0000000..32505f4 --- /dev/null +++ b/docs/openhabgui.md @@ -0,0 +1 @@ +Dokumentation wird noch erstellt... \ No newline at end of file diff --git a/docs/tasmota.md b/docs/tasmota.md new file mode 100644 index 0000000..32505f4 --- /dev/null +++ b/docs/tasmota.md @@ -0,0 +1 @@ +Dokumentation wird noch erstellt... \ No newline at end of file diff --git a/docs/tuya.md b/docs/tuya.md new file mode 100644 index 0000000..32505f4 --- /dev/null +++ b/docs/tuya.md @@ -0,0 +1 @@ +Dokumentation wird noch erstellt... \ No newline at end of file diff --git a/docs/usbcasecontrol.md b/docs/usbcasecontrol.md new file mode 100644 index 0000000..32505f4 --- /dev/null +++ b/docs/usbcasecontrol.md @@ -0,0 +1 @@ +Dokumentation wird noch erstellt... \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index c97182f..2b4a4b1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1 +1,37 @@ -site_name: My Docs +site_name: Home Automation Dokumentation +theme: + name: material + language: de + font: false + favicon: icon.png + logo: icon.png + features: + - navigation.tabs + - navigation.tabs.sticky +markdown_extensions: + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.tabbed + - pymdownx.superfences +nav: + - Home: index.md + - Bedienung: + - Alexa: alexa.md + - OpenHab: openhabgui.md + - Hardware&Infrastruktur: + - Netzwerk: network.md + - MobileAlerts: mobilealerts.md + - BoschSmartHome: bsh.md + - Tasmota: tasmota.md + - Tuya: tuya.md + - Software: + - MQTT: mqtt.md + - FHem: fhem.md + - OpenHab: openhab.md + - NodeRed: nodered.md + - Eigenentwicklungen: + - Fussbodenheizung: floorheating.md + - GaragentorSteuerung: garagedoor.md + - USBCaseControl: usbcasecontrol.md + - GartenSteuerung: gardencontrol.md + \ No newline at end of file