FHEMWiki - Benutzerbeiträge [de]

TelegramBot

2016-04-08T09:40:45Z

Horiba:

{{Infobox Modul
|ModPurpose=Senden und Empfangen von Nachrichten (Text und Fotos) mit dem freien Messagingdienst Telegram
|ModType=d
|ModForumArea=Unterstützende Dienste
|ModFTopic=38328
|ModTechName=[https://github.com/viegener/Telegram-fhem/blob/master/50_TelegramBot.pm 50_TelegramBot.pm]
|ModOwner=[[Benutzer:Viegener|Viegener]] ({{Link2FU|12772|Forum}} / [[Benutzer Diskussion:Viegener|Wiki]])}}

Das [[TelegramBot]]-Modul ermöglicht das Senden und Empfangen von Nachrichten über den Telegram-instant messaging Dienst (https://telegram.org/).
Es entsteht eine Möglichkeit Benachrichtungen aus Fhem zu versenden, zum Beispiel Alarmmeldungen.
Ausserdem können auch Kommandos über Telegram an Fhem gesendet werden um Steuerungsbefehle in Fhem auszulösen.

Das TelegramBot-Modul benötigt keine Zusatzsoftware auf dem Fhem-Server (anders als die Variante [[Telegram]]), sondern verwendet das [https://core.telegram.org/bots/api TelegramBot-API] über https-Aufrufe. Es muss jedoch das perl JSON modul installiert sein.

== Über Telegram Instant Messaging ==
Telegram-IDs und Versand/Empfang von Nachrichten sind kostenfrei.
Clients sind für gängige Smartphonesysteme erhältlich (iOS iPhone und Tablet, Android, Windows Phone) und
können auch aus dem WebBrowser verwendet werden.
Es gibt auch einen Kommandozeilen-Client für Linux, der die Grundlage dieses Moduls darstellt.
Mehrfachanmeldungen, auch parallel mit verschiedenen Geräten (z.B. Tablet und Smartphone), sind möglich.
Gruppenchats und Chats mit End-2-End-Verschlüsselung werden ebenfalls unterstützt.

Für die Unterstützung von ''WhatsApp'' siehe Modul [[yowsup]].

== Features ==
Unterstützt werden:

* Versand von Textnachrichten
* Versand und Empfang von Bildern/Audio/etc
* Empfang von Textnachrichten von beliebigen Kontakten
* Kommandos in Fhem über Telegram-Nachrichten von aussen auslösen
* Ergebnisse der Kommandos zusenden lassen

Eine detaillierte Beschreibung des Moduls ist im Fhem Forum und in der (englischen) Dokumentation zum Modul in der Commandref diesem {{Link2Forum|Topic=38328|LinkText=Diskussionsthread}} zu finden. Seit Oktober 2015 wird das Modul offiziell über Fhem-Update verteilt.

Die jeweils aktuellste Entwicklungs-Version des Moduls ist in Github [https://github.com/viegener/Telegram-fhem/blob/master/50_TelegramBot.pm 50_TelegramBot.pm] verfügbar.

== Hinweise zum Betrieb mit Fhem ==
{{Randnotiz|RNTyp=Warn|RNText=Achtung: Dieses Authtoken ist die einzige Authentifizierung für den Bot und sollte deshalb nicht aus der Hand gegeben werden. Die verwendeten Urls sind deshalb auch in den Log-Files nicht enthalten, da diese das Authtoken in Klartext enthalten. Auch im Forum sollte dieses Token nicht aufgenommen werden.
}}

Für die Anlage eines TelegramBot Devices in Fhem ist ein Authtoken erforderlich. Dieses Token wird über Anlegen eines neuen Bots im [https://core.telegram.org/bots#botfather BotFather] erzeugt. Dort mit dem Telegram-Befehl <code>/newbot</code> einen neuen Bot anlegen und mit einem Namen versehen. Hinweis: Die Namen für Bots müssen auf "Bot" enden. 

Das Anlegen eines TelegramBot devices erfolgt durch die Angabe dieses Tokens:

<code>define <name> TelegramBot <token> </code>

Beispiel: <code>define teleBot TelegramBot 110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw</code>

'''Das Empfangen von Nachrichten (polling) erfordert die Einstellung des Attributes'''
<code>pollingTimeout</code> '''auf einen Wert der grösser als Null ist. Beim Wert 0 oder ohne Setzen des Attributes findet kein Polling und damit auch kein Empfang statt.'''

'''Der TelegramBot kann erst dann Nachrichten an einen telegram user schicken, wenn dieser zuerst an den telegram bot eine Nachricht gesendet hat.'''

{{Randnotiz|RNTyp=Warn|RNText=TelegramBot setzt eine aktuelle Version von FHEM voraus, insbesondere Versionen weit vor der Umstellung auf 5.7 (also vor Herbst 2015) können mit einem TelegramBot-Modul nicht funktionieren, da insbesondere das HTTPSRV-Modul dann veraltet ist. Am besten auch den TelegramBot über den offiziellen Update mit dem Rest von FHEM installieren/aktualisieren.
}}

== Registrierung eines neuen Bot ==
Zur Registrierung wird ein funktionierender Telegram-Client (egal ob Web, App oder Programm)benötigt. Hier wird ein Chat zum BotFather gestartet und der Befehl /newbot gesendet. Nun fragt der BotFather die benötigten Angaben ab und liefert am Ende des Dialogs die Informationen für den neuen Bot.
Hier ein Beispiel, wie so ein Chat aussehen könnte:
<pre>Client:
/newbot
----------------
BotFather:
Alright, a new bot. How are we going to call it? Please choose a name for your bot.
----------------
Client:
Mein Name
----------------
BotFather:
Good. Now let's choose a username for your bot. It must end in `bot`. Like this, for example: TetrisBot or tetris_bot.
----------------
Client:
fhem_bot
----------------
BotFather:
Sorry, this username is already taken. Think of something different.
----------------
Client:
fhem1234_bot
----------------
BotFather:
Done! Congratulations on your new bot.
You will find it at telegram.me/fhem1234_bot.
You can now add a description, about section and profile picture for your bot, see /help for a list of commands.
----------------
Use this token to access the HTTP API:
1234567890:AbCdefgHIJklmnOPQRst-uvwxyz

For a description of the Bot API, see this page: https://core.telegram.org/bots/api
</pre>

== Tipps ==

=== Privacyeinstellungen ===

Damit der TelegramBot auch Meldungen in Gruppen sieht, müssen über den BotFather die Privacy-Einstellungen geändert werden. Beispielchat:<pre>Client:
/setprivacy
----------------
BotFather:
Choose a bot to change group messages settings.
----------------
Client:
@fhem1234_bot
----------------
BotFather:
'Enable' - your bot will only receive messages that either start with the '/' symbol or mention the bot by username.
'Disable' - your bot will receive all messages that people send to groups.
Current status is: ENABLED
----------------
Client:
Disable
----------------
BotFather:
Success! The new status is: DISABLED. /help</pre>

=== Kontakte ===

Der Bot merkt sich die bereits bekannten Kontakte im Reading <code>Contacts</code>. Dabei werden die einzelnen Kontakte jeweils als 3-teilige Einträge bestehend aus UserID, Vor- und Nachname des Benutzers (mit _ verbunden) und dem Username (mit vorangestelltem @).

Beispiel: <code>123456:Ralf_Mustermann:@ralf</code>

Verschiedene Einträge werden durch Leerzeichen getrennt.

Man kann die Kontakte auch manuell überschreiben (z.B. wenn das Reading fehlerhaft oder verloren sein sollte). Dazu gibt es den Set-Befehl <code>replaceContacts</code>. Dieser nimmt die Kontakte ebenfalls in der gleichen Form wie oben beschrieben entgegen.

Die Kontaktliste wird ansonsten nur durch den Empfang von Nachrichten erweitert, da es im TelegramBot-API keine Möglichkeit gibt Kontaktdaten von Telegram abzufragen (siehe auch pollingTimeout)

=== Reset ===

Es ist möglich den Bot im laufenden Betrieb zurückzusetzen (Set-Befehl <code>reset</code>). Dabei werden noch nicht abgeschlossene Übetragungen entfernt und die internen Zustände des Devices zurückgesetzt.

=== Gruppen ===

Um eine Nachricht von FHEM an eine Gruppe zu senden, muss der BOT in die Gruppe aufgenommen werden. Nach dem Senden einer Nachricht an die Gruppe kann im Modul die Gruppen-ID ermittelt werden und zum Senden von Nachrichten verwendet werden. Wenn die Privacy-Einstellungen nicht auf 'Disabled' gesetzt wurden, muss die Nachricht mit einem Slash (/) beginnen.

==== Supergroups / Supergruppen ====

Auch die neuen Supergruppen werden mit dem Bot unterstützt, es ist allerdings zu beachten, dass bei der Umwandlung einer Gruppe in eine Supergruppe eine neue ID in den Kontakten von Telegram vergeben wird. Wenn man also wie empfohlen IDs zur Identifikation von Benutzern einsetzt, muss entsprechend angepasst werden.

== Beispielszenarien ==

=== Benachrichtigungen über Ereignisse ===

Das einfachste Szenario für die Integration von Messaging-Diensten mit Fhem ist zur Benachrichtigung über Ereignisse. Diese Funktion kann zum Beispiel verwendet werden, um über einen erfolgten Neustart von Fhem zu informieren:

<code>define notify_fhem_reload notify global:INITIALIZED set telebotdevice message fhem newly started - just now !</code>

In diesem Beispiel wird der Nachrichtentext "fhem newly started - just now !" an den als default eingestellten Kontakt (Attribut: defaultPeer) gesendet, sobald Fhem neu gestartet wurde. Natürlich kann man auch beliebige andere Benachrichtigungen einführen.

=== Versand von Bildern ===

Es ist auch möglich Bilder auf dem Fhem-Server, die zum Beispiel von einer Kamera oder einem Wettermodul stammen über Telegram zu versenden. So wäre es z.B. möglich jeweils morgens die aktuelle Wetterkarte zu erhalten.

ACHTUNG: TelegramBot verwendet das HTTPUtils-Modul zur Kommunikation mit dem TelegramBot-API. Erst mit der Version, die seit 22.10.2015
([r9576] HttpUtils.pm: Async write for POST Requests {{Link2Forum|Topic=41583|LinkText=Fhem-Forum}}) verteilt wird, erlaubt auch den Transfer grösserer Bilder. Die Grenze liegt ansonsten bei ca. 14kb auf Raspberries (Plattformspezifische Grenze).

<code>define notify_fhem_reload notify wetter:report set telebotdevice sendPhoto /opt/fhem/wetter.jpg</code>

Bei Erreichen des entsprechenden Status am Wetter-Modul wird ein Image über Telegram versendet. Hier sind lokale Pfade (relativ zu fhem) oder absolute Pfade wie oben möglich.

=== Empfang von Bildern oder ähnlichem ===

Beim Empfang von Bildern wird zuerst nur eine ID vom Telegram-Server empfangen, diese befindet sich im Reading <code>msgFileId</code> angelegt (<code>123456:xxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxx</code>) und im Reading <code>msgText</code> steht dann so etwas wie
<code>received photo # Size: 107701</code>

Über das Get-Kommando <code>urlForFile</code> mit der ID aus dem msgFileId Reading lässt sich dann daraus ein URL ableiten, der dann zur eigentlichen Datei führt:

<code>https://api.telegram.org/file/bot123456:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/photo/file_25.jpg</code>

=== Versand von Emojis (Smileys) ===

Es ist auch möglich Emojis mit den (Text-)Nachrichten zu versenden. Die entsprechenden (Unicode-)Zeichen werden einfach direkt mit in den Text der Nachricht aufgenommen. Um das zu vereinfachen kann man das einfach per Copy und Paste von dieser Seite

http://apps.timwhitlock.info/emoji/tables/unicode (Spalte "Native")

übernehmen und mit der Nachricht verschicken.

Die Emojis können auch empfangen werden und werden so auch in FHEM / FHEMWeb angezeigt. Plattformspezifische (z.B. von iOS oder Android) Emojis werden dabei nicht unterstützt (gerade mit iOS sind viele neue farbige Emojis hinzugekommen, die wohl leider nur auf Apple-devices funktionieren).

=== Kommandos auslösen ===

Ein wichtiges Szenario ist die Möglichkeit Kommandos in Fhem ausführen zu können, ohne einen Zugang durch die Firewall einrichten zu müssen. Dazu ist die Definition eines Schlüsselwortes (Attribut: "cmdKeyword")erforderlich, mit dem man die Nachrichten beginnen muss, damit der TelegramBot die Kommandos erkennt.

<code>attr telebotdevice cmdKeyword doit</code>

Somit kann man dann durch Nachrichten die mit "doit" beginnen Kommandos an Fhem senden, die ähnlich wie im Kommandoeingabefeld von Fhemweb dann von Fhem ausgeführt werden. Das Ergebnis der Ausführung wird zurück an den Sender (und an den definierten defaultPeer) geschickt.

Somit können nicht nur Aktionen angestossen werden, sondern auch Infos abgefragt werden.

Beispiele

<code>doit set schalter on</code>

<code>doit list telegrambot</code>

{{Randnotiz|RNTyp=Warn|RNText=Achtung: Bei den Kommandos sollten man unbedingt das Attribut "cmdRestrictedPeer" setzen, damit nicht jeder Kommandos auf dem Fhem-Server ausführen kann. Dazu sollten die BenutzerIDs der erlaubten Benutzer (durch Leerzeichen getrennt angeben). Da Benutzernamen selber vergeben werden und nicht unbedingt eindeutig sind, sollten hier auch NUR BenutzerIDs verwendet werden.
}}

=== Favoriten für Kommandos anlegen ===

Grundidee bei den Favoriten ist, dass man lange Befehle, die man häufig braucht auf "Kurzwahl" legt.

Beispiel-Kommandos wie z.B. <code>set TYPE=ROLLADEN pos 100</code> und <code>set TYPE=ROLLADEN pos 0</code>, die man immer wieder braucht. Um nicht jedes mal dieses Kommando eintippen zu müssen auf dem Smartphone, kann man auch dafür Favoriten anlegen.

Dazu gibt man erst mal die beiden Kommandos getrennt durch Semikolon im Attribut favorites an:

<code>attr telegrambotdevice favorites set TYPE=ROLLADEN pos 100;set TYPE=ROLLADEN pos 0</code>

Um die Favorites jetzt ausführen zu können braucht man noch ein Schlüsselwort dafür.
Nehmen wir mal an man möchte die Favoriten mit <code>/short</code> ausführen können. Dazu muss dann das Attribut "cmdFavorites" setzen

<code>attr telegrambotdevice cmdFavorites /short</code>

Wenn man nun im Telegram Client
<code>/short 1</code> an den Bot schickt führt der Bot den ersten Favoriten aus und das Ergebnis der Ausführung wird zurückgeschickt.

Ausserdem kann man im Telegram Client
<code>/short</code> an den Bot schicken, dann antwortet der Bot mit

<pre>
Favorites

1
set TYPE=ROLLADEN pos 100
2
set TYPE=ROLLADEN pos 0

</pre>

== Links ==
* Github Repository für die Telegram-Fhem Entwicklung: https://github.com/viegener/Telegram-fhem
* Infos zum Telegram BotFather: https://core.telegram.org/bots#botfather

* Source code für das 50_TelegramBot.pm-Modul: https://github.com/viegener/Telegram-fhem/blob/master/50_TelegramBot.pm
* Source code für das modifizierte HTTPUtils-Modul zur Übertragung grosser Bilder: https://github.com/viegener/Telegram-fhem/blob/master/HttpUtils.pm

* Forum-Thread in dem das Modul vorgestellt wurde {{Link2Forum|Topic=38328|LinkText=Fhem-Forum}}
* Telegram messaging system https://telegram.org/
* TelegramBot API https://core.telegram.org/bots/api

--[[Benutzer:Viegener|Viegener]] ([[Benutzer Diskussion:Viegener|Diskussion]]) 22:49, 11. Okt. 2015 (CEST)

Telegram - old API method

2015-08-10T20:33:56Z

Horiba: /* Hinweise zum Betrieb mit Fhem */ Einrichtungsanleitung angefügt

{{Infobox Modul
|ModPurpose=Senden und Empfangen von Nachrichten (Text und Fotos) mit dem freien Messagingdienst Telegram
|ModType=x
|ModForumArea=Unterstützende Dienste
|ModFTopic=38328
|ModTechName=[https://github.com/viegener/Telegram-fhem/blob/master/70_Telegram.pm 70_Telegram.pm]
|ModOwner=[[Benutzer:Viegener|Viegener]] ({{Link2FU|12772|Forum}} / [[Benutzer Diskussion:Viegener|Wiki]])}}

Das [[Telegram]]-Modul ermöglicht das Senden und Empfangen von Nachrichten über den Telegram-instant messaging Dienst (https://telegram.org/).
Es entsteht eine Möglichkeit Benachrichtungen aus Fhem zu versenden, zum Beispiel Alarmmeldungen.
Ausserdem können auch Kommandos über Telegram an Fhem gesendet werden um Steuerungsbefehle in Fhem auszulösen.

Für den Betrieb des Telegram Moduls ist eine funktionsfähige Installation des inoffiziellen telegram command-line clients für Linux, ''telegram-cli'' (https://github.com/vysheng/tg), erforderlich.

Für die Unterstützung von ''WhatsApp'' siehe Modul [[yowsup]].

== Über Telegram Instant Messaging ==
Telegram-IDs und Versand/Empfang von Nachrichten sind kostenfrei.
Clients sind für gängige Smartphonesysteme erhältlich (iOS iPhone und Tablet, Android, Windows Phone) und
können auch aus dem WebBrowser verwendet werden.
Es gibt auch einen Kommandozeilen-Client für Linux, der die Grundlage dieses Moduls darstellt.
Mehrfachanmeldungen, auch parallel mit verschiedenen Geräten (z.B. Tablet und Smartphone), sind möglich.
Gruppenchats und Chats mit End-2-End-Verschlüsselung werden ebenfalls unterstützt.

== Features ==
Unterstützt werden:

* Versand von Textnachrichten an einen vordefinierten Kontakt (default peer)
* Versand von Textnachrichten an einen vordefinierten Kontakt als verschlüsselter Chat (secret chat)
* Versand von Bildern
* Empfang von Textnachrichten von beliebigen Kontakten
* Direkte Befehle an den telegram-client

Eine detaillierte Beschreibung des Moduls ist im Fhem Forum in diesem {{Link2Forum|Topic=38328|LinkText=Diskussionsthread}} zu finden, die jeweils aktuelle Version des Moduls ist im ersten Beitrag als Anhang verfügbar.

== Hinweise zum Betrieb mit Fhem ==
{{Randnotiz|RNTyp=Warn|RNText=Achtung: telegram-cli wird momentan NICHT aus Fhem heraus gestartet, sondern muss separat gestartet werden. Ausserdem muss telegram-cli bereits angemeldet sein und entsprechende Kontakte müssen eingerichtet werden. Generell ist auch die Verwendung einer existierenden telegram, empfohlen wird aber die Verwendung einer getrennten ID, zum Beispiel für die eigene Festnetznummer.

telegram-cli kann generell auch auf einem anderen Host betrieben werden, da die Kommunikation mit telegram-cli über Netzwerkprotokolle erfolgt.
}}
Das Telegram-Modul basiert auf einem im Hintergrund laufenden telegram-cli (https://github.com/vysheng/tg).

Informationen zu Einrichtung und Betrieb von telegram-cli finden sich im Readme in obigem Repository.
Weitere Informationen finden sich auch im Wiki des github Repositories: https://github.com/vysheng/tg/wiki

Hinweise zum Start von telegram-cli mit fhem finden sich in der Commandref / Doku zum Modul.

Hier eine Kurzanleitung zur Installation und zum Ausführen auf einem RaspberryPI:
# Notwendige Pakete installieren mittels ''<nowiki>sudo apt-get install libreadline-dev libconfig-dev libssl-dev libjansson-dev python-dev lua5.2 liblua5.2-dev libevent-dev lua-lgi</nowiki>''
# telegram-cli vom Repository laden: ''git clone --recursive https://github.com/vysheng/tg.git && cd tg''
# Konfigurieren mittels ''./configure'' und anschließend mit ''make'' erstellen. Das dauert ggf ziemlich lange >>20min
# zum Einrichten einmal Telegram starten: ''bin/telegram-cli -k tg-server.pub'' . Dabei wird die eigene Telefonnummer im Format +49301234567 verlangt. Der Bestätigungscode muss eingegeben werden und evtl der eigene Name. Eventuell mal mit ''msg <Emfänger> <Nachrichttext>'' testen ob alles funktioniert. Telegram beenden.
# telegram im Hintergrund starten: ''bin/telegram-cli -k tg-server.pub -W -C -d -P <portnummer> -l 20 -N & '' dabei beliebige freie Portnummer vergeben
# Neuestes FHEM Modul in den /opt/fhem/FHEM Ordner kopieren und mit den nötigen Rechten versehen, FHEM neu starten
# Telegram in FHEM definieren: define myTelegram Telegram <portnummer>
# das Attribut defaultPeer setzten damit Messages verschickt werden können (über den set msg Befehl)

== Links ==
* Source code für das 70_Telegram.pm-Modul: https://github.com/viegener/Telegram-fhem
* Forum-Thread in dem das Modul vorgestellt wurde {{Link2Forum|Topic=38328|LinkText=Fhem-Forum}}
* Repository mit telegram-cli https://github.com/vysheng/tg
* Telegram messaging system https://telegram.org/

HM-SEC-SC Tür-Fensterkontakt

2015-08-08T16:44:34Z

Horiba: /* Batteriestatus aktivieren */ Rechtschreibung

Homematic Funk-Tür-Fensterkontakt
== Technische Daten ==
Aktuelle Firmware: 2.1

== Features ==
Überwachung einer Tür oder eines Fensters zur Sicherheit oder um automatisch, bei vorhandenem [[HM-CC-TC Funk-Wandthermostat|HM-CC-TC]], die Heizung herunter zu regeln, sobald ein Fenster oder eine Tür geöffnet wird.

== Hinweise zum Betrieb mit FHEM ==
===Pairing===
Das Pairing sollte wie in [[HomeMatic Devices pairen]] beschrieben durchgeführt werden. Der Sensor muss hierfür geöffnet und die versenkte Anlerntaste mit einem spitzen Gegenstand betätigt werden. Bei erfolgreichem Pairing blinkt die LED grün.

===Nutzung mit Wandthermostat===
Bei Einsatz mit [[HM-CC-TC Funk-Wandthermostat|HM-CC-TC]] und Zentrale erst alle Tür-/Fensterkontakte mit dem HM-CC-TC verbinden (anlernen). Alternativ geht das auch nachträglich über entsprechende ''set''-Befehle von Fhem aus. Dafür müssen der HM-CC-TC und der HM-Sec-SC aber vorher mit Fhem gepairt worden sein.

Wenn ein bereits erfolgreich gepairter SC ein ''set <HM-Sec-SC-Name> getConfig'' beim anschließenden Drücken der Anlerntaste am SC mit einem lang andauernden Blinken der LED in orange mit anschließendem Leuchten der LED in rot (ca. 1 Sekunde) beantwortet wird, hilft meist ein ''set <HM-Sec-SC-Name> clear readings'', Anlernknopf drücken, nun wieder ''set <HM-Sec-SC-Name> getConfig'' und Anlernknopf drücken.

Dies sollte nun mit einem kurzen LED-Signal in orange mit anschließendem längeren Flackern der LED in grün beantwortet werden und nach einem Refresh der Browser-Seite sollten alle aktuellen Daten zum SC verfügbar sein.

===Batteriestatus aktivieren===
Der HM-SEC-SC sendet nur dann Batteriestatus, wenn der Sensor selber geöffnet wird (Batteriefach), nicht jedoch wenn er schaltet, noch in wiederkehrenden Abständen. Um dies zu ändern muss das Register cyclicInfoMsg auf on gesetzt werden.

Dazu wie folgt vorgehen:
in Fhem (Telnet oder Webfrontend)
get NameMeines_HM-SEC-SC reg all
set NameMeines_HM-SEC-SC regSet cyclicInfoMsg on
eingeben. Danach siehst man beim Device, dass mindestens ein Kommando pendig ist und in den Readings, dass das cyclicInfoMsg Register geschrieben werden soll.
Danach Fhem in den pairing modus versetzten, z.B. mit:
set HMLAN1 hmPairForSec 30
und den Knopf im Batteriefach des HM-SEC-SC drücken (Büroklammer).
Danach noch mal
get NameMeines_HM-SEC-SC reg all
in Fhem (Telnet oder WEbfrontend).
Jetzt sollten keine pendig commands mehr zu sehen sein und in den readings genau
R-cyclicInfoMsg on
stehen.

Danach bekommt man regelmäßig (etwa alle 24 Stunden) eine Batteriestatusmeldung, wenn der HM-SEC-SC Tür-Fensterkontakt etwa 24 Stunden lang '''nicht''' betätigt wurde.
(wenn er betätigt wurde erfolgt keine Meldung, da die erfolgreiche Betätigungsmeldung zeigt, das die Batterie noch in Ordnung ist).
Ohne diese Aktivierung kann auch der ActionDetector für dieses Geräte möglicherweise nicht verwendet werden.

Achtung: Hierdurch steigt der Batterieverbrauch etwas an, besonders wenn der HM-SEC-SC Tür-Fensterkontakt normalerweise sehr selten betätigt wird. Erfahrungswerte liegen hier zu aber nicht vor.

Vergleiche auch [[HomeMatic_Type_ThreeState]]

=== FHEM Config-Auszug ===
Ein exemplarischer Auszug aus der fhem.cfg:

define TuerKeller CUL_HM 1638AC
attr TuerKeller devInfo 810101
attr TuerKeller firmware 2.0
attr TuerKeller hmClass sender
attr TuerKeller model HM-SEC-SC
attr TuerKeller room Keller
attr TuerKeller serialNr IEQ0xxxxxx
attr TuerKeller subType threeStateSensor

== Hinweise zum Peeren mit HM-CC-TC ==
* Nur wenn der HM-Sec-SC mit einem [[HM-CC-TC_Funk-Wandthermostat|HM-CC-TC]] direkt gep'''ee'''rt wurde, steuert letzterer die Absenkung der Temperatur an den [[HM-CC-VD]]-Ventilen. Ansonsten muss diese Steuerung von FHEM erfolgen.
* Das P'''ee'''ren des SC mit einem CC <ins>mittels Anlerntaste</ins> muss vor dem P'''ai'''ren des TC mit FHEM/HMLAN erfolgen, sonst geht das Peeren nur noch über FHEM-Befehle.

* In der Anleitung des HM-Sec-SC steht:

<nowiki>Um den Tür-Fensterkontakt in den Anlernmodus zu bringen, drücken Sie mit einem spitzen Gegenstand auf die Anlerntaste.
Die Geräte-LED blinkt orange. (Abbruch durch kurze Betätigung der Anlerntaste, die Geräte-LED leuchtet dann rot auf.)"</nowiki>

Falls die LED nicht orange, sondern nach dem ersten Drücken rot blinkt, Knopf erneut drücken. Zumindest bei manchen Geräten lässt sich nur so ein Pairen mit den [[HM-CC-TC Funk-Wandthermostat|HM-CC-TC]] durchgeführen (Geräte-LED blinkt orange)

=== Problembehebung ===
Falls trotz korrekt gepeertem Fensterkontakt mit einem HM-CC-RT-DN oder HM-TC-IT-WM-W-EU die LED einen Fehler meldet (rot leuchtet). Überprüft im Fensterkontakt ob das Register "PeerNeedsBurst" gesetzt ist und im Wandthermostat bzw. Heizkörperregler das Attribut BurstAccess auf Auto.

PeerNeedsBurst kann mit folgendem Befehl gesetzt werden:
set <HM-SEC-SC> regSet peerNeedsBurst on <RT_oder_TC>_WindowRec

Danach muss entweder der Kontakt geschaltet werden (HM-SEC-SC-2) oder der Anlernknopf gedrückt werden (HM-SEC-SC)

== Mögliche Zustände ==
Der Sensor hat folgende Schaltzustände:

closed -> Der Sensor zeigt einen geschlossenen Zustand an
open -> Der Sensor zeigt einen geöffneten Zustand an
sabotageError: open -> Das Gehäuse des Sensors wurde geöffnet
sabotageError: closed -> Das Gehäuse des Sensors wurde geschlossen
alive: yes -> Wenn der SC über 24 Std. keine Statusänderung hatte, sendet er ein "Lebenszeichen" an Fhem

Die Änderungen der Zustände werden unmittelbar nach Statusänderung an Fhem / die Zentrale bzw. die gepeerten HM-CC-TC gemeldet.

=== Log-Auszüge ===
In FHEM sind folgende Zustände des HM-SEC-SC im Log zu sehen:

2012-02-13_21:52:02 TuerKeller cover: open
2012-02-13_21:52:02 TuerKeller sabotage
2012-02-13_21:55:23 TuerKeller cover: closed
2012-02-13_21:55:23 TuerKeller alive: yes
2012-02-13_21:55:52 TuerKeller closed (to broadcast)
2012-02-13_21:55:53 TuerKeller open (to broadcast)

Wenn der HM-SEC-SC mit einem HM-CC-TC gepeert ist, sehen die Meldungen auch so aus:

YYYY-MM-TT_HH:mm:ss CUL_HM_threeStateSensor_XYZXYZ contact: open (to HMLAN1)
YYYY-MM-TT_HH:mm:ss CUL_HM_threeStateSensor_XYZXYZ open
YYYY-MM-TT_HH:mm:ss CUL_HM_threeStateSensor_XYZXYZ contact: open (to CUL_HM_thermostat_ZYXZYX)

und

YYYY-MM-TT_HH:mm:ss CUL_HM_threeStateSensor_XYZXYZ contact: closed (to HMLAN1)
YYYY-MM-TT_HH:mm:ss CUL_HM_threeStateSensor_XYZXYZ closed
YYYY-MM-TT_HH:mm:ss CUL_HM_threeStateSensor_XYZXYZ contact: closed (to CUL_HM_thermostat_ZYXZYX)

wobei hier für den SC und TC noch keine Aliase vergeben wurden.

Zusätzlich, wenn die Knopfzellen (2 Stück, Typ LR44, Sollspannung 1,5 V) nachlassen:

2012-02-13_21:55:53 TuerKeller battery: low

was ansonsten so aussieht:

2012-02-13_21:55:53 TuerKeller battery: ok

== Batterien ==
Es werden 2 Stück Knopfzellen vom Typ LR44 (je nach Hersteller auch L1154, AG13, V13GA, A76 oder GPA76 genannt) benötigt. Diese sind Bestandteil der Lieferung, jedoch sollte man vor Installation / Inbetriebnahme die Spannung der Knopfzellen überprüfen. Diese sollte über 1,5 V liegen. Da Batterien eine begrenzte Lagerfähigkeit haben, kann es durchaus vorkommen, dass diese schon überlagert sind, also nicht mehr die für einen längeren Betrieb erforderliche Spannung haben bzw. halten können oder bereits nach ein paar Tagen leer (low) sind.

== Links ==
* [[HomeMatic]]
* Anleitung [http://www.elv-downloads.de/service/manuals/76788_HM_Sec_SC_GE_V1_0_UM.pdf PDF]

[[Kategorie:HomeMatic Components]]
[[Kategorie:Kontaktsensor (magnetisch)]]

Spritpreismonitor

2015-08-04T14:16:20Z

Horiba: /* Konfiguration */

Die hier vorgestellten Fragmente ermöglichen es, mit Hilfe von [[HTTPMOD]] bei [http://www.clever-tanken.de clever-tanken.de] von Wunschtankstellen die Spritpreise zu protokollieren. Die Credits dafür gehen an Forum-Benutzer {{Link2FU|1774|Phil__}}. Die Original Diskussion im Forum ist {{Link2Forum|Topic=22554|Message=210795|LinkText=hier}}.

== Einleitung ==
Im folgenden wird mit Hilfe des Moduls HTTPMOD der Spritpreis von ausgewählten Tankstellen abgerufen. Die Daten werden gespeichert und als Diagramm aufbereitet.

Zum Nachbau ist es erforderlich, "seine" Wunschtankstellen bei Clever-Tanken zu suchen. Jede Tankstelle hat eine eigene Nummer:
:<code>/tankstelle_details/0815</code>

Die ''600'' in den Beispielen gibt das Abrufintervall in Sekunden an.

== Konfiguration ==
Die erforderlichen Definitionen in der Fhem [[Konfiguration]] bestehen aus mehreren Teilen. Zunächst die erforderlichen Einstellungen, um die Daten der gewünschten Tankstellen abzuholen:

<pre>
define Shell HTTPMOD http://www.clever-tanken.de/tankstelle_details/4871 600
attr Shell group Spritpreise
attr Shell icon tanken
attr Shell readingsName_Diesel Diesel
attr Shell readingsName_SuperE5 SuperE5
attr Shell readingsRegex_Diesel Diesel[^0-9]+([0-9\.]+)
attr Shell readingsRegex_SuperE5 Super E5[^0-9]+([0-9\.]+)
attr Shell room Spritpreise
attr Shell stateFormat Liter_Diesel: Diesel
attr Shell timeout 5

define Total HTTPMOD http://www.clever-tanken.de/tankstelle_details/4870 600
attr Total group Spritpreise
attr Total icon tanken
attr Total readingsName_Diesel Diesel
attr Total readingsName_SuperE5 SuperE5
attr Total readingsRegex_Diesel Diesel[^0-9]+([0-9\.]+)
attr Total readingsRegex_SuperE5 Super E5[^0-9]+([0-9\.]+)
attr Total room Spritpreise
attr Total stateFormat Liter_Diesel: Diesel
attr Total timeout 5

define Aral HTTPMOD http://www.clever-tanken.de/tankstelle_details/4869 600
attr Aral group Spritpreise
attr Aral icon tanken
attr Aral readingsName_Diesel Diesel
attr Aral readingsName_SuperE5 SuperE5
attr Aral readingsRegex_Diesel Diesel[^0-9]+([0-9\.]+)
attr Aral readingsRegex_SuperE5 Super E5[^0-9]+([0-9\.]+)
attr Aral room Spritpreise
attr Aral stateFormat Liter_Diesel: Diesel
attr Aral timeout 5
</pre>

Dazu kommen noch die Definitionen für das [[FileLog]]:
<pre>
define FileLog_Spritpreise FileLog /media/usblog/fhem/log/spritpreise-langen-%Y-%m.log (Shell|Total|Aral):(SuperE5|Diesel).*
attr FileLog_Spritpreise alias Log Spritpreise
attr FileLog_Spritpreise group Logfile
attr FileLog_Spritpreise logtype text
attr FileLog_Spritpreise room Spritpreise
</pre>

Sowie eine passende [[readingsGroup]]:
<pre>
define Spritpreise readingsGroup (Shell|Total|Aral):(SuperE5|Diesel).*
attr Spritpreise group Spritpreisuebersicht
attr Spritpreise notime 1
attr Spritpreise room Spritpreise
attr Spritpreise style style="font-size:16px"
attr Spritpreise valueFormat {'%.2f €'}
attr Spritpreise valueStyle {Werte($READING,$VALUE)}
</pre>

Und eine [[SVG|Plotdefinition]]
<pre>
define SVG_FileLog_Spritpreise_1 SVG FileLog_Spritpreise:SVG_FileLog_Spritpreise_1:CURRENT
attr SVG_FileLog_Spritpreise_1 group Spritpreisverlauf
attr SVG_FileLog_Spritpreise_1 room Spritpreise
</pre>

== Farbliche Hervorhebung ==
Folgender Code gehört in 99_myUtils.pm; Die Werte könen natürlich entsprechend angepasst werden
<pre>
###################################################
### Spritpreisübersicht - Farbsortierung ###
###################################################

sub Werte($$) {
my ($name, $wert) = @_;
# Log(3,"$name $wert");
if ($name eq "Diesel") {
return 'style="color:red"' if($wert >= 1.39);
return 'style="color:blue"' if(($wert >= 1.33) && ($wert < 1.39));
return 'style="color:green;;font-weight:bold"' if($wert <= 1.32);
}elsif ($name eq "SuperE10") {
return 'style="color:crimson"' if($wert >= 1.70);
return 'style="color:yellow"' if(($wert >= 1.55) && ($wert < 1.70));
return 'style="color:lightgreen;;font-weight:bold"' if($wert < 1.55);
}elsif ($name eq "SuperE5") {
return 'style="color:red"' if($wert >= 1.59);
return 'style="color:blue"' if(($wert >= 1.49) && ($wert < 1.59));
return 'style="color:green;;font-weight:bold"' if($wert <= 1.48);
}
}
</pre>

=== Die zugehörige .gplot Datei ===
SVG_FileLog_Spritpreise_1.gplot
<pre>
# Created by FHEM/98_SVG.pm, 2014-10-22 12:57:34
set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
set title 'Spritpreise'
set ytics
set y2tics
set grid
set ylabel "Preise (€/Liter)"
set y2label "Preise (€/Liter)"

#FileLog 4:Aral.Diesel\x3a:1:
#FileLog 4:Shell.Diesel\x3a:1:
#FileLog 4:Total.Diesel\x3a:1:
#FileLog 4:Aral.SuperE5\x3a:1:
#FileLog 4:Shell.SuperE5\x3a:1:
#FileLog 4:Total.SuperE5\x3a:1:

plot "<IN>" using 1:2 axes x1y2 title 'Aral Diesel' ls l2 lw 1 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Shell Diesel' ls l1 lw 1 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Total Diesel' ls l0 lw 1 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Aral Super' ls l3 lw 1 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Shell Super' ls l4 lw 1 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Total Super' ls l5 lw 1 with lines
</pre>

== Tricks für HTTPMOD ==
Je nach Internetverbindung und Geschwindigkeit des Fhem Rechners kann das Modul manchmal Probleme haben, die Daten schnell genug zu verarbeiten.

Eine Lösung dazu wäre, die Daten vorher mit wget auf einem eigenen Webserver zu speichern (z.B. ein lokaler Apache), und HTTPMOD auf diesen zugreifen zu lassen.

== Links ==
* Vorstellung und Diskussion im {{Link2Forum|Topic=22554|LinkText=Fhem Forum}}
* [http://www.clever-tanken.de/ Clever Tanken]
* Eine Anleitung, wie man das mit wget macht, gibt es {{Link2Forum|Topic=28123|Message=216228|LinkText=hier}} (ist aber noch nicht ganz fertig)

[[Kategorie:Code Snippets]]