FHEMWiki - Benutzerbeiträge [de]

G-Homa

2017-08-09T10:09:38Z

Micomat: /* WLAN konfigurieren */

{{Infobox Modul
|Name=GHoma
|ModPurpose=Anbindung der WIFI Steckdose G-Homa
|ModCmdRef=GHoma
|ModType=d
|ModForumArea=Sonstige Systeme
|ModTechName=53_GHoma.pm
|ModOwner=klausw
}}

Die G-Homa oder GHoma Steckdose ist eine per WLAN schaltbare Steckdose. Diese Steckdose wird in vielen Baumärkten und im Internet vertrieben. Das Modul unterstützt die "set extensions". 
Es gibt sowohl eine Indoor, als auch eine Outdoor Variante.

==Vorbereitung der Steckdose==
Standardmäßig verbindet sich die Dose zu einem Server in der Cloud. Damit sie mit FHEM funktoiniert, muss diese Konfiguration angepasst werden.
===WLAN konfigurieren===
* Gerät in den AP Modus bringen (Knopf für mehr als 3s drücken, diesen Schritt wiederholen bis die LED permanent leuchtet)
* Nun einen Computer mit der SSID <code>G-Homa</code> verbinden.
* Im Browser zu http://10.10.100.254 (username:passwort = admin:admin)
* In STA Setting WLAN Einstellungen eintragen

'''Hinweis:''' Ab einer Firmware >1.0.06 wird in diesen Geräten die Konfiguration über HTTP nicht mehr unterstützt. In diesem Fall muss die Konfiguration über die G-Homa App erfolgen.

===Network Parameters settings===
Other Setting -> Protocol auf TCP-Server (bei 1.0.06 kann es notwendig sein auf TCP-Client umzustellen) 
Other Setting -> Port ID (wird später für FHEM benötigt) 
Other Setting -> Server Address (IP Adresse des FHEM Servers) 

===Optional===
Im Router alle ausgehenden Verbindungen für G-Homa blockieren.

===Allgemeines===
Die Dose erfordert eine dauerhafte Verbindung zum Server (fhem). Wenn die Verbindung wegen Timeouts, WLAN Ausfall, ... abbricht, beginnt die LED an der Steckdose zu blinken und Schaltvorgänge werden unterbunden. Erst wenn die Verbindung wieder steht, reagiert die Dose wieder wie gewohnt. Ist die Verbindung per WLAN zu schwach, kann das zu dauerhaften Reconnects führen.

==Define==

:<code>define <name> GHoma <port></code>
Legt ein GHoma Server device an. 
Neue Zwischenstecker werden beim ersten verbinden automatisch angelegt. 
Diese können aber auch manuell angelegt werden:
:<code>define <name> GHoma <Id></code>
Die Id besteht aus den letzten 6 Stellen der MAC Adresse des Zwischensteckers. 
Beispiel: MAC= AC:CF:23:A5:E2:3B -> Id= A5E23B

==Set==

