# Connected Spaces - Connected Spaces - Gebäude, die mitdenken. Für heute. Für morgen.

# Allgemein

# HomeAssistant

# Namenskonventionen

<span style="white-space: pre-wrap;">Hier ist eine </span>**BookStack-taugliche Dokumentation**<span style="white-space: pre-wrap;"> mit neutralem Standort. Du kannst sie direkt als Seite in BookStack einfügen.</span>

# Namenskonvention für Home-Assistant-, Zigbee- und Smart-Home-Geräte

## 1. Ziel der Namenskonvention

Diese Namenskonvention dient dazu, Geräte, Sensoren, Aktoren, Automationen und technische Komponenten in Home Assistant eindeutig, lesbar und langfristig wartbar zu benennen.

Sie orientiert sich gedanklich an strukturierten Gebäudeautomationssystemen wie KNX oder GLT, ist jedoch für Home Assistant, Zigbee, MQTT, WLAN-Geräte, Kameras und weitere Integrationen praxisnah angepasst.

Ziel ist eine einheitliche Struktur für:

```text
Geräte
Entitäten
Automationen
Szenen
Dashboards
Dokumentation
Fehlersuche
spätere Erweiterungen
```

---

## 2. Grundstruktur

Die empfohlene Namensstruktur lautet:

```text
<STANDORT>-<BEREICH>-<TYP>-<NUMMER>-<FUNKTION>
```

Beispiel:

```text
SITE-GARTEN-BWV-01-RASEN
```

Bedeutung:

```text
SITE    = neutraler Standortcode
GARTEN  = Bereich / Raum / Zone
BWV     = Gerätetyp, hier Bewässerungsventil
01      = laufende Nummer
RASEN   = Funktion oder konkrete Zone
```

---

## 3. Standortcode

Der Standortcode beschreibt den Installationsort neutral und ohne personenbezogene oder vollständige Adressangabe.

Empfohlene neutrale Standortcodes:

```text
SITE
HAUS
HOME
OBJ01
STANDORT01
```

Für produktive Umgebungen mit mehreren Standorten empfiehlt sich:

```text
OBJ01
OBJ02
OBJ03
```

Beispiele:

```text
OBJ01-GARTEN-BWV-01-RASEN
OBJ01-TECH-ZBC-01-SONOFF
OBJ01-EG-BEW-01-FLUR
```

Wenn nur ein Standort vorhanden ist, reicht auch:

```text
HOME-GARTEN-BWV-01-RASEN
```

oder:

```text
SITE-GARTEN-BWV-01-RASEN
```

---

## 4. Bereiche

Der Bereich beschreibt Raum, Etage, Außenbereich oder technische Zone.

Empfohlene Bereichscodes:

```text
TECH     Technik / Server / Netzwerk
EG       Erdgeschoss
OG       Obergeschoss
DG       Dachgeschoss
KG       Keller
GARTEN   Garten
HOF      Hof / Einfahrt
AUSSEN   Allgemeiner Außenbereich
GARAGE   Garage
CARPORT  Carport
BAD      Badezimmer
KUECHE   Küche
WOHNEN   Wohnzimmer
SCHLAF   Schlafzimmer
BUERO    Büro
FLUR     Flur
```

Beispiele:

```text
SITE-TECH-ZBC-01-SONOFF
SITE-GARTEN-BWV-01-RASEN
SITE-EG-BEW-01-FLUR
SITE-GARAGE-STE-01-WERKBANK
```

---

## 5. Gerätetypen und Kürzel

### Zentrale Technik

```text
HA     Home Assistant
RPI    Raspberry Pi
SRV    Server
NAS    Netzwerkspeicher
SW     Netzwerk-Switch
AP     Access Point
RTR    Router
FW     Firewall
ZBC    Zigbee Coordinator
ZBR    Zigbee Router / Repeater
MQTT   MQTT-Broker
```

### Licht und Strom

```text
LIC    Licht / Leuchte
LAM    Lampe
STE    Steckdose
REL    Relais
DIM    Dimmer
SCH    Schalter
TAS    Taster
```

### Sensorik

```text
TEMP   Temperatursensor
HUM    Luftfeuchtesensor
FEU    Bodenfeuchtesensor
BEW    Bewegungsmelder
PIR    PIR-Bewegungsmelder
PRES   Präsenzsensor
TUR    Tür-/Fensterkontakt
FEN    Fensterkontakt
RAUCH  Rauchmelder
WASS   Wassersensor
HELL   Helligkeitssensor
BAT    Batteriesensor
```

### Bewässerung

```text
BWV    Bewässerungsventil
BWP    Bewässerungspumpe
BWS    Bewässerungssensor
REGEN  Regensensor
FEU    Bodenfeuchtesensor
```

