set up of initial structure

This commit is contained in:
2021-03-07 19:09:32 +01:00
parent a52aea0137
commit 3cf5892f93
18 changed files with 111 additions and 13 deletions

1
docs/alexa.md Normal file
View File

@@ -0,0 +1 @@
Dokumentation wird noch erstellt...

7
docs/bsh.md Normal file
View File

@@ -0,0 +1,7 @@
# BoschSmartHome System
Dokumentation wird noch erstellt...
## Geräte
## bsh2mqtt Adapter

1
docs/fhem.md Normal file
View File

@@ -0,0 +1 @@
Dokumentation wird noch erstellt...

1
docs/floorheating.md Normal file
View File

@@ -0,0 +1 @@
Dokumentation wird noch erstellt...

1
docs/garagedoor.md Normal file
View File

@@ -0,0 +1 @@
Dokumentation wird noch erstellt...

1
docs/gardencontrol.md Normal file
View File

@@ -0,0 +1 @@
Dokumentation wird noch erstellt...

BIN
docs/icon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.2 KiB

View File

@@ -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

10
docs/mobilealerts.md Normal file
View File

@@ -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

1
docs/mqtt.md Normal file
View File

@@ -0,0 +1 @@
Dokumentation wird noch erstellt...

22
docs/network.md Normal file
View File

@@ -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.

1
docs/nodered.md Normal file
View File

@@ -0,0 +1 @@
Dokumentation wird noch erstellt...

1
docs/openhab.md Normal file
View File

@@ -0,0 +1 @@
Dokumentation wird noch erstellt...

1
docs/openhabgui.md Normal file
View File

@@ -0,0 +1 @@
Dokumentation wird noch erstellt...

1
docs/tasmota.md Normal file
View File

@@ -0,0 +1 @@
Dokumentation wird noch erstellt...

1
docs/tuya.md Normal file
View File

@@ -0,0 +1 @@
Dokumentation wird noch erstellt...

1
docs/usbcasecontrol.md Normal file
View File

@@ -0,0 +1 @@
Dokumentation wird noch erstellt...

View File

@@ -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