:<code>set <name> <value></code>
Gültige Werte für value:
:off
:on
Die [http://fhem.de/commandref#setExtensions set extensions] werden auch unterstützt.

==Attribute==

Für Zwischenstecker devices:
:restoreOnStartup
Wiederherstellen der Portzustände nach Neustart
Standard: last, gültige Werte: last, on, off

:restoreOnReinit
Wiederherstellen der Portzustände nach Neustart
Standard: last, gültige Werte: last, on, off

:blocklocal
Wert im Reading State sofort nach Änderung über lokale Taste wiederherstellen
Standard: no, gültige Werte: no, yes

Für Server devices:
:allowfrom
Regexp der erlaubten IP-Adressen oder Hostnamen. Wenn dieses Attribut gesetzt wurde, werden ausschließlich Verbindungen von diesen Adressen akzeptiert.

==Specs==
* Herstellerseite: [http://www.g-homa.com http://www.g-homa.com]
* [https://files.elv.com/Assets/Produkte/12/1218/121893/Downloads/121893_wifi_funkschaltsteckdose_um.pdf Bedienungsanleitung WiFi Smart Steckdose IP44]
* Typ: EMW302WFO
* Spannung: 230V
* Stecker/Dose: Schuko Typ-F
* Strom: max 16A
* Leistung: max 3680W
* Schutzklasse (nur Outdoor): IP44
* WiFi: 802.11 b/g/n
* Von EverFlourish Europe GmbH, Robert-Koch-Str. 4, D-66299 Friedrichsthal
* Das Gerät wird mit einem [http://www.iotworkshop.com/hf-lpt100f HF-LPT100F] realisiert, dass durch eine Spannungsaufbereitung, ein Relais nebst Treiber, einen Taster und einer LED auf zwei weiteren PCBs erweitert wurde.
:* Darauf ist als SoC ein [https://www.generationrobots.com/media/MediaTek_MT5931_Wi-Fi_Data_Sheet_v1_0.pdf MT5931] verbaut, weshalb das Gerät eine MAC von ''Hi-flying electronics technology Co.,Ltd'' an der WLAN-Schnittstelle verwendet.
:* Für technisch interessierte, lässt sich das Modul HF-LPT100F über eine UART-Schnittstelle (unbelegte Pins 5 und 6) am Pfostenstecker neu programmieren. Die Funktionen des Geräts sind realisiert durch:
::# einem Taster gegen Masse mit Pull-Up-Widerstand an GPIO 18
::# eine LED mit Vorwiderstand an GPIO 11
::# ein Relais mit Treiber an GPIO 12
:* Die UART und damit bei Bedarf auch GPIO 5 und 6 sind unbelegt.

[[Kategorie:IP Components]]
[[Kategorie:Schalter (Empfänger)]]

G-Homa

2017-08-09T10:09:10Z

Micomat: /* WLAN konfigurieren */

{{Infobox Modul
|Name=GHoma
|ModPurpose=Anbindung der WIFI Steckdose G-Homa
|ModCmdRef=GHoma
|ModType=d
|ModForumArea=Sonstige Systeme
|ModTechName=53_GHoma.pm
|ModOwner=klausw
}}

Die G-Homa oder GHoma Steckdose ist eine per WLAN schaltbare Steckdose. Diese Steckdose wird in vielen Baumärkten und im Internet vertrieben. Das Modul unterstützt die "set extensions". 
Es gibt sowohl eine Indoor, als auch eine Outdoor Variante.

==Vorbereitung der Steckdose==
Standardmäßig verbindet sich die Dose zu einem Server in der Cloud. Damit sie mit FHEM funktoiniert, muss diese Konfiguration angepasst werden.
===WLAN konfigurieren===
* Gerät in den AP Modus bringen (Knopf für mehr als 3s drücken, diesen Schritt wiederholen bis die LED permanent leuchtet)
* Nun einen Computer mit der SSID <code>G-Homa</code> verbinden.
* Im Browser zu http://10.10.100.254 (username:passwort = admin:admin)
* In STA Setting WLAN Einstellungen eintragen

'''Hinweis:''' Ab der Firmware >1.0.06 wird in diesen Geräten die Konfiguration über HTTP nicht mehr unterstützt. In diesem Fall muss die Konfiguration über die G-Homa App erfolgen.

===Network Parameters settings===
Other Setting -> Protocol auf TCP-Server (bei 1.0.06 kann es notwendig sein auf TCP-Client umzustellen) 
Other Setting -> Port ID (wird später für FHEM benötigt) 
Other Setting -> Server Address (IP Adresse des FHEM Servers) 

===Optional===
Im Router alle ausgehenden Verbindungen für G-Homa blockieren.

===Allgemeines===
Die Dose erfordert eine dauerhafte Verbindung zum Server (fhem). Wenn die Verbindung wegen Timeouts, WLAN Ausfall, ... abbricht, beginnt die LED an der Steckdose zu blinken und Schaltvorgänge werden unterbunden. Erst wenn die Verbindung wieder steht, reagiert die Dose wieder wie gewohnt. Ist die Verbindung per WLAN zu schwach, kann das zu dauerhaften Reconnects führen.

==Define==

:<code>define <name> GHoma <port></code>
Legt ein GHoma Server device an. 
Neue Zwischenstecker werden beim ersten verbinden automatisch angelegt. 
Diese können aber auch manuell angelegt werden:
:<code>define <name> GHoma <Id></code>
Die Id besteht aus den letzten 6 Stellen der MAC Adresse des Zwischensteckers. 
Beispiel: MAC= AC:CF:23:A5:E2:3B -> Id= A5E23B

==Set==

:<code>set <name> <value></code>
Gültige Werte für value:
:off
:on
Die [http://fhem.de/commandref#setExtensions set extensions] werden auch unterstützt.

==Attribute==

Für Zwischenstecker devices:
:restoreOnStartup
Wiederherstellen der Portzustände nach Neustart
Standard: last, gültige Werte: last, on, off

:restoreOnReinit
Wiederherstellen der Portzustände nach Neustart
Standard: last, gültige Werte: last, on, off

:blocklocal
Wert im Reading State sofort nach Änderung über lokale Taste wiederherstellen
Standard: no, gültige Werte: no, yes

Für Server devices:
:allowfrom
Regexp der erlaubten IP-Adressen oder Hostnamen. Wenn dieses Attribut gesetzt wurde, werden ausschließlich Verbindungen von diesen Adressen akzeptiert.

==Specs==
* Herstellerseite: [http://www.g-homa.com http://www.g-homa.com]
* [https://files.elv.com/Assets/Produkte/12/1218/121893/Downloads/121893_wifi_funkschaltsteckdose_um.pdf Bedienungsanleitung WiFi Smart Steckdose IP44]
* Typ: EMW302WFO
* Spannung: 230V
* Stecker/Dose: Schuko Typ-F
* Strom: max 16A
* Leistung: max 3680W
* Schutzklasse (nur Outdoor): IP44
* WiFi: 802.11 b/g/n
* Von EverFlourish Europe GmbH, Robert-Koch-Str. 4, D-66299 Friedrichsthal
* Das Gerät wird mit einem [http://www.iotworkshop.com/hf-lpt100f HF-LPT100F] realisiert, dass durch eine Spannungsaufbereitung, ein Relais nebst Treiber, einen Taster und einer LED auf zwei weiteren PCBs erweitert wurde.
:* Darauf ist als SoC ein [https://www.generationrobots.com/media/MediaTek_MT5931_Wi-Fi_Data_Sheet_v1_0.pdf MT5931] verbaut, weshalb das Gerät eine MAC von ''Hi-flying electronics technology Co.,Ltd'' an der WLAN-Schnittstelle verwendet.
:* Für technisch interessierte, lässt sich das Modul HF-LPT100F über eine UART-Schnittstelle (unbelegte Pins 5 und 6) am Pfostenstecker neu programmieren. Die Funktionen des Geräts sind realisiert durch:
::# einem Taster gegen Masse mit Pull-Up-Widerstand an GPIO 18
::# eine LED mit Vorwiderstand an GPIO 11
::# ein Relais mit Treiber an GPIO 12
:* Die UART und damit bei Bedarf auch GPIO 5 und 6 sind unbelegt.

[[Kategorie:IP Components]]
[[Kategorie:Schalter (Empfänger)]]

G-Homa

2017-08-09T10:08:39Z

Micomat: /* Network Parameters settings */

{{Infobox Modul
|Name=GHoma
|ModPurpose=Anbindung der WIFI Steckdose G-Homa
|ModCmdRef=GHoma
|ModType=d
|ModForumArea=Sonstige Systeme
|ModTechName=53_GHoma.pm
|ModOwner=klausw
}}

Die G-Homa oder GHoma Steckdose ist eine per WLAN schaltbare Steckdose. Diese Steckdose wird in vielen Baumärkten und im Internet vertrieben. Das Modul unterstützt die "set extensions". 
Es gibt sowohl eine Indoor, als auch eine Outdoor Variante.

==Vorbereitung der Steckdose==
Standardmäßig verbindet sich die Dose zu einem Server in der Cloud. Damit sie mit FHEM funktoiniert, muss diese Konfiguration angepasst werden.
===WLAN konfigurieren===
* Gerät in den AP Modus bringen (Knopf für mehr als 3s drücken, diesen Schritt wiederholen bis die LED permanent leuchtet)
* Nun einen Computer mit der SSID <code>G-Homa</code> verbinden.
* Im Browser zu http://10.10.100.254 (username:passwort = admin:admin)
* In STA Setting WLAN Einstellungen eintragen

'''Hinweis:''' Ab der Firmware 1.0.06 wird in diesen Geräten die Konfiguration über HTTP nicht mehr unterstützt. In diesem Fall muss die Konfiguration über die G-Homa App erfolgen.

===Network Parameters settings===
Other Setting -> Protocol auf TCP-Server (bei 1.0.06 kann es notwendig sein auf TCP-Client umzustellen) 
Other Setting -> Port ID (wird später für FHEM benötigt) 
Other Setting -> Server Address (IP Adresse des FHEM Servers) 

===Optional===
Im Router alle ausgehenden Verbindungen für G-Homa blockieren.

===Allgemeines===
Die Dose erfordert eine dauerhafte Verbindung zum Server (fhem). Wenn die Verbindung wegen Timeouts, WLAN Ausfall, ... abbricht, beginnt die LED an der Steckdose zu blinken und Schaltvorgänge werden unterbunden. Erst wenn die Verbindung wieder steht, reagiert die Dose wieder wie gewohnt. Ist die Verbindung per WLAN zu schwach, kann das zu dauerhaften Reconnects führen.

==Define==

:<code>define <name> GHoma <port></code>
Legt ein GHoma Server device an. 
Neue Zwischenstecker werden beim ersten verbinden automatisch angelegt. 
Diese können aber auch manuell angelegt werden:
:<code>define <name> GHoma <Id></code>
Die Id besteht aus den letzten 6 Stellen der MAC Adresse des Zwischensteckers. 
Beispiel: MAC= AC:CF:23:A5:E2:3B -> Id= A5E23B

==Set==

:<code>set <name> <value></code>
Gültige Werte für value:
:off
:on
Die [http://fhem.de/commandref#setExtensions set extensions] werden auch unterstützt.

==Attribute==

Für Zwischenstecker devices:
:restoreOnStartup
Wiederherstellen der Portzustände nach Neustart
Standard: last, gültige Werte: last, on, off

:restoreOnReinit
Wiederherstellen der Portzustände nach Neustart
Standard: last, gültige Werte: last, on, off

:blocklocal
Wert im Reading State sofort nach Änderung über lokale Taste wiederherstellen
Standard: no, gültige Werte: no, yes

Für Server devices:
:allowfrom
Regexp der erlaubten IP-Adressen oder Hostnamen. Wenn dieses Attribut gesetzt wurde, werden ausschließlich Verbindungen von diesen Adressen akzeptiert.

==Specs==
* Herstellerseite: [http://www.g-homa.com http://www.g-homa.com]
* [https://files.elv.com/Assets/Produkte/12/1218/121893/Downloads/121893_wifi_funkschaltsteckdose_um.pdf Bedienungsanleitung WiFi Smart Steckdose IP44]
* Typ: EMW302WFO
* Spannung: 230V
* Stecker/Dose: Schuko Typ-F
* Strom: max 16A
* Leistung: max 3680W
* Schutzklasse (nur Outdoor): IP44
* WiFi: 802.11 b/g/n
* Von EverFlourish Europe GmbH, Robert-Koch-Str. 4, D-66299 Friedrichsthal
* Das Gerät wird mit einem [http://www.iotworkshop.com/hf-lpt100f HF-LPT100F] realisiert, dass durch eine Spannungsaufbereitung, ein Relais nebst Treiber, einen Taster und einer LED auf zwei weiteren PCBs erweitert wurde.
:* Darauf ist als SoC ein [https://www.generationrobots.com/media/MediaTek_MT5931_Wi-Fi_Data_Sheet_v1_0.pdf MT5931] verbaut, weshalb das Gerät eine MAC von ''Hi-flying electronics technology Co.,Ltd'' an der WLAN-Schnittstelle verwendet.
:* Für technisch interessierte, lässt sich das Modul HF-LPT100F über eine UART-Schnittstelle (unbelegte Pins 5 und 6) am Pfostenstecker neu programmieren. Die Funktionen des Geräts sind realisiert durch:
::# einem Taster gegen Masse mit Pull-Up-Widerstand an GPIO 18
::# eine LED mit Vorwiderstand an GPIO 11
::# ein Relais mit Treiber an GPIO 12
:* Die UART und damit bei Bedarf auch GPIO 5 und 6 sind unbelegt.

[[Kategorie:IP Components]]
[[Kategorie:Schalter (Empfänger)]]

G-Homa

2016-01-20T18:51:54Z

Micomat:

G-Homa

2016-01-20T18:49:16Z

Micomat:

G-Homa

2016-01-20T18:48:21Z

Micomat:

{{Infobox Modul
|Name=GHoma
|ModPurpose=Anbindung der WIFI Steckdose G-Homa
|ModCmdRef=GHoma
|ModForumArea=Sonstige Systeme
|ModTechName=53_GHoma.pm
|ModOwner=klausw
}}

Die G-Homa oder GHoma Steckdose ist eine per WLAN schaltbare Steckdose. Diese Steckdose wird in vielen Baumärkten und im Internet vertrieben. Das Modul unterstützt die "set extensions". 
Es gibt sowohl eine Indoor, als auch eine Outdoor Variante.

=Vorbereitung der Steckdose=
Standardmäßig verbindet sich die Dose zu einem Server in der Cloud. Damit sie mit FHEM funktoiniert, muss diese Konfiguration angepasst werden.
==WLAN konfigurieren==
Gerät in den AP modus bringen (Knopf für mehr als 3s drücken, diesen Schritt wiederholen bis die LED permanent leuchtet)
Nun einen Computer mit der SSID G-Home verbinden. 
Im Browser zu 10.10.100.254 (username:passwort = admin:admin) 
In STA Setting WLAN Einstellungen eintragen
==Network Parameters settings==
Other Setting -> Protocol auf TCP-Server 
Other Setting -> Port ID (wird später für FHEM benötigt) 
Other Setting -> Server Address (IP Adresse des FHEM Servers) 
==Optional==
Im Router alle ausgehenden Verbindungen für G-Homa blockieren.

==Allgemeines==
Die Dose erfordert eine dauerhafte Verbindung zum Server (fhem). Wenn die Verbindung wegen Timeouts, WLAN Ausfall, ... abbricht, beginnt die LED an der Steckdose zu blinken und Schaltvorgänge werden unterbunden. Erst wenn die Verbindung wieder steht, reagiert die Dose wieder wie gewohnt. Ist die Verbindung per WLAN zu schwach, kann das zu dauerhaften Reconnects führen.

=Define=

:<code>define <name> GHoma <port></code>
Legt ein GHoma Server device an. 
Neue Zwischenstecker werden beim ersten verbinden automatisch angelegt. 
Diese können aber auch manuell angelegt werden:
:<code>define <name> GHoma <Id></code>
Die Id besteht aus den letzten 6 Stellen der MAC Adresse des Zwischensteckers. 
Beispiel: MAC= AC:CF:23:A5:E2:3B -> Id= A5E23B

=Set=

:<code>set <name> <value></code>
Gültige Werte für value:
:off
:on
Die [http://fhem.de/commandref#setExtensions set extensions] werden auch unterstützt.

=Attribute=

Für Zwischenstecker devices:
:restoreOnStartup
Wiederherstellen der Portzustände nach Neustart
Standard: last, gültige Werte: last, on, off

:restoreOnReinit
Wiederherstellen der Portzustände nach Neustart
Standard: last, gültige Werte: last, on, off

:blocklocal
Wert im Reading State sofort nach Änderung über lokale Taste wiederherstellen
Standard: no, gültige Werte: no, yes

Für Server devices:
:allowfrom
Regexp der erlaubten IP-Adressen oder Hostnamen. Wenn dieses Attribut gesetzt wurde, werden ausschließlich Verbindungen von diesen Adressen akzeptiert.

=Specs=
Herstellerseite: [http://www.g-homa.com] 
Spannung: 230V 
Stecker/Dose: Schuko Typ-F 
Strom: max 16A 
Leistung: max 3680W 
Schutzklasse (nur Outdoor): IP44 
WiFi: 802.11 b/g/n

G-Homa

2016-01-20T18:46:37Z

Micomat: Die Seite wurde neu angelegt: „{{Infobox Modul |Name=GHoma |ModPurpose=Anbindung der WIFI Steckdose G-Homa |ModCmdRef=GHoma |ModForumArea=Sonstige Systeme |ModTechName=53_THZ.pm |ModOwner=kl…“

{{Infobox Modul
|Name=GHoma
|ModPurpose=Anbindung der WIFI Steckdose G-Homa
|ModCmdRef=GHoma
|ModForumArea=Sonstige Systeme
|ModTechName=53_THZ.pm
|ModOwner=klausw
}}

Die G-Homa oder GHoma Steckdose ist eine per WLAN schaltbare Steckdose. Diese Steckdose wird in vielen Baumärkten und im Internet vertrieben. Das Modul unterstützt die "set extensions". 
Es gibt sowohl eine Indoor, als auch eine Outdoor Variante.

=Vorbereitung der Steckdose=
Standardmäßig verbindet sich die Dose zu einem Server in der Cloud. Damit sie mit FHEM funktoiniert, muss diese Konfiguration angepasst werden.
==WLAN konfigurieren==
Gerät in den AP modus bringen (Knopf für mehr als 3s drücken, diesen Schritt wiederholen bis die LED permanent leuchtet)
Nun einen Computer mit der SSID G-Home verbinden. 
Im Browser zu 10.10.100.254 (username:passwort = admin:admin) 
In STA Setting WLAN Einstellungen eintragen
==Network Parameters settings==
Other Setting -> Protocol auf TCP-Server 
Other Setting -> Port ID (wird später für FHEM benötigt) 
Other Setting -> Server Address (IP Adresse des FHEM Servers) 
==Optional==
Im Router alle ausgehenden Verbindungen für G-Homa blockieren.

==Allgemeines==
Die Dose erfordert eine dauerhafte Verbindung zum Server (fhem). Wenn die Verbindung wegen Timeouts, WLAN Ausfall, ... abbricht, beginnt die LED an der Steckdose zu blinken und Schaltvorgänge werden unterbunden. Erst wenn die Verbindung wieder steht, reagiert die Dose wieder wie gewohnt. Ist die Verbindung per WLAN zu schwach, kann das zu dauerhaften Reconnects führen.

=Define=

:<code>define <name> GHoma <port></code>
Legt ein GHoma Server device an. 
Neue Zwischenstecker werden beim ersten verbinden automatisch angelegt. 
Diese können aber auch manuell angelegt werden:
:<code>define <name> GHoma <Id></code>
Die Id besteht aus den letzten 6 Stellen der MAC Adresse des Zwischensteckers. 
Beispiel: MAC= AC:CF:23:A5:E2:3B -> Id= A5E23B

=Set=

:<code>set <name> <value></code>
Gültige Werte für value:
:off
:on
Die [http://fhem.de/commandref#setExtensions set extensions] werden auch unterstützt.

=Attribute=

Für Zwischenstecker devices:
:restoreOnStartup
Wiederherstellen der Portzustände nach Neustart
Standard: last, gültige Werte: last, on, off

:restoreOnReinit
Wiederherstellen der Portzustände nach Neustart
Standard: last, gültige Werte: last, on, off

:blocklocal
Wert im Reading State sofort nach Änderung über lokale Taste wiederherstellen
Standard: no, gültige Werte: no, yes

Für Server devices:
:allowfrom
Regexp der erlaubten IP-Adressen oder Hostnamen. Wenn dieses Attribut gesetzt wurde, werden ausschließlich Verbindungen von diesen Adressen akzeptiert.

=Specs=
Herstellerseite: [http://www.g-homa.com] 
Spannung: 230V 
Stecker/Dose: Schuko Typ-F 
Strom: max 16A 
Leistung: max 3680W 
Schutzklasse (nur Outdoor): IP44 
WiFi: 802.11 b/g/n

Tecalor THZ Wärmepumpe

2015-03-04T12:26:50Z

Micomat:

{{Infobox Modul
|Name=THZ
|ModPurpose=Anbindung Heizungssteuerung Tecalor
|ModType=d

|ModCmdRef=THZ
|ModForumArea=Sonstiges
|ModTechName=00_THZ.pm
|ModOwner=immiimmi
}}
Englisch version [[Tecalor THZ Heatpump]]

Hier wird beschrieben wie man mit FHEM eine Tecalor THZ / Stieben Eltron LWZ 303/403/403/404/SOL Wärmepumpe auslesen/steuern kann. Die 504 ist bislang nicht getestet, könnte aber ebenfalls funktionieren.

Zum besseren Verständnis: Tecalor ist die Privatkundenmarke von Stieben Eltron. Die Geräte sind absolut baugleich.

Nachfolgend wird von der "THZ" gesprochen.

Getestet sind die Versionen 2.06, 4.09, 4.19, 4.39 und 5.39.
Andere Versionen können funktionieren, das ist jedoch nicht garantiert.
HINWEIS: Diese Anleitung ist für Personen gedacht, die sich mit Elektronik auskennen.
Der Autor und der Entwickler haften nicht für Schäden und geben keine Funktionsgarantie.

'''ACHTUNG! Seit Version 0.087 wurden die Parameternamen geändert!''' 
Dies dient der Vereinheitlichung der Parameternamen. Werte mit "s" sind Statuswerte, solche mit "p" sind Parameter die in der Heizung eingestellt sind.
Weitere Infos bei den ausgelesenen Parametern. Nach einem Updaten müssen ggf. Sachen wie readingsGroups, Dashboards, etc. angepasst werden.

=Verbindungsmöglichkeiten=
==Lokal per RS232 oder USB==
Die THZ hat zwei Anschlüsse die zur Verbindung genutzt werden können.
* Einen Seriellen Anschluss der mit einem MNL-SG3 Stecker genutzt werden kann.
* Einen USB Anschluss der auf der Platine zu finden ist un mit einem TYP-B Kabel funktioniert.
'''ACHTUNG! Der USB Anschluss befindet sich rückseitig auf der Platine die sich hinter der Abdeckung hinter der rechten Türe. Darf nur stromlos verbunden werden. Dazu die Wärmepumpe komplett vom Strom trennen!!!'''

Die Baudraten variieren je nach Hardware- und Softwareversion zwischen 9600 und 115200 bei Seriell. Bei USB liegt diese bei 115200 oder 57600.
Eine Verbindungsanleitung zum Seriellen Port findet sich hier: [http://robert.penz.name/heat-pump-lwz/ Robert Penz Homepage]

==Entfernte Verbindung mit Ser2Net==
Wenn die FHEM Zentrale nicht direkt in der Nähe der Heizung steht kann mir Ser2Net gearbeitet werden. Dieses stellt auf einem TCP-Port einen virtuellen seriellen Anschluss zur Verfügung.

===Installation Ser2Net auf Linux===
Um den Serial-Port-Server Ser2Net zu installieren ist auf Linux folgendes zu tun:
:<code>sudo apt-get install ser2net</code>
in der /etc/ser2net.conf (/dev/ttyXXX)
:<code>2003:raw:500:/dev/ttyUSB0:115200 NONE 1STOPBIT 8DATABITS </code>
Der Port kann frei gewählt werden, solange er nicht bereits genutzt wird.

==Getestete Host-Systeme==
Getestet ist dieses Modul auf FritzBox, nas-qnap, Raspberry Pi und MacOS.

=Definition in FHEM=
==Mit direkter serieller oder USB Verbindung==
:<code>define Mythz THZ /dev/ttyUSB0@115200 # oder (/dev/ttyXXX)</code>
:<code>attr Mythz interval_sGlobal 300 # Internes Polling Intervall 5min</code>
:<code>attr Mythz interval_sHistory 28800 # Internes Polling Intervall 8h</code>
:<code>attr Mythz interval_sLast10errors 120 # Internes Polling Fehlerspeicher</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz</code>

Wenn die Attribute interval_sGlobal und interval_sHistory nicht definiert sind (oder 0), ist das interne Polling deaktiviert. Natürlich kann das Polling auch mit dem "at" Befehl ausserhalb des Moduls definiert werden.

:<code>define Mythz THZ /dev/ttyUSB0@115200 # oder (/dev/ttyXXX)</code>
:<code>define atMythzGlobal at +*00:05:00 {fhem "get Mythz sGlobal","1";;return()}</code>
:<code>define atMythzHistory at +*08:00:00 {fhem "get Mythz sHistory","1";;return()}</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz </code>

==Via Netzwerk mit Ser2Net==
:<code>define Mythz THZ 192.168.0.244:2003</code>
:<code>attr Mythz interval_sGlobal 300 # Internes Polling Intervall 5min</code>
:<code>attr Mythz interval_sHistory 28800 # Internes Polling Intervall 8h</code>
:<code>attr Mythz interval_sLast10errors 120 # Internes Polling Fehlerspeicher</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz</code>

=Ausgelesene Werte=
Wenn die Verbindung und das Auslesen erfolgreich waren, sollten Werte wie sGlobal, sFirmware, sHistory und diverse Einstellungen wie die Urlaubszeiten sowie einige PXX Werte angezeigt werden.

'''sGlobal (vormals allFB)'''

Beinhaltet alle aktuellen Werte wie Temperaturen von Wasser und Gas, Lüfterstatus, Drücke, usw.

'''sFirmware'''

Zeigt die Firmware Version der Wärmepumpe.

'''sHistory'''

Enthält Angaben zur Betriebsdauer. Beispielsweise die Anzahl der Betriebsstunden der Kompressoren.

'''pHoliday-Werte'''

Hier werden die aktuellen Einstellungen der Urlaubsfunktion der THZ angezeigt. Diese bewirken, dass keine Tagabsenkung (sofern programmiert) gemacht wird.
Die holiday-Werte können mittels <code>set</code> auch angepasst werden.

'''sLast10errors'''

Liest die letzten 10 Fehlercodes aus und stellt diese dar.

'''pXX-Werte & program-Werte'''

Die pXX-Werte und program-Werte stellen Einstellungen wie Heizkreistemperaturen und Lüfterstufen sowie Heizungs- und Warmwasserprogramme der THZ dar. Alle pXX-Werte und program-Werte können mittels <code>set</code> auch angepasst werden.
Es sind auch Lüfterdurchsatzmengen und Passivkühlung konfigurierbar. 
pOpMode zeigt den Betriebszustand. Automatik, Handbetrieb, etc...

'''party-time'''

Hier wird die Uhrzeit der Party programmiert.
Party-Time regelt die Lüfterstufe (p99FanStageParty) im Party-Modus. Diese kann auch angepasst werden.

'''sDHW (ex Status_DHW_F3)'''

Informationen zur Warmwasserbereitung

'''sHC1 (ex Status_HC1_F4)'''

Enthält Informationen zum Heizkreis 1

'''sHC2 (ex Status_HC2_F5)'''

Heizkreis 2 Informationen

'''sSol (ex Status_Sol_16)'''

Informationen zur Solaranlage

'''pOpMode (ex OperatingMode)'''

Betriebsart: Bereitschaft, Automatik, Tagbetrieb, Absenkbetrieb, WW-Betrieb, Manueller Betrieb, Notbetrieb

Wenn die Betriebsart via FHEM geändert werden soll dann muss als set-Wert die entsprechende englische Bezeichnung gesendet werden (Standby, Automatic, DAYmode, SetBack, DHWmode, Manual, Emergency)

'''sXXX'''

Es gibt noch einige weitere "s"tatus Werte die unter anderen die Wärmerückgewinnungswerte beinhalten.

= Plots - Grafische Darstellung =
Nachfolgend wird gezeigt wie man aus den Readings wie sGlobal grafische Plots erstellen kann.

'''Beispiel'''

Angenommen wir wollen aus sGlobal die outside_temp und die dhw_temp (dhw=domestic hot water = Warmwasser) grafisch darstellen:

In der fhem.cfg legen wir das Plot an:
:<code>define Plot_Temp SVG FileLog_Mythz:thz:CURRENT</code>
:<code>attr Plot_Temp room Heizung</code>

Daraufhin wird das Plot erzeugt, noch ohne Daten und evtl. mit einer Fehlermeldung.
Hier klicken wir dann auf den Plot-Namen um in das Plot-Konfigurationsfenster zu kommen.
Hier tragen wir die entsprechenden Daten ein.

'''Wichtig sind nun die Input-Felder'''

Unterhalb der Eingabemaske befinden sich die zu Mythz gehörenden Readings die verwendet werden können. Darunter auch sGlobal.

Das sGlobal wird in etwa so aussehen:
:<code>2014-03-02_13:07:49 Mythz sGlobal: outside_temp: 3.8 flow_temp: 26.5 return_temp: 27.2 hot_gas_temp: 32.1 dhw_temp: 43.4 flow_temp_HC2: -60 evaporator_temp: 5.3 condenser_temp: 27.4 Mixer_open: 0 Mixer_closed: 0 HeatPipeValve: 0 DiverterValve: 0 DHW_Pump: 0</code>

[[File:Thzplot.jpg|thumb]]

Um den richtigen Input zu finden, zählen wir die durch Leerzeichen getrennten Daten ab. Somit ist der Wert der outside_temp an Stelle 5, die dhw_temp an Stelle 13.
Diese Zahl tragen wir dann im Input-Feld ein und schon haben wir einen Plot der Daten erzeugt.

Weitere Infos zu [http://www.fhemwiki.de/wiki/Plots_erzeugen Plots]

= einzelne Werte aus den Readings=
Um einzelne Werte aus den großen Readings wie sGlobal oder history zu bekommen, kann man ein

userReading verwenden.
Beispiel:

:<code>attr Mythz userReadings AussenTemp {(split ' ',ReadingsVal("Mythz","sGlobal",0))[1]},

VorlaufTemp {(split ' ',ReadingsVal("Mythz","sGlobal",0))[3]}</code>

Weitere Infos zu userReadings in der [http://fhem.de/commandref_DE.html CommandRef]

= Hinweise =
* Ein kompletter Refresh aller Werte wird nur beim Systemstart von FHEM gemacht. Dies geschieht sehr langsam um die Performance nicht zu beeinträchtigen. Erst nachdem dieser Refresh (dauert ca. 3-4 Minuten) gelaufen ist, wird das interne Polling gestartet.
*Wenn das Refresh Intervall kürzer oder gleich ist wie der initiale Refresh kann es zu einer Überschneidung kommen was allerdings kein Problem sein sollte.
*Im Wintermodus kommt roomSetTemp (sHC1) von p01RoomTempDayHC1 und p02RoomTempNightHC1
*Im Sommermodus kommt roomSetTemp (sHC1) von p01RoomTempDayHC1SummerMode und p02RoomTempNightHC1SummerMode

= Bekannte Probleme =
Im FHEM Log tauchen bei Ser2Net Verbindung häufig folgende Meldungen auf:
:<code>2014.03.02 09:41:09 1: 192.168.178.50:2003 disconnected, waiting to reappear
2014.03.02 09:41:09 1: 192.168.178.50:2003 reappeared (Mythz)</code>
Dieses Problem ist aktuell nicht gelöst.

= Release History =
'''v0.067'''

Erstmalige Implementierung in FHEM

'''v0.068'''

neuer Befehl f. Party implementiert

'''v0.069'''

Deutsche CommandRef hinzugefügt

'''v0.070'''

BugFix in Status Bits

'''v0.071'''

Bugfix, undefFn verbessert

'''v0.072'''

* Alle programHC1*, programHC2*, programFan* und programDHW* sind nun mit "get" und "set" implementiert
* inside_temp wurde am Ende von allFB hinzugefügt
* der Ser2Net connect/disconnet Bug wurde eingedämmt auf max 1 Logeintrag pro Sekunde

'''v0.074'''

Jetzt sind auch die Lüfterdurchsatzmengen und die Passivkühlung ausgelesen und änderbar.

'''v0.075'''

interval_last10errors implementiert. Intervall, in dem der Fehlerspeicher ausgelesen werden soll

'''v0.076'''

Bugfixes und neuer Parameter Status_HC1_F4

'''v0.078'''

neue Parameter Status_Sol_16 und Status_DHW_F3

'''v0.080'''

* neue Parameter p49SummerModeTemp und p50SummerModeHysteresis
* Status_HC1_F4 und Status_HC2_F5 zeigen nun "mode: Summer" (oder Winter)
Die Berechnung des Modus ist wie folgt:
:<code> if outsidetemp > p49SummerModeTemp + p50SummerModeHysteresis ---> Summermode</code>
:<code> if outsidetemp < p49SummerModeTemp - p50SummerModeHysteresis ---> Wintermode</code>

'''v0.081'''

BugFix für Sommer/Wintermodus-Anzeige

'''v0.084'''

* OperatingMode wird nun ausgelesen (read-only)
* p33BoosterTimeoutDHW (read/write)
* p79BoosterTimeoutHC (read/write)

'''v0.085'''

OperatingMode kann jetzt auch geaendert werden.

'''v0.087'''

* Neue Readings
* Angepasste Readingnamen

'''v0.089'''

* Kommunikation wurde stabilisiert
* Bugfixes
* Neue Readings

'''v0.091'''

Neue Readings: sHeatRecoveredDay & sHeatRecoveredTotal

'''v0.094'''

Bugfixes

'''v0.095'''

Neue Readings: sHeatDHWDay & sHeatDHWTotal

'''v0.096'''

Weitere neue Readings: sEletrx... & sHeat...

'''v0.097'''

Bugfixes

'''v0.099'''

Raumeinfluss wurde in die Heizkurvengrafik eingebaut

'''v0.100'''

Neue Parameter: p54MinPumpCycles, p55MaxPumpCycles, p56OutTempMaxPumpCycles, p57OutTempMinPumpCycles

'''v0.101'''

* keine neuen Features
* Code clean up
* Logs in verbose 5 implementiert
* buffer overflow (Verursacht von sGlobal bei LWZ 303 Firmware 3.19) gefixt

'''v0.103'''

* Änderung der Kommunikation. Jetzt 10x schneller
* Versionsinformation hinzugefügt

'''v0.104'''

Delay in der Kommunikation hinzugefügt (aber immer noch 5x schneller)

'''v0.105'''

* Schnelleres set und get Verhalten
* Dauer des Update beim Start halbiert
* THZ Attribute können ohne Neustart geändert werden
* BugFix
* P83 hinzugefügt (DHWSetSolarTemp)
* Suffix bei den Temp-Werten hinzugefügt. z.B. p04DHWsetDay jetzt p04DHWsetDayTemp

'''v0.107'''

* p56 and p57 getauscht und repariert

'''v0.108'''

* Party-Time wurde entfernt da nicht funktionsfähig
* Grouping bei "set programFan_Mo-Fr_0 to 08:00--20:00" --> Einzelne Tage werden automatisch gesetzt

'''v0.109'''

* Fehlerbehebung bei langen Nachrichten via Seriellem Kabel

'''v0.110'''

* Bugfix (für seriellen Adapter) trunkating messages (forum 209294)

'''v.0111'''

* P21,22,23,24,25,29 hinzugefügt

'''v0.112'''

* Bugfix für Fehler verursacht durch DevIo.pm 6980 status disconnected msg223569

'''v0.113'''

* Unterstützung für ältere Firmewareversionen hinzugefügt

'''v0.114'''

* Unterstützung für ältere Firmewareversionen hinzugefügt

'''v0.115'''

* Implementierung von "Informationen aus dem Modul des HeatpumpMonitor von Robert Penz". Alle nicht identifizierbaren Teile erhalten den Wert "n.a."

'''v0.116'''

* weitere Unterstützung für ältere Firmewareversionen hinzugefügt

'''v0.118'''

* faultcode implementiert
* Rechtschreibefehler korrigiert: evuRelease

'''v0.119'''
* der Firmwareparameter 2.06 erhöht den Maximalcount der Wiederholung von DevIo_SimpleReadWithTimeout von 24 auf 50
* Reduktion des DevIo_SimpleReadWithTimeout von 0.06 auf 0.02
* Der Firmwareparameter 2.06 entfernt jetzt Register, die von älteren Wärmepumpen nicht unterstützt werden

'''v0.120'''

* Verzögerung zwischen programXXX_YY zugefügt

'''v0.121'''

* Register Interpretation von user godmorgon implementiert
* register 17 für ältere Firmwareversionen implementiert

'''v0.122'''

* pXX Register für ältere Firmwareversionen implementiert
* maximale Widerholungen jetzt limitiert auf 60, zuvor 50
* actualPower_Qc: gepatcht um Pufferüberlauf zu vermeiden

'''v0.123'''

* actualPower_Qc und actualPower_pEl korrigiert

'''v0.124'''

* Verlaufsregister angelegt für Firmwareversion 2.06

'''v.0125'''

* Anpassungen um die Firmware 2.06 zu unterstützen

'''v.0126'''

* Weitere Anpassungen um die Firmware 2.06 zu unterstützen

'''v0.127'''

* Bugfix:Unterschied in Parsingregel für FCtime

'''v0.128'''

* Die meisten Paramter können jetzt von WP älterer Firmware gelesen werden

'''v0.129'''

* sDisplay (Aktivitätsparameter die im Display dargestellt werden)

'''v0.130'''

* 2 Bugfixes
* Firmware-id enthält neue Feature wie HW: 74 SW: 2.08 Date: MAR 9 2011
* neuer Parameter p99RoomThermCorrection implementiert
* THZ_PrintcurveSVG (Heizkurve) wird jetzt durch p99RoomThermCorrection beeinflusst

'''v0.131'''

* p35PasteurisationInterval,p35PasteurisationTemp, p34BoosterDHWTempAct, p99DHWmaxFlowTemp, p89DHWeco hinzugefügt

'''v0.132'''

* p99startUnschedVent hinzugefügt
* Aufteilung großer Register implementiert. Nötig für Firmware 2.06.
* Heizkurven jetzt auf 15...35°C begrenzt für bessere Darstellung des Kurvenverlaufs

'''v0.133'''

* p12 FanStageManual hinzugefügt
* Autoskalierung der Heizkurvenskala

'''v0.133+'''

* fixed: Laut Bedienungsanleitung ist p99RoomThermCorrection der Parameter P76

= Beispielkonfiguration =

'''Start Definition mit Ser2Net'''

<code>
define Mythz THZ 192.168.111.5:2003 
attr Mythz room Sysintern
</code>

'''userReadings'''

[[File:dash.jpg|thumb]]

<code>
attr Mythz userReadings AussenTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[1]}, VorlaufTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[3]}, RuecklaufTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[5]}, WWTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[9]}, KollektorTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[79]}
</code>

'''interval Definitionen'''

<code>
attr Mythz interval_sGlobal 300 
attr Mythz interval_sHistory 28800 
attr Mythz interval_sLast10errors 120 
</code>

'''Definition von file-log und den SVG-Plots einiger Daten'''

<code>
define FileLog_Mythz FileLog ./log/Mythz-%Y-%m.log Mythz 
define wal_0 SVG FileLog_Mythz:thz:CURRENT 
attr wal_0 room Heizung 
define wal_1 SVG FileLog_Mythz:thz1:CURRENT 
attr wal_1 room Heizung 
define wal_2 SVG FileLog_Mythz:thz2:CURRENT 
attr wal_2 room Heizung 
define wal_3 SVG FileLog_Mythz:thz3:CURRENT 
attr wal_3 room Heizung 
define wal_4 SVG FileLog_Mythz:thz4:CURRENT 
attr wal_4 room Heizung 
</code>

'''readingsGroup'''

<code>
define rg_thz readingsGroup Mythz:<%temp_outside>,<Aussen>,AussenTemp Mythz:<%sani_supply_temp@red>,<Vorlauf>,VorlaufTemp Mythz:<%sani_return_temp@blue>,<Rücklauf>,RuecklaufTemp Mythz:<%sani_boiler_temp@BD7800>,<Wasser>,WWTemp Mythz:<%sani_solar_temp>,<Kollektor>,KollektorTemp
 
attr rg_thz alias Heizung Temperaturen 
attr rg_thz group THZ 
attr rg_thz room Sysintern 
attr rg_thz valueFormat { AussenTemp => '%1.f °C', VorlaufTemp => '%1.f °C', AussenTemp=> '%1.f °C', RuecklaufTemp=> '%1.f °C', WWTemp=> '%1.f °C', KollektorTemp=> '%1.f °C' }
</code>

'''Dashboard'''

<code>
define MyDashboard Dashboard 
attr MyDashboard dashboard_lockstate unlock 
attr MyDashboard dashboard_row top-center 
attr MyDashboard dashboard_showhelper 0 
attr MyDashboard dashboard_showtooglebuttons 0 
attr MyDashboard dashboard_tab1groups THZ 
attr MyDashboard dashboard_tab1name micofhem 
attr MyDashboard dashboard_tab1sorting t0c100,THZ,true,170,253 
attr MyDashboard dashboard_tabcount 1 
attr MyDashboard dashboard_webfrontendfilter WEB 
define MyDashboard_weblink weblink htmlCode {DashboardAsHtml("MyDashboard")} 
attr MyDashboard_weblink room DashboardRoom
</code>

'''FanSelector für die Lüftungssteuerung'''

<code>
define FanSelectorDay dummy 
attr FanSelectorDay group THZ 
attr FanSelectorDay setList 0 1 2 3 offFor60min 
attr FanSelectorDay webCmd 0:1:2:3:offFor60min 
attr FanSelectorDay devStateIcon 0:vent_ventilation_level_0 1:vent_ventilation_level_1 2:vent_ventilation_level_2 3:vent_ventilation_level_3 
define Notify_p07FanStageDay notify FanSelectorDay IF ([FanSelectorDay] eq "offFor60min") (define at_D_offFor60min at +00:59:00 set Mythz p07FanStageDay [Mythz:p07FanStageDay],set Mythz p07FanStageDay 0, setstate FanSelectorDay offFor60min) ELSE (set Mythz p07FanStageDay $EVENT) 
define Notify_FanselectorDay notify (Mythz.p07FanStageDay.*) setstate FanSelectorDay $EVTPART1 
attr FanSelectorDay room heatpump 
[[File:fanselectorv2.png|thumb]]
define FanSelectorNight dummy 
attr FanSelectorNight group THZ 
attr FanSelectorNight setList 0 1 2 3 offFor60min 
attr FanSelectorNight webCmd 0:1:2:3:offFor60min 
attr FanSelectorNight devStateIcon 0:vent_ventilation_level_0 1:vent_ventilation_level_1 2:vent_ventilation_level_2 3:vent_ventilation_level_3 
define Notify_p08FanStageNight notify FanSelectorNight IF ([FanSelectorNight] eq "offFor60min") (define at_N_offFor60min at +00:59:00 set Mythz p08FanStageNight [Mythz:p08FanStageNight],set Mythz p08FanStageNight 0, setstate FanSelectorNight offFor60min) ELSE (set Mythz p08FanStageNight $EVENT) 
define Notify_FanselectorNight notify (Mythz.p08FanStageNight.*) setstate FanSelectorNight $EVTPART1 
attr FanSelectorNight room heatpump</code>

= Links =
[https://launchpad.net/heatpumpmonitor Launchpad Heatpumpmonitor]

[http://forum.fhem.de/index.php/topic,13132.0.html Forenthread im FHEM-Forum]

[[Kategorie:Other Components]]
[[Kategorie:Heizungssteuerung]]

Tecalor THZ Wärmepumpe

2015-03-04T12:26:18Z

Micomat:

{{Infobox Modul
|Name=THZ
|ModPurpose=Anbindung Heizungssteuerung Tecalor
|ModType=d

|ModCmdRef=THZ
|ModForumArea=Sonstiges
|ModTechName=00_THZ.pm
|ModOwner=immiimmi
}}
Englisch version [[Tecalor THZ Heatpump]]

Hier wird beschrieben wie man mit FHEM eine Tecalor THZ / Stieben Eltron LWZ 303/403/403/404/SOL Wärmepumpe auslesen/steuern kann.

Zum besseren Verständnis: Tecalor ist die Privatkundenmarke von Stieben Eltron. Die Geräte sind absolut baugleich.

Nachfolgend wird von der "THZ" gesprochen.

Getestet sind die Versionen 2.06, 4.09, 4.19, 4.39 und 5.39.
Andere Versionen können funktionieren, das ist jedoch nicht garantiert.
HINWEIS: Diese Anleitung ist für Personen gedacht, die sich mit Elektronik auskennen.
Der Autor und der Entwickler haften nicht für Schäden und geben keine Funktionsgarantie.

'''ACHTUNG! Seit Version 0.087 wurden die Parameternamen geändert!''' 
Dies dient der Vereinheitlichung der Parameternamen. Werte mit "s" sind Statuswerte, solche mit "p" sind Parameter die in der Heizung eingestellt sind.
Weitere Infos bei den ausgelesenen Parametern. Nach einem Updaten müssen ggf. Sachen wie readingsGroups, Dashboards, etc. angepasst werden.

=Verbindungsmöglichkeiten=
==Lokal per RS232 oder USB==
Die THZ hat zwei Anschlüsse die zur Verbindung genutzt werden können.
* Einen Seriellen Anschluss der mit einem MNL-SG3 Stecker genutzt werden kann.
* Einen USB Anschluss der auf der Platine zu finden ist un mit einem TYP-B Kabel funktioniert.
'''ACHTUNG! Der USB Anschluss befindet sich rückseitig auf der Platine die sich hinter der Abdeckung hinter der rechten Türe. Darf nur stromlos verbunden werden. Dazu die Wärmepumpe komplett vom Strom trennen!!!'''

Die Baudraten variieren je nach Hardware- und Softwareversion zwischen 9600 und 115200 bei Seriell. Bei USB liegt diese bei 115200 oder 57600.
Eine Verbindungsanleitung zum Seriellen Port findet sich hier: [http://robert.penz.name/heat-pump-lwz/ Robert Penz Homepage]

==Entfernte Verbindung mit Ser2Net==
Wenn die FHEM Zentrale nicht direkt in der Nähe der Heizung steht kann mir Ser2Net gearbeitet werden. Dieses stellt auf einem TCP-Port einen virtuellen seriellen Anschluss zur Verfügung.

===Installation Ser2Net auf Linux===
Um den Serial-Port-Server Ser2Net zu installieren ist auf Linux folgendes zu tun:
:<code>sudo apt-get install ser2net</code>
in der /etc/ser2net.conf (/dev/ttyXXX)
:<code>2003:raw:500:/dev/ttyUSB0:115200 NONE 1STOPBIT 8DATABITS </code>
Der Port kann frei gewählt werden, solange er nicht bereits genutzt wird.

==Getestete Host-Systeme==
Getestet ist dieses Modul auf FritzBox, nas-qnap, Raspberry Pi und MacOS.

=Definition in FHEM=
==Mit direkter serieller oder USB Verbindung==
:<code>define Mythz THZ /dev/ttyUSB0@115200 # oder (/dev/ttyXXX)</code>
:<code>attr Mythz interval_sGlobal 300 # Internes Polling Intervall 5min</code>
:<code>attr Mythz interval_sHistory 28800 # Internes Polling Intervall 8h</code>
:<code>attr Mythz interval_sLast10errors 120 # Internes Polling Fehlerspeicher</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz</code>

Wenn die Attribute interval_sGlobal und interval_sHistory nicht definiert sind (oder 0), ist das interne Polling deaktiviert. Natürlich kann das Polling auch mit dem "at" Befehl ausserhalb des Moduls definiert werden.

:<code>define Mythz THZ /dev/ttyUSB0@115200 # oder (/dev/ttyXXX)</code>
:<code>define atMythzGlobal at +*00:05:00 {fhem "get Mythz sGlobal","1";;return()}</code>
:<code>define atMythzHistory at +*08:00:00 {fhem "get Mythz sHistory","1";;return()}</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz </code>

==Via Netzwerk mit Ser2Net==
:<code>define Mythz THZ 192.168.0.244:2003</code>
:<code>attr Mythz interval_sGlobal 300 # Internes Polling Intervall 5min</code>
:<code>attr Mythz interval_sHistory 28800 # Internes Polling Intervall 8h</code>
:<code>attr Mythz interval_sLast10errors 120 # Internes Polling Fehlerspeicher</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz</code>

=Ausgelesene Werte=
Wenn die Verbindung und das Auslesen erfolgreich waren, sollten Werte wie sGlobal, sFirmware, sHistory und diverse Einstellungen wie die Urlaubszeiten sowie einige PXX Werte angezeigt werden.

'''sGlobal (vormals allFB)'''

Beinhaltet alle aktuellen Werte wie Temperaturen von Wasser und Gas, Lüfterstatus, Drücke, usw.

'''sFirmware'''

Zeigt die Firmware Version der Wärmepumpe.

'''sHistory'''

Enthält Angaben zur Betriebsdauer. Beispielsweise die Anzahl der Betriebsstunden der Kompressoren.

'''pHoliday-Werte'''

Hier werden die aktuellen Einstellungen der Urlaubsfunktion der THZ angezeigt. Diese bewirken, dass keine Tagabsenkung (sofern programmiert) gemacht wird.
Die holiday-Werte können mittels <code>set</code> auch angepasst werden.

'''sLast10errors'''

Liest die letzten 10 Fehlercodes aus und stellt diese dar.

'''pXX-Werte & program-Werte'''

Die pXX-Werte und program-Werte stellen Einstellungen wie Heizkreistemperaturen und Lüfterstufen sowie Heizungs- und Warmwasserprogramme der THZ dar. Alle pXX-Werte und program-Werte können mittels <code>set</code> auch angepasst werden.
Es sind auch Lüfterdurchsatzmengen und Passivkühlung konfigurierbar. 
pOpMode zeigt den Betriebszustand. Automatik, Handbetrieb, etc...

'''party-time'''

Hier wird die Uhrzeit der Party programmiert.
Party-Time regelt die Lüfterstufe (p99FanStageParty) im Party-Modus. Diese kann auch angepasst werden.

'''sDHW (ex Status_DHW_F3)'''

Informationen zur Warmwasserbereitung

'''sHC1 (ex Status_HC1_F4)'''

Enthält Informationen zum Heizkreis 1

'''sHC2 (ex Status_HC2_F5)'''

Heizkreis 2 Informationen

'''sSol (ex Status_Sol_16)'''

Informationen zur Solaranlage

'''pOpMode (ex OperatingMode)'''

Betriebsart: Bereitschaft, Automatik, Tagbetrieb, Absenkbetrieb, WW-Betrieb, Manueller Betrieb, Notbetrieb

Wenn die Betriebsart via FHEM geändert werden soll dann muss als set-Wert die entsprechende englische Bezeichnung gesendet werden (Standby, Automatic, DAYmode, SetBack, DHWmode, Manual, Emergency)

'''sXXX'''

Es gibt noch einige weitere "s"tatus Werte die unter anderen die Wärmerückgewinnungswerte beinhalten.

= Plots - Grafische Darstellung =
Nachfolgend wird gezeigt wie man aus den Readings wie sGlobal grafische Plots erstellen kann.

'''Beispiel'''

Angenommen wir wollen aus sGlobal die outside_temp und die dhw_temp (dhw=domestic hot water = Warmwasser) grafisch darstellen:

In der fhem.cfg legen wir das Plot an:
:<code>define Plot_Temp SVG FileLog_Mythz:thz:CURRENT</code>
:<code>attr Plot_Temp room Heizung</code>

Daraufhin wird das Plot erzeugt, noch ohne Daten und evtl. mit einer Fehlermeldung.
Hier klicken wir dann auf den Plot-Namen um in das Plot-Konfigurationsfenster zu kommen.
Hier tragen wir die entsprechenden Daten ein.

'''Wichtig sind nun die Input-Felder'''

Unterhalb der Eingabemaske befinden sich die zu Mythz gehörenden Readings die verwendet werden können. Darunter auch sGlobal.

Das sGlobal wird in etwa so aussehen:
:<code>2014-03-02_13:07:49 Mythz sGlobal: outside_temp: 3.8 flow_temp: 26.5 return_temp: 27.2 hot_gas_temp: 32.1 dhw_temp: 43.4 flow_temp_HC2: -60 evaporator_temp: 5.3 condenser_temp: 27.4 Mixer_open: 0 Mixer_closed: 0 HeatPipeValve: 0 DiverterValve: 0 DHW_Pump: 0</code>

[[File:Thzplot.jpg|thumb]]

Um den richtigen Input zu finden, zählen wir die durch Leerzeichen getrennten Daten ab. Somit ist der Wert der outside_temp an Stelle 5, die dhw_temp an Stelle 13.
Diese Zahl tragen wir dann im Input-Feld ein und schon haben wir einen Plot der Daten erzeugt.

Weitere Infos zu [http://www.fhemwiki.de/wiki/Plots_erzeugen Plots]

= einzelne Werte aus den Readings=
Um einzelne Werte aus den großen Readings wie sGlobal oder history zu bekommen, kann man ein

userReading verwenden.
Beispiel:

:<code>attr Mythz userReadings AussenTemp {(split ' ',ReadingsVal("Mythz","sGlobal",0))[1]},

VorlaufTemp {(split ' ',ReadingsVal("Mythz","sGlobal",0))[3]}</code>

Weitere Infos zu userReadings in der [http://fhem.de/commandref_DE.html CommandRef]

= Hinweise =
* Ein kompletter Refresh aller Werte wird nur beim Systemstart von FHEM gemacht. Dies geschieht sehr langsam um die Performance nicht zu beeinträchtigen. Erst nachdem dieser Refresh (dauert ca. 3-4 Minuten) gelaufen ist, wird das interne Polling gestartet.
*Wenn das Refresh Intervall kürzer oder gleich ist wie der initiale Refresh kann es zu einer Überschneidung kommen was allerdings kein Problem sein sollte.
*Im Wintermodus kommt roomSetTemp (sHC1) von p01RoomTempDayHC1 und p02RoomTempNightHC1
*Im Sommermodus kommt roomSetTemp (sHC1) von p01RoomTempDayHC1SummerMode und p02RoomTempNightHC1SummerMode

= Bekannte Probleme =
Im FHEM Log tauchen bei Ser2Net Verbindung häufig folgende Meldungen auf:
:<code>2014.03.02 09:41:09 1: 192.168.178.50:2003 disconnected, waiting to reappear
2014.03.02 09:41:09 1: 192.168.178.50:2003 reappeared (Mythz)</code>
Dieses Problem ist aktuell nicht gelöst.

= Release History =
'''v0.067'''

Erstmalige Implementierung in FHEM

'''v0.068'''

neuer Befehl f. Party implementiert

'''v0.069'''

Deutsche CommandRef hinzugefügt

'''v0.070'''

BugFix in Status Bits

'''v0.071'''

Bugfix, undefFn verbessert

'''v0.072'''

* Alle programHC1*, programHC2*, programFan* und programDHW* sind nun mit "get" und "set" implementiert
* inside_temp wurde am Ende von allFB hinzugefügt
* der Ser2Net connect/disconnet Bug wurde eingedämmt auf max 1 Logeintrag pro Sekunde

'''v0.074'''

Jetzt sind auch die Lüfterdurchsatzmengen und die Passivkühlung ausgelesen und änderbar.

'''v0.075'''

interval_last10errors implementiert. Intervall, in dem der Fehlerspeicher ausgelesen werden soll

'''v0.076'''

Bugfixes und neuer Parameter Status_HC1_F4

'''v0.078'''

neue Parameter Status_Sol_16 und Status_DHW_F3

'''v0.080'''

* neue Parameter p49SummerModeTemp und p50SummerModeHysteresis
* Status_HC1_F4 und Status_HC2_F5 zeigen nun "mode: Summer" (oder Winter)
Die Berechnung des Modus ist wie folgt:
:<code> if outsidetemp > p49SummerModeTemp + p50SummerModeHysteresis ---> Summermode</code>
:<code> if outsidetemp < p49SummerModeTemp - p50SummerModeHysteresis ---> Wintermode</code>

'''v0.081'''

BugFix für Sommer/Wintermodus-Anzeige

'''v0.084'''

* OperatingMode wird nun ausgelesen (read-only)
* p33BoosterTimeoutDHW (read/write)
* p79BoosterTimeoutHC (read/write)

'''v0.085'''

OperatingMode kann jetzt auch geaendert werden.

'''v0.087'''

* Neue Readings
* Angepasste Readingnamen

'''v0.089'''

* Kommunikation wurde stabilisiert
* Bugfixes
* Neue Readings

'''v0.091'''

Neue Readings: sHeatRecoveredDay & sHeatRecoveredTotal

'''v0.094'''

Bugfixes

'''v0.095'''

Neue Readings: sHeatDHWDay & sHeatDHWTotal

'''v0.096'''

Weitere neue Readings: sEletrx... & sHeat...

'''v0.097'''

Bugfixes

'''v0.099'''

Raumeinfluss wurde in die Heizkurvengrafik eingebaut

'''v0.100'''

Neue Parameter: p54MinPumpCycles, p55MaxPumpCycles, p56OutTempMaxPumpCycles, p57OutTempMinPumpCycles

'''v0.101'''

* keine neuen Features
* Code clean up
* Logs in verbose 5 implementiert
* buffer overflow (Verursacht von sGlobal bei LWZ 303 Firmware 3.19) gefixt

'''v0.103'''

* Änderung der Kommunikation. Jetzt 10x schneller
* Versionsinformation hinzugefügt

'''v0.104'''

Delay in der Kommunikation hinzugefügt (aber immer noch 5x schneller)

'''v0.105'''

* Schnelleres set und get Verhalten
* Dauer des Update beim Start halbiert
* THZ Attribute können ohne Neustart geändert werden
* BugFix
* P83 hinzugefügt (DHWSetSolarTemp)
* Suffix bei den Temp-Werten hinzugefügt. z.B. p04DHWsetDay jetzt p04DHWsetDayTemp

'''v0.107'''

* p56 and p57 getauscht und repariert

'''v0.108'''

* Party-Time wurde entfernt da nicht funktionsfähig
* Grouping bei "set programFan_Mo-Fr_0 to 08:00--20:00" --> Einzelne Tage werden automatisch gesetzt

'''v0.109'''

* Fehlerbehebung bei langen Nachrichten via Seriellem Kabel

'''v0.110'''

* Bugfix (für seriellen Adapter) trunkating messages (forum 209294)

'''v.0111'''

* P21,22,23,24,25,29 hinzugefügt

'''v0.112'''

* Bugfix für Fehler verursacht durch DevIo.pm 6980 status disconnected msg223569

'''v0.113'''

* Unterstützung für ältere Firmewareversionen hinzugefügt

'''v0.114'''

* Unterstützung für ältere Firmewareversionen hinzugefügt

'''v0.115'''

* Implementierung von "Informationen aus dem Modul des HeatpumpMonitor von Robert Penz". Alle nicht identifizierbaren Teile erhalten den Wert "n.a."

'''v0.116'''

* weitere Unterstützung für ältere Firmewareversionen hinzugefügt

'''v0.118'''

* faultcode implementiert
* Rechtschreibefehler korrigiert: evuRelease

'''v0.119'''
* der Firmwareparameter 2.06 erhöht den Maximalcount der Wiederholung von DevIo_SimpleReadWithTimeout von 24 auf 50
* Reduktion des DevIo_SimpleReadWithTimeout von 0.06 auf 0.02
* Der Firmwareparameter 2.06 entfernt jetzt Register, die von älteren Wärmepumpen nicht unterstützt werden

'''v0.120'''

* Verzögerung zwischen programXXX_YY zugefügt

'''v0.121'''

* Register Interpretation von user godmorgon implementiert
* register 17 für ältere Firmwareversionen implementiert

'''v0.122'''

* pXX Register für ältere Firmwareversionen implementiert
* maximale Widerholungen jetzt limitiert auf 60, zuvor 50
* actualPower_Qc: gepatcht um Pufferüberlauf zu vermeiden

'''v0.123'''

* actualPower_Qc und actualPower_pEl korrigiert

'''v0.124'''

* Verlaufsregister angelegt für Firmwareversion 2.06

'''v.0125'''

* Anpassungen um die Firmware 2.06 zu unterstützen

'''v.0126'''

* Weitere Anpassungen um die Firmware 2.06 zu unterstützen

'''v0.127'''

* Bugfix:Unterschied in Parsingregel für FCtime

'''v0.128'''

* Die meisten Paramter können jetzt von WP älterer Firmware gelesen werden

'''v0.129'''

* sDisplay (Aktivitätsparameter die im Display dargestellt werden)

'''v0.130'''

* 2 Bugfixes
* Firmware-id enthält neue Feature wie HW: 74 SW: 2.08 Date: MAR 9 2011
* neuer Parameter p99RoomThermCorrection implementiert
* THZ_PrintcurveSVG (Heizkurve) wird jetzt durch p99RoomThermCorrection beeinflusst

'''v0.131'''

* p35PasteurisationInterval,p35PasteurisationTemp, p34BoosterDHWTempAct, p99DHWmaxFlowTemp, p89DHWeco hinzugefügt

'''v0.132'''

* p99startUnschedVent hinzugefügt
* Aufteilung großer Register implementiert. Nötig für Firmware 2.06.
* Heizkurven jetzt auf 15...35°C begrenzt für bessere Darstellung des Kurvenverlaufs

'''v0.133'''

* p12 FanStageManual hinzugefügt
* Autoskalierung der Heizkurvenskala

'''v0.133+'''

* fixed: Laut Bedienungsanleitung ist p99RoomThermCorrection der Parameter P76

= Beispielkonfiguration =

'''Start Definition mit Ser2Net'''

<code>
define Mythz THZ 192.168.111.5:2003 
attr Mythz room Sysintern
</code>

'''userReadings'''

[[File:dash.jpg|thumb]]

<code>
attr Mythz userReadings AussenTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[1]}, VorlaufTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[3]}, RuecklaufTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[5]}, WWTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[9]}, KollektorTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[79]}
</code>

'''interval Definitionen'''

<code>
attr Mythz interval_sGlobal 300 
attr Mythz interval_sHistory 28800 
attr Mythz interval_sLast10errors 120 
</code>

'''Definition von file-log und den SVG-Plots einiger Daten'''

<code>
define FileLog_Mythz FileLog ./log/Mythz-%Y-%m.log Mythz 
define wal_0 SVG FileLog_Mythz:thz:CURRENT 
attr wal_0 room Heizung 
define wal_1 SVG FileLog_Mythz:thz1:CURRENT 
attr wal_1 room Heizung 
define wal_2 SVG FileLog_Mythz:thz2:CURRENT 
attr wal_2 room Heizung 
define wal_3 SVG FileLog_Mythz:thz3:CURRENT 
attr wal_3 room Heizung 
define wal_4 SVG FileLog_Mythz:thz4:CURRENT 
attr wal_4 room Heizung 
</code>

'''readingsGroup'''

<code>
define rg_thz readingsGroup Mythz:<%temp_outside>,<Aussen>,AussenTemp Mythz:<%sani_supply_temp@red>,<Vorlauf>,VorlaufTemp Mythz:<%sani_return_temp@blue>,<Rücklauf>,RuecklaufTemp Mythz:<%sani_boiler_temp@BD7800>,<Wasser>,WWTemp Mythz:<%sani_solar_temp>,<Kollektor>,KollektorTemp
 
attr rg_thz alias Heizung Temperaturen 
attr rg_thz group THZ 
attr rg_thz room Sysintern 
attr rg_thz valueFormat { AussenTemp => '%1.f °C', VorlaufTemp => '%1.f °C', AussenTemp=> '%1.f °C', RuecklaufTemp=> '%1.f °C', WWTemp=> '%1.f °C', KollektorTemp=> '%1.f °C' }
</code>

'''Dashboard'''

<code>
define MyDashboard Dashboard 
attr MyDashboard dashboard_lockstate unlock 
attr MyDashboard dashboard_row top-center 
attr MyDashboard dashboard_showhelper 0 
attr MyDashboard dashboard_showtooglebuttons 0 
attr MyDashboard dashboard_tab1groups THZ 
attr MyDashboard dashboard_tab1name micofhem 
attr MyDashboard dashboard_tab1sorting t0c100,THZ,true,170,253 
attr MyDashboard dashboard_tabcount 1 
attr MyDashboard dashboard_webfrontendfilter WEB 
define MyDashboard_weblink weblink htmlCode {DashboardAsHtml("MyDashboard")} 
attr MyDashboard_weblink room DashboardRoom
</code>

'''FanSelector für die Lüftungssteuerung'''

<code>
define FanSelectorDay dummy 
attr FanSelectorDay group THZ 
attr FanSelectorDay setList 0 1 2 3 offFor60min 
attr FanSelectorDay webCmd 0:1:2:3:offFor60min 
attr FanSelectorDay devStateIcon 0:vent_ventilation_level_0 1:vent_ventilation_level_1 2:vent_ventilation_level_2 3:vent_ventilation_level_3 
define Notify_p07FanStageDay notify FanSelectorDay IF ([FanSelectorDay] eq "offFor60min") (define at_D_offFor60min at +00:59:00 set Mythz p07FanStageDay [Mythz:p07FanStageDay],set Mythz p07FanStageDay 0, setstate FanSelectorDay offFor60min) ELSE (set Mythz p07FanStageDay $EVENT) 
define Notify_FanselectorDay notify (Mythz.p07FanStageDay.*) setstate FanSelectorDay $EVTPART1 
attr FanSelectorDay room heatpump 
[[File:fanselectorv2.png|thumb]]
define FanSelectorNight dummy 
attr FanSelectorNight group THZ 
attr FanSelectorNight setList 0 1 2 3 offFor60min 
attr FanSelectorNight webCmd 0:1:2:3:offFor60min 
attr FanSelectorNight devStateIcon 0:vent_ventilation_level_0 1:vent_ventilation_level_1 2:vent_ventilation_level_2 3:vent_ventilation_level_3 
define Notify_p08FanStageNight notify FanSelectorNight IF ([FanSelectorNight] eq "offFor60min") (define at_N_offFor60min at +00:59:00 set Mythz p08FanStageNight [Mythz:p08FanStageNight],set Mythz p08FanStageNight 0, setstate FanSelectorNight offFor60min) ELSE (set Mythz p08FanStageNight $EVENT) 
define Notify_FanselectorNight notify (Mythz.p08FanStageNight.*) setstate FanSelectorNight $EVTPART1 
attr FanSelectorNight room heatpump</code>

= Links =
[https://launchpad.net/heatpumpmonitor Launchpad Heatpumpmonitor]

[http://forum.fhem.de/index.php/topic,13132.0.html Forenthread im FHEM-Forum]

[[Kategorie:Other Components]]
[[Kategorie:Heizungssteuerung]]

Tecalor THZ Heatpump

2015-03-04T12:25:20Z

Micomat:

{{Infobox Modul
|Name=THZ
|ModPurpose=Connect to Tecalor heatpump
|ModType=d

|ModCmdRef=THZ
|ModForumArea=Sonstiges
|ModTechName=00_THZ.pm
|ModOwner=immiimmi
}}German version: [[Tecalor THZ Wärmepumpe]]

This article describes how to connect to a Stiebel Eltron / Tecalor THZ/LWZ 303/304/403/404 heatpump and to read and write settings from and to the heating. 504 not tested yet but may also work.

For better understanding: Tecalor is the end customer brand of Stiebel Eltron. In the following the system will be called "THZ"

Tested are Software Versions 2.06, 4.09, 4.19, 4.39 and 5.39.
Older versions may work but there's no guarantee for.
NOTE: This manual is for persons who are familiar with electronics.
The author and the developer are not liable for any damage and there's no warranty.

'''ATTENTION!! Since v0.087 the reading names have changed.''' To have intuitive and consistent reading names the readings names changed to sXXX and pXXXX for status values and parameters in the heating. See readings section for more information. 
If you update you sure have to reconfigure readingsGroups, dashboards, and so...

=Connection to the heatpump=
==Local via RS232 or USB==
The THZ has two interface which can be used for a connection.
* One serial interface behind the right door which can be used with a MNL-SG3 Plug
* One USB interface on the electronics board which can be used with a TYPE-B USB cable.
'''Warning!!! The USB interface is on the back side of the electronics board behind the coverage wich is behind the right door. Do not connect the USB while the system is powered on! Before removing the coverage you have to power off the complete heatpump!!'''

The baud rates may vary based on hard- and software release between 9600 and 115200 for RS232. For USB it's 57600 or 115200 baud.
More information how to connect to the heatpump with RS232 can be found here: [http://robert.penz.name/heat-pump-lwz/ Robert Penz Homepage]

==Remote connection with Ser2Net==
If the FHEM server is not near the heatpump you can connect with Ser2Net. This will provide a virtual serial interface on a TCP-Port

===Installation Ser2Net on Linux===
To install Serial-Port-Server Ser2Net just follow these steps:
:<code>sudo apt-get install ser2net</code>
in /etc/ser2net.conf (/dev/ttyXXX)
:<code>2003:raw:500:/dev/ttyUSB0:115200 NONE 1STOPBIT 8DATABITS </code>
The port can be chosen on your own as long as it's still unused.

==Tested Host-Systems==
This module was tested on FritzBox, nas-qnap, Raspberry Pi and MacOS.

=Definition in FHEM=
==Direct RS232 serial or USB==
:<code>define Mythz THZ /dev/ttyUSB0@115200 # or (/dev/ttyXXX)</code>
:<code>attr Mythz interval_sGlobal 300 # Internal Polling Interval 5min</code>
:<code>attr Mythz interval_sHistory 28800 # Internal Polling Interval 8h</code>
:<code>attr Mythz interval_sLast10errors 120 # Internal Polling Fault Memory</code>

:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz</code>

If you don't define the attributes interval_sGlobal and interval_history (or they are 0), the internal polling is disabled. Sure you can also poll with the "at" command outside the module:

:<code>define Mythz THZ /dev/ttyUSB0@115200 # or (/dev/ttyXXX)</code>
:<code>define atMythzFB at +*00:05:00 {fhem "get Mythz sGlobal","1";;return()}</code>
:<code>define atMythz09 at +*08:00:00 {fhem "get Mythz sHistory","1";;return()}</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz </code>

==Over network with Ser2Net==
:<code>define Mythz THZ 192.168.0.244:2003</code>
:<code>attr Mythz interval_sGlobal 300 # Internal Polling Interval 5min</code>
:<code>attr Mythz interval_sHistory 28800 # Internal Polling Interval 8h</code>
:<code>attr Mythz interval_sLast10errors 120 # Internal Polling Interval Fault Memory</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz</code>

=Readings=
If the connection to the heatpump was successful you should see readings like sGlobal, sFirmware, sHistory and some settings like holiday and pXX parameters.einige PXX Werte angezeigt werden.

'''sGlobal (ex allFB)'''

Contains all actual values like water and gas temperatures, fan states, pressures, ...

'''sFirmware'''

Shows the firmware release.

'''sHistory'''

Contains information to operating hours, e.g. the compressors operating hours.

'''pHoliday-Werte'''

Here you can see the settings of the holiday configuration of the THZ. These are used to override the day setback for the give time.
You can change the holiday settings with <code>set</code>.

'''sLast10errors'''

Reads the last 10 errors and shows it.

'''pXX-values & program-values'''

The pXX & program values are settings like the heating circle, fan states, dhw programs and so on. All pXX and program valueas can be changed with the <code>set</code> command. NEW: Now the fanstage-inlet and outlet volumes are read- and writeable. 
pOpMode shows the Operating Mode of the THZ. Like Automatic, Setback, ...

'''party-time'''

This parameter sets the party time.
While this time range the fan state will change to the in p99FanStageParty stage.

'''sDHW (ex Status_DHW_F3)'''

Contains information about the Domestic Hot Water system

'''sHC1 (ex Status_HC1_F4)'''

Contains information about the Heatinc Circle 1

'''sHC2 (ex Status_HC2_F5)'''

Information of HC2

'''sSol (ex Status_Sol_16)'''

Solar Heating System informations

'''pOpMode (ex OperatingMode)'''

OperatingMode of the heating. One of: Standby, Automatic, DAYmode, SetBack, DHWmode, Manual, Emergency

If the operating mode should be changed via FHEM, the set command must send the depending mode code like shown above.

'''sXXX'''

There are some more "s"tatus readings with show you values like the heat recovery

= Plots - graphical views =
This shows you how to create plots from the heatpump readings.

'''Example'''

Assuming we want to read and plot the outside_temp and the dhw_temp from the sGlobal reading:

Creating the plot in fhem.cfg:
:<code>define Plot_Temp SVG FileLog_Mythz:thz:CURRENT</code>
:<code>attr Plot_Temp room Heizung</code>

This will setup the plot without any data and maybe with an error message.
Klick on the plot-name to open the plot config windows.
Here you enter the details.

'''Most important are now the input fields'''

Below the input mask you find the according readings to Mythz, including sGlobal.

sGlobal will like like this:
:<code>2014-03-02_13:07:49 Mythz sGlobal: outside_temp: 3.8 flow_temp: 26.5 return_temp: 27.2 hot_gas_temp: 32.1 dhw_temp: 43.4 flow_temp_HC2: -60 evaporator_temp: 5.3 condenser_temp: 27.4 Mixer_open: 0 Mixer_closed: 0 HeatPipeValve: 0 DiverterValve: 0 DHW_Pump: 0 .................output omitted</code>

[[File:Thzplot.jpg|thumb]]

To find the right input value just count the space seperated data. So the value for outside_temp is 5 and dhw_temp is 13 as these are the positions they are on.
This number will be entered into the input field to create the plot with the chosen data.

More information to [[Creating Plots]]

=extract single values from readings=
To separate values to from the "big readings" like sGlobal or history you can use a userReading.

Example:

:<code>attr Mythz userReadings OutsideTemp {(split ' ',ReadingsVal("Mythz","sGlobal",0))[1]},

FlowTemp {(split ' ',ReadingsVal("Mythz","sGlobal",0))[3]}</code>

More information to userReadings can be found in the [http://fhem.de/commandref_DE.html CommandRef]

= Notes =

* A full refresh (of all parameters) is done only at systemstart, very very slowly (not to decrease performance of FHEM), and takes ca 3 or 4 minutes. After that the intervall polling of sGlobal and sHistory register should start.
* If the FB-intervall or History-Intervall attributes are lower than 3 minutes, there clould be a concurrency. But that shouldn't cause any problems.
* in wintermode roomSetTemp (from sHC1) is given from p01RoomTempDayHC1 and p02RoomTempNightHC1
* in summermode roomSetTemp (from sHC1) is given from p01RoomTempDayHC1SummerMode and p02RoomTempNightHC1SummerMode

= known Problems =
In the FHEM Log you will find messages like this when using Ser2Net:
:<code>2014.03.02 09:41:09 1: 192.168.178.50:2003 disconnected, waiting to reappear
2014.03.02 09:41:09 1: 192.168.178.50:2003 reappeared (Mythz)</code>

This problem is not solved until now.

= Release History =
'''v0.067'''

Module first implemented in FHEM

'''v0.068'''

new command for party

'''v0.069'''

added German CommandRef

'''v0.070'''

BugFix in status bits

'''v0.071'''

Bugfix, undefFn improved

'''v0.072'''

* all programHC1*, programHC2*, programFan* and programDHW* have been implemented with get and set
* inside_temp has been added to the end of allFB
* connect/disconnet bug related to ser2net has been extremely improved: max one retry per second

'''v0.074'''

now the parameters air inlet- outlet-volumes and passive cooling are read and writeable

'''v0.075'''

implemented interval_last10errors. Interval for polling the internal fault memory of the heatpump.

'''v0.076'''

Bugfixes and new parameter Status_HC1_F4

'''v0.078'''

new parameters Status_Sol_16 and Status_DHW_F3

'''v0.080'''

* new Parameters p49SummerModeTemp and p50SummerModeHysteresis
* Status_HC1_F4 and Status_HC2_F5 now showing "mode: Summer" (or Winter)
Calculation of the mode is:
:<code> if outsidetemp > p49SummerModeTemp + p50SummerModeHysteresis ---> Summermode</code>
:<code> if outsidetemp < p49SummerModeTemp - p50SummerModeHysteresis ---> Wintermode</code>

'''v0.081'''

BugFix for Sommer/Wintermodus-Anzeige

'''v0.084'''

* OperatingMode now displayed (read-only)
* p33BoosterTimeoutDHW (read/write)
* p79BoosterTimeoutHC (read/write)

'''v0.085'''

OperatingMode is now read/write

'''v0.087'''

* Neue Readings
* Angepasste Readingnamen

'''v0.089'''

* Improvements on communication
* Bugfixes
* New readings

'''v0.091'''

New Readings: sHeatRecoveredDay & sHeatRecoveredTotal

'''v0.094'''

Bugfixes

'''v0.095'''

New Readings: sHeatDHWDay & sHeatDHWTotal

'''v0.096'''

More new Readings: sEletrx... & sHeat...

'''v0.097'''

Bugfixes

'''v0.099'''

room-influence has been included in the simulation curve plot

'''v0.100'''

new parameters: p54MinPumpCycles, p55MaxPumpCycles, p56OutTempMaxPumpCycles, p57OutTempMinPumpCycles

'''v0.101'''

* no new features
* lots of clean up
* logs in verbose 5 implemented.
* buffer overflow (caused by sGlobal for LWZ 303 firmware 3.19). has been fixed.

'''v0.103'''

* Major change in communications (10x faster)
* Added version information

'''v0.104'''

Added some delay in communications but still 5x faster

'''v0.105'''

* faster getting and setting of variables
* update after the start two times faster
* THZ attributes can be changed without restarting
* BugFixes
* P83 added (DHWSetSolarTemp)
* added suffix temp to the names of parameters. e.g. p04DHWsetDay now p04DHWsetDayTemp

'''v0.107'''

* p56 and p57 exchanged and fixed

'''v0.108'''

* Party-Time set removed as it has never worked
* set programFan_Mo-Fr_0 to 08:00--20:00 --> will now change the according day-program-sets also

'''v0.109'''

* bug fix for long messages in combination with serial cable connection
'''v0.110'''

* bugfix for interface (with serial cable) trunkating messages (forum 209294)

'''v.0111'''

* P21,22,23,24,25,29 added

'''v0.112'''

* bugfix for error caused by DevIo.pm 6980 status disconnected msg223569

'''v0.113'''

* support for older heatpumps

'''v0.114'''

* support for older heatpumps

'''v0.115'''

* implemented the "Informationen aus dem Modul des HeatpumpMonitors von Robert Penz". All non identified parts will receive value "n.a."

'''v0.116'''

* support for older heatpumps

'''v0.118'''

* faultcode implemented.
* Typo fix: evuRelease

'''v0.119'''
* the firmware parameter 2.06 increases the countmax of the repetition of DevIo_SimpleReadWithTimeout from 24 to 50
* decrease of the DevIo_SimpleReadWithTimeout from 0.06 to 0.02
* the firmware parameter 2.06 removes registers not supported from older heatpumps

'''v0.120'''

* delays between the programming of programXXX_YY.

'''v0.121'''

* register interpretation from user godmorgon implemented
* register 17 for old firmwares implemented

'''v0.122'''

* pXX register for old firmware implemented
* max repeat increased limited to 60, before was 50
* actualPower_Qc: patched to avoid buffer overflow

'''v0.123'''

* actualPower_Qc and actualPower_pEl fixed

'''v0.124'''

* history register pathed for firmware version 2.06

'''v.0125'''

* Adjustments to support Firmware 2.06

'''v.0126'''

* Further Adjustments to support Firmware 2.06

'''v0.127'''

* Bugfix:difference in the parsing rule for FCtime

'''v0.128'''

* now most of parameters can be read from old firmwares

'''v0.129'''

* sDisplay (Activity parameters symbolized in Display)

'''v0.130'''

* 2 bugfixes
* firmware-id contains new features e.g. HW: 74 SW: 2.08 Date: MAR 9 2011
* new parameter p99RoomThermCorrection implemented
* THZ_PrintcurveSVG is now influenced by p99RoomThermCorrection

'''v0.131'''

* added p35PasteurisationInterval,p35PasteurisationTemp, p34BoosterDHWTempAct, p99DHWmaxFlowTemp, p89DHWeco

'''v0.132'''

* added p99startUnschedVent
* splitting of big register implemented; this is needed for writing in old 2.06 firmware.
* vertical range in the heating curve changed to 15..35°C

'''v0.133'''

* p12 FanStageManual
* autoscale of heating curve

'''v0.133+'''

* fixed: According the manual our p99RoomThermCorrection is actually P76

= Beispielkonfiguration =

'''Start Definition mit Ser2Net'''

<code>
define Mythz THZ 192.168.111.5:2003 
attr Mythz room Sysintern
</code>

'''userReadings'''

[[File:dash.jpg|thumb]]

<code>
attr Mythz userReadings AussenTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[1]}, VorlaufTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[3]}, RuecklaufTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[5]}, WWTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[9]}, KollektorTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[79]}
</code>

'''interval Defintionen'''

<code>
attr Mythz interval_sGlobal 300 
attr Mythz interval_sHistory 28800 
attr Mythz interval_sLast10errors 120 
</code>

'''Definition von file-log und den SVG-Plots einiger Daten'''

<code>
define FileLog_Mythz FileLog ./log/Mythz-%Y-%m.log Mythz 
define wal_0 SVG FileLog_Mythz:thz:CURRENT 
attr wal_0 room Heizung 
define wal_1 SVG FileLog_Mythz:thz1:CURRENT 
attr wal_1 room Heizung 
define wal_2 SVG FileLog_Mythz:thz2:CURRENT 
attr wal_2 room Heizung 
define wal_3 SVG FileLog_Mythz:thz3:CURRENT 
attr wal_3 room Heizung 
define wal_4 SVG FileLog_Mythz:thz4:CURRENT 
attr wal_4 room Heizung 
</code>

'''readingsGroup'''

<code>
define rg_thz readingsGroup Mythz:<%temp_outside>,<Aussen>,AussenTemp Mythz:<%sani_supply_temp@red>,<Vorlauf>,VorlaufTemp Mythz:<%sani_return_temp@blue>,<Rücklauf>,RuecklaufTemp Mythz:<%sani_boiler_temp@BD7800>,<Wasser>,WWTemp Mythz:<%sani_solar_temp>,<Kollektor>,KollektorTemp
 
attr rg_thz alias Heizung Temperaturen 
attr rg_thz group THZ 
attr rg_thz room Sysintern 
attr rg_thz valueFormat { AussenTemp => '%1.f °C', VorlaufTemp => '%1.f °C', AussenTemp=> '%1.f °C', RuecklaufTemp=> '%1.f °C', WWTemp=> '%1.f °C', KollektorTemp=> '%1.f °C' }
</code>

'''Dashboard'''

<code>
define MyDashboard Dashboard 
attr MyDashboard dashboard_lockstate unlock 
attr MyDashboard dashboard_row top-center 
attr MyDashboard dashboard_showhelper 0 
attr MyDashboard dashboard_showtooglebuttons 0 
attr MyDashboard dashboard_tab1groups THZ 
attr MyDashboard dashboard_tab1name micofhem 
attr MyDashboard dashboard_tab1sorting t0c100,THZ,true,170,253 
attr MyDashboard dashboard_tabcount 1 
attr MyDashboard dashboard_webfrontendfilter WEB 
define MyDashboard_weblink weblink htmlCode {DashboardAsHtml("MyDashboard")} 
attr MyDashboard_weblink room DashboardRoom
</code>

'''FanSelector für die Lüftungssteuerung'''

<code>
define FanSelectorDay dummy 
attr FanSelectorDay group THZ 
attr FanSelectorDay setList 0 1 2 3 offFor60min 
attr FanSelectorDay webCmd 0:1:2:3:offFor60min 
attr FanSelectorDay devStateIcon 0:vent_ventilation_level_0 1:vent_ventilation_level_1 2:vent_ventilation_level_2 3:vent_ventilation_level_3 
define Notify_p07FanStageDay notify FanSelectorDay IF ([FanSelectorDay] eq "offFor60min") (define at_D_offFor60min at +00:59:00 set Mythz p07FanStageDay [Mythz:p07FanStageDay],set Mythz p07FanStageDay 0, setstate FanSelectorDay offFor60min) ELSE (set Mythz p07FanStageDay $EVENT) 
define Notify_FanselectorDay notify (Mythz.p07FanStageDay.*) setstate FanSelectorDay $EVTPART1 
attr FanSelectorDay room heatpump 
[[File:fanselectorv2.png|thumb]]
define FanSelectorNight dummy 
attr FanSelectorNight group THZ 
attr FanSelectorNight setList 0 1 2 3 offFor60min 
attr FanSelectorNight webCmd 0:1:2:3:offFor60min 
attr FanSelectorNight devStateIcon 0:vent_ventilation_level_0 1:vent_ventilation_level_1 2:vent_ventilation_level_2 3:vent_ventilation_level_3 
define Notify_p08FanStageNight notify FanSelectorNight IF ([FanSelectorNight] eq "offFor60min") (define at_N_offFor60min at +00:59:00 set Mythz p08FanStageNight [Mythz:p08FanStageNight],set Mythz p08FanStageNight 0, setstate FanSelectorNight offFor60min) ELSE (set Mythz p08FanStageNight $EVENT) 
define Notify_FanselectorNight notify (Mythz.p08FanStageNight.*) setstate FanSelectorNight $EVTPART1 
attr FanSelectorNight room heatpump</code>

= Links =
[https://launchpad.net/heatpumpmonitor Launchpad Heatpumpmonitor]

[http://forum.fhem.de/index.php/topic,13132.0.html Thread in the FHEM-Forum]

[[Kategorie:Other Components]]
[[Kategorie:Heizungssteuerung]]

Tecalor THZ Heatpump

2015-03-04T12:23:54Z

Micomat: /* Release History */

{{Infobox Modul
|Name=THZ
|ModPurpose=Connect to Tecalor heatpump
|ModType=d

|ModCmdRef=THZ
|ModForumArea=Sonstiges
|ModTechName=00_THZ.pm
|ModOwner=immiimmi
}}German version: [[Tecalor THZ Wärmepumpe]]

This article describes how to connect to a Stiebel Eltron / Tecalor THZ/LWZ 303/304/404 heatpump and to read and write settings from and to the heating.

For better understanding: Tecalor is the end customer brand of Stiebel Eltron. In the following the system will be called "THZ"

Tested are Software Versions 4.09, 4.19, 4.39 and 5.39.
Older versions may work but there's no guarantee for.
NOTE: This manual is for persons who are familiar with electronics.
The author and the developer are not liable for any damage and there's no warranty.

'''ATTENTION!! Since v0.087 the reading names have changed.''' To have intuitive and consistent reading names the readings names changed to sXXX and pXXXX for status values and parameters in the heating. See readings section for more information. 
If you update you sure have to reconfigure readingsGroups, dashboards, and so...

=Connection to the heatpump=
==Local via RS232 or USB==
The THZ has two interface which can be used for a connection.
* One serial interface behind the right door which can be used with a MNL-SG3 Plug
* One USB interface on the electronics board which can be used with a TYPE-B USB cable.
'''Warning!!! The USB interface is on the back side of the electronics board behind the coverage wich is behind the right door. Do not connect the USB while the system is powered on! Before removing the coverage you have to power off the complete heatpump!!'''

The baud rates may vary based on hard- and software release between 9600 and 115200 for RS232. For USB it's 57600 or 115200 baud.
More information how to connect to the heatpump with RS232 can be found here: [http://robert.penz.name/heat-pump-lwz/ Robert Penz Homepage]

==Remote connection with Ser2Net==
If the FHEM server is not near the heatpump you can connect with Ser2Net. This will provide a virtual serial interface on a TCP-Port

===Installation Ser2Net on Linux===
To install Serial-Port-Server Ser2Net just follow these steps:
:<code>sudo apt-get install ser2net</code>
in /etc/ser2net.conf (/dev/ttyXXX)
:<code>2003:raw:500:/dev/ttyUSB0:115200 NONE 1STOPBIT 8DATABITS </code>
The port can be chosen on your own as long as it's still unused.

==Tested Host-Systems==
This module was tested on FritzBox, nas-qnap, Raspberry Pi and MacOS.

=Definition in FHEM=
==Direct RS232 serial or USB==
:<code>define Mythz THZ /dev/ttyUSB0@115200 # or (/dev/ttyXXX)</code>
:<code>attr Mythz interval_sGlobal 300 # Internal Polling Interval 5min</code>
:<code>attr Mythz interval_sHistory 28800 # Internal Polling Interval 8h</code>
:<code>attr Mythz interval_sLast10errors 120 # Internal Polling Fault Memory</code>

:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz</code>

If you don't define the attributes interval_sGlobal and interval_history (or they are 0), the internal polling is disabled. Sure you can also poll with the "at" command outside the module:

:<code>define Mythz THZ /dev/ttyUSB0@115200 # or (/dev/ttyXXX)</code>
:<code>define atMythzFB at +*00:05:00 {fhem "get Mythz sGlobal","1";;return()}</code>
:<code>define atMythz09 at +*08:00:00 {fhem "get Mythz sHistory","1";;return()}</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz </code>

==Over network with Ser2Net==
:<code>define Mythz THZ 192.168.0.244:2003</code>
:<code>attr Mythz interval_sGlobal 300 # Internal Polling Interval 5min</code>
:<code>attr Mythz interval_sHistory 28800 # Internal Polling Interval 8h</code>
:<code>attr Mythz interval_sLast10errors 120 # Internal Polling Interval Fault Memory</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz</code>

=Readings=
If the connection to the heatpump was successful you should see readings like sGlobal, sFirmware, sHistory and some settings like holiday and pXX parameters.einige PXX Werte angezeigt werden.

'''sGlobal (ex allFB)'''

Contains all actual values like water and gas temperatures, fan states, pressures, ...

'''sFirmware'''

Shows the firmware release.

'''sHistory'''

Contains information to operating hours, e.g. the compressors operating hours.

'''pHoliday-Werte'''

Here you can see the settings of the holiday configuration of the THZ. These are used to override the day setback for the give time.
You can change the holiday settings with <code>set</code>.

'''sLast10errors'''

Reads the last 10 errors and shows it.

'''pXX-values & program-values'''

The pXX & program values are settings like the heating circle, fan states, dhw programs and so on. All pXX and program valueas can be changed with the <code>set</code> command. NEW: Now the fanstage-inlet and outlet volumes are read- and writeable. 
pOpMode shows the Operating Mode of the THZ. Like Automatic, Setback, ...

'''party-time'''

This parameter sets the party time.
While this time range the fan state will change to the in p99FanStageParty stage.

'''sDHW (ex Status_DHW_F3)'''

Contains information about the Domestic Hot Water system

'''sHC1 (ex Status_HC1_F4)'''

Contains information about the Heatinc Circle 1

'''sHC2 (ex Status_HC2_F5)'''

Information of HC2

'''sSol (ex Status_Sol_16)'''

Solar Heating System informations

'''pOpMode (ex OperatingMode)'''

OperatingMode of the heating. One of: Standby, Automatic, DAYmode, SetBack, DHWmode, Manual, Emergency

If the operating mode should be changed via FHEM, the set command must send the depending mode code like shown above.

'''sXXX'''

There are some more "s"tatus readings with show you values like the heat recovery

= Plots - graphical views =
This shows you how to create plots from the heatpump readings.

'''Example'''

Assuming we want to read and plot the outside_temp and the dhw_temp from the sGlobal reading:

Creating the plot in fhem.cfg:
:<code>define Plot_Temp SVG FileLog_Mythz:thz:CURRENT</code>
:<code>attr Plot_Temp room Heizung</code>

This will setup the plot without any data and maybe with an error message.
Klick on the plot-name to open the plot config windows.
Here you enter the details.

'''Most important are now the input fields'''

Below the input mask you find the according readings to Mythz, including sGlobal.

sGlobal will like like this:
:<code>2014-03-02_13:07:49 Mythz sGlobal: outside_temp: 3.8 flow_temp: 26.5 return_temp: 27.2 hot_gas_temp: 32.1 dhw_temp: 43.4 flow_temp_HC2: -60 evaporator_temp: 5.3 condenser_temp: 27.4 Mixer_open: 0 Mixer_closed: 0 HeatPipeValve: 0 DiverterValve: 0 DHW_Pump: 0 .................output omitted</code>

[[File:Thzplot.jpg|thumb]]

To find the right input value just count the space seperated data. So the value for outside_temp is 5 and dhw_temp is 13 as these are the positions they are on.
This number will be entered into the input field to create the plot with the chosen data.

More information to [[Creating Plots]]

=extract single values from readings=
To separate values to from the "big readings" like sGlobal or history you can use a userReading.

Example:

:<code>attr Mythz userReadings OutsideTemp {(split ' ',ReadingsVal("Mythz","sGlobal",0))[1]},

FlowTemp {(split ' ',ReadingsVal("Mythz","sGlobal",0))[3]}</code>

More information to userReadings can be found in the [http://fhem.de/commandref_DE.html CommandRef]

= Notes =

* A full refresh (of all parameters) is done only at systemstart, very very slowly (not to decrease performance of FHEM), and takes ca 3 or 4 minutes. After that the intervall polling of sGlobal and sHistory register should start.
* If the FB-intervall or History-Intervall attributes are lower than 3 minutes, there clould be a concurrency. But that shouldn't cause any problems.
* in wintermode roomSetTemp (from sHC1) is given from p01RoomTempDayHC1 and p02RoomTempNightHC1
* in summermode roomSetTemp (from sHC1) is given from p01RoomTempDayHC1SummerMode and p02RoomTempNightHC1SummerMode

= known Problems =
In the FHEM Log you will find messages like this when using Ser2Net:
:<code>2014.03.02 09:41:09 1: 192.168.178.50:2003 disconnected, waiting to reappear
2014.03.02 09:41:09 1: 192.168.178.50:2003 reappeared (Mythz)</code>

This problem is not solved until now.

= Release History =
'''v0.067'''

Module first implemented in FHEM

'''v0.068'''

new command for party

'''v0.069'''

added German CommandRef

'''v0.070'''

BugFix in status bits

'''v0.071'''

Bugfix, undefFn improved

'''v0.072'''

* all programHC1*, programHC2*, programFan* and programDHW* have been implemented with get and set
* inside_temp has been added to the end of allFB
* connect/disconnet bug related to ser2net has been extremely improved: max one retry per second

'''v0.074'''

now the parameters air inlet- outlet-volumes and passive cooling are read and writeable

'''v0.075'''

implemented interval_last10errors. Interval for polling the internal fault memory of the heatpump.

'''v0.076'''

Bugfixes and new parameter Status_HC1_F4

'''v0.078'''

new parameters Status_Sol_16 and Status_DHW_F3

'''v0.080'''

* new Parameters p49SummerModeTemp and p50SummerModeHysteresis
* Status_HC1_F4 and Status_HC2_F5 now showing "mode: Summer" (or Winter)
Calculation of the mode is:
:<code> if outsidetemp > p49SummerModeTemp + p50SummerModeHysteresis ---> Summermode</code>
:<code> if outsidetemp < p49SummerModeTemp - p50SummerModeHysteresis ---> Wintermode</code>

'''v0.081'''

BugFix for Sommer/Wintermodus-Anzeige

'''v0.084'''

* OperatingMode now displayed (read-only)
* p33BoosterTimeoutDHW (read/write)
* p79BoosterTimeoutHC (read/write)

'''v0.085'''

OperatingMode is now read/write

'''v0.087'''

* Neue Readings
* Angepasste Readingnamen

'''v0.089'''

* Improvements on communication
* Bugfixes
* New readings

'''v0.091'''

New Readings: sHeatRecoveredDay & sHeatRecoveredTotal

'''v0.094'''

Bugfixes

'''v0.095'''

New Readings: sHeatDHWDay & sHeatDHWTotal

'''v0.096'''

More new Readings: sEletrx... & sHeat...

'''v0.097'''

Bugfixes

'''v0.099'''

room-influence has been included in the simulation curve plot

'''v0.100'''

new parameters: p54MinPumpCycles, p55MaxPumpCycles, p56OutTempMaxPumpCycles, p57OutTempMinPumpCycles

'''v0.101'''

* no new features
* lots of clean up
* logs in verbose 5 implemented.
* buffer overflow (caused by sGlobal for LWZ 303 firmware 3.19). has been fixed.

'''v0.103'''

* Major change in communications (10x faster)
* Added version information

'''v0.104'''

Added some delay in communications but still 5x faster

'''v0.105'''

* faster getting and setting of variables
* update after the start two times faster
* THZ attributes can be changed without restarting
* BugFixes
* P83 added (DHWSetSolarTemp)
* added suffix temp to the names of parameters. e.g. p04DHWsetDay now p04DHWsetDayTemp

'''v0.107'''

* p56 and p57 exchanged and fixed

'''v0.108'''

* Party-Time set removed as it has never worked
* set programFan_Mo-Fr_0 to 08:00--20:00 --> will now change the according day-program-sets also

'''v0.109'''

* bug fix for long messages in combination with serial cable connection
'''v0.110'''

* bugfix for interface (with serial cable) trunkating messages (forum 209294)

'''v.0111'''

* P21,22,23,24,25,29 added

'''v0.112'''

* bugfix for error caused by DevIo.pm 6980 status disconnected msg223569

'''v0.113'''

* support for older heatpumps

'''v0.114'''

* support for older heatpumps

'''v0.115'''

* implemented the "Informationen aus dem Modul des HeatpumpMonitors von Robert Penz". All non identified parts will receive value "n.a."

'''v0.116'''

* support for older heatpumps

'''v0.118'''

* faultcode implemented.
* Typo fix: evuRelease

'''v0.119'''
* the firmware parameter 2.06 increases the countmax of the repetition of DevIo_SimpleReadWithTimeout from 24 to 50
* decrease of the DevIo_SimpleReadWithTimeout from 0.06 to 0.02
* the firmware parameter 2.06 removes registers not supported from older heatpumps

'''v0.120'''

* delays between the programming of programXXX_YY.

'''v0.121'''

* register interpretation from user godmorgon implemented
* register 17 for old firmwares implemented

'''v0.122'''

* pXX register for old firmware implemented
* max repeat increased limited to 60, before was 50
* actualPower_Qc: patched to avoid buffer overflow

'''v0.123'''

* actualPower_Qc and actualPower_pEl fixed

'''v0.124'''

* history register pathed for firmware version 2.06

'''v.0125'''

* Adjustments to support Firmware 2.06

'''v.0126'''

* Further Adjustments to support Firmware 2.06

'''v0.127'''

* Bugfix:difference in the parsing rule for FCtime

'''v0.128'''

* now most of parameters can be read from old firmwares

'''v0.129'''

* sDisplay (Activity parameters symbolized in Display)

'''v0.130'''

* 2 bugfixes
* firmware-id contains new features e.g. HW: 74 SW: 2.08 Date: MAR 9 2011
* new parameter p99RoomThermCorrection implemented
* THZ_PrintcurveSVG is now influenced by p99RoomThermCorrection

'''v0.131'''

* added p35PasteurisationInterval,p35PasteurisationTemp, p34BoosterDHWTempAct, p99DHWmaxFlowTemp, p89DHWeco

'''v0.132'''

* added p99startUnschedVent
* splitting of big register implemented; this is needed for writing in old 2.06 firmware.
* vertical range in the heating curve changed to 15..35°C

'''v0.133'''

* p12 FanStageManual
* autoscale of heating curve

'''v0.133+'''

* fixed: According the manual our p99RoomThermCorrection is actually P76

= Beispielkonfiguration =

'''Start Definition mit Ser2Net'''

<code>
define Mythz THZ 192.168.111.5:2003 
attr Mythz room Sysintern
</code>

'''userReadings'''

[[File:dash.jpg|thumb]]

<code>
attr Mythz userReadings AussenTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[1]}, VorlaufTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[3]}, RuecklaufTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[5]}, WWTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[9]}, KollektorTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[79]}
</code>

'''interval Defintionen'''

<code>
attr Mythz interval_sGlobal 300 
attr Mythz interval_sHistory 28800 
attr Mythz interval_sLast10errors 120 
</code>

'''Definition von file-log und den SVG-Plots einiger Daten'''

<code>
define FileLog_Mythz FileLog ./log/Mythz-%Y-%m.log Mythz 
define wal_0 SVG FileLog_Mythz:thz:CURRENT 
attr wal_0 room Heizung 
define wal_1 SVG FileLog_Mythz:thz1:CURRENT 
attr wal_1 room Heizung 
define wal_2 SVG FileLog_Mythz:thz2:CURRENT 
attr wal_2 room Heizung 
define wal_3 SVG FileLog_Mythz:thz3:CURRENT 
attr wal_3 room Heizung 
define wal_4 SVG FileLog_Mythz:thz4:CURRENT 
attr wal_4 room Heizung 
</code>

'''readingsGroup'''

<code>
define rg_thz readingsGroup Mythz:<%temp_outside>,<Aussen>,AussenTemp Mythz:<%sani_supply_temp@red>,<Vorlauf>,VorlaufTemp Mythz:<%sani_return_temp@blue>,<Rücklauf>,RuecklaufTemp Mythz:<%sani_boiler_temp@BD7800>,<Wasser>,WWTemp Mythz:<%sani_solar_temp>,<Kollektor>,KollektorTemp
 
attr rg_thz alias Heizung Temperaturen 
attr rg_thz group THZ 
attr rg_thz room Sysintern 
attr rg_thz valueFormat { AussenTemp => '%1.f °C', VorlaufTemp => '%1.f °C', AussenTemp=> '%1.f °C', RuecklaufTemp=> '%1.f °C', WWTemp=> '%1.f °C', KollektorTemp=> '%1.f °C' }
</code>

'''Dashboard'''

<code>
define MyDashboard Dashboard 
attr MyDashboard dashboard_lockstate unlock 
attr MyDashboard dashboard_row top-center 
attr MyDashboard dashboard_showhelper 0 
attr MyDashboard dashboard_showtooglebuttons 0 
attr MyDashboard dashboard_tab1groups THZ 
attr MyDashboard dashboard_tab1name micofhem 
attr MyDashboard dashboard_tab1sorting t0c100,THZ,true,170,253 
attr MyDashboard dashboard_tabcount 1 
attr MyDashboard dashboard_webfrontendfilter WEB 
define MyDashboard_weblink weblink htmlCode {DashboardAsHtml("MyDashboard")} 
attr MyDashboard_weblink room DashboardRoom
</code>

'''FanSelector für die Lüftungssteuerung'''

<code>
define FanSelectorDay dummy 
attr FanSelectorDay group THZ 
attr FanSelectorDay setList 0 1 2 3 offFor60min 
attr FanSelectorDay webCmd 0:1:2:3:offFor60min 
attr FanSelectorDay devStateIcon 0:vent_ventilation_level_0 1:vent_ventilation_level_1 2:vent_ventilation_level_2 3:vent_ventilation_level_3 
define Notify_p07FanStageDay notify FanSelectorDay IF ([FanSelectorDay] eq "offFor60min") (define at_D_offFor60min at +00:59:00 set Mythz p07FanStageDay [Mythz:p07FanStageDay],set Mythz p07FanStageDay 0, setstate FanSelectorDay offFor60min) ELSE (set Mythz p07FanStageDay $EVENT) 
define Notify_FanselectorDay notify (Mythz.p07FanStageDay.*) setstate FanSelectorDay $EVTPART1 
attr FanSelectorDay room heatpump 
[[File:fanselectorv2.png|thumb]]
define FanSelectorNight dummy 
attr FanSelectorNight group THZ 
attr FanSelectorNight setList 0 1 2 3 offFor60min 
attr FanSelectorNight webCmd 0:1:2:3:offFor60min 
attr FanSelectorNight devStateIcon 0:vent_ventilation_level_0 1:vent_ventilation_level_1 2:vent_ventilation_level_2 3:vent_ventilation_level_3 
define Notify_p08FanStageNight notify FanSelectorNight IF ([FanSelectorNight] eq "offFor60min") (define at_N_offFor60min at +00:59:00 set Mythz p08FanStageNight [Mythz:p08FanStageNight],set Mythz p08FanStageNight 0, setstate FanSelectorNight offFor60min) ELSE (set Mythz p08FanStageNight $EVENT) 
define Notify_FanselectorNight notify (Mythz.p08FanStageNight.*) setstate FanSelectorNight $EVTPART1 
attr FanSelectorNight room heatpump</code>

= Links =
[https://launchpad.net/heatpumpmonitor Launchpad Heatpumpmonitor]

[http://forum.fhem.de/index.php/topic,13132.0.html Thread in the FHEM-Forum]

[[Kategorie:Other Components]]
[[Kategorie:Heizungssteuerung]]

Tecalor THZ Wärmepumpe

2015-03-04T12:23:12Z

Micomat: /* Release History */

{{Infobox Modul
|Name=THZ
|ModPurpose=Anbindung Heizungssteuerung Tecalor
|ModType=d

|ModCmdRef=THZ
|ModForumArea=Sonstiges
|ModTechName=00_THZ.pm
|ModOwner=immiimmi
}}
Englisch version [[Tecalor THZ Heatpump]]

Hier wird beschrieben wie man mit FHEM eine Tecalor THZ / Stieben Eltron LWZ 303/403/404
/SOL Wärmepumpe auslesen/steuern kann.

Zum besseren Verständnis: Tecalor ist die Privatkundenmarke von Stieben Eltron. Die Geräte sind absolut baugleich.

Nachfolgend wird von der "THZ" gesprochen.

Getestet sind die Versionen 4.09, 4.19, 4.39 und 5.39.
Ältere Versionen können funktionieren, das ist jedoch nicht garantiert.
HINWEIS: Diese Anleitung ist für Personen gedacht, die sich mit Elektronik auskennen.
Der Autor und der Entwickler haften nicht für Schäden und geben keine Funktionsgarantie.

'''ACHTUNG! Seit Version 0.087 wurden die Parameternamen geändert!''' 
Dies dient der Vereinheitlichung der Parameternamen. Werte mit "s" sind Statuswerte, solche mit "p" sind Parameter die in der Heizung eingestellt sind.
Weitere Infos bei den ausgelesenen Parametern. Nach einem Updaten müssen ggf. Sachen wie readingsGroups, Dashboards, etc. angepasst werden.

=Verbindungsmöglichkeiten=
==Lokal per RS232 oder USB==
Die THZ hat zwei Anschlüsse die zur Verbindung genutzt werden können.
* Einen Seriellen Anschluss der mit einem MNL-SG3 Stecker genutzt werden kann.
* Einen USB Anschluss der auf der Platine zu finden ist un mit einem TYP-B Kabel funktioniert.
'''ACHTUNG! Der USB Anschluss befindet sich rückseitig auf der Platine die sich hinter der Abdeckung hinter der rechten Türe. Darf nur stromlos verbunden werden. Dazu die Wärmepumpe komplett vom Strom trennen!!!'''

Die Baudraten variieren je nach Hardware- und Softwareversion zwischen 9600 und 115200 bei Seriell. Bei USB liegt diese bei 115200 oder 57600.
Eine Verbindungsanleitung zum Seriellen Port findet sich hier: [http://robert.penz.name/heat-pump-lwz/ Robert Penz Homepage]

==Entfernte Verbindung mit Ser2Net==
Wenn die FHEM Zentrale nicht direkt in der Nähe der Heizung steht kann mir Ser2Net gearbeitet werden. Dieses stellt auf einem TCP-Port einen virtuellen seriellen Anschluss zur Verfügung.

===Installation Ser2Net auf Linux===
Um den Serial-Port-Server Ser2Net zu installieren ist auf Linux folgendes zu tun:
:<code>sudo apt-get install ser2net</code>
in der /etc/ser2net.conf (/dev/ttyXXX)
:<code>2003:raw:500:/dev/ttyUSB0:115200 NONE 1STOPBIT 8DATABITS </code>
Der Port kann frei gewählt werden, solange er nicht bereits genutzt wird.

==Getestete Host-Systeme==
Getestet ist dieses Modul auf FritzBox, nas-qnap, Raspberry Pi und MacOS.

=Definition in FHEM=
==Mit direkter serieller oder USB Verbindung==
:<code>define Mythz THZ /dev/ttyUSB0@115200 # oder (/dev/ttyXXX)</code>
:<code>attr Mythz interval_sGlobal 300 # Internes Polling Intervall 5min</code>
:<code>attr Mythz interval_sHistory 28800 # Internes Polling Intervall 8h</code>
:<code>attr Mythz interval_sLast10errors 120 # Internes Polling Fehlerspeicher</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz</code>

Wenn die Attribute interval_sGlobal und interval_sHistory nicht definiert sind (oder 0), ist das interne Polling deaktiviert. Natürlich kann das Polling auch mit dem "at" Befehl ausserhalb des Moduls definiert werden.

:<code>define Mythz THZ /dev/ttyUSB0@115200 # oder (/dev/ttyXXX)</code>
:<code>define atMythzGlobal at +*00:05:00 {fhem "get Mythz sGlobal","1";;return()}</code>
:<code>define atMythzHistory at +*08:00:00 {fhem "get Mythz sHistory","1";;return()}</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz </code>

==Via Netzwerk mit Ser2Net==
:<code>define Mythz THZ 192.168.0.244:2003</code>
:<code>attr Mythz interval_sGlobal 300 # Internes Polling Intervall 5min</code>
:<code>attr Mythz interval_sHistory 28800 # Internes Polling Intervall 8h</code>
:<code>attr Mythz interval_sLast10errors 120 # Internes Polling Fehlerspeicher</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz</code>

=Ausgelesene Werte=
Wenn die Verbindung und das Auslesen erfolgreich waren, sollten Werte wie sGlobal, sFirmware, sHistory und diverse Einstellungen wie die Urlaubszeiten sowie einige PXX Werte angezeigt werden.

'''sGlobal (vormals allFB)'''

Beinhaltet alle aktuellen Werte wie Temperaturen von Wasser und Gas, Lüfterstatus, Drücke, usw.

'''sFirmware'''

Zeigt die Firmware Version der Wärmepumpe.

'''sHistory'''

Enthält Angaben zur Betriebsdauer. Beispielsweise die Anzahl der Betriebsstunden der Kompressoren.

'''pHoliday-Werte'''

Hier werden die aktuellen Einstellungen der Urlaubsfunktion der THZ angezeigt. Diese bewirken, dass keine Tagabsenkung (sofern programmiert) gemacht wird.
Die holiday-Werte können mittels <code>set</code> auch angepasst werden.

'''sLast10errors'''

Liest die letzten 10 Fehlercodes aus und stellt diese dar.

'''pXX-Werte & program-Werte'''

Die pXX-Werte und program-Werte stellen Einstellungen wie Heizkreistemperaturen und Lüfterstufen sowie Heizungs- und Warmwasserprogramme der THZ dar. Alle pXX-Werte und program-Werte können mittels <code>set</code> auch angepasst werden.
Es sind auch Lüfterdurchsatzmengen und Passivkühlung konfigurierbar. 
pOpMode zeigt den Betriebszustand. Automatik, Handbetrieb, etc...

'''party-time'''

Hier wird die Uhrzeit der Party programmiert.
Party-Time regelt die Lüfterstufe (p99FanStageParty) im Party-Modus. Diese kann auch angepasst werden.

'''sDHW (ex Status_DHW_F3)'''

Informationen zur Warmwasserbereitung

'''sHC1 (ex Status_HC1_F4)'''

Enthält Informationen zum Heizkreis 1

'''sHC2 (ex Status_HC2_F5)'''

Heizkreis 2 Informationen

'''sSol (ex Status_Sol_16)'''

Informationen zur Solaranlage

'''pOpMode (ex OperatingMode)'''

Betriebsart: Bereitschaft, Automatik, Tagbetrieb, Absenkbetrieb, WW-Betrieb, Manueller Betrieb, Notbetrieb

Wenn die Betriebsart via FHEM geändert werden soll dann muss als set-Wert die entsprechende englische Bezeichnung gesendet werden (Standby, Automatic, DAYmode, SetBack, DHWmode, Manual, Emergency)

'''sXXX'''

Es gibt noch einige weitere "s"tatus Werte die unter anderen die Wärmerückgewinnungswerte beinhalten.

= Plots - Grafische Darstellung =
Nachfolgend wird gezeigt wie man aus den Readings wie sGlobal grafische Plots erstellen kann.

'''Beispiel'''

Angenommen wir wollen aus sGlobal die outside_temp und die dhw_temp (dhw=domestic hot water = Warmwasser) grafisch darstellen:

In der fhem.cfg legen wir das Plot an:
:<code>define Plot_Temp SVG FileLog_Mythz:thz:CURRENT</code>
:<code>attr Plot_Temp room Heizung</code>

Daraufhin wird das Plot erzeugt, noch ohne Daten und evtl. mit einer Fehlermeldung.
Hier klicken wir dann auf den Plot-Namen um in das Plot-Konfigurationsfenster zu kommen.
Hier tragen wir die entsprechenden Daten ein.

'''Wichtig sind nun die Input-Felder'''

Unterhalb der Eingabemaske befinden sich die zu Mythz gehörenden Readings die verwendet werden können. Darunter auch sGlobal.

Das sGlobal wird in etwa so aussehen:
:<code>2014-03-02_13:07:49 Mythz sGlobal: outside_temp: 3.8 flow_temp: 26.5 return_temp: 27.2 hot_gas_temp: 32.1 dhw_temp: 43.4 flow_temp_HC2: -60 evaporator_temp: 5.3 condenser_temp: 27.4 Mixer_open: 0 Mixer_closed: 0 HeatPipeValve: 0 DiverterValve: 0 DHW_Pump: 0</code>

[[File:Thzplot.jpg|thumb]]

Um den richtigen Input zu finden, zählen wir die durch Leerzeichen getrennten Daten ab. Somit ist der Wert der outside_temp an Stelle 5, die dhw_temp an Stelle 13.
Diese Zahl tragen wir dann im Input-Feld ein und schon haben wir einen Plot der Daten erzeugt.

Weitere Infos zu [http://www.fhemwiki.de/wiki/Plots_erzeugen Plots]

= einzelne Werte aus den Readings=
Um einzelne Werte aus den großen Readings wie sGlobal oder history zu bekommen, kann man ein

userReading verwenden.
Beispiel:

:<code>attr Mythz userReadings AussenTemp {(split ' ',ReadingsVal("Mythz","sGlobal",0))[1]},

VorlaufTemp {(split ' ',ReadingsVal("Mythz","sGlobal",0))[3]}</code>

Weitere Infos zu userReadings in der [http://fhem.de/commandref_DE.html CommandRef]

= Hinweise =
* Ein kompletter Refresh aller Werte wird nur beim Systemstart von FHEM gemacht. Dies geschieht sehr langsam um die Performance nicht zu beeinträchtigen. Erst nachdem dieser Refresh (dauert ca. 3-4 Minuten) gelaufen ist, wird das interne Polling gestartet.
*Wenn das Refresh Intervall kürzer oder gleich ist wie der initiale Refresh kann es zu einer Überschneidung kommen was allerdings kein Problem sein sollte.
*Im Wintermodus kommt roomSetTemp (sHC1) von p01RoomTempDayHC1 und p02RoomTempNightHC1
*Im Sommermodus kommt roomSetTemp (sHC1) von p01RoomTempDayHC1SummerMode und p02RoomTempNightHC1SummerMode

= Bekannte Probleme =
Im FHEM Log tauchen bei Ser2Net Verbindung häufig folgende Meldungen auf:
:<code>2014.03.02 09:41:09 1: 192.168.178.50:2003 disconnected, waiting to reappear
2014.03.02 09:41:09 1: 192.168.178.50:2003 reappeared (Mythz)</code>
Dieses Problem ist aktuell nicht gelöst.

= Release History =
'''v0.067'''

Erstmalige Implementierung in FHEM

'''v0.068'''

neuer Befehl f. Party implementiert

'''v0.069'''

Deutsche CommandRef hinzugefügt

'''v0.070'''

BugFix in Status Bits

'''v0.071'''

Bugfix, undefFn verbessert

'''v0.072'''

* Alle programHC1*, programHC2*, programFan* und programDHW* sind nun mit "get" und "set" implementiert
* inside_temp wurde am Ende von allFB hinzugefügt
* der Ser2Net connect/disconnet Bug wurde eingedämmt auf max 1 Logeintrag pro Sekunde

'''v0.074'''

Jetzt sind auch die Lüfterdurchsatzmengen und die Passivkühlung ausgelesen und änderbar.

'''v0.075'''

interval_last10errors implementiert. Intervall, in dem der Fehlerspeicher ausgelesen werden soll

'''v0.076'''

Bugfixes und neuer Parameter Status_HC1_F4

'''v0.078'''

neue Parameter Status_Sol_16 und Status_DHW_F3

'''v0.080'''

* neue Parameter p49SummerModeTemp und p50SummerModeHysteresis
* Status_HC1_F4 und Status_HC2_F5 zeigen nun "mode: Summer" (oder Winter)
Die Berechnung des Modus ist wie folgt:
:<code> if outsidetemp > p49SummerModeTemp + p50SummerModeHysteresis ---> Summermode</code>
:<code> if outsidetemp < p49SummerModeTemp - p50SummerModeHysteresis ---> Wintermode</code>

'''v0.081'''

BugFix für Sommer/Wintermodus-Anzeige

'''v0.084'''

* OperatingMode wird nun ausgelesen (read-only)
* p33BoosterTimeoutDHW (read/write)
* p79BoosterTimeoutHC (read/write)

'''v0.085'''

OperatingMode kann jetzt auch geaendert werden.

'''v0.087'''

* Neue Readings
* Angepasste Readingnamen

'''v0.089'''

* Kommunikation wurde stabilisiert
* Bugfixes
* Neue Readings

'''v0.091'''

Neue Readings: sHeatRecoveredDay & sHeatRecoveredTotal

'''v0.094'''

Bugfixes

'''v0.095'''

Neue Readings: sHeatDHWDay & sHeatDHWTotal

'''v0.096'''

Weitere neue Readings: sEletrx... & sHeat...

'''v0.097'''

Bugfixes

'''v0.099'''

Raumeinfluss wurde in die Heizkurvengrafik eingebaut

'''v0.100'''

Neue Parameter: p54MinPumpCycles, p55MaxPumpCycles, p56OutTempMaxPumpCycles, p57OutTempMinPumpCycles

'''v0.101'''

* keine neuen Features
* Code clean up
* Logs in verbose 5 implementiert
* buffer overflow (Verursacht von sGlobal bei LWZ 303 Firmware 3.19) gefixt

'''v0.103'''

* Änderung der Kommunikation. Jetzt 10x schneller
* Versionsinformation hinzugefügt

'''v0.104'''

Delay in der Kommunikation hinzugefügt (aber immer noch 5x schneller)

'''v0.105'''

* Schnelleres set und get Verhalten
* Dauer des Update beim Start halbiert
* THZ Attribute können ohne Neustart geändert werden
* BugFix
* P83 hinzugefügt (DHWSetSolarTemp)
* Suffix bei den Temp-Werten hinzugefügt. z.B. p04DHWsetDay jetzt p04DHWsetDayTemp

'''v0.107'''

* p56 and p57 getauscht und repariert

'''v0.108'''

* Party-Time wurde entfernt da nicht funktionsfähig
* Grouping bei "set programFan_Mo-Fr_0 to 08:00--20:00" --> Einzelne Tage werden automatisch gesetzt

'''v0.109'''

* Fehlerbehebung bei langen Nachrichten via Seriellem Kabel

'''v0.110'''

* Bugfix (für seriellen Adapter) trunkating messages (forum 209294)

'''v.0111'''

* P21,22,23,24,25,29 hinzugefügt

'''v0.112'''

* Bugfix für Fehler verursacht durch DevIo.pm 6980 status disconnected msg223569

'''v0.113'''

* Unterstützung für ältere Firmewareversionen hinzugefügt

'''v0.114'''

* Unterstützung für ältere Firmewareversionen hinzugefügt

'''v0.115'''

* Implementierung von "Informationen aus dem Modul des HeatpumpMonitor von Robert Penz". Alle nicht identifizierbaren Teile erhalten den Wert "n.a."

'''v0.116'''

* weitere Unterstützung für ältere Firmewareversionen hinzugefügt

'''v0.118'''

* faultcode implementiert
* Rechtschreibefehler korrigiert: evuRelease

'''v0.119'''
* der Firmwareparameter 2.06 erhöht den Maximalcount der Wiederholung von DevIo_SimpleReadWithTimeout von 24 auf 50
* Reduktion des DevIo_SimpleReadWithTimeout von 0.06 auf 0.02
* Der Firmwareparameter 2.06 entfernt jetzt Register, die von älteren Wärmepumpen nicht unterstützt werden

'''v0.120'''

* Verzögerung zwischen programXXX_YY zugefügt

'''v0.121'''

* Register Interpretation von user godmorgon implementiert
* register 17 für ältere Firmwareversionen implementiert

'''v0.122'''

* pXX Register für ältere Firmwareversionen implementiert
* maximale Widerholungen jetzt limitiert auf 60, zuvor 50
* actualPower_Qc: gepatcht um Pufferüberlauf zu vermeiden

'''v0.123'''

* actualPower_Qc und actualPower_pEl korrigiert

'''v0.124'''

* Verlaufsregister angelegt für Firmwareversion 2.06

'''v.0125'''

* Anpassungen um die Firmware 2.06 zu unterstützen

'''v.0126'''

* Weitere Anpassungen um die Firmware 2.06 zu unterstützen

'''v0.127'''

* Bugfix:Unterschied in Parsingregel für FCtime

'''v0.128'''

* Die meisten Paramter können jetzt von WP älterer Firmware gelesen werden

'''v0.129'''

* sDisplay (Aktivitätsparameter die im Display dargestellt werden)

'''v0.130'''

* 2 Bugfixes
* Firmware-id enthält neue Feature wie HW: 74 SW: 2.08 Date: MAR 9 2011
* neuer Parameter p99RoomThermCorrection implementiert
* THZ_PrintcurveSVG (Heizkurve) wird jetzt durch p99RoomThermCorrection beeinflusst

'''v0.131'''

* p35PasteurisationInterval,p35PasteurisationTemp, p34BoosterDHWTempAct, p99DHWmaxFlowTemp, p89DHWeco hinzugefügt

'''v0.132'''

* p99startUnschedVent hinzugefügt
* Aufteilung großer Register implementiert. Nötig für Firmware 2.06.
* Heizkurven jetzt auf 15...35°C begrenzt für bessere Darstellung des Kurvenverlaufs

'''v0.133'''

* p12 FanStageManual hinzugefügt
* Autoskalierung der Heizkurvenskala

'''v0.133+'''

* fixed: Laut Bedienungsanleitung ist p99RoomThermCorrection der Parameter P76

= Beispielkonfiguration =

'''Start Definition mit Ser2Net'''

<code>
define Mythz THZ 192.168.111.5:2003 
attr Mythz room Sysintern
</code>

'''userReadings'''

[[File:dash.jpg|thumb]]

<code>
attr Mythz userReadings AussenTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[1]}, VorlaufTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[3]}, RuecklaufTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[5]}, WWTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[9]}, KollektorTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[79]}
</code>

'''interval Definitionen'''

<code>
attr Mythz interval_sGlobal 300 
attr Mythz interval_sHistory 28800 
attr Mythz interval_sLast10errors 120 
</code>

'''Definition von file-log und den SVG-Plots einiger Daten'''

<code>
define FileLog_Mythz FileLog ./log/Mythz-%Y-%m.log Mythz 
define wal_0 SVG FileLog_Mythz:thz:CURRENT 
attr wal_0 room Heizung 
define wal_1 SVG FileLog_Mythz:thz1:CURRENT 
attr wal_1 room Heizung 
define wal_2 SVG FileLog_Mythz:thz2:CURRENT 
attr wal_2 room Heizung 
define wal_3 SVG FileLog_Mythz:thz3:CURRENT 
attr wal_3 room Heizung 
define wal_4 SVG FileLog_Mythz:thz4:CURRENT 
attr wal_4 room Heizung 
</code>

'''readingsGroup'''

<code>
define rg_thz readingsGroup Mythz:<%temp_outside>,<Aussen>,AussenTemp Mythz:<%sani_supply_temp@red>,<Vorlauf>,VorlaufTemp Mythz:<%sani_return_temp@blue>,<Rücklauf>,RuecklaufTemp Mythz:<%sani_boiler_temp@BD7800>,<Wasser>,WWTemp Mythz:<%sani_solar_temp>,<Kollektor>,KollektorTemp
 
attr rg_thz alias Heizung Temperaturen 
attr rg_thz group THZ 
attr rg_thz room Sysintern 
attr rg_thz valueFormat { AussenTemp => '%1.f °C', VorlaufTemp => '%1.f °C', AussenTemp=> '%1.f °C', RuecklaufTemp=> '%1.f °C', WWTemp=> '%1.f °C', KollektorTemp=> '%1.f °C' }
</code>

'''Dashboard'''

<code>
define MyDashboard Dashboard 
attr MyDashboard dashboard_lockstate unlock 
attr MyDashboard dashboard_row top-center 
attr MyDashboard dashboard_showhelper 0 
attr MyDashboard dashboard_showtooglebuttons 0 
attr MyDashboard dashboard_tab1groups THZ 
attr MyDashboard dashboard_tab1name micofhem 
attr MyDashboard dashboard_tab1sorting t0c100,THZ,true,170,253 
attr MyDashboard dashboard_tabcount 1 
attr MyDashboard dashboard_webfrontendfilter WEB 
define MyDashboard_weblink weblink htmlCode {DashboardAsHtml("MyDashboard")} 
attr MyDashboard_weblink room DashboardRoom
</code>

'''FanSelector für die Lüftungssteuerung'''

<code>
define FanSelectorDay dummy 
attr FanSelectorDay group THZ 
attr FanSelectorDay setList 0 1 2 3 offFor60min 
attr FanSelectorDay webCmd 0:1:2:3:offFor60min 
attr FanSelectorDay devStateIcon 0:vent_ventilation_level_0 1:vent_ventilation_level_1 2:vent_ventilation_level_2 3:vent_ventilation_level_3 
define Notify_p07FanStageDay notify FanSelectorDay IF ([FanSelectorDay] eq "offFor60min") (define at_D_offFor60min at +00:59:00 set Mythz p07FanStageDay [Mythz:p07FanStageDay],set Mythz p07FanStageDay 0, setstate FanSelectorDay offFor60min) ELSE (set Mythz p07FanStageDay $EVENT) 
define Notify_FanselectorDay notify (Mythz.p07FanStageDay.*) setstate FanSelectorDay $EVTPART1 
attr FanSelectorDay room heatpump 
[[File:fanselectorv2.png|thumb]]
define FanSelectorNight dummy 
attr FanSelectorNight group THZ 
attr FanSelectorNight setList 0 1 2 3 offFor60min 
attr FanSelectorNight webCmd 0:1:2:3:offFor60min 
attr FanSelectorNight devStateIcon 0:vent_ventilation_level_0 1:vent_ventilation_level_1 2:vent_ventilation_level_2 3:vent_ventilation_level_3 
define Notify_p08FanStageNight notify FanSelectorNight IF ([FanSelectorNight] eq "offFor60min") (define at_N_offFor60min at +00:59:00 set Mythz p08FanStageNight [Mythz:p08FanStageNight],set Mythz p08FanStageNight 0, setstate FanSelectorNight offFor60min) ELSE (set Mythz p08FanStageNight $EVENT) 
define Notify_FanselectorNight notify (Mythz.p08FanStageNight.*) setstate FanSelectorNight $EVTPART1 
attr FanSelectorNight room heatpump</code>

= Links =
[https://launchpad.net/heatpumpmonitor Launchpad Heatpumpmonitor]

[http://forum.fhem.de/index.php/topic,13132.0.html Forenthread im FHEM-Forum]

[[Kategorie:Other Components]]
[[Kategorie:Heizungssteuerung]]

Kindle Display

2014-10-12T08:14:49Z

Micomat:

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>

If you want to add a "last modified" timestamp to the dispaly, create a placeholder for it in your SVG template (like "last modified lmtime123") and then define a Regex / Expr attribute pair to replace it with the Reading "LastUpdate" from your FileReplacer device:
:<code>attr kindledisplay Regex14 lmtime123</code>
:<code>attr kindledisplay Expr14 ReadingsVal("kindledisplay", "LastUpdate", "never")</code>

=== Templates ===
You can find my templates here: [http://forum.fhem.de/index.php?topic=21821.msg202396#msg202396 fhem Forum]. Feel free to use and modify.

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
A Kindle 4 differs in a few ways from the later models. It doesn't use upstart but old start up scripts so the online screensaver scripts will not start automatically after a reboot of your kindle. You can either manually start the patched /mnt/base-us/extensions/onlinescreensaver/bin/enable.sh which starts /mnt/base-us/extensions/onlinescreensaver/bin/scheduler.sh as a background process or you can create your own startup script in /etc/init.d or you can create a cron job to periodically update the screen.

Another difference is the power management. The original online screensave was created for a kindle paperwhite which has a real time clock with alarm functions that can be controlled through the sysfs. Utils.sh in the online screensavers bin directory puts the next wake up time in /sys/class/rtc/rtc$RTC/wakealarm to achieve this. So the Paperwhite can sleep most of the time and only wake up to retrieve the latest PNG, display it and go back to sleep. On a Kindle 4 this does not work so the Kindle can not go to sleep and wake up but is has to keep running. Therefore it needs a lot more power than a paperwhite. While the paperwhite might run for two weeks or longer before it needs a recharge (depending on your update frequency) the Kindle 4 will need a recharge after 2 days or a power connection / docking station.

As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to change some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.

=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" to keep the Kindle awake ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>mntroot rw</code>
Changing the root password:
:<code>passwd</code>
Changing the timeouts:
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout (time before the secreensaver gets displayed) with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line to keep the Kindle awake for at least 2 days. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 

=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>vi /etc/crontab/root</code>
Add the following line at the bottom. */5 means every 5 minutes.
:<code>*/5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh</code>
:<code>/etc/init.d/cron restart</code>
Setting back filesystem in read-only mode
:<code>mntroot ro</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

=Examples and Pictures=
[[Datei:KindleDisplay.jpg|200px]] Kindle Display Example on Kindle 4
----

[[Kategorie:HOWTOS]]

Kindle Display

2014-10-09T20:53:30Z

Micomat: /* fhem configuration */

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>

If you want to add a "last modified" timestamp to the dispaly, create a placeholder for it in your SVG template (like "last modified lmtime123") and then define a Regex / Expr attribute pair to replace it with the Reading "LastUpdate" from your FileReplacer device:
:<code>attr kindledisplay Regex14 lmtime123</code>
:<code>attr kindledisplay Expr14 ReadingsVal("kindledisplay", "LastUpdate", "never")</code>

=== Templates ===
You can find my templates here: [http://forum.fhem.de/index.php?topic=21821.msg202396#msg202396 fhem Forum]. Feel free to use and modify.

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
A Kindle 4 differs in a few ways from the later models. It doesn't use upstart but old start up scripts so the online screensaver scripts will not start automatically after a reboot of your kindle. You can either manually start the patched /mnt/base-us/extensions/onlinescreensaver/bin/enable.sh which starts /mnt/base-us/extensions/onlinescreensaver/bin/scheduler.sh as a background process or you can create your own startup script in /etc/init.d or you can create a cron job to periodically update the screen.

Another difference is the power management. The original online screensave was created for a kindle paperwhite which has a real time clock with alarm functions that can be controlled through the sysfs. Utils.sh in the online screensavers bin directory puts the next wake up time in /sys/class/rtc/rtc$RTC/wakealarm to achieve this. So the Paperwhite can sleep most of the time and only wake up to retrieve the latest PNG, display it and go back to sleep. On a Kindle 4 this does not work so the Kindle can not go to sleep and wake up but is has to keep running. Therefore it needs a lot more power than a paperwhite. While the paperwhite might run for two weeks or longer before it needs a recharge (depending on your update frequency) the Kindle 4 will need a recharge after 2 days or a power connection / docking station.

As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to change some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.

=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" to keep the Kindle awake ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>mntroot rw</code>
Changing the root password:
:<code>passwd</code>
Changing the timeouts:
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout (time before the secreensaver gets displayed) with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line to keep the Kindle awake for at least 2 days. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 

=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>vi /etc/crontab/root</code>
Add the following line at the bottom. */5 means every 5 minutes.
:<code>*/5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh</code>
:<code>/etc/init.d/cron restart</code>
Setting back filesystem in read-only mode
:<code>mntroot ro</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

=Examples and Pictures=
[[Datei:KindleDisplay.jpg|200px]] Kindle Display Example on Kindle 4
----

[[Kategorie:HOWTOS]]

Kindle Display

2014-10-09T20:53:04Z

Micomat: /* Kindle 4 additional tasks */

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>

If you want to add a "last modified" timestamp to the dispaly, create a placeholder for it in your SVG template (like "last modified lmtime123") and then define a Regex / Expr attribute pair to replace it with the Reading "LastUpdate" from your FileReplacer device:
:<code>attr kindledisplay Regex14 lmtime123</code>
:<code>attr kindledisplay Expr14 ReadingsVal("kindledispay", "LastUpdate", "never")</code>

=== Templates ===
You can find my templates here: [http://forum.fhem.de/index.php?topic=21821.msg202396#msg202396 fhem Forum]. Feel free to use and modify.

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
A Kindle 4 differs in a few ways from the later models. It doesn't use upstart but old start up scripts so the online screensaver scripts will not start automatically after a reboot of your kindle. You can either manually start the patched /mnt/base-us/extensions/onlinescreensaver/bin/enable.sh which starts /mnt/base-us/extensions/onlinescreensaver/bin/scheduler.sh as a background process or you can create your own startup script in /etc/init.d or you can create a cron job to periodically update the screen.

Another difference is the power management. The original online screensave was created for a kindle paperwhite which has a real time clock with alarm functions that can be controlled through the sysfs. Utils.sh in the online screensavers bin directory puts the next wake up time in /sys/class/rtc/rtc$RTC/wakealarm to achieve this. So the Paperwhite can sleep most of the time and only wake up to retrieve the latest PNG, display it and go back to sleep. On a Kindle 4 this does not work so the Kindle can not go to sleep and wake up but is has to keep running. Therefore it needs a lot more power than a paperwhite. While the paperwhite might run for two weeks or longer before it needs a recharge (depending on your update frequency) the Kindle 4 will need a recharge after 2 days or a power connection / docking station.

As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to change some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.

=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" to keep the Kindle awake ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>mntroot rw</code>
Changing the root password:
:<code>passwd</code>
Changing the timeouts:
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout (time before the secreensaver gets displayed) with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line to keep the Kindle awake for at least 2 days. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 

=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>vi /etc/crontab/root</code>
Add the following line at the bottom. */5 means every 5 minutes.
:<code>*/5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh</code>
:<code>/etc/init.d/cron restart</code>
Setting back filesystem in read-only mode
:<code>mntroot ro</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

=Examples and Pictures=
[[Datei:KindleDisplay.jpg|200px]] Kindle Display Example on Kindle 4
----

[[Kategorie:HOWTOS]]

Kindle Display

2014-10-09T20:52:14Z

Micomat: /* fhem configuration */

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>

If you want to add a "last modified" timestamp to the dispaly, create a placeholder for it in your SVG template (like "last modified lmtime123") and then define a Regex / Expr attribute pair to replace it with the Reading "LastUpdate" from your FileReplacer device:
:<code>attr kindledisplay Regex14 lmtime123</code>
:<code>attr kindledisplay Expr14 ReadingsVal("kindledispay", "LastUpdate", "never")</code>

=== Templates ===
You can find my templates here: [http://forum.fhem.de/index.php?topic=21821.msg202396#msg202396 fhem Forum]. Feel free to use and modify.

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
A Kindle 4 differs in a few ways from the later models. It doesn't use upstart but old start up scripts so the online screensaver scripts will not start automatically after a reboot of your kindle. You can either manually start the patched /mnt/base-us/extensions/onlinescreensaver/bin/enable.sh which starts /mnt/base-us/extensions/onlinescreensaver/bin/scheduler.sh as a background process or you can create your own startup script in /etc/init.d or you can create a cron job to periodically update the screen.

Another difference is the power management. The original online screensave was created for a kindle paperwhite which has a real time clock with alarm functions that can be controlled through the sysfs. Utils.sh in the online screensavers bin directory puts the next wake up time in /sys/class/rtc/rtc$RTC/wakealarm to achieve this. So the Paperwhite can sleep most of the time and only wake up to retrieve the latest PNG, display it and go back to sleep. On a Kindle 4 this does not work so the Kinde can not go to sleep and wake up but is has to keep running. Therefore it needs a lot more power than a paperwhite. While the paperwhite might run for two weeks or longer before it needs a recharge (depending on your update frequency) the Kindle 4 will need a recharge after 2 days or a power connection / docking station.

As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to change some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.

=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" to keep the Kindle awake ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>mntroot rw</code>
Changing the root password:
:<code>passwd</code>
Changing the timeouts:
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout (time before the secreensaver gets displayed) with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line to keep the Kindle awake for at least 2 days. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 

=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>vi /etc/crontab/root</code>
Add the following line at the bottom. */5 means every 5 minutes.
:<code>*/5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh</code>
:<code>/etc/init.d/cron restart</code>
Setting back filesystem in read-only mode
:<code>mntroot ro</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

=Examples and Pictures=
[[Datei:KindleDisplay.jpg|200px]] Kindle Display Example on Kindle 4
----

[[Kategorie:HOWTOS]]

Kindle Display

2014-09-26T16:44:58Z

Micomat: /* Changing the "sleep settings" */

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>
=== Templates ===
You can find my templates here: [http://forum.fhem.de/index.php?topic=21821.msg202396#msg202396 fhem Forum]. Feel free to use and modify.

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to change some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.

=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>mntroot rw</code>
Changing the root password:
:<code>passwd</code>
Changing the timeouts:
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 

=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>cd /etc/crontab/root</code>
Add the following line at the bottom. */5 means every 5 minutes.
:<code>*/5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh</code>
:<code>/etc/init.d/cron restart</code>
Setting back filesystem in read-only mode
:<code>mntroot to</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

=Examples and Pictures=
[[Datei:KindleDisplay.jpg|200px]] Kindle Display Example on Kindle 4
----

[[Kategorie:HOWTOS]]

Kindle Display

2014-09-25T04:27:10Z

Micomat: /* USB Network Hack */

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>
=== Templates ===
You can find my templates here: [http://forum.fhem.de/index.php?topic=21821.msg202396#msg202396 fhem Forum]. Feel free to use and modify.

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to change some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.

=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>motroot rw</code>
Changing the root password:
:<code>passwd</code>
Changing the timeouts:
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 

=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>cd /etc/crontab/root</code>
Add the following line at the bottom. */5 means every 5 minutes.
:<code>*/5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh</code>
:<code>/etc/init.d/cron restart</code>
Setting back filesystem in read-only mode
:<code>mntroot to</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

=Examples and Pictures=
[[Datei:KindleDisplay.jpg|200px]] Kindle Display Example on Kindle 4
----

[[Kategorie:HOWTOS]]

Kindle Display

2014-09-25T04:26:39Z

Micomat: /* Cron setting (optional) */

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>
=== Templates ===
You can find my templates here: [http://forum.fhem.de/index.php?topic=21821.msg202396#msg202396 fhem Forum]. Feel free to use and modify.

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.
=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>motroot rw</code>
Changing the root password:
:<code>passwd</code>
Changing the timeouts:
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 

=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>cd /etc/crontab/root</code>
Add the following line at the bottom. */5 means every 5 minutes.
:<code>*/5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh</code>
:<code>/etc/init.d/cron restart</code>
Setting back filesystem in read-only mode
:<code>mntroot to</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

=Examples and Pictures=
[[Datei:KindleDisplay.jpg|200px]] Kindle Display Example on Kindle 4
----

[[Kategorie:HOWTOS]]

Kindle Display

2014-09-25T04:26:03Z

Micomat: /* Changing the "sleep settings" */

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>
=== Templates ===
You can find my templates here: [http://forum.fhem.de/index.php?topic=21821.msg202396#msg202396 fhem Forum]. Feel free to use and modify.

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.
=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>motroot rw</code>
Changing the root password:
:<code>passwd</code>
Changing the timeouts:
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 

=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>cd /etc/crontab/root</code>
Add the following line at the bottom. */5 means every 5 minutes.
:<code>*/5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh</code>
:<code>/etc/init.d/cron restart</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

=Examples and Pictures=
[[Datei:KindleDisplay.jpg|200px]] Kindle Display Example on Kindle 4
----

[[Kategorie:HOWTOS]]

Kindle Display

2014-09-25T04:24:55Z

Micomat: /* Cron setting (optional) */

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>
=== Templates ===
You can find my templates here: [http://forum.fhem.de/index.php?topic=21821.msg202396#msg202396 fhem Forum]. Feel free to use and modify.

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.
=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>mountroot rw</code>
:<code>passwd</code>
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 
=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>cd /etc/crontab/root</code>
Add the following line at the bottom. */5 means every 5 minutes.
:<code>*/5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh</code>
:<code>/etc/init.d/cron restart</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

=Examples and Pictures=
[[Datei:KindleDisplay.jpg|200px]] Kindle Display Example on Kindle 4
----

[[Kategorie:HOWTOS]]

Kindle Display

2014-09-25T04:24:10Z

Micomat: /* Cron setting (optional) */

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>
=== Templates ===
You can find my templates here: [http://forum.fhem.de/index.php?topic=21821.msg202396#msg202396 fhem Forum]. Feel free to use and modify.

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.
=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>mountroot rw</code>
:<code>passwd</code>
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 
=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>cd /etc/crontab/root</code>
:<code>--> */5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh</code>
:<code>/etc/init.d/cron restart</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

=Examples and Pictures=
[[Datei:KindleDisplay.jpg|200px]] Kindle Display Example on Kindle 4
----

[[Kategorie:HOWTOS]]

Kindle Display

2014-09-24T09:02:18Z

Micomat:

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>
=== Templates ===
You can find my templates here: [http://forum.fhem.de/index.php?topic=21821.msg202396#msg202396 fhem Forum]. Feel free to use and modify.

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.
=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>mountroot rw</code>
:<code>passwd</code>
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 
=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>cd /etc/crontab/root</code>
:<code>--> */5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh
:<code>/etc/init.d/cron restart</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

=Examples and Pictures=
[[Datei:KindleDisplay.jpg|200px]] Kindle Display Example on Kindle 4
----

[[Kategorie:HOWTOS]]

Kindle Display

2014-09-24T09:01:18Z

Micomat: /* fhem and server configuration */

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>
=== Templates ===
You can find my templates here: [http://forum.fhem.de/index.php?topic=21821.msg202396#msg202396 fhem Forum]. Feel free to use and modify.

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.
=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>mountroot rw</code>
:<code>passwd</code>
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 
=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>cd /etc/crontab/root</code>
:<code>--> */5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh
:<code>/etc/init.d/cron restart</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

=Examples and Pictures=
[[Datei:KindleDisplay.jpg|200px]] Kindle Display Example on Kindle 4
----

[[Kategorie:HOWTOS]]

Kindle Display

2014-09-24T09:00:13Z

Micomat: /* Examples and Pictures */

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.
=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>mountroot rw</code>
:<code>passwd</code>
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 
=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>cd /etc/crontab/root</code>
:<code>--> */5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh
:<code>/etc/init.d/cron restart</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

=Examples and Pictures=
[[Datei:KindleDisplay.jpg|200px]] Kindle Display Example on Kindle 4
----

[[Kategorie:HOWTOS]]

Datei:KindleDisplay.jpg

2014-09-24T08:56:32Z

Micomat: KindleDisplay

KindleDisplay

Kindle Display

2014-09-24T08:55:46Z

Micomat:

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.
=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>mountroot rw</code>
:<code>passwd</code>
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 
=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>cd /etc/crontab/root</code>
:<code>--> */5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh
:<code>/etc/init.d/cron restart</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

=Examples and Pictures=

[[Kategorie:HOWTOS]]

Kindle Display

2014-09-24T08:50:30Z

Micomat:

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.
=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>mountroot rw</code>
:<code>passwd</code>
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 
=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>cd /etc/crontab/root</code>
:<code>--> */5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh
:<code>/etc/init.d/cron restart</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

[[Kategorie:HOWTOS]]

Kindle Display

2014-09-24T08:48:28Z

Micomat: /* fhem configuration */

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done! 
If you want to change readingVals to something in your language you can try using it like this:
:<code>attr kindledisplay Expr11 (ReadingsVal("XY", "Reading", "off") eq "on" ? "An" : "Aus")</code>

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.
=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>mountroot rw</code>
:<code>passwd</code>
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 
=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>cd /etc/crontab/root</code>
:<code>--> */5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh
:<code>/etc/init.d/cron restart</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

Kindle Display

2014-09-24T08:46:02Z

Micomat: /* Modifying the Kindle */

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done!

=Modifying the Kindle=
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

==Jailbreaking the Kindle==
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
=== Kindle Touch/Paperwhite ===
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

=== Kindle 4 / Universal method ===

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

==Installing additional software==

=== MKK ===
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

=== KUAL ===
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

=== Backdoorlock ===
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

=== ScreenSavers Hack ===
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

=== Online ScreeSaver ===
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

==== Online Screen Saver - Kindle 4 Special Tasks ====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.
=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>mountroot rw</code>
:<code>passwd</code>
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 
=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>cd /etc/crontab/root</code>
:<code>--> */5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh
:<code>/etc/init.d/cron restart</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

Kindle Display

2014-09-24T08:41:56Z

Micomat: /* Kindle 4 additional tasks */

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done!

==Modifying the Kindle==
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

===Jailbreaking the Kindle===
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
==== Kindle Touch/Paperwhite ====
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

==== Kindle 4 / Universal method ====

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

===Installing additional software===

==== MKK ====
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

==== KUAL ====
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

==== Backdoorlock ====
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

==== ScreenSavers Hack ====
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

==== Online ScreeSaver ====
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

===== Online Screen Saver - Kindle 4 Special Tasks =====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==
As your Kindle 4 needs some more attention to get it done, please find the steps here:

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system. 
Download and install the kindle-usbnetwork file from here: [http://www.mobileread.com/forums/showthread.php?t=88004 USBNETWORK] 
I'm sure you know what to do in the meantime ;-) 
After that, activate the USBNetwork via KUAL and connect the Kindle via USB.
=== Connecting to the Kindle ===
Before you can connect you need to install the RNDIS driver. [https://github.com/ev3dev/ev3dev/wiki/Setting-Up-Windows-USB-Ethernet-Networking Here you can find] a very good "HowTo" to do this. Note that the IP-Addresses you need to configure are different then addresses used in the example. Your RNDIS Interface needs to have 192.168.15.201 configured, the Kindle uses 192.168.15.244 on this interface. 
Don't wonder you cannot ping the Kindle! 
Now you can use a ssh-client like putty to connect to the Kindle. Telnet is also an option but only when WiFI mode is disabled. So better forget about it. Success? Great job!
=== Changing the "sleep settings" ===
After you connected to the Kindle you will be asked for a password. Login with root and blank password. Should work. 
Now we need to make the filesystem writeable:
:<code>mountroot rw</code>
:<code>passwd</code>
:<code>cd /etc/kdb.src/yoshi/system/daemon/powerd/</code>
Edit the t1_timeout with the editor "vi" and change the last line to 200. 
Same for the t2_timeout but here we enter 200000 in the last line. 
These values are setting the "sleep" counters on the Kindle. Unfortunately this will lower the battery faster then normal so I recommend to have the display in a docking station. 
=== Cron setting (optional) ===
In my case that all didn't really work for me so i decided to run the onlinescreensaver update script via cron:
:<code>cd /etc/crontab/root</code>
:<code>--> */5 * * * * /mnt/us/extensions/onlinescreensaver/bin/update.sh
:<code>/etc/init.d/cron restart</code>
That's it for me. Not working? Ask and look here for help: [http://forum.fhem.de/index.php/topic,21821.0.html FHEM Forum]

Kindle Display

2014-09-24T08:08:39Z

Micomat: /* Kindle 4 Special */

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done!

==Modifying the Kindle==
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

===Jailbreaking the Kindle===
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
==== Kindle Touch/Paperwhite ====
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

==== Kindle 4 / Universal method ====

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

===Installing additional software===

==== MKK ====
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

==== KUAL ====
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

==== Backdoorlock ====
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

==== ScreenSavers Hack ====
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

==== Online ScreeSaver ====
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

===== Online Screen Saver - Kindle 4 Special Tasks =====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system later.

Kindle Display

2014-09-24T08:07:44Z

Micomat: /* Kindle 4 additional tasks */

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done!

==Modifying the Kindle==
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

===Jailbreaking the Kindle===
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
==== Kindle Touch/Paperwhite ====
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

==== Kindle 4 / Universal method ====

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

===Installing additional software===

==== MKK ====
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

==== KUAL ====
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

==== Backdoorlock ====
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

==== ScreenSavers Hack ====
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

==== Online ScreeSaver ====
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

===== Kindle 4 Special =====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

==Kindle 4 additional tasks==

=== USB Network Hack ===
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system later.

Kindle Display

2014-09-24T08:07:12Z

Micomat: /* Online ScreeSaver */

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done!

==Modifying the Kindle==
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

===Jailbreaking the Kindle===
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
==== Kindle Touch/Paperwhite ====
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

==== Kindle 4 / Universal method ====

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

===Installing additional software===

==== MKK ====
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

==== KUAL ====
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

==== Backdoorlock ====
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

==== ScreenSavers Hack ====
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

==== Online ScreeSaver ====
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.
Just download the application from [http://www.mobileread.com/forums/showthread.php?t=236104 here], extract the file and copy the folder into the extensions directory. 
Now you have to edit the config.sh file up to your need. 
'''NOTE''' Use a linux/unix compatible editor (like notepad++) only! 
You need to enter the image URL, the update interval and the schedule for the updates. That's all.

===== Kindle 4 Special =====
To get it running on a Kindle 4 you need to change some lines in the OnlineScreenSaver files. 
You can find a .diff file for the changes here: [http://forum.fhem.de/index.php/topic,21821.msg190911.html#msg190911 fhem forum] 
No idea what to do with this file? It just shows you in which lines changes were made and what was changed. I recommend to edit all the files shown in the diff-file locally and then copy the whole package to the kindle first.

===Kindle 4 additional tasks===

==== USB Network Hack ====
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system later.

Kindle Display

2014-09-24T07:58:29Z

Micomat: /* ScreenSavers Hack */

'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) 
As long as I'm working on it, this information will be shown.'''

This article shows how to configure a Amazon Kindle eBook-Reader as a information display for fhem. Use this manual at your own risk. Jailbreaking a Kindle is quite easy but there is no guarantee for breaking the system. 
I will show how to configure it with the FileReplacer.pm from Stefan. The "old" method with the special function in MyUtils is not part of this article.

All of the information shown below is collected from the fhem-forum [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum]. Many thanks to everybody who participated on the development of this information to get it done.Special thanks to "alex" and "stefan" from the board. Further information is from the [http://www.mobileread.com mobileread board].

=Hardware requirements=
==Kindle Touch / Paperwhite / Paperwhite 2==
You can use Kindle Touch / Paperwhite / Paperwhite 2 without any limitations.
==Kindle 4==
For setting this up on the Kindle 4 (with the 5-way button) you need some more configuration work but it's also working. Addidional tasks for this version are shown down below.

=Prerequisites=
==fhem and server configuration==
===Server configuration===
Not sure if still needed, but just for in case it is, install imagemagick on your linux system. 
:<code>apt-get install imagemagick</code>
That's it :)
===fhem configuration===
First you need a svg-template. You can find one in the first posting on the [http://forum.fhem.de/index.php/topic,21821.0.html fhem-Forum] thread. In the template just replace the data with some placeholder you like. Later this placeholder is found via a regular expression and replaced by your data. 
For example, you can set XYZ at the place where the first temperature should be shown and ABC for the first humidity value. 
If you want to edit the template you can use the free software [www.inkscape.org/de/ Inkscape]. For more information about generating SVGs for fhem please refer to this article [http://www.fhemwiki.de/wiki/Icons Icons]. Most important information is to save the SVG as a "normal SVG" and not as an inkscape SVG. 
For the Kindle Paperwhite the resolution of the SVG must be 758 x 1024 for the Kindle 4 version use 600x800. This is mandatory. Wrong scaled images won't be displayed on the Kindle. Copy the Kindle_Template.svg to <nowiki>/opt/fhem/www/images/</nowiki>. 
Download and install the [http://forum.fhem.de/index.php/topic,21821.msg200310.html#msg200310 FileReplacer.pm from fhem Forums], save it to /opt/fhem/FHEM and load the module. You can also restart fhem instead. 
All we're doing now is to using the FileReplacer module to read the SVG template, replace a search pattern with our data and saving it. 
:<code>define kindledisplay FileReplacer /opt/fhem/www/images/template1.svg /opt/fhem/www/images/status1.svg 60</code>
:<code>attr kindledisplay DoPNG 1</code>
:<code>attr kindledisplay UTF8-Encode 1</code>
:<code>attr kindledisplay room Display</code>

DoPNG enabled the generation from SVG to PNG. UTF8-Encode is needed to support special characters. 
Now just create your mappings:
:<code>attr kindledisplay Regex1 XYZ </code>
:<code>attr kindledisplay Expr1 sprintf("%.1f", ReadingsVal("Sensor1", "Temp1", 0)) </code>
:<code>attr kindledisplay Regex2 ABC </code>
:<code>attr kindledisplay Expr2 sprintf("%.1f", ReadingsVal("Sensor1", "Hum1", 0)) </code>
And so on... :) The FileReplacer will replace the pattern XYZ with the ReadingsVal from Sensor1. 
Now check if the PNG is created [http://your-fhem-ip:8083/fhem/www/images/status1.png http://your-fhem-ip:8083/fhem/www/images/KindleDisplay.png]. If so, be happy, the first part is done!

==Modifying the Kindle==
To prevent from error messages like "your Kindle is no longer registered as a test Kindle..." please make sure your Kindle is connected to a valid Amazon Account. 
We need to download some software to install it on the Kindle. 
Please download it from [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums] 
* Kindle Jailbreak [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* MKK Mobileread Kindlet Kit [http://www.mobileread.com/forums/showthread.php?t=233932 Mobileread Forums]
* KUAL [http://www.mobileread.com/forums/showthread.php?t=203326 Mobileread Forums]
* Screensavers Hack [http://www.mobileread.com/forums/showthread.php?t=88004 Mobileread Forums]
* OnlineScreenSaver [http://www.mobileread.com/forums/showthread.php?t=236104 Mobileread Forums]

* for Kindle 4 only: USBNETWORK [http://www.mobileread.com/forums/showthread.php?t=88004 also Mobileread Forums]
 Always use the newest version and look for one who fits to your Kindle (e.G. K4).

===Jailbreaking the Kindle===
Don't worry. This sounds more hard and dangerous than it is in fact. It's just a few steps to have full access to your Kindle.
==== Kindle Touch/Paperwhite ====
* Download the kindle-jailbreak-0.12.N.zip file, and unpack it. In there, you'll find some .bin files, and a src directory.Leave the directory alone, and upload the correct Update_*_install.bin file for your kindle & FW version to the root directory of your Kindle.
 
* Now, eject & unplug your Kindle, and go to [HOME] -> [MENU] > Settings -> [MENU] > Update Your Kindle. It should be quick. (And, on FW 2.x only, it should FAIL (With a U006 error, in the bottom left corner of the screen). It's completely normal, intended, and harmless).
 
And that's it, your Kindle is now ready to install custom hacks! 
(Quoted from http://www.mobileread.com/forums/showthread.php?t=88004)

==== Kindle 4 / Universal method ====

* Download and unzip the jailbreak.
* Plug in the Kindle and copy the data.tar.gz & ENABLE_DIAGS files plus the diagnostic_logs folder to the Kindle's USB drive's root
* Safely remove the USB cable and restart the Kindle (Menu -> Settings -> Menu -> Restart)
* Once the device restarts into diagnostics mode, select "D) Exit, Reboot or Disable Diags" (using the 5-way keypad)
* Select "R) Reboot System" and "Q) To continue" (following on-screen instructions, when it tells you to use 'FW Left' to select an option, it means left on the 5-way keypad)
* Wait about 20 seconds: you should see the Jailbreak screen for a while, and the device should then restart normally
* After the Kindle restarts, you should see a new book titled "You are Jailbroken", if you see this, the jailbreak has been successful.

===Installing additional software===

==== MKK ====
The Mobileread Kindlet Kit (MKK) is used to execute custom Kindlets (programs) on the Kindle. 
Download the software from here: [http://www.mobileread.com/forums/showthread.php?t=233932 MKK] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button). 
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle. 
After the update it is installed.

==== KUAL ====
The Kindle Unified Application Launcher (KUAL) running applications on the Kindle. 
Download it from here: [http://www.mobileread.com/forums/showthread.php?t=203326 KUAL] 
Unzip the folder and copy the matching .azw2 file to the documents directory of your kindle. 
 
(K2, DX, K3, K4) 
Put KUAL-KDK-1.0.azw2 in documents folder. 
Run it by clicking new kindlet (book) document in your list. 
 
(Touch, PaperWhite) 
Put KUAL-KDK-2.0.azw2 in documents folder. 
Run it by clicking icon. 

==== Backdoorlock ====
This is used to prevent from getting automated updates which could remove the JailBreak. 
Download from here: [http://www.mobileread.com/forums/showthread.php?t=205666 Backdoorlock] 
Unzip the folder and copy the .bin file to the root directory of your kindle. Please note that you need to install the Kindle matching version (e.g. K4 = Kindle 4 with 5-way-button).
On the Kindle goto Menu -> Settings -> Menu -> Update your Kindle.
After the update it is installed.

==== ScreenSavers Hack ====
The ScreenSavers Hack let you show custom screen savers on the kindle. 
Download the file: [http://www.mobileread.com/forums/showthread.php?t=88004 ScreenSaver Hack] 
Install the corresponding .bin file as the others before and use the "update your kindle" function to install it. 
After the installation you will find a directory called "linkss" in the Kindle root. Here open the screensavers dir and delete all images.

==== Online ScreeSaver ====
This application copies the fhem-PNG from your fhem-server to the ScreenSavers hack.

===Kindle 4 additional tasks===

==== USB Network Hack ====
This hack is used to get SSH/Telnet Access to your Kindle. We need this on Kindle 4 to chage some settings on the system later.

Kindle Display

2014-09-24T07:56:00Z

Micomat: /* KUAL */

Kindle Display

2014-09-24T07:55:42Z

Micomat: /* MKK */

Kindle Display

2014-09-24T07:55:25Z

Micomat: /* Backdoorlock */

Kindle Display

2014-09-24T07:52:11Z

Micomat: /* KUAL */

Kindle Display

2014-09-24T07:26:22Z

Micomat: /* MKK */

Kindle Display

2014-09-24T07:17:13Z

Micomat: /* Kindle 4 additional tasks */

Kindle Display

2014-09-24T07:14:45Z

Micomat: /* Installing additional software */

Kindle Display

2014-09-24T07:09:19Z

Micomat:

Kindle Display

2014-09-24T06:19:11Z

Micomat: /* Jailbreaking the Kindle */

Kindle Display

2014-09-24T05:39:02Z

Micomat: /* fhem and server configuration */

Kindle Display

2014-09-24T05:26:29Z

Micomat: /* Modifying the Kindle */

Kindle Display

2014-09-24T05:23:31Z

Micomat:

Kindle Display

2014-09-24T05:23:05Z

Micomat: /* Jailbreaking the Kindle */

Kindle Display

2014-09-23T17:01:09Z

Micomat: Die Seite wurde neu angelegt: „'''NOTE: This Article is not yet finished! This note will be removed once i think it's okay ;) As long as I'm working on it, this information will be shown…“

Tecalor THZ Wärmepumpe

2014-08-07T03:24:31Z

Micomat: /* Release History */

Englisch version [[Tecalor THZ Heatpump]]

Hier wird beschrieben wie man mit FHEM eine Tecalor THZ / Stieben Eltron LWZ 303/403/404
/SOL Wärmepumpe auslesen steuern kann.

Zum besseren Verständnis: Tecalor ist die Privatkundenmarke von Stieben Eltron. Die Geräte sind absolut baugleich.

Nachfolgend wird von der "THZ" gesprochen.

Getestet sind die Versionen 4.09, 4.19, 4.39 und 5.39.
Ältere Versionen können funktionieren, das ist jedoch nicht garantiert.
HINWEIS: Diese Anleitung ist für Personen gedacht, die sich mit Elektronik auskennen.
Der Autor und der Entwickler haften nicht für Schäden und geben keine Funktionsgarantie.

'''ACHTUNG! Seit Version 0.087 wurden die Parameternamen geaendert!''' 
Dies dient der Vereinheitlichung der Parameternamen. Werte mit "s" sind Statuswerte, solche mit "p" sind Parameter die in der Heizung eingestellt sind.
Weitere Infos bei den ausgelesenen Parametern. Nach einem Updaten muessen ggf. Sachen wie readingsGroups, Dashboards, etc. angepasst werden.

=Verbindungsmöglichkeiten=
==Lokal per RS232 oder USB==
Die THZ hat zwei Anschlüsse die zur Verbindung genutzt werden können.
* Einen Seriellen Anschluss der mit einem MNL-SG3 Stecker genutzt werden kann.
* Einen USB Anschluss der auf der Platine zu finden ist un mit einem TYP-B Kabel funktioniert.
'''ACHTUNG! Der USB Anschluss befindet sich rückseitig auf der Platine die sich hinter der Abdeckung hinter der rechten Türe. Darf nur stromlos verbunden werden. Dazu die Wärmepumpe komplett vom Strom trennen!!!'''

Die Baudarten variieren je nach Hardware- und Softwareversion zwischen 9600 und 115200 bei Seriell. Bei USB liegt diese bei 115200 oder 57600.
Eine Verbindnugsanleitung zum Seriellen Port findet sich hier: [http://robert.penz.name/heat-pump-lwz/ Robert Penz Homepage]

==Entfernte Verbindung mit Ser2Net==
Wenn die FHEM Zentrale nicht direkt in der Nähe der Heizung steht kann mir Ser2Net gearbeitet werden. Dieses stellt auf einem TCP-Port einen virtuellen seriellen Anschluss zur Verfügung.

===Installation Ser2Net auf Linux===
Um den Serial-Port-Server Ser2Net zu installieren ist auf Linux folgendes zu tun:
:<code>sudo apt-get install ser2net</code>
in der /etc/ser2net.conf (/dev/ttyXXX)
:<code>2003:raw:500:/dev/ttyUSB0:115200 NONE 1STOPBIT 8DATABITS </code>
Der Port kann frei gewählt werden solange er nicht bereits genutzt wird.

==Getestete Host-Systeme==
Getestet ist dieses Modul auf FritzBox, nas-qnap, Raspberry Pi und MacOS.

=Definition in FHEM=
==Mit direkter serieller oder USB Verbindung==
:<code>define Mythz THZ /dev/ttyUSB0@115200 # oder (/dev/ttyXXX)</code>
:<code>attr Mythz interval_sGlobal 300 # Internes Polling Intervall 5min</code>
:<code>attr Mythz interval_sHistory 28800 # Internes Polling Intervall 8h</code>
:<code>attr Mythz interval_sLast10errors 120 # Internes Polling Fehlerspeicher</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz</code>

Wenn die Attribute interval_sGlobal und interval_sHistory nicht definiert sind (oder 0), ist das interne Polling deaktiviert. Natürlich kann das Polling auch mit dem "at" Befehl ausserhalb des Moduls definiert werden.

:<code>define Mythz THZ /dev/ttyUSB0@115200 # oder (/dev/ttyXXX)</code>
:<code>define atMythzGlobal at +*00:05:00 {fhem "get Mythz sGlobal","1";;return()}</code>
:<code>define atMythzHistory at +*08:00:00 {fhem "get Mythz sHistory","1";;return()}</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz </code>

==Via Netzwerk mit Ser2Net==
:<code>define Mythz THZ 192.168.0.244:2003</code>
:<code>attr Mythz interval_sGlobal 300 # Internes Polling Intervall 5min</code>
:<code>attr Mythz interval_sHistory 28800 # Internes Polling Intervall 8h</code>
:<code>attr Mythz interval_sLast10errors 120 # Internes Polling Fehlerspeicher</code>
:<code>define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz</code>

=Ausgelesene Werte=
Wenn die Verbindung und das Auslesen erfolgreich waren, sollten Werte wie sGlobal, sFirmware, sHistory und diverse Einstellungen wie die Urlaubszeiten sowie einige PXX Werte angezeigt werden.

'''sGlobal (vormals allFB)'''

Beinhaltet alle aktuellen Werte wie Temperaturen von Wasser und Gas, Lüfterstatus, Drücke, usw

'''sFirmware'''

Zeigt die Firmware Version der Wärmepumpe.

'''sHistory'''

Enthält Angaben zur Betriebsdauer. Beispielsweise die Anzahl der Betriebsstunden der Kompressoren.

'''pHoliday-Werte'''

Hier werden die aktuellen Einstellungen der Urlaubsfunktion der THZ angezeigt. Diese bewirken, dass keine Tagabsenkund (sofern programmiert) gemacht wird.
Die holiday-Werte können mittels <code>set</code> auch angepasst werden.

'''sLast10errors'''

Liest die letzten 10 Fehlercodes aus und stellt diese dar.

'''pXX-Werte & program-Werte'''

Die pXX-Werte und program-Werte stellen Einstellungen wie Heizkreistemperaturen und Lüfterstufen sowie Heizungs- und Warmwasserprogramme der THZ dar. Alle pXX-Werte und program-Werte können mittels <code>set</code> auch angepasst werden.
Es sind auch Lüfterdurchsatzmengen und Pssivkühlung konfiguriertbar. 
pOpMode zeigt den Betriebszustand. Automatik, Handbetrieb, etc...

'''party-time'''

Hier wird die Uhrzeit der Party programmiert.
Party-Time regelt die Lüfterstufe (p99FanStageParty) im Party-Modus. Diese kann auch angepasst werden.

'''sDHW (ex Status_DHW_F3)'''

Informationen zur Warmwasserbereitung

'''sHC1 (ex Status_HC1_F4)'''

Enthält Informationen zum Heizkreis 1

'''sHC2 (ex Status_HC2_F5)'''

Heizkreis 2 Informationen

'''sSol (ex Status_Sol_16)'''

Informationen zur Solaranlage

'''pOpMode (ex OperatingMode)'''

Betriebsart: Bereitschaft, Automatik, Tagbetrieb, Absenkbetrieb, WW-Betrieb, Manueller Betrieb, Notbetrieb

Wenn die Betriebsart via FHEM geaendert werden soll dann muss als set-Wert die entsprechende englische Bezeichnung gesendet werden (Standby, Automatic, DAYmode, SetBack, DHWmode, Manual, Emergency)

'''sXXX'''

Es gibt noch einige weitere "s"tatus Werte die unter anderen die Wärmerückgewinnungswerte beinhalten.

= Plots - Grafische Darstellung =
Nachfolgend wird gezeigt wie man aus den Readings wie sGlobal grafische Plots erstellen kann.

'''Beispiel'''

Angenommen wir wollen aus sGlobal die outside_temp und die dhw_temp (dhw=domestic hot water = Warmwasser) grafisch darstellen:

In der fhem.cfg legen wir das Plot an:
:<code>define Plot_Temp SVG FileLog_Mythz:thz:CURRENT</code>
:<code>attr Plot_Temp room Heizung</code>

Daraufhin wird das Plot erzeugt, noch ohne Daten und evtl mit einer Fehlermeldung.
Hier klicken wir dann auf den Plot-Namen um in das Plot-Konfigurationsfenster zu kommen.
Hier tragen wir die entsprechenden Daten ein.

'''Wichtig sind nun die Input-Felder'''

Unterhalb der Eingabemaske befinden sich die zu Mythz gehörenden Readings die verwendet werden können. Darunter auch sGlobal.

Das sGlobal wird in etwa so aussehen:
:<code>2014-03-02_13:07:49 Mythz sGlobal: outside_temp: 3.8 flow_temp: 26.5 return_temp: 27.2 hot_gas_temp: 32.1 dhw_temp: 43.4 flow_temp_HC2: -60 evaporator_temp: 5.3 condenser_temp: 27.4 Mixer_open: 0 Mixer_closed: 0 HeatPipeValve: 0 DiverterValve: 0 DHW_Pump: 0</code>

[[File:Thzplot.jpg|thumb]]

Um den richtigen Input zu finden zählen wir die durch Leerzeichen getrennten Daten ab. Somit ist der Wert der outside_temp an Stelle 5, die dhw_temp an Stelle 13.
Diese Zahl tragen wir dann im Input-Feld ein und schon haben wir einen Plot der Daten erzeugt.

Weitere Infos zu [http://www.fhemwiki.de/wiki/Plots_erzeugen Plots]

= einzelne Werte aus den Readings=
Um einzelne Werte aus den großen Readings wie sGlobal oder history zu bekommen kann man ein

userReading verwenden.
Beispiel:

:<code>attr Mythz userReadings AussenTemp {(split ' ',ReadingsVal("Mythz","sGlobal",0))[1]},

VorlaufTemp {(split ' ',ReadingsVal("Mythz","sGlobal",0))[3]}</code>

Weitere Infos zu userReadings in der [http://fhem.de/commandref_DE.html CommandRef]

= Hinweise =
* Ein kompletter Refresh aller Werte wird nur beim Systemstart von FHEM gemacht. Dies geschieht sehr langsam um die Performance nicht zu beeinträchtigen. Erst nachdem dieser Refresh (dauert ca. 3-4 Minuten) gelaufen ist wird das interne Polling gestartet.
*Wenn das Refresh Inervall kürzer oder gleich ist wie der initiale Refresh kann es zu einer Überschneidung kommen was allerdings kein Problem sein sollte.
*Im Wintermodus kommt roomSetTemp (sHC1) von p01RoomTempDayHC1 und p02RoomTempNightHC1
*Im Sommermodus kommt roomSetTemp (sHC1) von p01RoomTempDayHC1SummerMode und p02RoomTempNightHC1SummerMode

= Bekannte Probleme =
Im FHEM Log tauchen bei Ser2Net Verbindung häufig folgende Meldungen auf:
:<code>2014.03.02 09:41:09 1: 192.168.178.50:2003 disconnected, waiting to reappear
2014.03.02 09:41:09 1: 192.168.178.50:2003 reappeared (Mythz)</code>
Dieses Problem ist aktuell nicht gelöst.

= Release History =
'''v0.067'''

Erstmalige Implementierung in FHEM

'''v0.068'''

neuer Befehl f. Party implementiert

'''v0.069'''

Deutsche CommandRef hinzugefügt

'''v0.070'''

BugFix in Status Bits

'''v0.071'''

Bugfix, undefFn verbessert

'''v0.072'''

* Alle programHC1*, programHC2*, programFan* und programDHW* sind nun mit "get" und "set" implementiert
* inside_temp wurde am Ende von allFB hinzugefügt
* der Ser2Net connect/disconnet Bug wurde eingedeämmt auf max 1 Logeintrag pro Sekunde

'''v0.074'''

Jetzt sind auch die Lüfterdurchsatzmengen und die Passivkühlung ausgelesen und änderbar.

'''v0.075'''

interval_last10errors implementiert. Intervall in dem der Fehlerspeicher ausgelesen werden soll

'''v0.076'''

Bugfixes und neuer Parameter Status_HC1_F4

'''v0.078'''

neue Parameter Status_Sol_16 und Status_DHW_F3

'''v0.080'''

* neue Parameter p49SummerModeTemp und p50SummerModeHysteresis
* Status_HC1_F4 und Status_HC2_F5 zeigen nun "mode: Summer" (oder Winter)
Die Berechnung des Modus ist wie folgt:
:<code> if outsidetemp > p49SummerModeTemp + p50SummerModeHysteresis ---> Summermode</code>
:<code> if outsidetemp < p49SummerModeTemp - p50SummerModeHysteresis ---> Wintermode</code>

'''v0.081'''

BugFix für Sommer/Wintermodus-Anzeige

'''v0.084'''

* OperatingMode wird nun ausgelesen (read-only)
* p33BoosterTimeoutDHW (read/write)
* p79BoosterTimeoutHC (read/write)

'''v0.085'''

OperatingMode kann jetzt auch geaendert werden.

'''v0.087'''

* Neue Readings
* Angepasste Readingnamen

'''v0.089'''

* Kommunikation wurde stabilisiert
* Bugfixes
* Neue Readings

'''v0.091'''

Neue Readings: sHeatRecoveredDay & sHeatRecoveredTotal

'''v0.094'''

Bugfixes

'''v0.095'''

Neue Readings: sHeatDHWDay & sHeatDHWTotal

'''v0.096'''

Weitere neue Readings: sEletrx... & sHeat...

'''v0.097'''

Bugfixes

'''v0.099'''

Raumeinfluss wurde in die Heizkurvengrafik eingebaut

'''v0.100'''

Neue Parameter: p54MinPumpCycles, p55MaxPumpCycles, p56OutTempMaxPumpCycles, p57OutTempMinPumpCycles

'''v0.101'''

* keine neuen Features
* Code clean up
* Logs in verbose 5 implementiert
* buffer overflow (Verursacht von sGlobal bei LWZ 303 Firmware 3.19) gefixt

'''v0.103'''

* Aenderung der Kommunikation. Jetzt 10x schneller
* Versionsinformation hinzugefuegt

'''v0.104'''

Delay in der Kommunikation hinzugefuegt (aber immer noch 5x schneller)

'''v0.105'''

* Schnelleres set und get Verhalten
* Dauer des Update beim Start halbiert
* THZ Attribute koennen ohne Neustart geaendert werden
* BugFix
* P83 hinzugefuegt (DHWSetSolarTemp)
* Suffix bei den Temp-Werten hinzugefuegt. z.B. p04DHWsetDay jetzt p04DHWsetDayTemp

'''v0.107'''

* p56 and p57 getauscht und repariert

'''v0.108'''

* Party-Time wurde entfernt da nicht funktionsfaehig
* Grouping bei "set programFan_Mo-Fr_0 to 08:00--20:00" --> Einzelne Tage werden automatisch gesetzt

'''v0.109'''

* Fehlerbehebung bei langen Nachrichten via Seriellem Kabel

= Beispielkonfiguration =

'''Start Definition mit Ser2Net'''

<code>
define Mythz THZ 192.168.111.5:2003 
attr Mythz room Sysintern
</code>

'''userReadings'''

[[File:dash.jpg|thumb]]

<code>
attr Mythz userReadings AussenTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[1]}, VorlaufTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[3]}, RuecklaufTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[5]}, WWTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[9]}, KollektorTemp:sGlobal {(split ' ',ReadingsVal("Mythz","sGlobal",0))[79]}
</code>

'''interval Defintionen'''

<code>
attr Mythz interval_sGlobal 300 
attr Mythz interval_sHistory 28800 
attr Mythz interval_sLast10errors 120 
</code>

'''Definition von file-log und den SVG-Plots einiger Daten'''

<code>
define FileLog_Mythz FileLog ./log/Mythz-%Y-%m.log Mythz 
define wal_0 SVG FileLog_Mythz:thz:CURRENT 
attr wal_0 room Heizung 
define wal_1 SVG FileLog_Mythz:thz1:CURRENT 
attr wal_1 room Heizung 
define wal_2 SVG FileLog_Mythz:thz2:CURRENT 
attr wal_2 room Heizung 
define wal_3 SVG FileLog_Mythz:thz3:CURRENT 
attr wal_3 room Heizung 
define wal_4 SVG FileLog_Mythz:thz4:CURRENT 
attr wal_4 room Heizung 
</code>

'''readingsGroup'''

<code>
define rg_thz readingsGroup Mythz:<%temp_outside>,<Aussen>,AussenTemp Mythz:<%sani_supply_temp@red>,<Vorlauf>,VorlaufTemp Mythz:<%sani_return_temp@blue>,<Rücklauf>,RuecklaufTemp Mythz:<%sani_boiler_temp@BD7800>,<Wasser>,WWTemp Mythz:<%sani_solar_temp>,<Kollektor>,KollektorTemp
 
attr rg_thz alias Heizung Temperaturen 
attr rg_thz group THZ 
attr rg_thz room Sysintern 
attr rg_thz valueFormat { AussenTemp => '%1.f °C', VorlaufTemp => '%1.f °C', AussenTemp=> '%1.f °C', RuecklaufTemp=> '%1.f °C', WWTemp=> '%1.f °C', KollektorTemp=> '%1.f °C' }
</code>

'''Dashboard'''

<code>
define MyDashboard Dashboard 
attr MyDashboard dashboard_lockstate unlock 
attr MyDashboard dashboard_row top-center 
attr MyDashboard dashboard_showhelper 0 
attr MyDashboard dashboard_showtooglebuttons 0 
attr MyDashboard dashboard_tab1groups THZ 
attr MyDashboard dashboard_tab1name micofhem 
attr MyDashboard dashboard_tab1sorting t0c100,THZ,true,170,253 
attr MyDashboard dashboard_tabcount 1 
attr MyDashboard dashboard_webfrontendfilter WEB 
define MyDashboard_weblink weblink htmlCode {DashboardAsHtml("MyDashboard")} 
attr MyDashboard_weblink room DashboardRoom
</code>

'''FanSelector für die Lüftungssteuerung'''

<code>
define FanSelectorDay dummy 
attr FanSelectorDay group THZ 
attr FanSelectorDay setList 0 1 2 3 offFor60min 
attr FanSelectorDay webCmd 0:1:2:3:offFor60min 
attr FanSelectorDay devStateIcon 0:vent_ventilation_level_0 1:vent_ventilation_level_1 2:vent_ventilation_level_2 3:vent_ventilation_level_3 
define Notify_p07FanStageDay notify FanSelectorDay IF ([FanSelectorDay] eq "offFor60min") (define at_D_offFor60min at +00:59:00 set Mythz p07FanStageDay [Mythz:p07FanStageDay],set Mythz p07FanStageDay 0, setstate FanSelectorDay offFor60min) ELSE (set Mythz p07FanStageDay $EVENT) 
define Notify_FanselectorDay notify (Mythz.p07FanStageDay.*) setstate FanSelectorDay $EVTPART1 
attr FanSelectorDay room heatpump 
[[File:fanselectorv2.png|thumb]]
define FanSelectorNight dummy 
attr FanSelectorNight group THZ 
attr FanSelectorNight setList 0 1 2 3 offFor60min 
attr FanSelectorNight webCmd 0:1:2:3:offFor60min 
attr FanSelectorNight devStateIcon 0:vent_ventilation_level_0 1:vent_ventilation_level_1 2:vent_ventilation_level_2 3:vent_ventilation_level_3 
define Notify_p08FanStageNight notify FanSelectorNight IF ([FanSelectorNight] eq "offFor60min") (define at_N_offFor60min at +00:59:00 set Mythz p08FanStageNight [Mythz:p08FanStageNight],set Mythz p08FanStageNight 0, setstate FanSelectorNight offFor60min) ELSE (set Mythz p08FanStageNight $EVENT) 
define Notify_FanselectorNight notify (Mythz.p08FanStageNight.*) setstate FanSelectorNight $EVTPART1 
attr FanSelectorNight room heatpump</code>

= Links =
[https://launchpad.net/heatpumpmonitor Launchpad Heatpumpmonitor]

[http://forum.fhem.de/index.php/topic,13132.0.html Forenthread im FHEM-Forum]

[[Kategorie:Other Components]]
[[Kategorie:Heizungssteuerung]]