### Klima und Energie

```text
THERM  Thermostat
HK     Heizkörper
KLIMA  Klimagerät
PV     Photovoltaik
WR     Wechselrichter
AKKU   Batteriespeicher
ZAEHL  Zähler
ENERG  Energiemessgerät
```

### Sicherheit und Kamera

```text
CAM    Kamera
NVR    Videorekorder
DOOR   Türklingel / Doorbell
ALARM  Alarmgerät
SIR    Sirene
LOCK   Schloss
```

---

## 6. Nummerierung

<span style="white-space: pre-wrap;">Die Nummer ist zweistellig und beginnt bei </span>`<span class="editor-theme-code">01</span>`.

Beispiele:

```text
01
02
03
```

Nicht empfohlen:

```text
1
2
3
```

Grund: Zweistellige Nummern sortieren sauberer und bleiben bei größeren Installationen übersichtlich.

Beispiele:

```text
SITE-GARTEN-BWV-01-RASEN
SITE-GARTEN-BWV-02-BEET
SITE-GARTEN-BWV-03-GEWAESHAUS
```

---

## 7. Funktion oder Zone

Die Funktion beschreibt den konkreten Zweck, die Zone oder den Einsatzort.

Beispiele:

```text
RASEN
BEET
TERRASSE
GEWAESHAUS
HAUSTUER
EINFAHRT
WERKBANK
FLUR
SERVER
```

Beispiele vollständiger Gerätenamen:

```text
SITE-GARTEN-BWV-01-RASEN
SITE-GARTEN-BWV-02-BEET
SITE-GARTEN-FEU-01-RASEN
SITE-GARTEN-FEU-02-BEET
SITE-TECH-ZBC-01-SONOFF
SITE-EG-BEW-01-FLUR
SITE-GARAGE-STE-01-WERKBANK
```

---

## 8. Home-Assistant-Entitäten

Home Assistant wandelt Gerätenamen meist in kleingeschriebene Entitäten mit Unterstrichen um.

Aus:

```text
SITE-GARTEN-BWV-01-RASEN
```

wird idealerweise:

```text
switch.site_garten_bwv_01_rasen
sensor.site_garten_bwv_01_rasen_battery
sensor.site_garten_bwv_01_rasen_linkquality
```

Empfohlene Entitätsstruktur:

```text
<domain>.<standort>_<bereich>_<typ>_<nummer>_<funktion>
```

Beispiele:

```text
switch.site_garten_bwv_01_rasen
sensor.site_garten_feu_01_rasen
binary_sensor.site_eg_tur_01_haustuer
camera.site_aussen_cam_01_einfahrt
light.site_eg_lic_01_flur
```

---

## 9. Beispiele für Zigbee-Geräte

### Zigbee Coordinator

Gerätename:

```text
SITE-TECH-ZBC-01-SONOFF
```

Beschreibung:

```text
Zigbee Coordinator für Home Assistant / ZHA
```

Mögliche Entitäten:

```text
sensor.site_tech_zbc_01_sonoff_status
sensor.site_tech_zbc_01_sonoff_linkquality
```

---

### Bewässerungsventil

Gerätename:

```text
SITE-GARTEN-BWV-01-RASEN
```

Mögliche Entität:

```text
switch.site_garten_bwv_01_rasen
```

Beschreibung:

```text
Zigbee-Bewässerungsventil für die Rasenbewässerung
```

---

### Bodenfeuchtesensor

Gerätename:

```text
SITE-GARTEN-FEU-01-RASEN
```

Mögliche Entitäten:

```text
sensor.site_garten_feu_01_rasen_moisture
sensor.site_garten_feu_01_rasen_battery
sensor.site_garten_feu_01_rasen_temperature
```

---

### Bewegungsmelder

Gerätename:

```text
SITE-EG-BEW-01-FLUR
```

Mögliche Entität:

```text
binary_sensor.site_eg_bew_01_flur_motion
```

---

### Steckdose

Gerätename:

```text
SITE-GARAGE-STE-01-WERKBANK
```

Mögliche Entität:

```text
switch.site_garage_ste_01_werkbank
```

---

## 10. Automationen

Automationen sollten ebenfalls nach einem einheitlichen Muster benannt werden.

Empfohlene Struktur:

```text
AUTO-<BEREICH>-<FUNKTION>-<NUMMER>
```

Beispiele:

```text
AUTO-GARTEN-BEWAESSERUNG-01
AUTO-GARTEN-BEWAESSERUNG-RASEN-MORGENS
AUTO-EG-LICHT-FLUR-BEWEGUNG
AUTO-AUSSEN-KAMERA-EINFAHRT-BEWEGUNG
```

Für Home Assistant kann der Anzeigename sprechender sein:

