enocean
Allgemein
Enocean plugin zur Integration von Enocean Funksensoren und -aktoren, z.B. von Eltako, Gira, Hoppe, Peha.
Anforderungen
Es wird ein Hardware Radio Transceiver Modul benötigt, z.B.:
USB 300
Fam4Pi
EnOcean PI 868 Funk Modul
Wichtig
Der user smarthome, unter dem smarthomeNG ausgeführt wird, muss die nötigen Zugriffsrechte auf die Linux Gruppe dialout besitzen, damit die Hardware über Linux devices angesprochen und konfiguriert werden kann.
Hierzu folgendes in der Linux Konsole ausführen:
sudo gpasswd --add smarthome dialout
Aktoren, Schalter oder Stellglieder, die vom Enocean plugin gesteuert werden sollen, müssen vorher einmalig angelert werden. Der Anlernvorgang wird unten im Kaptiel Webinterface beschrieben. Für das Auslesen von Statusinfromationen von Enocean Sensoren ist kein Anlernvorgang nötig.
Konfiguration
Die Informationen zur Konfiguration des Plugins sind unter Plugin ‚enocean‘ Konfiguration beschrieben.
plugin.yaml
serialport
Hier wird der serialport zum Enocean Hardwareadapter angegeben werden. Unter Linux wird empfohlen, das entsprechende Linux Uart device über eine Udev-Regel auf einen Link zu mappen und diesen Link dann als serialport anzugeben.
tx_id
Die tx_id ist die Transmitter ID der Enocean Hardware und als achtstelliger Hexadezimalwert definiert. Die Angabe ist erstmal optional und muss nur zwingend angegeben werden, falls Enocean Aktoren geschaltet werden sollen, d.h. der Hardware Kontroller auch Senebefehle absetzen muss.
Werden mehrere Aktuatoren betrieben, sollte die Base-ID (not Unique-ID or Chip-ID) der Enocean Hardware als Transmitter ID angegeben werden. Weitere Information zum Unterschied zwischen Base-ID und Chip-ID finden sich unter:
Über die Angabe der Base-ID können für die Kommunikation mit den Aktuatoren 128 verschiedene Sende-IDs im Wertebereich von (Base-ID und Base-ID + 127) vergeben werden.
Wie bekommt man die Base-ID des Enocean Adapters?
Es gibt zwei verschiedene Wege, um die Base ID der Enocean Hardware auszulesen:
Über das Enocean Plugin Webinterface
Über die smarthomeNG Logdateien, die durch das Enocean plugin erzeugt werden.
Zu a)
Konfiguriere das Enocean plugin in der plugin.yaml mit leerer tx_id (oder tx_id = 0).
Starte SmarthomeNG neu.
Öffne das Enocean webinterface des Plugins unter: http://smarthome.local:8383/enocean
Ablesen der Transceiver’s BaseID, welches auf der oberen recten Seite angezeigt wird.
Übernahme der im Webinterface angezeigten Base-ID in die plugin.yaml als Parameter tx_id.
Zu b)
Konfiguriere das Enocean plugin in der plugin.yaml mit leerer tx_id (oder tx_id = 0).
Konfiguriere das Loglevel INFO in logger.yaml für das Enocean Plugin. Alternativ über das Admin Interface unter Logger
Starte SmarthomeNG neu.
Nach dem Neustart das Logfile öffnen und nach dem Eintrag
enocean: Base ID = 0xYYYYZZZZsuchen.
Übernahme dieser im Log angezeigten Base-ID in die plugin.yaml als Parameter tx_id.
item.yaml
#### enocean_rx_id, enocean_rx_eep and enocean_tx_id_offset
Ein EnOcean Item (Sensor oder Aktor) muss mindestens ein enocean_rx_id und ein enocean_rx_eep Attribut definieren.
Der Attribut ``enocean_rx_id‘‘ gibt dabei die eindeutige ID (EnOcean Identification Number) als hexadezimaler String an. Dieser ist auf dem Gerät vermerkt.
Alternativ kann über das Webinterface unbekannte IDs von sendeden Enocean Geräten in der Nähe angezeigt werden.
Die Enocean EEP gibt das EnOcean Equipment Profile an. Das Datenblatt des Enocean Geräts verrät, welche EEPs unterstützt werden. In einer Nachricht einer bestimmten Nachricht können sich verschiedene Signale wie z.B. Batteriestatus, Schaltstatus (an/aus) etc. befinden. Um diese Signale den einzelnen smarthomeNG Items zuzuordnen, werden abgekürzte Keys verwendet und als Attribut ``enocean_rx_key angegeben.
Im Beispiel sind die verschiedenen Keys ersichtlich. Folgende Keys werden vom Plugin unterstützt:
Schalter mit zwei Tastern, (EEP F6_02_01 oder F6_02_02)
AI = left rocker down A0 = left rocker up BI = right rocker down B0 = right rocker up
**Schalter mit zwei Tastern), (EEP F6_02_03)
AI = left rocker down A0 = left rocker up BI = right rocker down B0 = right rocker up A = last state of left rocker B = last state of right rocker
Fenstergriff, (EEP F6_10_0)
STATUS = handle_status
Sendende Items, z.B. um Schaltaktoren zu schalten, benötigen weiterhin eine Transmitting ID. Diese wird im Attribut enocean_tx_id_offset definiert.
Enocean Equipment Profiles
Das Encoean Protokoll basiert auf sogenannten EnOcean Equipment Profilen (EEPs). Sie definieren den Nachrichtentyp der vm EnOcean Gerät gesendet wird. EEPs sind standardisiert. Informationen dazu können unter http://www.enocean-alliance.org/eep/ gefunden werden.
Status EEPs
Die folgenden Status EEPs werden vom Plugin aktuell unterstützt:
A5_02_01 - A5_02_0B Temperature Sensors (40°C overall range, various starting offsets, 1/6°C resolution)
A5_02_10 - A5_02_1B Temperature Sensors (80°C overall range, various starting offsets, 1/3°C resolution)
A5_02_20 High Precision Temperature Sensor (ranges -10*C to +41.2°C, 1/20°C resolution)
A5_02_30 High Precision Temperature Sensor (ranges -40*C to +62.3°C, 1/10°C resolution)
A5_04_02 Energy (optional), humidity and temperature sensor
A5_07_03 Occupancy sensor, e.g. NodOn PIR-2-1-0x
A5_08_01 Brightness and movement sensor
A5_11_04 Dimmer status feedback
A5_12_01 Power Measurement, e.g. Eltako FSVA-230V
A5_0G_03 shutter feedback in s if actor is stopped before reaching his position (for calculation of new position)
A5_30_01 Alarm sensor, e.g. Eltako FSM60B water leak sensor
A5_30_03 Alarm sensor, e.g. Eltako FSM60B water leak sensor
D2_01_07 Simple electronic switch
D2_01_12 Simple electronic switch with 2 channels, like NodOn In-Wall module
D5_00_01 Door/Window Contact, e.g. Eltako FTK, FTKB
F6_02_01 2-Button-Rocker
F6_02_02 2-Button-Rocker
F6_02_03 2-Button-Rocker, Status feedback from manual buttons on different actors, e.g. Eltako FT55, FSUD-230, FSVA-230V, FSB61NP-230V or Gira switches.
F6_10_00 Mechanical Handle (value: 0(closed), 1(open), 2(tilted)
F6_0G_03 Feedback of shutter actor (Eltako FSB14, FSB61, FSB71 - actor for Shutter) if reaching the endposition and if motor is active
Eine vollständige Liste aller EEPs mit detallierten Informationen findet sich unter [EnOcean Alliance](http://www.enocean-alliance.org/eep/)
Steuer EEPs
Die folgenden Sende EEPs werden vom Plugin aktuell unterstützt:
A5_38_08_01 Regular switch actor command (on/off)
A5_38_08_02 Dimmer command with fix on off command (on: 100, off:0)
A5_38_08_03 Dimmer command with specified dim level (0-100)
A5_3F_7F Universal actuator command, e.g. blind control
D2_01_07 Simple electronic switch
D2_01_12 Simple electronic switch with 2 channels
Web Interface
Das enocean Plugin verfügt über ein Webinterface.
Aufruf des Webinterfaces
Das Plugin kann aus dem Admin Interface aufgerufen werden. Dazu auf der Seite Plugins in der entsprechenden Zeile das Icon in der Spalte Web Interface anklicken.
Außerdem kann das Webinterface direkt über http://smarthome.local:8383/enocean aufgerufen werden.
Das Webinterface zeigt oben rechts allgemeine Informationen, wie
die BaseID der verwendeten Hardware
ob der Sendemodus aktiviert ist
ob empfangene Enocean Nachrichten von unbekannten (nicht konfigurierten) Geräten in die Konsole geloggt werden sollen
ob der UTE Anlernmodus aktiviert ist.
Weiterhin können über Schaltflächen
der Sendemodus aktiviert und deaktiviert werden
der UTE Anlernmodus aktiviert und deaktiviert werden
das Logging von empfangenen Nachrichten unbekannten Enocean Geräte aktiviert und deaktiviert werden.
Unter dem TAB Übersicht werden alle konfigurierten Enocean items angezeigt.
Unter dem TAB ‚Neu anlerenen‘ können neue Enocean Aktuatoren angelernt werden. Hierzu wird
Der entsprechende Aktor/Stellglied in den Anlernmodus gebracht (siehe jeweilige Bedienungsanleitung)
Eine Transmit ID ausgewählt (TX ID). Enocean unterstützt bis zu 127 verschiedene IDs.
c) Als Hinweis bzw. Vorschlag wird die erste freie ID auf der linken Seite angezeigt. c) Der Aktortyp ausgwählt. Im Plugin wird anhand des Typs das Lerntelegram ausgewählt. d) Auf die Schaltfläche
Anlernenklicken. Das Anlerntelegram wird gesendet und der Aktor sollte den Anlernvorgang quittieren (siehe jeweilige Bedienungsanleitung).
Beispiele
Beispiele für eine Item.yaml mit verschiedenen Enocean Sensoren und Aktoren:
EnOcean_Item:
Outside_Temperature:
type: num
enocean_rx_id: 0180924D
enocean_rx_eep: A5_02_05
enocean_rx_key: TMP
Door:
enocean_rx_id: 01234567
enocean_rx_eep: D5_00_01
status:
type: bool
enocean_rx_key: STATUS
FT55switch:
enocean_rx_id: 012345AA
enocean_rx_eep: F6_02_03
up:
type: bool
enocean_rx_key: BO
down:
type: bool
enocean_rx_key: BI
Brightness_Sensor:
name: brightness_sensor_east
remark: Eltako FAH60
type: num
enocean_rx_id: 01A51DE6
enocean_rx_eep: A5_06_01
enocean_rx_key: BRI
visu_acl: rw
sqlite: 'yes'
dimmer1:
remark: Eltako FDG14 - Dimmer
enocean_rx_id: 00112233
enocean_rx_eep: A5_11_04
light:
type: bool
enocean_rx_key: STAT
enocean_tx_eep: A5_38_08_02
enocean_tx_id_offset: 1
level:
type: num
enocean_rx_key: D
enocean_tx_eep: A5_38_08_03
enocean_tx_id_offset: 1
ref_level: 80
dim_speed: 100
block_dim_value: 'False'
handle:
enocean_rx_id: 01234567
enocean_rx_eep: F6_10_00
status:
type: num
enocean_rx_key: STATUS
actor1:
enocean_rx_id: FFAABBCC
enocean_rx_eep: A5_12_01
power:
type: num
enocean_rx_key: VALUE
actor1B:
remark: Eltako FSR61, FSR61NP, FSR61G, FSR61LN, FLC61NP - Switch for Ligths
enocean_rx_id: 1A794D3
enocean_rx_eep: F6_02_03
light:
type: bool
enocean_tx_eep: A5_38_08_01
enocean_tx_id_offset: 1
enocean_rx_key: B
block_switch: 'False'
cache: 'True'
enforce_updates: 'True'
visu_acl: rw
actor_D2:
remark: Actor with VLD Command
enocean_rx_id: FFDB7381
enocean_rx_eep: D2_01_07
move:
type: bool
enocean_rx_key: STAT
enocean_tx_eep: D2_01_07
enocean_tx_id_offset: 1
# pulsewith-attribute removed use autotimer functionality instead
autotimer: 1 = 0
actorD2_01_12:
enocean_rx_id: 050A2FF4
enocean_rx_eep: D2_01_12
switch:
cache: 'on'
type: bool
enocean_rx_key: STAT_A
enocean_channel: A
enocean_tx_eep: D2_01_12
enocean_tx_id_offset: 2
awning:
name: Eltako FSB14, FSB61, FSB71
remark: actor for Shutter
type: str
enocean_rx_id: 1A869C3
enocean_rx_eep: F6_0G_03
enocean_rx_key: STATUS
move:
type: num
enocean_tx_eep: A5_3F_7F
enocean_tx_id_offset: 0
enocean_rx_key: B
enocean_rtime: 60
block_switch: 'False'
enforce_updates: 'True'
cache: 'True'
visu_acl: rw
rocker:
enocean_rx_id: 0029894A
enocean_rx_eep: F6_02_01
short_800ms_directly_to_knx:
type: bool
enocean_rx_key: AI
enocean_rocker_action: **toggle**
enocean_rocker_sequence: released **within** 0.8
knx_dpt: 1
knx_send: 3/0/60
long_800ms_directly_to_knx:
type: bool
enocean_rx_key: AI
enocean_rocker_action: toggle
enocean_rocker_sequence: released **after** 0.8
knx_dpt: 1
knx_send: 3/0/61
rocker_double_800ms_to_knx_send_1:
type: bool
enforce_updates: true
enocean_rx_key: AI
enocean_rocker_action: **set**
enocean_rocker_sequence: **released within 0.4, pressed within 0.4**
knx_dpt: 1
knx_send: 3/0/62
brightness_sensor:
enocean_rx_id: 01234567
enocean_rx_eep: A5_08_01
lux:
type: num
enocean_rx_key: BRI
movement:
type: bool
enocean_rx_key: MOV
occupancy_sensor:
enocean_rx_id: 01234567
enocean_rx_eep: A5_07_03
lux:
type: num
enocean_rx_key: ILL
movement:
type: bool
enocean_rx_key: PIR
voltage:
type: bool
enocean_rx_key: SVC
temperature_sensor:
enocean_rx_id: 01234567
enocean_rx_eep: A5_04_02
temperature:
type: num
enocean_rx_key: TMP
humidity:
type: num
enocean_rx_key: HUM
power_status:
type: num
enocean_rx_key: ENG
sunblind:
name: Eltako FSB14, FSB61, FSB71
remark: actor for Shutter
type: str
enocean_rx_id: 1A869C3
enocean_rx_eep: F6_0G_03
enocean_rx_key: STATUS
# runtime Range [0 - 255] s
enocean_rtime: 80
Tgt_Position:
name: Eltako FSB14, FSB61, FSB71
remark: Pos. 0...255
type: num
enocean_rx_id: ..:.
enocean_rx_eep: ..:.
enforce_updates: 'True'
cache: 'True'
visu_acl: rw
Act_Position:
name: Eltako FSB14, FSB61, FSB71
remark: Ist-Pos. 0...255 berechnet aus (letzer Pos. + Fahrzeit * 255/rtime)
type: num
enocean_rx_id: ..:.
enocean_rx_eep: ..:.
enocean_rx_key: POSITION
enforce_updates: 'True'
cache: 'True'
visu_acl: rw
eval: min(max(value, 0), 255)
on_update:
- EnOcean_Item.sunblind = 'stopped'
Run:
name: Eltako FSB14, FSB61, FSB71
remark: Ansteuerbefehl 0x00, 0x01, 0x02
type: num
enocean_rx_id: ..:.
enocean_rx_eep: ..:.
enocean_tx_eep: A5_3F_7F
enocean_tx_id_offset: 0
enocean_rx_key: B
enocean_rtime: ..:.
# block actuator
block_switch: 'True'
enforce_updates: 'True'
cache: 'True'
visu_acl: rw
struct: uzsu.child
Movement:
name: Eltako FSB14, FSB61, FSB71
remark: Wenn Rolladen gestoppt wurde steht hier die gefahrene Zeit in s und die Richtung
type: num
enocean_rx_id: ..:.
enocean_rx_eep: A5_0G_03
enocean_rx_key: MOVE
cache: 'False'
enforce_updates: 'True'
eval: value * 255/int(sh.EnOcean_Item.sunblind.property.enocean_rtime)
on_update:
- EnOcean_Item.sunblind = 'stopped'
- EnOcean_Item.sunblind.Act_Position = EnOcean_Item.sunblind.Act_Position() + value
RGBdimmer:
type: num
remark: Eltako FRGBW71L - RGB Dimmer
enocean_rx_id: 1A869C3
enocean_rx_eep: A5_3F_7F
enocean_rx_key: DI_0
red:
type: num
enocean_tx_eep: 07_3F_7F
enocean_tx_id_offset: 1
enocean_rx_key: DI_0
ref_level: 80
dim_speed: 100
color: red
green:
type: num
enocean_tx_eep: 07_3F_7F
enocean_tx_id_offset: 1
enocean_rx_key: DI_1
ref_level: 80
dim_speed: 100
color: green
blue:
type: num
enocean_tx_eep: 07_3F_7F
enocean_tx_id_offset: 1
enocean_rx_key: DI_2
ref_level: 80
dim_speed: 100
color: blue
white:
type: num
enocean_tx_eep: 07_3F_7F
enocean_tx_id_offset: 1
enocean_rx_key: DI_3
ref_level: 80
dim_speed: 100
color: white
water_sensor:
enocean_rx_id: 00000000
enocean_rx_eep: A5_30_03
alarm:
type: bool
enocean_rx_key: ALARM
visu_acl: ro
temperature:
type: num
enocean_rx_key: TEMP
visu_acl: ro