```text
Bewässerung Garten Rasen morgens
Licht Flur bei Bewegung einschalten
Kamera Einfahrt Bewegung melden
```

Die interne Entität kann daraus werden:

```text
automation.bewaesserung_garten_rasen_morgens
automation.licht_flur_bei_bewegung_einschalten
```

---

## 11. Beispiel: Bewässerungsautomation

Gerät:

```text
SITE-GARTEN-BWV-01-RASEN
```

Entität:

```text
switch.site_garten_bwv_01_rasen
```

Automation:

```text
AUTO-GARTEN-BEWAESSERUNG-RASEN-MORGENS
```

Beispielhafte Automation:

```yaml
alias: AUTO-GARTEN-BEWAESSERUNG-RASEN-MORGENS
description: Bewässert den Rasen morgens für 15 Minuten.
trigger:
  - platform: time
    at: "06:00:00"
condition: []
action:
  - service: switch.turn_on
    target:
      entity_id: switch.site_garten_bwv_01_rasen
  - delay: "00:15:00"
  - service: switch.turn_off
    target:
      entity_id: switch.site_garten_bwv_01_rasen
mode: single
```

Wichtig: Bewässerungsventile sollten immer mit automatischer Abschaltung betrieben werden.

Nicht empfohlen:

```text
nur einschalten
```

Empfohlen:

```text
einschalten → definierte Dauer warten → ausschalten
```

---

## 12. Regeln für gute Namen

### Verwenden

```text
Großbuchstaben für Gerätenamen
Bindestriche als Trenner
klare Bereichscodes
klare Typkürzel
zweistellige Nummern
sprechende Funktionsbezeichnung
```

Beispiel:

```text
SITE-GARTEN-BWV-01-RASEN
```

### Vermeiden

```text
Herstellernamen als Hauptname
unverständliche Zigbee-/Tuya-Bezeichnungen
Leerzeichen
Umlaute
Sonderzeichen
zu lange freie Namen
```

Nicht empfohlen:

```text
Tuya Valve
TS0601
Bewässerung neu
Garten Ding
Ventil 1
```

Besser:

```text
SITE-GARTEN-BWV-01-RASEN
```

---

## 13. Umgang mit Umlauten

Für technische Namen sollten Umlaute vermieden werden.

Empfohlene Schreibweise:

```text
Ä → AE
Ö → OE
Ü → UE
ß → SS
```

Beispiele:

```text
KUECHE
TUER
GEWAESHAUS
AUSSEN
```

Nicht empfohlen:

```text
Küche
Tür
Gewächshaus
Außen
```

---

## 14. Empfohlene Startstruktur

Für eine typische Home-Assistant-Installation kann folgender Anfang verwendet werden:

```text
SITE-TECH-HA-01
SITE-TECH-ZBC-01-SONOFF
SITE-TECH-MQTT-01
SITE-GARTEN-BWV-01-RASEN
SITE-GARTEN-FEU-01-RASEN
SITE-EG-BEW-01-FLUR
SITE-AUSSEN-CAM-01-EINFAHRT
SITE-GARAGE-STE-01-WERKBANK
```

---

## 15. Dokumentationsvorlage für einzelne Geräte

Für jedes Gerät sollte in BookStack eine kurze Gerätedokumentation gepflegt werden.

### Gerätename

```text
SITE-GARTEN-BWV-01-RASEN
```

### Gerätetyp

```text
Zigbee-Bewässerungsventil
```

### Bereich

```text
Garten
```

### Funktion

```text
Bewässerung der Rasenfläche
```

### Integration

```text
Home Assistant / ZHA
```

### Protokoll

```text
Zigbee
```

### Entitäten

```text
switch.site_garten_bwv_01_rasen
sensor.site_garten_bwv_01_rasen_battery
sensor.site_garten_bwv_01_rasen_linkquality
```

### Automationen

```text
AUTO-GARTEN-BEWAESSERUNG-RASEN-MORGENS
```

### Hinweise

```text
Das Ventil muss in Automationen immer mit automatischer Abschaltung verwendet werden.
```

---

## 16. Zusammenfassung

Die empfohlene Namenskonvention lautet:

```text
<STANDORT>-<BEREICH>-<TYP>-<NUMMER>-<FUNKTION>
```

Beispiel:

```text
SITE-GARTEN-BWV-01-RASEN
```

Für Home Assistant entstehen daraus saubere Entitäten wie:

```text
switch.site_garten_bwv_01_rasen
```

Diese Struktur ist:

```text
lesbar
erweiterbar
KNX-/GLT-nah
für Automationen geeignet
für Dokumentation geeignet
für spätere Fehlersuche hilfreich
```

Sie sollte konsequent für alle neuen Geräte, Entitäten und Automationen verwendet werden.