http://wiki.fhem.de/w/api.php?action=feedcontributions&feedformat=atom&user=FidelFHEMWiki - Benutzerbeiträge [de]2026-04-09T21:23:33ZBenutzerbeiträgeMediaWiki 1.43.6http://wiki.fhem.de/w/index.php?title=MQTT2-Module_-_Praxisbeispiele&diff=34340MQTT2-Module - Praxisbeispiele2020-12-07T23:22:01Z<p>Fidel: /* Allgemeine Einstellungen und Hinweise */</p>
<hr />
<div>== Einführung: MQTT bzw. MQTT2 in FHEM ==<br />
{{Randnotiz|RNTyp=y|RNText=Sollten Sie MQTT2_CLIENT verwenden, beachten Sie bitte, dass der MQTT2_CLIENT die ursprüngliche Herkunft der über MQTT verteilten Informationen nicht kennt. Daher ergeben sich in der Anwendung kleinere Unterschiede, zu deren Verständnis die diesbezüglichen [[MQTT2_CLIENT#Anwendung|Hinweise zu MQTT2_CLIENT]] bekannt sein sollten.}}Zur Einbindung von Geräten, welche zur Nutzung des MQTT-Protokols konfiguriert werden können und darüber mit einem MQTT-Server (früher: Broker) kommunizieren, stehen unter FHEM verschiedene Optionen zur Verfügung, wobei nicht alle Module beliebig miteinander verwendet werden können. Details hierzu sind dieser [[MQTT|Übersicht]] zu entnehmen. <br />
<br />
Im Rahmen dieses Artikels wird für die eigentlichen Geräte [[MQTT2 DEVICE|MQTT2_DEVICE]] verwendet, damit wird als IO-Device entweder {{Link2CmdRef|Anker=MQTT2_SERVER|Lang=en|Label=MQTT2_SERVER}} oder [[MQTT2 CLIENT|MQTT2_CLIENT]] benötigt, mit einem IO-Device des Typs [[MQTT (Modul)|MQTT]] funktioniert die nachfolgende Darstellung dagegen nicht<ref>Allerdings können die Konfigurationen in der Regel recht einfach auf die bisherige MQTT-Implementierung übertragen werden</ref>. MQTT2_DEVICE unterstützt u.a. auch die ''setExtensions'' direkt, also z.B. ''on-for-timer<ref>Beachten Sie bei mehrkanaligen Geräten, dass jeweils nur ein Hauptkanal mittels setExtensions verwaltet werden kann! U.a. aus diesen Grund ist es meist sinnvoller, die ''split''-Varianten der attrTemplate-Einrichtung zu verwenden.</ref>'' sowie ''[[MQTT2-Module - Praxisbeispiele#attrTemplate_2|attrTemplate]]''<ref>Auch MQTT_DEVICE unterstützt SetExtensions, allerdings muss dies dort per Attribut eingeschaltet werden</ref>.<br />
<br />
=== Allgemeine Einstellungen und Hinweise ===<br />
{{Randnotiz|RNTyp=r|RNText=Beachten Sie, dass für [[autocreate]] in Verbindung mit MQTT2_SERVER '''zwingend''' jeder über MQTT kommunizierende Client eine ClientID angeben muss. Passen Sie daher ggf. die Einstellungen Ihres Geräts an. Manche Geräte verwenden auch "Wegwerf"-ClientID's. Für diese empfiehlt es sich, ggf. dann die durch autocreate erstellten Geräte nachzubearbeiten und die ClientID-Angabe v.a. aus den Inhalten des readingList-Attributs zu entfernen.}}Die nachfolgenden Beispiele gelingen am einfachsten mit '''MQTT2_SERVER als Server ("Broker")''', für diesen sollte dabei ''autocreate'' '''nicht deaktiviert''' sein, damit die erforderlichen MQTT2_DEVICES soweit möglich automatisiert erstellt werden<ref>Dabei wird vorausgesetzt, dass ein allgemeines {{Link2CmdRef|Anker=autocreate|Lang=en|Label=autocreate}}-Device (''TYPE=autocreate'') ebenfalls aktiv ist.</ref> . <br />
<br />
Beispiel<ref>MQTT2_SERVER verwendet als default-Einstellung für ''autocreate'' ''simple'', ohne dass ein entsprechendes Attribut gesetzt werden müsste. Die Einstellung ''complex'' empfiehlt sich in der Regel nicht; diese ist jedoch dann zu empfehlen, wenn das Device entweder verschachtelte JSON-Array-Strukturen liefert oder bestimmte Readings nicht gefüllt werden sollen.</ref>:<br />
define MQTT2_FHEM_Server MQTT2_SERVER 1883 global<br />
<br />
Falls der MQTT Broker mit Hilfe von [[allowed]] abgesichert wurde, muss in den Geräten ebenfalls User bzw. Passwort eingetragen werden, damit eine MQTT Kommunikation möglich ist.<br />
<br />
{{Hinweis|Die Code-Darstellung in diesem Beitrag entspricht jeweils dem RAW-Format zum [[Import von Code Snippets]]. Wer die Attribute direkt und einzeln bearbeitet, muss ggf. die "\" entfernen!}}<br />
<br />
=== MQTT-Einstellungen in den Geräten ===<br />
Die Beispiele gehen davon aus, dass die einzubindenden Geräte '''''mit den default-Einstellungen''''' für MQTT betrieben werden, wenn man von den Angaben zum Server und ggf. der Gerätekennung absieht. Es sollten also insbesondere '''keine Veränderungen der topic-Pfade''' vorgenommen werden.<br />
<br />
{{Hinweis|Einige der hier beschriebenen Einstellungen haben Änderungen der sich durch die jeweiligen Automatismen eigentlich jeweils ergebenden Standard-Werte zur Folge, insbesondere, was Reading-Namen und von den Geräten gesendete Werte angeht. Sie sollten daher zunächst die Konfiguration des jeweiligen MQTT2-DEVICE-Geräts abschließen, und erst anschließend die weitere Integration mit Event-Handlern, logging usw. vornehmen. }}<br />
<br />
== zigbee2mqtt ==<br />
[[Bild:MQTT2_zigbee2mqtt_Bulbs.png|400px|thumb|Darstellung in FHEMWEB]]<br />
[https://github.com/Koenkk/zigbee2mqtt zigbee2mqtt] ist ein open-source Projekt, mit dem zigbee-Geräte über MQTT direkt angesprochen werden können, ohne dass hierfür eine Bridge eines Herstellers benötigt wird.<br />
=== Installation von zigbee2mqtt ===<br />
Die Installation des zigbee2mqtt-Diensts ist auf der [https://www.zigbee2mqtt.io/ Homepage des Projekts] beschrieben. Ergänzend muss in der configuration.yaml eine ''client_id'' unter ''mqtt'' (z.B. zigbee_pi) vergeben werden<ref>Die Anführungszeichen sowie genau zwei Leerzeichen sind hier erforderlich!</ref>.<br />
mqtt:<br />
client_id: 'zigbee_pi'<br />
Da der Dienst auch später in den Anlernmodus versetzt werden kann, kann man auch gleich <code>permit_join: false</code> setzen, um das versehentliche Einbinden neuer oder fremder Geräte zu unterbinden.<br />
{{Hinweis|Wird ein CC2531 auf demselben Linux-Computer verwendet, auf dem auch FHEM installiert ist, kann es vorkommen, dass FHEM diesen mit einem CUL verwechselt und durch ''initialUsbCheck'' in FHEM einbindet, wodurch er für den zigbee2mqtt-Dienst nicht mehr verfügbar ist. Dann sollte ''initialUsbCheck'' deaktiviert und das automatisch angelegte CUL-Device wieder gelöscht werden. Weiter sollte der CC2531 auch in FHEM '''und''' zigbee2mqtt ''[[Mehrere USB-Geräte einbinden|by-id]]'' eingebunden werden, um Probleme beim gleichzeitigen Einsatz anderer Geräte, die ''/dev/ttyACMx'' belegen können, zu vermeiden (betrifft z.B. CUL/MapleCUL ).}}<br />
<br />
=== Define eines MQTT2-Devices als "Bridge" === <br />
Dann kann eine Art "Grund-Device" angelegt werden, das für die Ansteuerung des eigentlichen Server-Dienstes genutzt wird, der bereits unmittelbar nach der erfolgreichen Konfiguration von zigbee2mqtt zur Verfügung steht. In der Regel sollte dieses automatisch erstellt werden, wenn der zigbee2mqtt-Dienst (oder der betreffende Rechner) neu gestartet wird (oder FHEM oder dort ein Sensor einen Messwert sendet). Beispiel<ref>Hier waren bereits zwei Zigbee-Geräte angelernt</ref>:<br />
<br />
defmod MQTT2_zigbee_pi MQTT2_DEVICE zigbee_pi<br />
attr MQTT2_zigbee_pi IODev MQTT2_FHEM_Server<br />
attr MQTT2_zigbee_pi readingList zigbee_pi:zigbee2mqtt/bridge/state:.* state\<br />
zigbee_pi:zigbee2mqtt/0x90fd9ffffe65db16:.* { json2nameValue($EVENT, '') }\''<br />
zigbee_pi:zigbee2mqtt/0x90fd9ffffe0bcd51:.* { json2nameValue($EVENT, '') }\''<br />
zigbee_pi:zigbee2mqtt/bridge/log:.* { json2nameValue($EVENT, 'log_') }<br />
attr MQTT2_zigbee_pi room MQTT2_DEVICE<br />
<br />
Für die Funktion einer zigbee2mqtt-Bridge steht ein {{Link2CmdRef|Anker=set|Lang=en|Label=template}} bereit, das direkt die passenden Attribute vergibt, um dem zigbee2mqtt-Dienst passende Anweisungen geben zu können und weitere Geräte für die eigentlichen Aktoren und Sensoren anzulegen:<br />
<br />
set MQTT2_zigbee_pi attrTemplate zigbee2mqtt_bridge<br />
<br />
Ist dieses angelegt, kann zigbee2mqtt mit <code>set MQTT2_zigbee_pi permit_join true</code> in den Anlernmodus versetzt werden, anzulernende Geräte müssen anschließend jeweils nach Bedienungsanleitung in den Anlernmodus gebracht werden.<br />
<br />
=== Vereinzeln der eigentlichen Geräte ===<br />
<br />
Über das mit dem template vergebene bridgeRegexp-Attribut <br />
attr MQTT2_zigbee_pi bridgeRegexp zigbee2mqtt/([A-Za-z0-9]*)[/]?.*:.* "zigbee_$1" <br />
werden anschließend neue MQTT2_DEVICE-Geräte automatisch angelegt, sobald ein bisher unbekanntes Zigbee-Gerät einen neuen Status (z.B. einen Messwert) meldet. Um zu erfragen, welche Geräte dem zigbee-Deinst bekannt sind, kann via <code>get MQTT2_zigbee_pi devicelist true</code> eine Liste abgefragt werden, die weitere Informationen zu den bereits angelernten Geräten enthält.<br />
Geräte, die nicht automatisch etwas senden, kann man mit Hilfe des MQTT2_SERVER-Geräts einmalig schalten, damit diese ihren Status bzw. das erfolgreiche Schalten zurückmelden, Beispiel<ref>Die mit 0x... beginnende Angabe entspricht dabei dem ''friendly_name''.</ref>:<br />
set MQTT2_FHEM_Server publish zigbee2mqtt/0x90fd9ffffe0bcd51/set {"state":"ON","brightness":60}<br />
<br />
Für Gerätetypen, für die bereits templates vorhanden sind, ist es am einfachsten, diese einmalig auf die Geräte anzuwenden. Das Vorgehen entspricht dabei dem oben für die Bridge beschriebenen. Dafür wird immer vorausgesetzt, dass ein neues Device mit autocreate (ggf. über die bridgeRegexp) angelegt wurde<ref>Dieses befindet sich dann im Raum MQTT2_DEVICE. Um diesen sichtbar zu machen, muss ggf. die Browser-Seite neu geladen werden.</ref> <br />
<br />
Beispiele:<br />
==== IKEA-Tradfri-Birne ====<br />
{{Randnotiz|RNTyp=g|RNText=Wie wähle ich nun das richtige Template für mein Leuchtmittel aus?<br />
-> Es wird nicht zwischen einer Birne/Bulb/Lampe und einem LED-Controller unterschieden sondern anhand der möglichen Lichtdarstellung des Gerätes:<br />
<br />
light_dimmer:<br />
Das anzusteuernde Geräte besitzt ausschließlich eine feste Lichtfarbe welche gedimmt werden kann.<br />
<br />
light_cct:<br />
Das anzusteuernde Gerät besitzt eine warmweiße sowie kaltweiße Lichtfarbe welche verändert sowie gedimmt werden kann.<br />
<br />
light_rgb_xxx:<br />
Das anzusteuernde Gerät besitzt die Möglichlichkeit einer farbigen Lichtdarstellung (Rot, Grün, Blau) und kann gedimmt werden.<br />
<br />
light_rgbw_xxx:<br />
Das anzusteuernde Gerät besitzt die Möglichlichkeit einer farbigen Lichtdarstellung (Rot, Grün, Blau) und besitzt eine warmweiße ODER kaltweiße Lichtfarbe welche eingestellt sowie gedimmt werden kann.<br />
<br />
light_rgbcct_xxx:<br />
Das anzusteuernde Gerät besitzt die Möglichlichkeit einer farbigen Lichtdarstellung (Rot, Grün, Blau) und besitzt eine warmweiße UND kaltweiße Lichtfarbe welche verändert sowie gedimmt werden kann.<br />
<br />
xxx:<br />
hex: Farbänderung mit hex<br />
rgb: Farbänderung mit r g b<br />
xy: Farbänderung mit x sowie y<br />
hue: Farbänderung mit hue und saturation<br />
<br />
Warum diese Einteilung in "hex", "rgb", "xy" sowie "hue"?<br />
-> Zigbee2MQTT unterstützt das Übermitteln aller dieser Werte, allerdings unterscheiden sich hier die Geräte. Manche "verstehen" nur z.B. Hex-Farbänderungen, andere halt nur eine Farbänderung mit rgb-Werten.<br />
-> Aus diesem Grund muss an dieser Stelle probiert werden mit welchem der 4 Templates sich die Farbveränderung des Gerätes steuern lässt!<br />
<br />
HINWEIS: Templates für Farbänderungen mithilfe von XY- sowie HUE-Werten wurden bis heute nicht angelegt!<br />
}}<br />
Beispiel eines dimmbaren Tradfri-Leuchtmittels<br />
defmod IKEA_Bulb2 MQTT2_DEVICE<br />
attr IKEA_Bulb2 IODev MQTT2_FHEM_Server<br />
attr IKEA_Bulb2 icon light_control<br />
attr IKEA_Bulb2 devStateIcon {zigbee2mqtt_devStateIcon255($name)}<br />
attr IKEA_Bulb2 readingList zigbee_pi:zigbee2mqtt/0x90fd9ffffe0bcd51:.* { json2nameValue($EVENT) }<br />
attr IKEA_Bulb2 setList on:noArg zigbee2mqtt/0x90fd9ffffe0bcd51/set {"state":"ON"}\<br />
off:noArg zigbee2mqtt/0x90fd9ffffe0bcd51/set {"state":"OFF"}\<br />
brightness:colorpicker,BRI,0,15,255 zigbee2mqtt/0x90fd9ffffe0bcd51/set {"state":"on","$EVTPART0":"$EVTPART1"}<br />
attr IKEA_Bulb2 webCmd toggle:on:off:brightness<br />
attr IKEA_Bulb2 model L_02a_zigbee2mqtt_bulb<br />
<br />
Kann man auch die Farbtemperatur einstellen, wird die setList wie folgt erweitert oder das entsprechende template<ref>Durch die ''model''-Angabe kann nachvollzogen werden, welches template angewendet wurde.</ref> anwendet:<br />
...<br />
color_temp:colorpicker,CT,250,1,454 zigbee2mqtt/0x90fd9ffffe0bcd51/set {"$EVTPART0":"$EVTPART1"}<br />
<br />
Die templates sind dabei in der Regel so gestaltet, dass eventuell mehr Optionen in FHEMWEB erscheinen, als tatsächlich vorhanden oder erwünscht sind. <br />
Da sich obige einfarbige dimmbare Lampe durch Klicken auf das devStateIcon schalten lässt, ist für die vollständige Ansteuerung bereits dieses webCmd hinreichend:<br />
attr IKEA_Bulb2 webCmd brightness<br />
<br />
==== Temp/Hum. Sensor ====<br />
tbd<br />
<br />
==== Motion Sensor ====<br />
Als MQTT-Server wird hier ''mosquitto'' verwendet, als IO-Device wird daher ein {{Link2CmdRef|Anker=MQTT2_CLIENT|Lang=en|Label=MQTT2_CLIENT}}-Gerät definiert: <br />
<br />
defmod mqtt2_client MQTT2_CLIENT 192.168.2.4:1883<br />
attr mqtt2_client autocreate 1<br />
attr mqtt2_client rawEvents zigbee2mqtt/GB_Bewegungsmelder:.*<br />
attr mqtt2_client room test<br />
attr mqtt2_client subscriptions #<br />
<br />
Das eigentliche Device sieht dann so aus:<br />
defmod GB_Bewegungsmelder_MQTT2 MQTT2_DEVICE zigbee_158d0001f9d030<br />
attr GB_Bewegungsmelder_MQTT2 IODev mqtt2_client<br />
attr GB_Bewegungsmelder_MQTT2 devStateIcon motion:motion_detector@red off:motion_detector@green no_motion:motion_detector@green<br />
attr GB_Bewegungsmelder_MQTT2 icon motion_detector@blue<br />
attr GB_Bewegungsmelder_MQTT2 readingList mqtt2client:zigbee2mqtt/GB_Bewegungsmelder:.* { json2nameValue($EVENT) }<br />
attr GB_Bewegungsmelder_MQTT2 room MQTT2_DEVICE<br />
attr GB_Bewegungsmelder_MQTT2 stateFormat {\<br />
if(ReadingsVal("$name","occupancy",0) eq "true") {\<br />
sprintf("motion");;\<br />
} else {\<br />
sprintf("no_motion");; \<br />
}\<br />
}<br />
==== Anlegen von Zigbee2MQTT-Gruppen in FHEM ====<br />
{{Hinweis|Die nachfolgende Darstellung ist vorläufig!}}<br />
{{Hinweis|Bevor man eine Gruppe mithilfe von Zigbee2MQTT anlegen kann, sollte man sicherstellen, dass man über die aktuelleste Version von Zigbee2MQTT verfügt (min. vom 15. Februar 2019). Außerdem sollte auch der Koordinator (zumeist CC2531) die aktuellste Firmware besitzen (min. vom 15. Februar 2019). Falls ein flashen des Koordinators mit der neusten Firmware erfolgen soll, ist darauf zu achten, dass nach einem flashen alle Geräte neu angelernt werden müssen! (Hinweise zum flashen ohne erneutem anlernen sind hier zu finden: https://www.zigbee2mqtt.io/information/flashing_without_re-pairing.html)}}<br />
<br />
=====Erstellen einer Zigbee2MQTT-Gruppe=====<br />
Bevor das Ganze in FHEM funktioniert, muss eine Gruppe in der "configuration.yaml" angelegt werden, dieser Vorgang ist auf folgender Seite beschrieben: https://www.zigbee2mqtt.io/information/groups.html<br />
Wenn die Geräte anschließend über den FHEM MQTT2-Server der Gruppe hinzugefügen werden sollen, kann dies mit folgendem Befehl erfolgen:<br />
set <MQTT2-Server> publish zigbee2mqtt/bridge/group/<Zigbee2MQTT Friendly-Gruppenname>/add <Zigbee2MQTT Friendly-Gerätename><br />
<br />
Beispiel:<br />
set MQTT2_FHEM_Server publish zigbee2mqtt/bridge/group/Wohnzimmer/add Stehlampe<br />
<br />
Dieser Befehl kann so oft verwendet werden, wie man Geräte zu einer Gruppe hinzufügen möchte.<br />
<br />
Zum Entfernen eines Gerätes aus einer Gruppe kann folgender Befehl verwendet werden:<br />
set <MQTT2-Server> publish zigbee2mqtt/bridge/group/<Zigbee2MQTT Friendly-Gruppenname>/remove <Zigbee2MQTT Friendly-Gerätename><br />
Beispiel:<br />
set MQTT2_FHEM_Server publish zigbee2mqtt/bridge/group/Wohnzimmer/remove Kuechenlampe<br />
<br />
=====Anlegen der Gruppe in FHEM=====<br />
Da Gruppen in Zigbee2MQTT aktuell keine Rückmeldung über ihren Status geben, wird auch beim einmaligen Schalten kein Gerät automatisch in FHEM angelegt. Aus diesem Grund muss dies mit folgendem Befehl noch manuell erfolgen:<br />
defmod <FHEM NAME> MQTT2_DEVICE<br />
Beispiel<br />
defmod lichtWohnzimmer MQTT2_DEVICE<br />
Anschließend wird auch für dieses Gerät wieder ein passendes template ausgewählt, wie als wäre es ein normales Zigbee2MQTT-Gerät.<br />
Im anschließenden Dialog-Fenster welches sich nach dem Setzen des templates öffnet, müssen die folgenden Werte durch passendes ersetzt werden:<br />
BASE_TOPIC -> zigbee2mqtt<br />
DEV_ID -> <Zigbee2MQTT Friendly-Gruppenname><br />
<br />
Danach sollte sich die Gruppe wie ein normales Zigbee2MQTT Gerät steuern lassen.<br />
<br />
== Tasmota ==<br />
{{Randnotiz|RNTyp=r|RNText=Bitte beachten Sie, dass versicherungsrechtliche Probleme entstehen können, wenn die herstellereigene Firmware ersetzt wird!}}[https://github.com/arendst/Sonoff-Tasmota Tasmota] ('''T'''heo '''A'''rends '''S'''onoff '''M'''QTT '''O'''ver '''T'''he '''A'''ir - einer offenen Firmware von [https://github.com/arendst arendst]) ist eine open-source Software für ESP8266-Geräte, die z.B. statt der originalen Firmware für Sonoff-Geräte und andere ESP8266-basierte WLAN-Steckdosen usw. verwendet werden kann. <br />
{{Hinweis|[[Datei:Tasmota mqtt config.png|120px|thumb|right]]Vor allem, aber nicht nur bei Verwendung des MQTT2_CLIENT als IO, ist es empfehlenswert, in der MQTT-Konfiguration der tasmota-Geräte für den Parameter ''<nowiki>topic = %topic% (tasmota)</nowiki>'' ebenfalls die dynamisch aus der Chip-ID erzeugte Kennung ''DVES_%06X'' zu verwenden. (Kopieren Sie einfach diese Zeichenkette aus dem Eingabefeld für ''"client ..."'', siehe nebenstehende Abbildung). Die eigentliche Umbenennung zu einem "sprechenden Namen" kann dann innerhalb von FHEM - mittels ''rename'' oder ggf. mit einem ''alias'' - erfolgen.}}<br />
=== MQTT2_DEVICE ===<br />
Dieses sollte bei aktiviertem ''autocreate'' am MQTT2_SERVER-Device automatisch angelegt werden, sobald das betreffende Gerät eingesteckt oder neu gestartet oder an einem evtl. vorhandenen Taster geschalten wird. Bislang wurden Tasmota version(en) ab 6.1.1 bis min. 8.1.0 getestet, dies auf verschiedener Hardware, zunächst mit Sonoff Touch und S20, zwischenzeitlich mit einer Vielzahl von Geräten, die per USB-Adapter oder mit der Methode aus dem [https://www.heise.de/ct/artikel/Tuya-Convert-IoT-Geraete-ohne-Loeten-vom-Cloud-Zwang-befreien-4283623.html Tuya-Convert]-Projekt des heise-Verlags auf Tasmota umgeflasht wurden.<br />
<br />
=== Manuelle Anpassungen ===<br />
Die RAW-Definition kann dann beispielsweise wie folgt ergänzt werden: <br />
defmod MQTT2_DVES_9B01BD MQTT2_DEVICE DVES_9B01BD<br />
attr MQTT2_DVES_9B01BD IODev m2server<br />
attr MQTT2_DVES_9B01BD readingList DVES_9B01BD:tele/DVES_9B01BD/STATE:.* { json2nameValue($EVENT) }\<br />
DVES_9B01BD:tele/DVES_9B01BD/LWT:.* LWT\<br />
DVES_9B01BD:cmnd/DVES_9B01BD/POWER:.* POWER\<br />
DVES_9B01BD:tele/DVES_9B01BD/UPTIME:.* { json2nameValue($EVENT) }\<br />
DVES_9B01BD:tele/DVES_9B01BD/SENSOR:.* { json2nameValue($EVENT) }\<br />
DVES_9B01BD:tele/DVES_9B01BD/INFO1:.* { json2nameValue($EVENT) }\<br />
DVES_9B01BD:tele/DVES_9B01BD/INFO2:.* { json2nameValue($EVENT) }\<br />
DVES_9B01BD:tele/DVES_9B01BD/INFO3:.* { json2nameValue($EVENT) }\<br />
DVES_9B01BD:stat/DVES_9B01BD/RESULT:.* { json2nameValue($EVENT) }\<br />
DVES_9B01BD:stat/DVES_9B01BD/STATE:.* { json2nameValue($EVENT) }<br />
attr MQTT2_DVES_9B01BD room MQTT2_DEVICE<br />
attr MQTT2_DVES_9B01BD setList on cmnd/DVES_9B01BD/POWER on\<br />
off cmnd/DVES_9B01BD/POWER off\<br />
reboot cmnd/DVES_9B01BD/Restart 1<br />
attr MQTT2_DVES_9B01BD webCmd on:off:reboot<br />
<br />
=== attrTemplate ===<br />
<br />
===== Allgemeines =====<br />
Für gängige Tasmota-Geräte stehen ''templates'' bereit, mit denen sich diese schnell konfigurieren lassen. <br />
Beachten Sie dazu den Abschnitt ''attrTemplate'' in [[MQTT2 DEVICE#attrTemplate|MQTT2_DEVICE]]. Bei Anwendung eines template mit "split" im Namen werden dabei weitere Geräte angelegt und konfiguriert.{{Hinweis|Bitte attrTemplates nicht verwechseln mit templates, die auf den Tasmota- bzw. Blackadder-Seiten angeboten werden, welche zur Konfiguration der firmware genutzt werden können! Es sollte zunächst die firmware korrekt eingerichtet werden, so dass das Gerät selbst direkt auf dessen Web-Interface korrekt bedient werden kann.}}<br />
<br />
===== Kein passendes attrTemplate vorhanden? =====<br />
Exisitert (noch) kein passendes attrTemplate, ist zu empfehlen, zunächst das "''tasmota_basic''" anzuwenden. Dieses führt einige Basiskonfigurationen durch, die für FHEM hilfreich sind, z.B. wird die firmware so eingestellt, dass Schaltzustände in Kleinschreibung übermittelt werden, statt der defaults "ON" bzw. "OFF".<br />
<br />
Allerdings stellt dieses das ''autocreate'' an dem MQTT2_DEVICE auf 0, was dann nicht optimal ist, wenn man weitere Readings aus dem Gerät erwartet, etwa, weil zusätzliche Sensoren vorhanden sind. In diesem Fall empfiehlt es sich, das ''autocreate''-Attribut an dem MQTT2_DEVICE zu löschen, damit alle weiteren Informationen verarbeitet werden und ggf. im ''jsonMap''-Attribut nur die Angabe "''POWER1:state''" zu belassen.<br />
<br />
=== on-for-timer ===<br />
Um z.B. ein Relais nur für einen Zeitraum anzuschalten, kann man bei Tasmota-Geräten zwischen mehrere Varianten wählen. Ohne speziellen ''setter'' in der ''setList'' werden die '''SetExtensions''' verwendet. Timer laufen damit innerhalb FHEM. Da diese intern als temporäres [[at]] ausgeführt werden, sind diese auch noch nach einem FHEM-Neustart vorhanden, sofern FHEM ordnungsgemäß beendet und neu gestartet wird.<br />
<br />
Die Tasmota-firmware bietet ergänzend dazu zwei Möglichkeiten an, bei denen der Timer direkt auf dem ESP-Microcontroller verwaltet wird:<br />
<br />
==== delay ==== <br />
Zeile zur Erweiterung der ''setList'' (Attributeingabe via FHEMWEB!):<br />
on-for-timer {my $duration = $EVTPART1*10; 'cmnd/DVES_575127/Backlog POWER1 1; delay '.$duration.'; POWER1 0'}<br />
<br />
Ohne Auswirkungen auf alles, was danach kommt, hat aber den Nachteil, dass die möglichen Zeitspannen auf 3600 1/10 Sekunden begrenzt sind (siehe https://github.com/arendst/Tasmota/wiki/Commands#delay), also eine Stunde.<br />
<br />
====pulseTime ====<br />
Zeile zur Erweiterung der ''setList'' (s.o.):<br />
on-for-timer {my $duration = $EVTPART1 < 11.2 ? $EVTPART1*10 : $EVTPART1+100; 'CMNDTOPIC/Backlog pulseTime1 '.$duration.'; POWER1 1'}<br />
Auch hier sind die möglichen längsten Einschaltdauern begrenzt, allerdings ist diese mit 18h deutlich länger als mit ''delay''. Diese Implementierung hat den Nachteil, dass der ESP-Microcontroller die jeweils letzte pulseTime auch für alle weiteren "normalen" Einschaltvorgänge berücksichtigt, das Relais also ebenfalls nach Ablauf der übermittelten pulseTime abgeschaltet wird; dies gilt allerdings ohne explizites ''save'' nur bis zum nächsten reboot des Microcontrollers.<br />
<br />
=== zigbee2tasmota ===<br />
[https://tasmota.github.io/docs/Zigbee/ zigbee2tasmota] ist eine Erweiterung der Tasmota-firmware für Microcontroller, insbesondere dem ESP8266 (und ESP32)(link), über die einige ZigBee-Chipsätze (insbesondere TI CC2530) als [[ZigBee#Koordinator_.28ZigBee_coordinator.2C_ZC.29|Coordinator]] eingebunden werden können, um ein ZigBee-Netzwerk aufzubauen.<br />
{{Hinweis|Stand 08/2020 war die Einbindung anderer Chipsätze erst in einem Alpha-Stadium; die Zahl der über einen CC2530 einbindbaren ZigBee-Geräte ist daher derzeit relativ begrenzt (ca. 16)!}}<br />
Auch für diese Lösung stehen einige ''attrTemplate'' zur Verfügung. Nähere Informationen hierzu sind dem Artikel [[Zigbee2Tasmota-MQTT]] zu entnehmen.<br />
<br />
== ESPurna ==<br />
ESPurna ist eine weitere alternative firmware für ESP8266-basierte Geräte, Details sind der [https://github.com/xoseperez/espurna/wiki Projektseite] zu entnehmen.<br />
<br />
Das Format, in dem ESPurna Daten sendet, unterscheidet sich v.a. darin, dass bool'sche Werte als 0 oder 1 gesendet werden, und nicht wie sonst üblich als "on" oder "off" oä.. Es stehen einige Mustertemplates zur Verfügung, um diese Art der Payload in FHEM-konforme Werte zu überführen.<br />
<br />
== Shelly ==<br />
=== Vorbemerkung ===<br />
Auch für Shelly-Geräte steht eine Auswahl an [[MQTT2-Module - Praxisbeispiele#attrTemplate_2|templates]] bereit.<br />
Beachten Sie auch hier, dass uU. bei Anwendung eines template mit "split" im Namen weitere Geräte angelegt und konfiguriert werden.<br />
<br />
Standardmäßig senden die Shelly-Geräte ihren kompletten Status alle 30 Sekunden. Dies kann man über den Parameter ''mqtt_update_period'' in den ''settings'' ändern, allerdings ist dieser nur über die HTTP-Schnittstelle des Shelly verfügbar. Um diese Statusupdates abzustellen, kann über den Browser folgender Befehl verwendet werden:<br />
http://<ip-des-shelly>/settings?mqtt_update_period=0, <br />
Soweit bekannt, werden dann nur statische updates ausgeschaltet, z.B. für das Relay bzw. angeschlossene Taster oder Schalter; insbesondere Verbrauchswerte werden dennoch aktualisiert.<br />
<br />
=== Shelly1 ===<br />
<br />
=== Shellybulb ===<br />
Zunächst muss man einen Statusupdate des Shellybulb erzwingen (Aus- und Einschalten, physikalisch oder per Web-UI), damit das Gerät bei eingeschaltetem autocreate angelegt wird. Dies sieht zunächst so aus:<br />
Internals:<br />
CFGFN <br />
CID shellybulb_3CC533<br />
DEF shellybulb_3CC533<br />
DEVICETOPIC MQTT2_shellybulb_3CC533<br />
IODev MQTT2_FHEM_Server<br />
NAME MQTT2_shellybulb_3CC533<br />
NR 246<br />
STATE ???<br />
TYPE MQTT2_DEVICE<br />
READINGS:<br />
2018-12-12 19:28:08 status_blue 0<br />
2018-12-12 19:28:08 status_brightness 61<br />
2018-12-12 19:28:08 status_effect 0<br />
2018-12-12 19:28:08 status_gain 26<br />
2018-12-12 19:28:08 status_green 0<br />
2018-12-12 19:28:08 status_ison true<br />
2018-12-12 19:28:08 status_mode color<br />
2018-12-12 19:28:08 status_red 255<br />
2018-12-12 19:28:08 status_temp 3250<br />
2018-12-12 19:28:08 status_white 0<br />
Attributes:<br />
IODev MQTT2_FHEM_Server<br />
readingList shellybulb_3CC533:shellies/shellybulb-3CC533/color/0/status:.* { json2nameValue($EVENT, 'status_') }<br />
room MQTT2_DEVICE<br />
[[Bild:MQTT2 Shellybulb.png|400px|thumb|Darstellung in FHEMWEB nach Anwendung des template]]Dann bei den set-Anweisungen das attrTemplate "shellybulb" auswählen und setzen. Es erscheint eine Abfrage, ob die vorhandenen Readings gelöscht werden sollen. Diese bitte bestätigen und die Seite neu laden. Danach einmal An- und Ausschalten, damit die Readings auch durch einen neuen Status initialisiert werden und die Seite im Browser neu laden.<br />
<br />
=== Shelly Plug S ===<br />
Über die Leistungsmessung des Shelly Plug S lässt sich sehr einfach auch eine Erkennung des Betriebszustandes des angeschlossenen Gerätes realisieren. Dazu stellt man zuerst fest, wieviel Leistung das Gerät in jedem Betriebszustand verbraucht und kann dann z.B. für einen angeschlossenen Fernseher, der im Standby 1 Watt und im Betrieb > 100 Watt verbraucht, den Zustand erkennen und als on/off Status anzeigen. Dazu wird das state Reading wie folgt definiert:<br />
attr readingList shellies/shellyplug-s-123456/relay/0/power:.* { { state => $EVTPART0<100?"off":"on" } }<br />
Der Status des MQTT2 Devices zeigt dann bei <100W "off" und sonst "on" an.<br />
<br />
=== HTTP-Commands ===<br />
In diesem {{Link2Forum|Topic=102369|LinkText=Forumsbeitrag}} wird eine Lösung vorgestellt, um über [[99 myUtils anlegen|myUtils-Code]] weitere Kommandos bereitzustellen, die sonst nur direkt über das Web-Interface zu erreichen sind.<br />
<br />
== 8-Port-Ethernet Board ==<br />
<gallery><br />
datei:8-relais-ethernetboard closed.jpg|mit Gehäuse<br />
datei:8-Port-MQTT-Relais-Board.jpg|ohne Gehäuse<br />
</gallery><br />
In diesem {{Link2Forum|Topic=107536|Message=1016379|LinkText=Forenbeitrag}} bzw. dem betreffenden Thread wurde ein Relais-Board vorgestellt, mit dem 8 Relais über Ethernetkabel verbunden werden, die Kommunikation erfolgt dann über MQTT. Über die verwendete Software ist wenig bekannt, es könnte jedoch sein, dass diese Art der Einbindung auch bei weiteren Boards funktioniert, die einen bestimmten Ethernet-Chipset von TI (DP83848) und eine Cortex M3 MCU verwenden.<br />
<br />
== Milight-Bridge ==<br />
=== Vorbemerkung ===<br />
Der [https://github.com/sidoh/esp8266_milight_hub esp8266_milight_hub] ist ein open source- Projekt, mit dem auf Basis von ''openmili'' eine Vielzahl von MiLight-Geräten gesteuert werden können. Der MiLight-Hub erstetzt dabei eine beliebige Zahl von Milight-Bridges und ist auch zu verschiedenen Versionen des MiLight-Protokols kompatibel.<br />
Neben MQTT kann dieser auch mit HTTPMOD oder Wifilight (bzw. den MiLight-Modulen) gesteuert werden. Die Hardware entspricht dabei im Wesentlichen einem MySensors-Wifi-Gateway<ref>Es wird lediglich ein anderer CS-PIN genutzt. Dies kann einfach in der Web-Oberfläche der Firmware umgestellt werden.</ref>.<br />
Hier wird vorausgesetzt, dass eine funktionierende Bridge vorhanden ist.<br />
Der Vorteil der MQTT-Lösung liegt darin, dass man bei kompatiblen Fernbedienungen auch direkt Informationen über Schaltvorgänge erhält, die mit der Fernbedienung ausgelöst werden.<br />
<br />
=== Einstellungen am MiLight-Hub ===<br />
Die zum FHEM-Server bzw. dem MQTT2_SERVER passenden Vorgaben sind im Web-Interface des Hub einzustellen. Gegebenenfalls passen Sie die vom Hub zurückzugebenden Elemente im Web-Interface des Hub an.<br />
Die Einstellungen für ''MQTT topic pattern'' usw. können auf den default-Werten<ref>Diese sind: <br>''milight/:device_id/:device_type/:group_id'' für "topic pattern"<br>''milight/updates/:hex_device_id/:device_type/:group_id'' für "update topic pattern"<br>''milight/states/:hex_device_id/:device_type/:group_id'' für "state topic pattern". Der Autor hat derzeit folgende Infotypen zum Senden markiert: "status, brightness, hue, color, mode, color_temp, bulb_mode, computed_color, hex_color" (enthält eventuell zu viele Angaben. Bei einem Eventhandler muss man uU. darauf achten, dass kurz hintereinander zweimal dasselbe Event kommen kann (für ON/OFF)).</ref> belassen werden, für die seit Mitte 2019 vorhandene Option, eine LWT-Message zu senden (''MQTT Client Status Topic''), tragen Sie ''milight/LWT'' ein und aktivieren ''Detailed''.<br />
<br />
=== FHEM-Devices ===<br />
[[Bild:MQTT2 MiLight.png|400px|thumb|Milight: Darstellung in FHEMWEB]]<br />
==== Bridge ====<br />
Wird nun über den Hub oder eine von diesem erkannte Fernbedienung ein vorhandenes Leuchtmittel geschaltet, wird bei eingeschaltetem autocreate ein erstes Device erstellt, die zunächst erstellte Definition sieht typischerweise etwa so aus:<br />
defmod MQTT2_milight_hub_1370325 MQTT2_DEVICE milight_hub_1370325<br />
attr MQTT2_milight_hub_1370325 IODev MQTT2_FHEM_Server<br />
attr MQTT2_milight_hub_1370325 readingList milight_hub_1370325:milight/updates/0xBE59/rgbw/1:.* { json2nameValue($EVENT, '1_', $JSONMAP) }<br />
attr MQTT2_milight_hub_1370325 room MQTT2_DEVICE<br />
<br />
Auf dieses Device wird nun das ''template'' '''esp_milight_hub_bridge''' angewandt.<br />
<br />
==== Einzelne Leuchtmittel ====<br />
<br />
Wird nun nochmals das oben verwendete Leuchtmittel geschaltet, erstellt autocreate ein weiteres Device:<br />
defmod MQTT2_milight_0xBE59_1 MQTT2_DEVICE milight_0xBE59_1<br />
attr MQTT2_milight_0xBE59_1 IODev MQTT2_FHEM_Server<br />
attr MQTT2_milight_0xBE59_1 readingList milight/states/0xBE59/rgbw/1:.* { json2nameValue($EVENT, '1_', $JSONMAP) }<br />
attr MQTT2_milight_0xBE59_1 room MQTT2_DEVICE<br />
<br />
Auf dieses wird nun eines der Bulb-templates angewendet. Wählt man das template X_01_esp_milight_hub_rgbw_bulb, wird eine einfache Variante erstellt, die neben einem toggelnden Icon nur Regler für Helligkeit, die Farbe und zwei Schaltflächen für den Weiß- und Nachtmodus enthält. Wer mehr oder andere Steuerelemente erhalten möchte, verwendet ein anderes template. Nicht benötigte Elemente kann man dabei einfach aus der Definition löschen.<br />
<br />
Alle weiteren Devices werden genauso erstellt. <br />
<br />
Um ein Device zu erhalten, mit dem sich alle Kanäle gleichzeitig steuern lassen, kann das template ''X_01a_esp_milight_hub_make_rgbw_group'' verwendet werden. Dieses verändert nicht das aktuelle Device, sondern erstellt '''eine Kopie''', die dann modifiziert wird. Diese Kopie ist unter dem Namen ''milight_<RemoteID>_0'' im selben Raum zu finden wie das Ausgangsgerät und kann ebenfalls an die eigenen Wünsche angepasst werden. <br />
<br />
Weitere Beispiele:<br />
Beispiel für ein RGB-CCT-Device:<br />
defmod Licht_Wz_all MQTT2_DEVICE<br />
attr Licht_Wz_all IODev MQTT2_Broker<br />
attr Licht_Wz_all eventMap /set_white:Weiss/night_mode:Nacht/white_mode:white/on:on/off:off/ON:on/OFF:off/next_mode:Mode/mode_speed_up:Up/mode_speed_down:Down/<br />
attr Licht_Wz_all group Licht<br />
attr Licht_Wz_all icon light_control<br />
attr Licht_Wz_all readingList milight/0x5D02/rgb_cct/0:.* { json2nameValue($EVENT) }\<br />
milight/updates/0x5D02/rgb_cct/0:.* { json2nameValue($EVENT) }\<br />
milight/states/0x5D02/rgb_cct/0:.* { json2nameValue($EVENT) }\<br />
<br />
attr Licht_Wz_all room Wohnzimmer<br />
attr Licht_Wz_all setList on milight/0x5D02/rgb_cct/0 {"status":"ON"}\<br />
off milight/0x5D02/rgb_cct/0 {"status":"OFF"}\<br />
level milight/0x5D02/rgb_cct/0 {"$EVTPART0":"$EVTPART1"}\<br />
hue:colorpicker,HUE,0,1,359 milight/0x5D02/rgb_cct/0 {"$EVTPART0":"$EVTPART1"}\<br />
command:uzsuSelectRadio,Weiss,Nacht,Mode,Up,Down milight/0x5D02/rgb_cct/0 {"$EVTPART0":"$EVTPART1"}\<br />
brightness:colorpicker,BRI,0,1,255 milight/0x5D02/rgb_cct/0 {"$EVTPART0":"$EVTPART1"}\<br />
next_mode milight/0x5D02/rgb_cct/0 {"$EVTPART0":"$EVTPART1"}\<br />
mode_speed_up milight/0x5D02/rgb_cct/0 {"$EVTPART0":"$EVTPART1"}\<br />
mode_speed_down milight/0x5D02/rgb_cct/0 {"$EVTPART0":"$EVTPART1"}\<br />
saturation:colorpicker,BRI,0,1,100 milight/0x5D02/rgb_cct/0 {"$EVTPART0":"$EVTPART1"}\<br />
color_temp:colorpicker,CT,153,1,370 milight/0x5D02/rgb_cct/0 {"$EVTPART0":"$EVTPART1"}\<br />
device_id milight/0x5D02/rgb_cct/0 {"$EVTPART0":"$EVTPART1"}\<br />
effect milight/0x5D02/rgb_cct/0 {"$EVTPART0":"$EVTPART1"}\<br />
mode milight/0x5D02/rgb_cct/0 {"$EVTPART0":"$EVTPART1"}\<br />
commands milight/0x5D02/rgb_cct/0 {"$EVTPART0":"$EVTPART1"}<br />
attr Licht_Wz_all sortby 1<br />
attr Licht_Wz_all webCmd command:brightness:saturation:color_temp:hue<br />
attr Licht_Wz_all webCmdLabel command\ <br />
:brightness:saturation\<br />
:color_temp:hue<br />
==== Ein Leuchtmittel, mehrere Fernbedienungen ====<br />
Pairt man mehrere Fernbedienungen mit einem Leuchtmittel, sollten auch alle entsprechenden Fernbedienungscodes in das readingList-Attribut übernommen werden. Dazu übernimmt man am einfachsten die Einträge aus den zusätzlichen MQTT2_DEVICEs. Benötigt man das zusätzliche Device nicht separat, um z.B. eine getrennte Gruppenschaltung zu realisieren, kann man dieses löschen. Beispiel-readingList für ein Device, das auf zwei Fernbedienungscodes und zwei Gruppen "hört":<br />
<br />
attr Licht_Wz_all readingList milight/states/0x1234/rgbw/2:.* {json2nameValue($EVENT) }\<br />
milight/updates/0x1234/rgbw/2:.* { json2nameValue($EVENT) }\<br />
milight/states/0x1234/rgbw/0:.* { json2nameValue($EVENT) }\<br />
milight/updates/0x1234/rgbw/0:.* { json2nameValue($EVENT) }\<br />
milight/states/0xABCD/rgbw/0:.* { json2nameValue($EVENT) }\<br />
milight/updates/0xABCD/rgbw/0:.* { json2nameValue($EVENT) }\<br />
milight/states/0xABCD/rgbw/4:.* { json2nameValue($EVENT) }\<br />
milight/updates/0xABCD/rgbw/4:.* { json2nameValue($EVENT) }<br />
<br />
==== Fernbedienung als Input-Device nutzen ====<br />
In diesem {{Link2Forum|Topic=103493|LinkText=Thread}} ist dargestellt, wie man eine Fernbedingung des Typs FUT089 dazu verwenden kann, einen [[MPD]] oder Rollladenaktoren zu steuern, oder diese Fernbedienung für [[Hue#HUE-Device|HUEDevice]]-Leuchtmittel zu nutzen.<br />
Um hier nur Differenz-Meldungen direkt an die betreffende myUtils-Funktion zu übergeben und doppelte Events zu verhindern, sollte hier die readingList so angepasst werden, dass nur Messages aus dem "updates"-Zweig ausgewertet werden: <br />
defmod MiLight_RC1_0 MQTT2_DEVICE milight_0xABCD_0<br />
attr MiLight_RC1_0 readingList milight/states/0xABCD/fut089/[0-8]:.* {}<br />
milight/updates/0xABCD/fut089/0:.* { FHEM::attrT_MiLight_Utils::MPDcontrol('myMPD',$EVENT, 'Yamaha_Main') }\<br />
milight/updates/0x5D47/fut089/1:.* { FHEM::attrT_MiLight_Utils::FUT_to_RGBW('Licht_Stehlampe_links',$EVENT) }\<br />
milight/updates/0x5D47/fut089/2:.* { FHEM::attrT_MiLight_Utils::FUT_to_RGBW('Licht_Stehlampe_rechts',$EVENT) }\<br />
milight/updates/0x5D47/fut089/3:.* { FHEM::attrT_MiLight_Utils::four_Lights_matrix($EVENT, 'Licht_WoZi_Vorn_Aussen', 'Licht_WoZi_Vorn_Mitte', 'Licht_WoZi_Hinten_Aussen', 'Licht_WoZi_Hinten_Mitte') }\<br />
milight/updates/0x5D47/fut089/4:.* { FHEM::attrT_MiLight_Utils::shuttercontrol('Jalousie_WZ',$EVENT) }\<br />
milight/updates/0x5D47/fut089/5:.* { FHEM::attrT_MiLight_Utils::shuttercontrol('Rollladen_WZ_SSO',$EVENT) }\<br />
milight/updates/0x5D47/fut089/6:.* { FHEM::attrT_MiLight_Utils::shuttercontrol('Rollladen_WZ_SSW',$EVENT) }\<br />
milight/updates/0x5D47/fut089/7:.* {}\<br />
milight/updates/0x5D47/fut089/8:.* {}<br />
attr MiLight_RC_WZ stateFormat CommandSet<br />
<br />
<br />
== eBus ==<br />
An dieser Stelle sollen lediglich die Grundzüge erläutert werden, eine ausführliche Anleitung über die Konfiguration des [[EBUS-MQTT2|eBus mit MQTT2 gibt es hier]].<br />
<br />
=== Vorbereitung und Definition am eBus ===<br />
Vorausgesetzt wird ein laufender eBus-Dämon. Dessen Einrichtung wird im Artikel [[EBUS#Software|EBUS]] beschrieben.<br />
In der Konfiguration des Dämons ( /etc/default/ebusd ) ist die Kommunikation über MQTT zu aktivieren und die Topic-Struktur festzulegen, z.B. ''ebusd/%circuit/%name''.<br />
--accesslevel=* --mqttport=1883 --mqttjson --mqtthost=IpAdresseMQTTSERVER --mqtttopic=ebusd/%circuit/%name<br />
{{Hinweis|Nachfolgend wird davon ausgegangen, dass als Vorgabe für mqtttopic ''ebusd'' verwendet wurde. Dies kann geändert werden, es wird aber dringend empfohlen, das mqtttopic in jedem Fall mit ''ebus...'' zu beginnen!}}<br />
<br />
=== Vorbereitung und Definition in FHEM ===<br />
Unabhängig von dem konkret genutzten IO-Modul (MQTT2_SERVER oder MQTT2_CLIENT) sollte an diesem '''''vor''''' den nachfolgenden Schritten zunächst das autocreate ausgeschaltet werden. Weiter sollte geprüft werden, ob es bereits MQTT2_DEVICE-Geräte gibt, die Einträge in der ''readingList'' enthalten, die vom ebus stammen. Da wir die ''readingList'' anschließend mit erweiterten JSON-Optionen erstellen wollen, müssen zumindest sämtliche ''readingList''-Attribute entsprechend bereinigt oder gelöscht werden; in der Regel ist es einfacher, diese Geräte nach dem Deaktivieren des autocreate am IO zu löschen.<br />
{{Randnotiz|RNTyp=y|RNText=Sollten Sie MQTT2_CLIENT als IO nutzen, sollte für das weitere Vorgehen eine Kopie des MQTT2-"Sammeldevices" genutzt werden, und dessen ''CID'' auf ''ebusd'' geändert werden. Nach Anwendung des ebusd-splitter-templates müssen dann alle den ebus betreffenden Einträge aus der ''readingList'' des "Sammeldevices" gelöscht werden oder diese ganz gelöscht.}}Ist der ebus-Dämon lauffähig und für MQTT konfiguriert, sendet dieser regelmäßige Messages. <br />
<br />
Sind die Vorbereitungen abgeschlossen, aktivieren wir ''autocreate'' wieder, allerdings wählen wir als autocreate-Methode ''complex'' aus, da der eBus-Dämon teilweise<ref>Dies betrifft vorrangig die Statusmeldungen</ref> eine weiter verschachtelte JSON-Struktur zum Versenden der Informationen verwendet als üblich. Danach wird wie bei den anderen o.g. Geräten automatisch ein neues MQTT2_DEVICE angelegt<ref>Bei Verwendung des MQTT2_CLIENT wird dann die ''readingList'' am bereits definierten MQTT2_DEVICE aus der Kopie des "Sammeldevice" automatisch wieder erstellt bzw. gefüllt.</ref><br />
<br />
==== "ebus-Bridge" ====<br />
Auf das von ''autocreate'' erstellte MQTT2_DEVICE wird nunmehr das template ''eBus_daemon_splitter'' angewendet. Nach einiger Zeit sollte sowohl die readingList an diesem Device erweitert worden sein, wie auch ein oder mehrere neue MQTT2_DEVICE-Geräte angelegt. <br />
Dieses Device liefert zukünftig Readings zum Dämon selbst, wie dessen ''uptime'', alle weiteren am eBus angeschlossenen Teilnehmer werden dagegen zweckmäßigerweise durch ein oder mehrere weitere MQTT2_DEVICE-Geräte dargestellt. <br />
<br />
Das ''attrTemplate'' läd eine weitere ''attrTemplate''-file und [[99 myUtils anlegen|99_myUtils-Code]] vom FHEM-Server nach. Beides steht dann auch unmittelbar zur Nutzung zur Verfügung. <br />
==== "ebusd_bai" und weitere Geräte ====<br />
{{Hinweis|Der eBus-Dämon sendet nicht alle Informationen zu allen am eBus angeschlossenen Geräte automatisch. Diese müssen teilweise erst aktiv angefragt werden. Wie das im einzelnen erfolgen kann, ist dem o.g. Detailartikel zu entnehmen.}}<br />
Funktioniert die Kommunikation zwischen dem eBus-Dämon und FHEM, sollte nach einigen Minuten zumindest ein weiteres Gerät namens ''MQTT2_ebus_bai'' angelegt worden sein.<br />
<br />
== Sonos2Mqtt ==<br />
Aus einem Versuch heraus ist ein {{Link2Forum|Topic=111711|LinkText=kleines Projekt}} geworden: Die Sonos Umgebung mit Hilfe von sonos2mqtt als generisches MQTT2_DEVICE komfortabel in FHEM einzubinden.<br />
<br />
Mit Hilfe von ein paar Templates ist die grundlegende Einbindung in FHEM nach einer kleinen Installation auf Systemebene schnell erledigt. Es läuft derzeit noch zahlreiche Entwicklung und Ideenfindung, die Fortschritte sind live im Thread oder [[Sonos2mqtt|konsolidiert im Wiki]] zu finden.<br />
<br />
=== Setup im System ===<br />
Voraussetzung: nodejs und pm2 ist installiert und für alle Benutzer verfügbar. Je nach Entwicklungsstand sind auch Betaversionen verfügbar. Für aktuelle Beta einfach anstatt sonos2mqtt -> sonosmqtt@3.1.0-beta.1 beim Setup verwenden.<syntaxhighlight lang="bash"><br />
sudo npm install -g sonos2mqtt<br />
</syntaxhighlight><br />
<br />
=== Setup in FHEM ===<br />
Man definiert lediglich ein Bridge Device, der Rest wird automatisch erledigt.<br />
<br />
Voraussetzung: <br />
* autocreate im System ist aktiv. <br />
* Der verwendete MQTT2_SERVER steht auf '''autocreate simple''' (default/Standard).<br />
Bei der Anwendung des Template für die Bridge wird der Topic (default: sonos) abgefragt! Einfach eintippen und ok drücken. <br />
<br />
Der folgende Code muss modifiziert werden! Den Abschnitt [[MQTT2-Module - Praxisbeispiele#Start sonos2mqtt|Start sonos2mqtt]] beachten!<br />
<br />
'''Achtung dieser Code muss "am Block" in der Raw Def ausgeführt werden!''' <br />
# man kopiert diesen Codeblock, <br />
# drückt im Webinterface das große + ,<br />
# und fügt den Code ins Editorfenster ein. <br />
# Dort muss/kann man die persönlichen Anpassungen machen. <br />
# Zum Abschluss execute - fertig<br />
<syntaxhighlight lang="perl"><br />
define SonosBridge MQTT2_DEVICE<br />
attr SonosBridge IODev NameDesVorhandenenMQTT2Servers<br />
attr SonosBridge room MQTT2_DEVICE<br />
define n_pm2_sonos notify global:INITIALIZED|n_pm2_sonos:start "pm2 -s start sonos2mqtt -- --mqtt mqtt://myuser:the_secret_password@192.168.0.3:1800"<br />
sleep global:ATTR.SonosBridge.stateFormat.connected;trigger n_pm2_sonos start<br />
set SonosBridge attrTemplate sonos2mqtt_bridge_comfort<br />
</syntaxhighlight>Der obige Code startet sowohl das sonso2mqtt Modul sofort und implentiert ein notify für den zukünftigen automatischen Start beim Start von FHEM.<br />
<br />
Das hier verwendete Template sonos2mqtt_bridge_comfort: <br />
* setzt das Template sonos2mqtt_bridge auf das Device SonosBridge<br />
* definiert zwei notify, diese erledigen im weiteren Betrieb die automatische Konfiguration der automatisch erzeugten MQTT2_DEVICEs <br />
** mit dem Template sonos2mqtt_speaker.<br />
** Ermitteln Detailinformation des jeweiligen Players (vor allem IP Adresse und Modelnumber)<br />
** Laden die Sonosgeräte Icons von den UPNP Devices herunter<br />
** erweitern das setList input Kommando um den TV Eingang (HDMI, spdif) bzw. Line_IN Eingang falls vorhanden (Modelnumber)<br />
<br />
==== Wozu dient die Bridge? ====<br />
Sie stellt ein paar wesentliche Funktionen zu Verfügung<br />
# Auffangen von nicht benötigten MQTT Nachrichten<br />
# Erzeugung/Weiterleitung von Nachrichten für die einzelnen Player - damit auch die Erzeugung von separaten Playern nach dem Schema MQTT2_RINCON12345678901234567<br />
# Status sonos2mqtt als Reading connected (0 offline, 1 connected, 2 Player connected)<br />
Sie kann auch als zentrales Device verwendet werden um die Sonos Umgebung abzubilden, z.B. Readings für Favoriten u.ä.<br />
<br />
==== Start sonos2mqtt ====<br />
Soll das Modul sonos2mqtt mit seinen default Einstellungen gestartet werden genügt dieser kurze Befehl:<syntaxhighlight lang="bash"><br />
"pm2 start sonos2mqtt"<br />
</syntaxhighlight>Ist der MQTT2_SERVER in FHEM nicht "einfach so" sondern mit anderen Einstellungen erstellt und mit allowed abgesichert, müssen weiter Parameter übergeben werden. Dies erfolgt mit dem doppelten Bindestrich -- hinter dem nodejs Modul.<br />
<br />
Beispiel:<syntaxhighlight lang="perl"><br />
"pm2 start sonos2mqtt -- --mqtt mqtt://myuser:the_secret_password@192.168.0.3:1800"<br />
</syntaxhighlight>Tipp: Verwendet man anstatt "Befehl" den Syntax {qx(Befehl)} in der FHEM Kommandozeile, wirkt der Befehl zwar blockierend aber die Ausgabe erfolgt im Browser und nicht im Logfile. Mit dem Parameter -s erfolgt keine Ausgabe.<br />
<br />
==== Autostart von sonos2mqtt mit pm2 (Alternative) ====<br />
Der obige Code startet das sonos2mqtt nodejs Modul mit pm2 beim Start von FHEM. Sollte das nicht funktionieren oder nicht ins gesamte Konzept passen (weil z.B. mehrere nodejs Module geladen werden) kann der automatische Start direkt im System erfolgen. Zunächst dafür das oben eventuell schon definierte notify löschen!<syntaxhighlight lang="perl"><br />
delete n_pm2_sonos<br />
</syntaxhighlight>Der Start des Modul muss nicht mit erhöhten Rechten geschehen! Im Terminal folgendes eingeben (unter dem angemeldeten Benutzer wird sonos2mqtt später immer gestartet):<syntaxhighlight lang="bash"><br />
pm2 start sonos2mqtt<br />
pm2 startup<br />
</syntaxhighlight>Der letzte Befehl "redet", d.h. es gibt eine Ausgabe in der Art:<syntaxhighlight lang="bash"><br />
[PM2] To setup the Startup Script, copy/paste the following command:<br />
sudo env PATH=$PATH:/usr/bin /usr/lib/node_modules/pm2/bin/pm2 startup systemd -u pi --hp /home/pi<br />
</syntaxhighlight>Man tut einfach genau das, was dasteht: die letzte Zeile kopieren und wieder einfügen und ausführen. Danach muss man die Konfiguration von pm2 noch sichern:<syntaxhighlight lang="bash"><br />
pm2 save<br />
</syntaxhighlight><br />
<br />
=== Sonos2mqtt mit mehr Komfort ===<br />
Im Wiki Artikel [[Sonos2mqtt]] geht es weiter.<br />
<br />
== Allgemeine Hinweise ==<br />
=== MQTT2_SERVER und MQTT2_CLIENT für Debugging nutzen ===<br />
Nutzt man das rawEvents-Attribut am MQTT2-IO<ref>z.B. <code>attr MQTT2_FHEM_Server rawEvents .*</code>, der regex-Filter kann wie üblich angepasst werden</ref>, kann man den Datenverkehr des Servers am Event-Monitor mitschneiden. Dies ist insbesondere für unbekannte Geräte nützlich, deren Topic- und Payload-Struktur noch nicht bekannt ist.<br />
Um den kompletten MQTT Datenaustausch mitzuschneiden, kann man mit <code>attr mqtt2_server verbose 5</code> auch alles ins FHEM-Log schreiben lassen.<br />
<br />
=== autocreate funktioniert anscheinend nicht? ===<br />
In der Regel wird bei neu eingehenden MQTT-Messages über ''autocreate'' ein neues Device erstellt, wenn Nachrichten von einem bisher unbekannten Gerät kommen. Geschieht dies nicht, sollten folgende Punkte geprüft werden:<br />
# Ein allgemeines {{Link2CmdRef|Anker=autocreate|Lang=en|Label=autocreate}}-Device (''TYPE=autocreate'') muss vorhanden und aktiv sein.<br />
# ''autocreate'' am IO muss eingeschaltet sein, was für MQTT2_SERVER bedeutet, dass es nicht auf "0" stehen darf (hier ist dann ''simple'' die aktive Voreinstellung), für MQTT2_CLIENT sollte ebenfalls ''simple'' verwendet werden; dies muss hier allerdings explizit gesetzt werden.<br />
<br />
Wird dann immer noch kein Device erstellt, gibt es in aller Regel ein Device, das bereits einen entsprechenden Eintrag in der readingList enthält, oder es sind keine Nachrichten eingegangen. Überprüfen Sie daher dann ggf. die Einstellungen am Client-Gerät (z.B. im Web-Interface des Shelly oder Tasmota-geflashten ESP8266).<br />
<br />
=== attrTemplate ===<br />
Zur Konfiguration von MQTT2_DEVICE-Geräten kann die Funktion ''[[AttrTemplate|attrTemplate]]'' genutzt werden. <br />
Die Anwendung für MQTT2_DEVICE ist [[MQTT2 DEVICE#attrTemplate|hier]] beschrieben.<br />
<br />
{{Hinweis|In einigen Fällen kann es vorkommen, dass die template-Bezeichnung zwischenzeitlich geändert wurde. Seit 21.09.2019 erfolgt die Sortierung der auswählbaren templates nicht mehr nur nach den Namen, so dass die entsprechenden Namensbestandteile entfallen sind, die einer besseren Sortierung dienten.}}<br />
<br />
=== attrTemplate: Es werden nicht alle templates angezeigt ===<br />
Siehe Beitrag [[AttrTemplate#Warum finde ich das Template xyz nicht.3F|AttrTemplate: Warum finde ich das Template xyz nicht.]]<br />
<br />
=== attrTemplate und Sprachsteuerung ===<br />
Konfiguriert man MQTT2_DEVICE-Geräte mit attrTemplate, werden in der Regel auch direkt die für die Sprachsteuerung der Geräte erforderlichen Attribute mit gesetzt. Weiterführende Hinweise sind auch zu diesem Teilaspekt von ''[[AttrTemplate|attrTemplate]]'' dem betreffenden Hauptartikel zu entnehmen.<br />
<br />
=== bridgeRegexp ===<br />
[[Datei:Mqtt2 server.png|300px|thumb|left|Logische Verortung der bridgeRegexp-Angaben]]{{Randnotiz|RNTyp=y|RNText=Beachten Sie, dass aufgrund des geschilderten Prinzips eine Änderung einer bridgeRegexp bei einem Gerät auch dazu führt, dass alle Readings eines Geräts und alle readingList-Einträge gelöscht werden.}}Üblicherweise werden alle Informationen, die aus einer Quelle stammen auch '''''einem''''' ''MQTT2_DEVICE'' zugeordnet, wobei im Falle des dort nicht aktivierten autocreate-Attributs entsprechende readingList-Einträge erzeugt werden. In dem nebenstehenden Schaubild wären dies die Geräte ''A'' bis ''D''. Das '''Attribut''' ''bridgeRegexp'' kann dazu genutzt werden, um neue, bisher unbekannte Topic-Strukturen im Rahmen des autocreate-Vorgangs anders zu strukturieren. Diese werden dabei im Ergebnis einem '''anderen Device''' (das ggf. erst erstellt wird) zugeschlagen, sollte eine zu der topic-Struktur passende regex in diesem Attribut gesetzt sein. Für dessen CID und die Bildung des Names wird die im 2. Teil jedes Eintrags als ''newClientId'' hinterlegte Angabe verwendet. In nebenstehendem Schaubild ist dies exemplarisch für die Gerätegruppe ''D'' mit dem ''bridge''-Device ''D'' und dessen ''Satelliten'' ''D1'' bis ''D4'' dargestellt.<br />
Dementsprechend sind in den hier aufgeführten Beispielen ''bridgeRegexp''-Attribute immer dort zu finden, wo ein Gerät oder Dienst dazu dient, mit weiteren, ggf. auf andere Weise kommunizierende Geräte oder Baugruppen zu kommunizieren, wie z.B. für über hier dargestellten ''zigbee2mqtt'' oder ''zigbee2tasmota''. Ein Sonderfall hierbei ist das template ''MQTT2_CLIENT_general_bridge'' zur Verwendung mit dem [[MQTT2_CLIENT#Anwendung|MQTT2_CLIENT]], denn aus dessen Sicht stammen alle Informationen aus derselben Quelle, nämlich z.B. dem ''mosquitto''-Server und würden sonst alle einem einem MQTT2_DEVICE zugewiesen.<br />
<br />
=== Ständig neue Devices? ===<br />
MQTT2_SERVER kann zwischen verschiedenen Geräten auch anhand der ClientID unterscheiden. Für jedes neu erkannte Gerät wird auch ein eigenes MQTT2_DEVICE angelegt. Abhilfemaßnahmen:<br />
==== Vergabe einer ClientID ====<br />
Die meisten MQTT-fähigen Geräte enthalten Optionen zur Vergabe einer eindeutigen ClientID (siehe das Beispiel des zigbee2mqtt-Dienstes oben). <br />
Wird keine ClientID vergeben, verwenden manche Clients für jede Verbindung wieder neue ID's. Es wird empfohlen, möglichst von diesen Einstelloptionen Gebrauch zu machen.<br />
<br />
==== Löschen der ClientID aus der readingList usw. ====<br />
Ist dies nicht möglich oder erwünscht, kann man auch die ClientID aus den readingList-, setList- und getList-Attributen entfernen. Dies ist jedenfalls solange unschädlich als nicht mehrere Geräte identische Topic-Pfade verwenden (daher die Empfehlung, insbesondere bei Tasmota-Geräten den ''default'' "sonoff" zu ändern).<br />
Beispielsweise wäre <code>attr Milight_Bridge readingList milight_hub_1370325:milight/LWT:.* {json2nameValue($EVENT) }</code> zu ändern in <code>attr Milight_Bridge readingList milight/LWT:.* {json2nameValue($EVENT) }</code><br />
Die über ''attrTemplate'' verfügbaren Konfigurationen verwenden in der Regel keine ClientID's bzw. entfernen diese.<br />
<br />
=== Wildcards in readingList und setList ===<br />
Auch in readingList und in setList sollten sich sog. wildcards verwenden lassen. Die Vorgehensweise ist jedoch unterschiedlich:<br />
<br />
In ''readingList'' werden normale regex-Ausdrücke verwendet. Ein Punkt steht daher z.B. für ein beliebiges Zeichen, alles zwischen zwei Topic-Tree-Elementen (getrennt typischerweise durch einen "/") kann man so schreiben: "[^/]+" (entspricht: "Mindestens ein Zeichen, das kein Schrägstrich ist"). Ergänzender Hinweis: Will man z.B. Informationen aus einem beliebigen Teil des Topic-trees extrahieren und als Reading-Namen verwenden, kann dies im Rahmen eines Perl-Aufrufs geschehen. Beispiele aus der mqtt2.template-file: OpenMQTTGateway_BT_scanner und OpenMQTTGateway_BT_gtag (letzteres überführt die Information, über welches Gateway bestimmte Informationen eingegangen ist jeweils in eigene Readings pro Gateway).<br />
<br />
In ''setList'' gelten dagegen die wildcard-Konventionen aus der MQTT-Welt. Dort steht "+" für einen austauschbaren Teil des Topic-Trees (zwischen zwei Schrägstrichen). Anmerkung: Bitte vorher prüfen, ob es wirklich sinnvoll ist, derart unspezifische Publishes vorzunehmen. Meist gibt es "Gruppen-Topics", auf die mehrere Geräte eines bestimmten Typs hören bzw. man kann dies dort (in der firmware bzw. auf den Konfigurationsseiten der Geräte) einstellen.<br />
<br />
=== Die JSON-Daten sollen ausnahmsweise nicht ausgepackt werden ===<br />
In manchen Fällen ist das automatische Auspacken der JSON-Payload nicht erwünscht. In diesen Fällen kann man einfach den gewünschten Reading-Namen in die readingList eintragen, statt der Anweisung, den JSON an json2NameValue() zu übergeben. Aus<br />
<syntaxhighlight>attr MQTT_OwnTracks readingList owntracks/clouduser/mi6:.* { json2nameValue($EVENT) }\<br />
owntracks/clouduser/mi6/waypoints:.* { json2nameValue($EVENT) }\<br />
owntracks/clouduser/mi6/event:.* { json2nameValue($EVENT) }<br />
</syntaxhighlight><br />
wird dann:<br />
<syntaxhighlight><br />
attr MQTT_OwnTracks readingList owntracks/clouduser/mi6:.* json_mi6\<br />
owntracks/clouduser/mi6/waypoints:.* json_waypoints\<br />
owntracks/clouduser/mi6/event:.* json_event<br />
</syntaxhighlight><br />
Erforderlichenfalls kann man die Einträge auch doppelt erstellen, um sowohl den JSON wie auch die ausgepackten Readings zu erhalten.<br />
<br />
=== Weiterführende Themen ===<br />
==== Verbinden mehrerer FHEM-Instanzen über MQTT ====<br />
Wie im Hauptartikel zu [[MQTT#Kommunikation zu sonstigen FHEM-Geräten über MQTT|MQTT]] erläutert, gibt es mehrere Varianten, wie man mit Hilfe von FHEM aus Events an beliebigen Geräten MQTT-Messages erzeugen kann. So kann man z.B. Messdaten eines Systems über ein ''notify'' iVm. einer einfachen ''publish''-Anweisung an ein zweites FHEM schicken, das diese Daten dann z.B. mit Hilfe der MQTT2-Module auswerten kann.<br />
Damit dabei Nachrichten unterschiedlicher Quellen auch als getrennte Readings bzw. ggf. auch gesonderten MQTT2_DEVICE-Instanzen zugeordnet werden, sollte man entsprechende Topic-Strukturen wählen, die dann auch mit Hilfe einer geeigneten ''bridgeRegexp'' automatisiert ausgewertet werden kann, siehe z.B. dieser {{Link2Forum|Topic=107145|LinkText=Forumsthread}}:<br />
attr MQTT2_myMqttServer bridgeRegexp \<br />
SmartHome/MqttGenericBridge2/([A-Za-z0-9]*)/.*:.* "mgb2_$1"<br />
Dabei werden die betreffenden Informationen der entfernten FHEM-Instanz alle nach dem Schema ''SmartHome/MqttGenericBridge2/<Device-Name>/<Reading-Name>'' versendet.<br />
<br />
==== Umstellung von MQTT_DEVICE (und Derivaten wie XiaomiMQTTDevice) zu MQTT2_DEVICE ====<br />
Wer beabsichtigt, von der Implementierung MQTT+MQTT_DEVICE zu MQTT2-IO und MQTT2_DEVICE zu wechseln, sollte einige Punkte beachten. Viele diesbezügliche Fragen sind vor allem in {{Link2Forum|Topic=103762|LinkText=diesem Foren-Thread}}<br />
<br />
näher erläutert.<br />
<br />
== Links ==<br />
* {{Link2Forum|Topic=91394|LinkText=Thread, aus dem diese Anleitung ursprünglich entstanden ist}}<br />
* {{Link2Forum|Topic=91807|LinkText=Thread zum Tasmota-Device}}<br />
* {{Link2Forum|Topic=97989|LinkText=Thread, aus dem diese Anleitung für den eBus ursprünglich entstanden ist}}<br />
* {{Link2Forum|Topic=94495|LinkText=Neue templates einreichen}}<br />
* {{Link2Forum|Topic=94494|LinkText=Fragen, Wünsche und Kritik zu mqtt2.template}}<br />
<br />
== Hinweise ==<br />
<references /><br />
[[Kategorie:HOWTOS]]<br />
[[Kategorie:MQTT]]<br />
[[Kategorie:ZigBee]]<br />
[[Kategorie:IP Components|IP Komponenten]]<br />
[[Kategorie:Other Components]]<br />
[[Kategorie:Interfaces]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=Knxd&diff=23010Knxd2017-10-21T19:44:42Z<p>Fidel: </p>
<hr />
<div>= knxd mit einem IP Gateway einrichten =<br />
Damit FHEM auf den KNX Bus zugreifen kann, benötigt man ein passendes Interface<br />
<br />
Es gibt:<br />
<br />
* RS232<br />
* USB<br />
* IP<br />
<br />
Ich beschreibe die Einrichtung von knxd mit einem IP Gateway auf einen Raspberry Pi2 mit Wheezy oder Jessie.<br />
<br />
== Installation ==<br />
<br />
<br />
'''1. als erstes müssen folgende Pakete installiert werden (Referenz Debian Jessie):'''<br />
<syntaxhighlight lang="bash">sudo apt-get update<br />
sudo apt-get install debhelper cdbs automake libtool libusb-1.0-0-dev git-core build-essential libsystemd-daemon-dev dh-systemd libev-dev cmake<br />
</syntaxhighlight><br />
<br />
'''1.1 als erstes müssen folgende Pakete installiert werden (Referenz Debian Stretch):'''<br />
<syntaxhighlight lang="bash">sudo apt-get update<br />
sudo apt-get install debhelper cdbs automake libtool libusb-1.0-0-dev git-core build-essential libsystemd-dev dh-systemd libev-dev cmake<br />
</syntaxhighlight><br />
<br />
<br />
'''2. knxd herunterladen und installieren'''<br />
Achtung: Wenn Abhängigkeiten fehlen, dann installiere diese nach. Nicht einfach mittels "-d" diese übergehen!<br />
<syntaxhighlight lang="bash"><br />
git clone https://github.com/knxd/knxd.git<br />
cd knxd<br />
git checkout stable<br />
dpkg-buildpackage -b -uc<br />
cd ..<br />
sudo dpkg -i knxd_*.deb knxd-tools_*.deb<br />
</syntaxhighlight><br />
<br />
== Konfiguration ==<br />
'''1. Ohne systemd'''<br />
<br />
es muss als nächstes die Konfigurationsdatei editiert werden.<br />
<br />
das geht mit:<br />
<syntaxhighlight lang="bash"><br />
sudo nano /etc/default/knxd <br />
</syntaxhighlight><br />
dann folgende Einträge anpassen:<br />
<syntaxhighlight lang="bash"><br />
DAEMON_ARGS="-u /tmp/eib -u /var/run/knx -i -b ipt:192.168.188.XX"<br />
</syntaxhighlight><br />
und<br />
<syntaxhighlight lang="bash"><br />
START_KNXD=YES<br />
</syntaxhighlight><br />
'''2. Mit systemd z. B. für Debian Jessie'''<br />
<br />
Die Konfigurationsdatei bei Jessie hat sich wegen der Nutzung von systemd geändert:<br />
<syntaxhighlight lang="bash"><br />
sudo nano /etc/knxd.conf <br />
</syntaxhighlight><br />
dann folgende Einträge anpassen:<br />
<syntaxhighlight lang="bash"><br />
KNXD_OPTS="-u /tmp/eib -u /var/run/knx -b ipt:192.168.188.XX"<br />
</syntaxhighlight><br />
und<br />
<syntaxhighlight lang="bash"><br />
START_KNXD=YES<br />
</syntaxhighlight><br />
== knxd Status überprüfen ==<br />
<syntaxhighlight lang="bash"><br />
/etc/init.d/knxd status<br />
</syntaxhighlight><br />
<br />
== FAQ ==<br />
'''Wie wird eibd vorher deinstalliert?'''<br />
<syntaxhighlight lang="bash"><br />
sudo rm -r /usr/local/bin/{eibd,knxtool,group*} /usr/local/lib/lib{eib,pthsem}*.so* /usr/local/include/pth*<br />
</syntaxhighlight><br />
<br />
'''folgender Fehler: dpkg-buildpackage: Fehler: Fehler-Exitstatus von debian/rules build war 2'''<br />
<syntaxhighlight lang="bash"><br />
sudo apt-get install git-core build-essential<br />
</syntaxhighlight><br />
<br />
oder<br />
<br />
<syntaxhighlight lang="bash"><br />
in der datei knxd/debian/rules die Zeile:<br />
bash tools/test.sh auskommentieren<br />
</syntaxhighlight><br />
<br />
'''Fehler: dpkg-buildpackage: error: fakeroot not found, either install the fakeroot <....> '''<br />
<syntaxhighlight lang="bash"><br />
sudo apt-get install fakeroot dpkg-dev<br />
</syntaxhighlight><br />
<br />
== Links ==<br />
[[Benutzer:Marthinx]]<br />
<br />
[https://github.com/knxd/knxd Github knxd]<br />
<br />
[https://knx-user-forum.de/forum/projektforen/knxd/1049547-grundlagen-zum-knxd-mit-installationsanleitung-vor-dem-schreiben-lesen Forums-Thread zu knxd. Sehr informativ.]<br />
<br />
[[Kategorie:Examples]]<br />
[[Kategorie:EIB/KNX]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=Alexa-Fhem&diff=17838Alexa-Fhem2016-12-16T22:19:11Z<p>Fidel: /* Alexa-Fhem installieren */</p>
<hr />
<div>'''Alexa-Fhem''' ist eine in JavaScript und auf NodeJS basierende Software, welche es ermöglicht, der digitalen Amazon Assistentin Alexa zusätzliche Skills für die Heimautomatisierung via FHEM beizubringen. Eine erste funktionierende Version wurde von [https://forum.fhem.de/index.php?action=profile;u=430 justme1968] im [https://forum.fhem.de/index.php/topic,60244.0.html Forum] veröffentlicht.<br />
Das ist eine erste Version der Dokumentation zur Installation und Einrichtung, eine Erweiterung wird sicherlich in nächster Zeit noch folgen.<br />
{{Infobox Modul<br />
|ModPurpose=Anbindung von FHEM an Amazon Assistent Alexa<br />
|ModType=x<br />
|ModTechName=<br />
|ModForumArea=Sonstige Systeme<br />
|ModOwner=justme1968<br />
}} <br />
<br />
<br />
==Einführung==<br />
<br />
===Arbeitsweise und Datenfluss===<br />
[[Datei:2gpXyLN.jpg|200px|thumb|right|Grafische Darstellung der beteiligten Komponenten]]<br />
Echo -> AVS -> AWS Lambda -> alexa-fhem -> AWS Lambds -> AVS -> Echo<br />
<br />
*Der Echo (oder ein anderes Alexa/AVS fähiges device) nimmt Audiodaten auf und schickt diese an AVS (Amazon Voice Service) zur Erkennung<br />
*AVS führt die Spracherkennung durch und erzeugt ein Event mit Informationen zu den Erkannten Daten<br />
:*Beim Custom Sill kommen die dazu nötgen Informationen aus dem ''Interaction Model'' der Alexa Skills Konfiguration<br />
:*Beim Home Automation Skill sind die möglichen Sätze fest vorgegeben <br />
*Das Event wird an den unter ''Configruation'' in der Alexa Skills Konfiguration hinterlegten Endpoint geschickt<br />
:*Beim Home Automation Skill ist das zwingend eine AWS Lambda Routine<br />
:*Beim Custom Skill kann das im Prinzip auch ein eigener Web Service sein<br />
*Das Event wird vom <code>lambda.js</code> code an alexa-fhem weitergeleitet<br />
*alexa-fhem steuert FHEM und sendet ein Antwort Event zurück<br />
*<code>lambda.js</code> nimmt diese Antwort entgegen und gibt sie an AVS zurück<br />
*AVS sogt dafür das der echo 'antwortet' und das die Card in der Alexa App erscheint<br />
<br />
===Anmerkungen===<br />
*Ein Skill hat keinen zugriff auf die Audiodaten<br />
*Mit dem Skill API kann ein Skill zu zu keiner Zeit von sich aus aktiv werden und 'einfach' Daten an den Echo schicken oder ihn dazu bringen irgendetwas zu tun.<br />
*Es ist ein kleines Wunder wie schnell die Reaktion auf einen gesprochenen Satz erfolgt wenn man berücksichtigt welchen Weg die Daten insgesamt gehen.<br />
<br />
==Installation==<br />
<br />
Grundvoraussetzung für alle folgenden Schritte ist, dass ein Amazon-Account vorhanden ist. Es wird davon ausgegangen, dass bereits für alle folgenden Amazon-Dienste vorab das Konto jeweils eingerichtet wurde, die Einrichtung dieser ist nicht Bestandteil dieser Anleitungen.<br />
<br />
Es sei an dieser Stelle darauf hingewiesen, dass für die Nutzung der Amazon AWS-Dienste zwingend die Daten einer Kreditkarte angegeben werden müssen. Nach gegenwärtigem Kenntnisstand sollen jedoch keine Kosten für die Nutzung der im Rahmen dieses How To beschriebenen Dienste anfallen, sofern diese in einem Rahmen genutzt werden, der selbst eine intensive private Nutzung nicht überschreitet. Der Benutzer sei an dieser Stelle auf die von Amazon veröffentlichten Preislisten verwiesen.<br />
<br />
{{Randnotiz|RNTyp=[g|Info]|RNText=Da die einzelnen Schritte der Anleitung an verschiedenen Stellen unterbrochen und später fortgesetzt werden müssen, empfiehlt es sich, die Anleitung einmal vollständig gelesen zu haben. Dies vermeidet Fehler, die ansonsten geschehen können. Während der Konfiguration bietet es sich an diese Schritte dann parallel in gleichzeitig geöffneten Browserfenster durchzuführen. }}<br />
<br />
<br />
=== Voraussetzungen ===<br />
Folgende grundlegende Voraussetzungen sollten erfüllt sein, bevor du mit der Einrichtung beginnst:<br />
* Amazon Echo oder Amazon Dot<br />
* node.js (vermutlich ab Version 0.12.7, getestet mit 4.2.6. Kann in Debian z.B. mit <source lang="bash" style="width:50%;">sudo apt-get install nodejs-legacy</source> installiert werden)<br />
* Weiterleitung von Port 3000 vom Router aus auf den Rechner, auf dem Alexa-Fhem läuft<br />
* Es empfiehlt sich ein alexa Gerät in FHEM anzulegen.<br />
<br />
=== Alexa-Fhem installieren ===<br />
# Die tgz-Datei entpacken (Quelle: https://forum.fhem.de/index.php/topic,60244.0.html) (neuere Version verügbar, bitte Hinweise unter Custom Skill beachten:https://forum.fhem.de/index.php/topic,60244.msg540117.html#msg540117)<br />
# Verzeichnis ''package'' in ''alexa-fhem'' umbenennen<br />
# Durch <source lang="bash" style="width:50%;">cd alexa-fhem</source> in das Verzeichnis wechseln<br />
# Mit (kein sudo!) <source lang="bash" style="width:50%;">npm install</source> alle Abhängigkeiten installieren<br />
# SSL Zertifikat erzeugen durch Aufruf von (kein sudo!)<source lang="bash" style="width:50%;">./createKey.sh</source>. Hierbei beachten, dass ein Kennwort vergeben werden soll, das mindestens aus 4 Zeichen besteht.<br />
# Die Datei ''config-sample.json'' nach ''~/.alexa/config.json'' kopieren und die Werte auf die eigene Umgebung hin anpassen. Der Filter funktioniert hierbei wie bei [http://www.fhemwiki.de/wiki/Homebridge_einrichten#Einstellungen_f.C3.BCr_homebridge homebridge-fhem],die folgenden Zeilen sind anzupassen oder zu löschen:<br>"nat-pmp": -> wenn nat-pmp verwendet werden soll: die ip des eigenen routers,<br>"nat-upnp": -> wenn nat-upnp verwendet werden soll: ''true'',<br>"applicationId": -> SkillID aus "Alexa Custom Skill anlegen" Punkt 7 (s.u.),<br>"oauthClientID": -> ''Client Id'' aus Punkt 1. '''Login with Amazon'''<br />
# Durch Aufruf von <source lang="bash" style="width:50%;">./bin/alexa</source> den Dienst starten (kein sudo!)<br />
<br />
Der Start des Alexa-Dienstes auf der Console ist immer dann zu empfehlen, wenn man auf die Ausgaben des Dienstes angewiesen ist und beispielsweise sehen möchte, welche Devices durch den Dienst bereitgestellt werden oder ob Fehler auftreten. Beendet man die Console-Session wird auch der Dienst wieder beendet. Insofern ist die vorgenannte Vorgehensweise nur für ein Debugging zu empfehlen und nicht im Regelbetrieb. Nachfolgend ist beschrieben, wie man den Alexa-Dienst aus FHEM heraus starten / stoppen und neu starten kann.<br />
<br />
=== Alexa-Fhem aus FHEM heraus starten ===<br />
Zunächst das Start-up-Skript aus diesem Post herunterladen [https://forum.fhem.de/index.php/topic,60244.msg517271.html#msg517271 https://forum.fhem.de/index.php/topic,60244.msg517271.html#msg517271] und unter /etc/init.d/alexa speichern.<br />
<br />
Das Script geht davon aus, das der alexa-fhem script unter /opt/fhem/alexa-fhem liegt, und die logfiles später unter /opt/fhem/log. Sollte das nicht der Fall sein, muss das Skript angepasst werden.<br />
<br />
Nun folgende Kommandos ausführen:<br />
<source lang="bash" style="width:50%;">sudo chmod 755 /etc/init.d/alexa<br />
sudo update-rc.d alexa defaults</source><br />
<br />
In der Datei <code>/etc/sudoers</code> den User fhem für die Nutzung von sudo zulassen (<code>sudo nano /etc/sudoers</code>), z.B. durch Anfügen der nachfolgenden Zeile:<br />
<code>fhem ALL=(ALL) NOPASSWD: ALL</code><br />
<br />
Nun folgende Devices anlegen (ggf. einem Raum zuordnen, z.B. AlexaControl):<br />
<br />
<source lang="bash" style="width:75%;">define FHEM.Alexa.Status dummy</source><br />
<br />
<br />
<source lang="bash" style="width:75%;">define FHEM.Alexa dummy<br />
attr FHEM.Alexa event-on-change-reading state<br />
attr FHEM.Alexa webCmd status:start:stop:restart</source><br />
<br />
<br />
<source lang="bash" style="width:75%;">define FHEM.Alexa.DOIF DOIF ([FHEM.Alexa] eq "start") <br />
(set FHEM.Alexa on, {system ("sudo /etc/init.d/alexa start > /dev/null 2>&1 &")}) <br />
DOELSEIF ([FHEM.Alexa] eq "stop") <br />
(set FHEM.Alexa on, {system ("sudo /etc/init.d/alexa stop > /dev/null 2>&1 &")}) <br />
DOELSEIF ([FHEM.Alexa] eq "restart") <br />
(set FHEM.Alexa on, {system ("sudo /etc/init.d/alexa restart > /dev/null 2>&1 &")}) <br />
DOELSEIF ([FHEM.Alexa] eq "status") <br />
(set FHEM.Alexa on, {system ("sudo /etc/init.d/alexa status > /dev/null 2>&1 &")})</source><br />
<br />
=== Alexa Device mit dem Modul 39_alexa.pm anlegen ===<br />
<br />
Das Modul 39_alexa.pm stellt innerhalb von FHEM verschiedene Attribute z.B. alexaName oder alexaRoom zur Verfügung. Manche dieser Attribute (wie z.b. alexaName) werden in beiden Skills verwendet, andere werden ausschließlich bei einer Nutzung des Alexa Custom Skill verwendet.<br />
<br />
Die Einrichtung des Alexa Device geschieht durch die nachfolgende Definition:<br />
<source lang="bash" style="width:70%;">define MyAlexa alexa</source><br />
<br />
=== Alexa Skills anlegen ===<br />
<br />
==== Abgrenzung des '''Alexa Smart Home Skills''' und des '''Alexa Custom Skills''' ====<br />
<br />
Der Alexa Smart Home Skill ist ein Amazon-Alexa-Standard-Skill, der wesentliche Basisfunktionalitäten bereitstellt. Zu diesen gehört im Wesentlichen die Funktionalität, durch Alexa-FHEM bereitgestellte Devices im Alexa-Account des Benutzers anzulegen. Der Alexa Smart Home Skill reagiert auf gesprochene Interaktion in einem beschränkten Umfang. Beispielsweise genügt ein "Alexa, schalte die Wohnzimmerlampe an" um eine Interaktion zwischen Alexa Smart Home Skill und FHEM-Alexa auszulösen. Nach erfolgreicher Einrichtung wird dieser Skill in der Alexa-App bzw. im Web in der Rubrik "Smart Home" als Skill angezeigt.<br />
<br />
Der Alexa Custom Skill ist kein Standard-Smart-Home-Skill, sondern ein individuell entwickelter Skill, so wie alle anderen Skills auch. Er wird daher auch nicht in der Alexa-App unter der Rubrik "Smart Home" angezeigt. Gesprochene Interaktion mit diesem Skill erfolgt dadurch, dass entweder der Skill explizit gestartet wird (z.B. "Alexa, starte [Name des Skills]") oder direkt angesprochen wird (z.B. "Alexa, frage [Name des Skills] wie ist der Status von [Device] "). Der Alexa Custom Skill befindet sich in Entwicklung und wird hinsichtlich seiner Funktionalitäten laufend weiterentwickelt. Die Einrichtung dieses Skills ist grundsätzlich optional, jedoch werden anspruchsvollere Steuerungsmöglichkeiten nur mit diesem realisiert werden können.<br />
<br />
=== Alexa Smart Home Skill anlegen ===<br />
Für folgende Schritte muss man unter der Adresse http://developer.amazon.com angemeldet sein<br />
# Anmeldung auswählen<br />[[Datei:Developer.amazon.com-01-login2.png|200px]]<br />
# Anmeldedaten eingeben<br />[[Datei:Developer.amazon.com-02-userpass2.png|200px]]<br />
<br />
==== Apps & Services ====<br />
# Klicke nach der Anmeldung auf ''APPS & SERVICES''<br />[[Datei:Developer.amazon.com-03-apps_and_services.png|200px]]<br />
# Klicke anschließend auf ''Security Profiles''<br />[[Datei:Developer.amazon.com-05-apps_and_services_-_security_profiles.png|200px]]<br />
# Wähle anschließend ''Create a New Security Profile'' aus<br />[[Datei:Developer.amazon.com-06-apps_and_services_-_create_a_new_security_profile.png|200px]]<br />
# Gebe dann ein Namen und eine Beschreibung für das Profil ein und bestätige die Eingaben durch anklicken von ''Save''<br />[[Datei:Developer.amazon.com-07-apps_and_services_-_security_profile_management.png|200px]]<br />
<br />
==== Login with Amazon ====<br />
{{Randnotiz|RNTyp=[g|Info]|RNText=Hier wird beschrieben, wo ''Client Id'' und ''Client Secret'' zu finden ist}}<br />
# Nachdem du die vorherigen Schritte befolgt hast, siehst du im Browser das Profil dass du angelegt hast. Klicke jetzt oben rechts auf ''Login with Amazon''<br/>[[Datei:Developer.amazon.com-08-login_with_amazon.png|200px]]<br />
# Auf der neu geladenen Seite klickst du dann auf ''Sign up''<br/>[[Datei:Developer.amazon.com-09-login_with_amazon_-_sign_up.png|200px]]<br />
# Wähle anschließend im Dropdown Menü das vorher angelegte Profil aus und bestätige das anschließend mit ''Confirm''<br/>[[Datei:Developer.amazon.com-10-login_with_amazon_-_create_new_profile.png|200px]] [[Datei:Developer.amazon.com-11-login_with_amazon_-_create_new_profile2.png|200px]]<br />
# Im folgenden Fenster gibst du dann die Adresse [https://www.amazon.com/gp/help/customer/display.html?nodeId=468496 https://www.amazon.com/gp/help/customer/display.html?nodeId=468496] ein und bestätigst die Eingabe mit ''Save''<br/>[[Datei:Developer.amazon.com-12-login_with_amazon_-_enter_consent_screen_information.png|200px]]<br />
# Klicke dann bei dem neu angelegten Eintrag auf der rechten Seite auf das Zahnrad und wähle ''Web Settings'' aus<br/>[[Datei:Developer.amazon.com-13-login_with_amazon_-_web_settings.png|200px]]<br />
# Im neu geladenen Fenster klickst du dann auf ''Edit''<br/>[[Datei:Developer.amazon.com-14-login_with_amazon_-_edit.png|200px]]<br />
# Füge zuletzt dann bei ''Allowed Return URLs'' die Adresse [https://layla.amazon.co.uk/api/skill/link/xxx https://layla.amazon.co.uk/api/skill/link/xxx], [https://pitangui.amazon.com/api/skill/link/xxx https://pitangui.amazon.com/api/skill/link/xxx], und [https://layla.amazon.com/api/skill/link/xxx https://layla.amazon.com/api/skill/link/xxx] hinzu. xxx muss hierbei durch den Wert ersetzt werden, der bei Punkt 6 '''Skill Kit einrichten''' unter '''Redirect Urls''' am Ende der URLs angezeigt wird.<br/>[[Datei:Developer.amazon.com-15-login_with_amazon_-_allowed_return_urls.png|200px]]<br />
<br />
==== Skill Kit einrichten ====<br />
# Wähle im Menü den Punkt ''Alexa'' aus<br />[[Datei:Developer.amazon.com-03-apps_and_services.png|200px]]<br />
# Klicke dann ''Get started'' beim Punkt ''Alexa Skills Kit'' an<br />[[Datei:Developer.amazon.com-17-alexa_-_alex_skills_kit_-_get_started.png|200px]]<br />
# Wähle dann auf der neu geladenen Seite oben rechts ''Add a New Skill'' aus<br />[[Datei:Developer.amazon.com-18-alexa_-_alex_skills_kit_-_add_a_new_skill.png|200px]]<br />
# Auf der folgenden Seite wählst du ''Smart Home Skill API'' sowie ''German'' als Sprache aus und gibst ein Name für den Skill ein was du dann mit ''Next'' bestätigst.<br />[[Datei:Developer.amazon.com-19-alexa_-_alex_skills_kit_-_skill_information.png|200px]]<br />
# Die folgende Seite klickst du mit ''Next'' dann weiter<br />[[Datei:Developer.amazon.com-20-alexa_-_alex_skills_kit_-_interaction_model.png|200px]]<br />
# Auf der Seite Configuration gibst du dann unter '''Authorization URL''' die Adresse: <source lang="bash" style="width:70%;">https://www.amazon.com/ap/oa</source>an, bei '''Scope''': <source lang="bash" style="width:70%;">profile:user_id</source> und bei '''Access Token URI''': <source lang="bash" style="width:70%;">https://api.amazon.com/auth/o2/token</source>sowie bei '''Privacy Policy URL''' die Adresse: <source lang="bash" style="width:70%;">https://www.amazon.com/gp/help/customer/display.html?nodeId=468496</source><br /><br />Folgende Felder müssen individuell ausgefüllt werden:<br />* ''Service Endpoint Type'' -> Europe auswählen und im Textfeld den Wert aus Punkt 12 '''AWS Lambda Funktion anlegen''' eintragen<br />* ''Client Id'' -> ''Client Id'' aus Punkt 1. '''Login with Amazon'''<br />* ''Client Secret'' -> ''Client Secret'' aus Punkt 1. '''Login with Amazon'''<br /><br /><br />[[Datei:Developer.amazon.com-21-alexa_-_alex_skills_kit_-_configuration.png|200px]]<br />
# <br />[[Datei:Developer.amazon.com-22-alexa_-_alex_skills_kit_-_test.png|200px]]<br />
<br />
{{Randnotiz|RNTyp=[g|Info]|RNText=Hier wird beschrieben, wo die ''Alexa Skill Id'' zu finden ist}}<br />
Zur späteren Verwendung unter Punkt 7 '''AWS Lambda Funktion anlegen''' wird noch die Application Id benötigt. An diese kommt man wie folgt:<br />
# Wähle im Menü den Punkt ''Alexa'' aus<br />[[Datei:Developer.amazon.com-03-apps_and_services.png|200px]]<br />
# Klicke dann ''Get started'' beim Punkt ''Alexa Skills Kit'' an<br />[[Datei:Developer.amazon.com-17-alexa_-_alex_skills_kit_-_get_started.png|200px]]<br />
# Beim vorher angelegten Eintrag auf ''Edit'' klicken<br />[[Datei:Developer.amazon.com-23-alexa_-_alex_skills_kit_-_overview.png|200px]]<br />
# Die Id, die nun oben angezeigt wird, ist die gesuchte <br />[[Datei:Aws.amazon.com-06-configure_triggers2.png|200px]]<br />
<br />
=== Alexa Custom Skill anlegen ===<br />
'''ACHTUNG:''' die daten unter 'interaction model' unten gelten nur für skill version 0.1.3. ab version 0.1.4 werden die daten im alexa device erzeugt. wie das geht steht hier {{Link2Forum|Topic=60244|Message=540117|LinkText=im Forum}}.<br />
<br />
Für folgende Schritte muss man unter der Adresse http://developer.amazon.com angemeldet sein<br />
# Anmeldung auswählen<br />[[Datei:Developer.amazon.com-01-login2.png|200px]]<br />
# Anmeldedaten eingeben<br />[[Datei:Developer.amazon.com-02-userpass2.png|200px]]<br />
# Wähle im Menü den Punkt ''Alexa'' aus und klicke dann ''Get started'' beim Punkt ''Alexa Skills Kit''<br />[[Datei:CustomSkill_1.PNG|400px]]<br />
# Klicke dann oben rechts auf ''Add a new skill''<br />
# Auf der Seite '''Create a new Alexa Skill''' werden folgende Optionen gewählt / Informationen eingetragen:<br />
#:* Skill Type = Custom Interaction Model<br />
#:* Language = German<br />
#:* Name: Hier dem Skill einen beliebigen Namen geben. Dieser wird in der Alexa App unter "Meine Skills" angezeigt.<br />
#:* Invocation Name: Name des Skills, unter dem dieser später gestartet wird. Z.B. "Alexa, starte James"<br />[[Datei:CustomSkill_2.PNG|400px]]<br />
# Mit ''Next'' die Seite verlassen.<br />
# Auf der Seite '''Interaction Model''' folgende Eingaben tätigen:<br />
#:* In die Box '''Intent Schema''' den Programmcode aus folgendem Post einfügen: [https://forum.fhem.de/index.php/topic,60244.msg528230.html#msg528230 https://forum.fhem.de/index.php/topic,60244.msg528230.html#msg528230]<br />[[Datei:CustomSkill_3.PNG|400px]]<br />
{{Randnotiz|RNTyp=[g|Info]|RNText=Hier wird bereits die Skill ID angezeigt (siehe Screenshot), die später als zusätzlicher Trigger für AWS Lambda verwendet wird. Bitte per Copy / Paste speichern.}}<br />
:* Nun auf ''Add Slot Type'' klicken und die Custom Slot Types (siehe [https://forum.fhem.de/index.php/topic,60244.msg528230.html#msg528230 https://forum.fhem.de/index.php/topic,60244.msg528230.html#msg528230]) einrichten. Bitte beachten, dass das Pipeline-Zeichen einen Zeilenumbruch darstellen soll. Im Screenshot ist sichtbar, wie das aussehen muss.<br /> Für FHEM_DEVICE und FHEM_ROOM bitte die eigenen in FHEM definierten Devices und Räume benennen (siehe oben alexaName und alexaRoom).<br /><br />
[[Datei:CustomSkill_4.PNG|400px]]<br /><br />
Der Screenshot zeigt die Einrichtung für FHEM_DEVICE. Nach der Einrichtung von FHEM_DEVICE ''SAVE'' klicken und die weiteren Slot Types (FHEM_ROOM, FHEM_SWITCH_ACTION und FHEM_artikel) jeweils durch klicken auf ''Add Slot Type'' einrichten.<br />
:* Unter Sample Utterances bitte den Text aus [https://forum.fhem.de/index.php/topic,60244.msg528230.html#msg528230 https://forum.fhem.de/index.php/topic,60244.msg528230.html#msg528230] reinkopieren<br />[[Datei:CustomSkill_5.PNG|400px]]<br />
#:* Eingaben mit ''Next'' abschließen.<br />
# Auf der Folgeseite ''Configuration'' bitte folgende Angaben machen:<br />
#:* Service Endpoint Type = AWS Lambda<br />
#:* Geographical Region = Europe<br />
#:* Im Feld ''Europe'' wird die ARN eingetragen, die man erst in nachfolgenden Abschnitt erhält! Es muss hier also erst mal pausiert werden! Den Browser Tab geöffnet lassen!<br />
#:* Sobald man die ARN hat geht es hier weiter...<br />
#:* Do you allow users to create an account or link to an existing account with you? = Yes<br />
#:* Authorization URL = https://www.amazon.com/ap/oa<br />
#:* Client ID = Client ID von oben aus '''Login with Amazon'''<br />
#:* Domain List - nichts eingeben<br />
#:* Scope = profile:user_id<br />
#:* Redirect URLs - sollten vorbelegt sein<br />
#:* Authorization Grant Type - Auth Code Grant auswählen<br />
#:* Access Token URI = https://api.amazon.com/auth/o2/token<br />
#:* Client Secret = siehe oben bei '''Login with Amazon'''<br />
#:* Client Authentication Scheme = HTTP Basic<br />
#:* Privacy Policy URL = https://www.amazon.com/gp/help/customer/display.html?nodeId=468496<br />
#:* Das sollte jetzt alles wie folgt aussehen:<br /><br />
[[Datei:CustomSkill_6.PNG|400px]]<br /><br />
[[Datei:CustomSkill_7.PNG|400px]]<br /><br />
:* Damit ist die Einrichtung des Custom Skill abgeschlossen. Auf der Folgeseite lässt sich der Skill dann testen. In der Alexa App sollte der Skill nun auch sichtbar sein. Er musshier noch aktiviert werden und die Kontoverknüpfung eingerichtet werden, was selbsterklärend ist.<br />
<br />
=== AWS Lambda Funktion anlegen ===<br />
Für folgende Schritte muss man unter der Adresse http://aws.amazon.com angemeldet sein<br />
# Anmeldung auswählen<br />[[Datei:Aws.amazon.com-01-site.png|200px]]<br />
# Anmeldedaten eingeben<br />[[Datei:Aws.amazon.com-02-login.png|200px]]<br />
# Den Punkt ''Lambda'' links auf der Startseite auswählen<br />[[Datei:Aws.amazon.com-03-lambda.png|200px]]<br />
# Anschließend den Punkt ''Get Started Now'' auswählen<br />[[Datei:Aws.amazon.com-04-get_started_now.png|200px]]<br />
# Den Blueprint ''Blank function'' auswählen<br />[[Datei:Aws.amazon.com-05-select_blueprint.png|200px]]<br />
# Im neuen Fenster dann auf den gestrichelten Kasten klicken und ''Alexa Smart Home'' auswählen und mit ''Next'' bestätigen<br />[[Datei:Aws.amazon.com-06-configure_triggers1.png|200px]]<br />''Achtung! Es ist möglich, dass ihr hier '''Alexa Smart Home''' überhaupt nicht auswählen könnt. Dann solltet ihr ganz rechts oben in der Ecke mal schauen, welche Region bzw. welches Land ausgewählt ist. Ich empfehle hier '''Ireland''' auszuwählen. Dann erscheint bei den Funktionen auch '''Alexa Smart Home'''.''<br />
# Bei ''Application Id'' den Wert eintragen, dessen Ermittlung unter '''Skill Kit einrichten''' in der zusätzlichen Beschreibung beschrieben wird, den Haken bei ''Enable trigger'' setzen und mit ''Next'' bestätigen <br />[[Datei:Aws.amazon.com-06-configure_triggers3.png|200px]]<br />
# Auf der Konfigurationsseite bei ''Name'' den Wert FHEM eingeben, bei ''Runtime'' Node.js 4.3. Bei ''Role'' den Wert ''Choose an existing role'' wählen (wenn es noch keine existing role gibt: zuerst Create a custom role -> in dem Popup dann lambda_basic_execution und auf Allow) und bei ''Existing role'' dann ''x'' wählen. Der Quellcode der Datei lambda.js aus dem Quellpaket wird dann an die Stelle des großen Textfeldes vollständig eingefügt. Dann noch den Hostname im Quellcode an den eigenen anpassen. Anschließend alles mit ''Next'' bestätigen.<br />[[Datei:Aws.amazon.com-07-configure_function.png|200px]]<br />
# Auf der Übersichtsseite dann ''Create function'' anklicken<br />[[Datei:Aws.amazon.com-08-review.png|200px]]<br />
# Klicke dann auf der Übersichtsseite oben links auf ''Function''<br />[[Datei:Aws.amazon.com-09-go_overview.png|200px]]<br />
# Wähle dann die angelegte Funktion aus und klicke dann im Menü ''Action'' auf den Punkt ''Show ARN''<br />[[Datei:Aws.amazon.com-10-1-show_arn.png|200px]]<br />
# Es wird nun eine ARN Adresse angezeigt, die für den Punkt 6 bei '''Skill Kit einrichten''' benötigt wird<br />[[Datei:Aws.amazon.com-10-2-arn.png|200px]]<br />
<br />
=== Alexa Skill einrichten ===<br />
# Auf http://alexa.amazon.de anmelden<br />
# Auf ''Skills'' klicken<br />[[Datei:Alexa.amazon.de-01-startseite.png|200px]]<br />
# Oben rechts ''Meine Skills'' auswählen<br />[[Datei:Alexa.amazon.de-03-meine_skills.png|200px]]<br />
# In der Liste der Skills sollte das angelegte FHEM Skill angezeigt werden. Dieses anklicken<br />[[Datei:Alexa.amazon.de-02-liste_skills.png|200px]]<br />
# Oben Rechts in den Details des Skills auf ''Skill aktivieren'' klicken<br />[[Datei:Alexa.amazon.de-04-skill_details.png|200px]]<br />
# In dem neu geöffneten Fenster die Authorisierung bestätigen<br />[[Datei:Alexa.amazon.de-05-amazon_auth.png|200px]]<br />
# Anschließend sollte die Verbindung erfolgreich aufgebaut worden sein <br />[[Datei:Alexa.amazon.de-06-success.png|200px]]<br />
<br />
=== Geräteeinrichtung ===<br />
# Auf http://alexa.amazon.de anmelden<br />
# Auf ''Smart Home'' klicken<br />[[Datei:Alexa.amazon.de-01-startseite.png|200px]]<br />
# Anschließend den Punkt ''Geräte suchen'' anklicken<br />[[Datei:Alexa.amazon.de-07-Gerätesuche.png|200px]]<br />
# Wurde soweit alles korrekt eingerichtet, werden nun die gefundenen Geräte angezeigt.<br />
<br />
Tip: Es macht Sinn, unter ''Meine Gruppen'' Gruppen benannt nach den Räumen einzurichten. Hierdurch kann Alexa die Geräte besser auseinander halten, vor allem wenn die den gleichen Alias (z.B. "Licht") haben.<br />
<br />
== Nutzung ==<br />
=== Sprachkommandos ===<br />
Nach erfolgreicher Einrichtung sollte Alexa mit den folgenden Befehlen nutzbar sein:<br />
<pre style="width:50%;"><br />
“alexa, schalte <gerät/raum> ein”<br />
“alexa, schalte <gerät/raum> aus”<br />
“alexa, stelle <gerät/raum> auf <wert> prozent”<br />
“alexa, stelle <gerät/raum> auf <anzahl> grad”<br />
“alexa, erhöhe <gerät/raum> um <anzahl> prozent”<br />
“alexa, reduziere <gerät/raum> um <anzahl> prozent”<br />
“alexa, erhöhe <gerät/raum> um <anzahl> grad”<br />
“alexa, reduziere <gerät/raum> um <anzahl> grad”<br />
</pre><br />
<br />
=== Optimierung ===<br />
Normalerweise wird von Alexa-Fhem der Wert im Feld ''NAME'' verwendet, mit dem ein Gerät angesprochen werden kann via Alexa. Ist ein anderer "Rufname" gewünscht, kann das Feld ''Alias'' gesetzt werden. Der hier gesetzte Wert wird dann als alternativer Name verwendet.<br />
<br />
=== Troubleshooting ===<br />
<br />
====Allgemeiner Hinweis====<br />
Besonders wichtig ist, dass man sich sehr genau an diese Anleitung hält. Ein häufiger Fehler ist, dass die einfachen Anführungszeichen in der Anleitung unter '''AWS Lambda Funktion anlegen''' Punkt 8 einfach weggelassen werden. Diese sind zwingend notwendig. Es darf auch nur der reine Hostname eingetragen werden. Also kein ''http://'' davor. Entweder eine feste IP Adresse oder den Hostnamen, um den Rechner zu erreichen, den ihr über den Port 3000 freigegeben habt. Das sollte dann so aussehen:<br />
<pre style="width:50%;"><br />
const PORT=3000;<br />
const HOST='mein.host.name';<br />
</pre><br />
<br />
====Freigabe von Port 3000====<br />
{{Randnotiz|RNTyp=Fehl|RNText=Derzeit müsst ihr über einen echten IPv4 Anschluss verfügen, damit der Amazon Lambda-Server euch erreichen kann. DS-Lite Anschlüsse wie die von <b>UnityMedia</b> z.B. funktionieren derzeit leider nicht. Eine möglicher "Workaround" wird hier beschrieben: https://forum.fhem.de/index.php/topic,60244.msg518276.html#msg518276}}<br />
<br />
Auf dem Router muss der Port 3000 Protokoll TCP freigegeben werden. D.h. von außen muss man wenn man den Port 3000 aufruft, auf dem intern laufenden node.js Alexa-Dienst zugreifen können.<br />
Je nach Router gestaltet sich das Portforwarding bzw. die Portumleitung etwas schwieriger.<br />
<br />
Bei einem Speedport Router der Telekom beispielsweise, muss der Router komplett neu gestartet werden, wenn die Portfreigabe eingerichtet wurde. <br />
<br />
Bei der Fritz!Box ist das nicht nötig, bei dieser finden die Freigabe unter ''Internet -> Freigaben -> Portfreigaben'' statt. Dort wählt man dann den Rechner aus und richtet eine neue Freigabe ein. Wichtig hierbei ist, dass man Portfreigabe auswählt und nicht MyFRITZ!-Freigabe. Bei Port von bis trägt man 3000 ein, bei Port extern ebenfalls.<br />
<br />
Um die Portweiterleitung zu testen, solltet ihr euch auch nicht im gleichen Netz befinden. Viele Router blockieren den Netzaufruf aus dem gleichen Netz. Am besten testet ihr es, wenn ihr an eurem Mobiltelefon W-LAN deaktiviert und im Browser folgende Seite aufruft: ''https://mein.hostname:3000''. Wenn ihr im Browser dann einen Quellcode von Alexa seht, funktioniert die Portumleitung.<br />
<br />
Wenn bis hier alles funktioniert und es läuft dennoch nicht rund, liegt das Problem woanders. Kommt z.B. bei der Gerätesuche kein Request rein (sichtbar auf dem Bildschirm, wenn bin/alexa gestartet wurden), kann evtl. der Lambda-Dienst falsch konfiguriert sein.<br />
<br />
====Probleme mit node.js - npm install====<br />
<br />
Falls eine Fehlermeldung auftritt, dass "npm" nicht gefunden werden kann, bitte NodeJS entsprechend der Anleitung im Homebridge-Artikel vorgehen: [http://www.fhemwiki.de/wiki/Homebridge_einrichten#NodeJS_installieren NodeJS installieren] sowie [http://www.fhemwiki.de/wiki/Homebridge_einrichten#Python.2C_g.2B.2B.2C_MDNS_installieren Python, g++, MDNS installieren], siehe auch folgenden Abschnitt.<br />
<br />
====Es kommen diverse Fehlermeldungen beim Starten von alexa-fhem und es beendet sich====<br />
Wenn man auf der Konsole angemeldet ist, den Befehl<source lang="bash" style="width:50%;">node -v</source>eingeben. Ist die Version niedriger als die geforderte 0.12, muss eine neuere installiert werden. Hier darf man dann im Wiki unter http://www.fhemwiki.de/wiki/Homebridge_einrichten#NodeJS_installieren nachschauen. NodeJS V4 sollte hierbei schon ausreichen. Solange die node.js Version nicht passt, gar nicht groß rum experimentieren! Bitte beachtet, dass alle Voraussetzungen unter http://www.fhemwiki.de/wiki/Alexa-Fhem#Voraussetzungen erfüllt sind! Keine Experimente mit Versionen die darunter liegen.<br />
<br />
====Fehlermeldung ''NAT-PMP failed: Error: timeout'' Fehler angezeigt beim Start von alexa-fhem====<br />
Wenn ihr dann alexa-fhem über die Konsole startet und bekommt folgenden Fehler: ''NAT-PMP failed: Error: timeout'', lasst euch davon nicht irritieren. Das bedeutet lediglich, dass der Port nicht automatich freigegeben wurde über uPNP. Alternativ prüft, ob die Funktion der Portfreigabe via uPNP auf eurem Router aktiviert ist.<br />
<br />
====Nach Start auf der Console beendet sich Alexa-FHEM sofort wieder====<br />
Unmittelbar nach dem Start von Alexa-FHEM werden ein paar UPNP Fehlermeldungen ausgegeben. Unmittelbar danach beendet sich Alexa-FHEM wieder. <br />
<br />
Viele scheinen ein Problem mit UPNP auf dem Raspberry Pi zu haben. Wenn dieses Problem auftritt einfach in der <code>~/.alexa/config.json</code> die folgenden Zeilen rauslöschen:<br />
<br />
<pre><br />
"nat-pmp": "10.0.1.1",<br />
"nat-upnp": true,<br />
</pre><br />
<br />
Jetzt erneut Alexa-FHEM starten. Sollte nun laufen.<br />
<br />
====Was ist zu tun, wenn alexa-fhem keine Geräte findet?====<br />
Zunächst müssen die Geräte, die angesprochen werden wollen, unter FHEM ein neues Attribut zugewiesen bekommen. Dazu das Gerät in FHEM öffnen und das Attribut ''genericDeviceType switch'' hinzufügen, wenn es ein Schalter mit der Funktiona AN/AUS sein soll. Wenn man will, kann man dem Gerät jetzt noch über das Attribut ''alias'' eine besseren Namen geben, mit dem Alexa das Gerät dann auch finden kann.<br />
Anschließend muss alexa-fhem neu gestartet werden und die definierten Geräte sollten nun gefunden werden.<br />
<br />
====Was ist zu tun, wenn Alexa zwar Geräte findet, diese aber nicht angesprochen werden können?====<br />
Zuerst die Informationen zum Datenfluss ganz oben ansehen. Dann am besten von hinten nach vorne vorgehen:<br />
* wenn nichts bei alexa-fhem ankommt: port forwarding prüfen<br />
* wenn lambda.js nichts los wird: im cloudwatch log nachsehen<br />
* wenn bei lambda.js nichts ankommt: den trigger prüfen<br />
<br />
<br />
Zunächst sollte man sich unter ''http://aws.amazon.com'' das Logfile seiner erstellten Funktion anschauen. Ist überhaupt ein Logfile vorhanden? Falls nicht, liegt es vermutlich am Trigger.<br />
Den solltet ihr überprüfen. Scheinbar kommt es hin und wieder vor, dass dieser nicht gesetzt ist. Dazu einfach auf ''Triggers'' klicken und mit ''Add trigger'' erneut einen anlegen. Hier muss, wie in der Anleitung unter '''AWS Lambda Funktion anlegen''' Punkt 7, die ''Application Id'' stehen und der Haken bei ''Enable trigger'' gesetzt sein. Dann alexa-fhem neu starten.<br />
Wenn ihr Änderugen gemacht habt und den alexa-fhem Dienst noch nicht neu gestartet habt, wäre jetzt der richtige Zeitpunkt.<br />
<br />
====Was ist zu tun, wenn sich der Alexa-Service nicht starten lässt?====<br />
Schaut bitte in das Unterverzeichnis [alexa-fhem (also dort, wo Ihr Alexa-FHEM instelliert habt]/bin. Die dort befindliche Datei ''alexa'' muss ausführbar sein. Also z.B. so:<br />
<source lang="bash" style="width:70%;">2755327 4 -rwxr-xr-x 1 pi pi 339 Nov 26 23:20 alexa</source><br />
Sollte dies nicht der Fall sein bitte mit:<br />
<source lang="bash" style="width:70%;">chmod +x alexa</source><br />
die Datei ausführbar machen. Sofern der User "pi" Eigentümer ist, ist kein sudo erforderlich.<br />
<br />
[[Kategorie:HOWTOS]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=PanStamp_RGBWW_Board_mit_DMX_und_IR&diff=12609PanStamp RGBWW Board mit DMX und IR2015-10-21T21:09:35Z<p>Fidel: /* IR-Belegung Panstamp RGB-Board TBC */</p>
<hr />
<div>{{Baustelle}}<br />
{{SEITENTITEL:panStamp RGBWW Board mit DMX und IR}}<br />
<br />
{{Infobox Hardware<br />
|Bild=panStampRGBv1.0.jpg<br />
|Bildbeschreibung=RGBWW Board<br />
|HWProtocol=SWAP<br />
|HWType=Sender, Empfänger, Sensor, [[Interface]]<br />
|HWCategory=<br />
|HWComm=868MHz<br />
|HWChannels=<br />
|HWVoltage=12V<br />
|HWPowerConsumption=<br />
|HWPoweredBy=Netzteil<br />
|HWSize=<br />
|HWDeviceFHEM=[http://fhem.de/commandref.html#SWAP_0000002200000003 35_SWAP_0000002200000003.pm] [http://fhem.de/commandref.html#SWAP 34_SWAP.pm]<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=430 Andre / justme1968]<br />
|HWManufacturer=panStamp<br />
}}<br />
[[panStamp RGBWW Board mit DMX und IR]] unterstützt RGBW LEDs und lässt sich per Infrarot Fernbedienung, DMX Controller (z.B. als Unterputz Touchpanel) und FHEM bedienen.<br />
Es ist eine Hard- und Softwareentwicklung auf Basis von panStamp Modulen und verwendet zusätzlich das FHEM Modul [[SWAP 0000002200000003]] als 3. Ebene<br />
<br />
Der Funktionsumfang wird in diesem {{Link2Forum|Topic=12487|Message=81923|LinkText=Forenthread}} vorgestellt. Die Hardware für das Board wird {{Link2Forum|Topic=13890|LinkText=hier}} im FHEM Forum vorgestellt und ein Prototyp ist {{Link2Forum|Topic=12487|Message=85777|LinkText=hier}} zu sehen.<br />
<br />
== Hardware ==<br />
Die Projektseite zur Hardware findet sich [http://itse.homeip.net/projekte/12/6/ hier]. Eine Version 2 des Boards in geplant. <br />
<br />
=== Kompatibilität RBG-Board mit NRG-panStamps ===<br />
Mit dem hier beschriebenen Sketch ist das Board nur mit den panStamp AVRs kompatibel. Die Pinbelegung zwischen AVR und NRG ist im Prinzip gleich bis auf Pin 23. Das ist bei dem NRG ein IO Pin und nicht GND wie beim AVR. Das wäre kein Problem wenn man entweder hardwareseitig den Kontakt unterbricht oder aber programmiertechnisch diesen Pin '''NIE''' als Ausgang definiert. Ansonsten gibt’s einen „kurzen“. Oder wenn er als Ausgang definiert ist darf er nur das GND Potential haben, also Low, 0. {{Link2Forum|Topic=13890 |Message=247069}}<br />
<br />
Da es derzeit (Stand 01.05.2015) aber keinen Sketch gibt, der auf den NRG lauffähig ist, wäre vorher noch diese Herausforderung zu lösen.<br />
<br />
=== Eigenschaften des fade TBC ===<br />
Der wichtige Punkt ist das das RGBWW-Board Farbübergänge autonom macht und FHEM nur den Trigger zum starten und Rückmeldung über den Status gibt. d.h. wie ruckelfrei das faden ist hängt nicht von äußeren Bedingungen wie Funklast, FHEM timing oder FHEM Auslastung ab. Im Board gibt es 15 '''Register''' die jeweils eine Farbe und eine Anzeigedauer enthalten. Diese werden (ein mal) von FHEM aus programmiert. Zum starten wird dann nur noch das Anfangs- und das Endregister gesendet und das Board überblendet zwischen allen Farben der Register zwischen Anfang und Ende in der eingestellten Zeit.<br />
Die eigentliche Einschränkung ist das die aktuelle AVR Version der panstamps ''nur'' 8bit pwm kann (jedenfalls wenn es 3 oder mehr Kanäle sein sollen und die Hardware PWM genutzt wird). Wenn dir diese 256 Stufen pro Grundfarbe reichen ist es absolut Ruckelfrei. d.h. es gibt keinen zeitlichen Jitter. Ob dir die Anzahl der Helligkeitsstufen reicht hängt ein wenig von den LEDs selber ab und davon zwischen welchen Farben du konkret wechselst. Im dunklen Bereich wirst du vermutlich stufen sehen (also beim aufblenden von dunkel zu hell). wenn du zwischen zwei hellen Farben (z.b. von rot nach grün) blendest wirst du keine stufen sehen. {{Link2Forum|Topic=13890|Message=106644}}<br />
<br />
== Software ==<br />
Eine Übersicht über die derzeit vorhandene Funktionalität des [[SWAP_0000002200000003|Fhem Moduls]] und panStamp Sketches (Stand 01.05.2015):<br />
{{Link2Forum|Topic=13890 |Message=1205404}}<br />
was geht:<br />
* Bis zu vier LED Kanäle (je nach Kombination von ir und soft PWM)<br />
* Ir senden<br />
* Ir empfangen<br />
* Messen ob die LED Versorgungsspannung an ist<br />
* Helligkeit eines an Pin <code>A2</code> angeschlossenen Helligkeitssensors (LDR)<br />
* Konfiguration der DMX Basisadresse über das SWAP Register <code>0x12</code><br />
* Optional soft on auf letzten RGBW Wert<br />
* Alles was auch vorher schon ging: dimmen, faden, ir fernbedienungen anlernen, ...<br />
<br />
wichtig zu wissen:<br />
* Wenn ir aktiv ist und kein soft PWM lässt sich der 4. Kanal nur ein und aus schalten<br />
* Wenn ir aktiv ist muss soft PWM aktiv sein um den 4. Kanal auch zu dimmen<br />
* Es wird nur ein zusätzlicher LED Kanal tatsächlich schon unterstützt. Der fünfte kommt noch<br />
* Bei ir senden sind nur die Aufrufe für Sony und NEC tatsächlich eingebaut. Die Anderen sind aber einfach zu ergänzen<br />
* Beim ir senden sind noch keine Wiederholungen eingebaut. Die müssen laut Protokoll aber eigentlich sein<br />
<br />
was noch kommt:<br />
* besseres soft PWM<br />
* mehr Konfiguration bezüglich default verhalten. ramp zeiten, delays, ...<br />
* hsv Farbmodell um besser zu faden und vor allem um den Weißanteil automatisch auf die weißen LEDs zu legen<br />
* die virtuellen channel <br />
* fhem kompatibles ir senden<br />
* sofortiges senden von Helligkeit und LED Spannung bei Änderung<br />
* andere ir lib mit sehr viel besserer Geräte Unterstützung<br />
<br />
wie gehabt muss alles über <code>config.h</code> mit Compilerschalter konfiguriert werden.<br />
<br />
=== Arduino IDE 1.5 / 1.6 einrichten ===<br />
Mit der Arduino IDE 1.5.x gab es zusätzlich eine [http://www.panstamp.com/news/panstamp-is-now-fully-arduino-1-5-enabled/ grundlegende Umstellungen der Arduino SWAP Library], für die der derzeitige Sketch [r4716] angepasst werden muss. Der Sketch ist nur kompatibel zur alten SWAP Library, die unter [[panStamp_Programmierung#Arduino_IDE_1.0.x_vorbereiten|Arduino IDE 1.0 installiert]] werden muss (Stand 01.05.2015).<br />
<br />
=== Arduino IDE 1.0 einrichten ===<br />
Zum Flashen der panStamps wird die [[panStamp_Programmierung#Arduino_IDE_1.0.x_vorbereiten|Arduino IDE 1.0.x benötigt]]. Für den RGBWW-Sketch sind je nach gewünschtem Funktionsumfang noch folgende libs zu installieren:<br />
<br />
* Die Dateien der '''Panstamp Lib''' läd man von hier [[http://old.panstamp.com/downloads]] (panstamp_library.zip, 129k v.25, May 31, 2013). Mit der neueren Lib v.4 läuft die Kompillierung des derzeitigen Sketches nicht durch. Die Dateien der Lib speichert man in einem entsprechend neuen Unterordner, z.B. hierin <code>C:\Users\<username>\Documents\Arduino\libraries</code>. Am Ende der ganzen Aktion sollten sich in diesem Unterordner 3 neue Unterordner befinden: <code>IRremote, DMXSerial und panstamp</code>.<br />
<br />
* Die Dateien der '''IR Remote Lib''' kopiert man von hier [[https://github.com/shirriff/Arduino-IRremote]] und speichert sie ebenfalls in einem passenden Unterordner von <code>libraries</code>.<br />
<br />
* Die Dateien der '''DMX Lib''' kopiert man von hier [[http://www.mathertel.de/Arduino/DMXSerial.aspx]] und speichert sie ein weiteres Mal in einem weiteren Unterordner von <code>libraries</code>. Weitere Informationen zur Verwendung von Arduino Librarys finden sich hier [[http://arduino.cc/en/Hacking/Libraries]]. Dass die Librarys richtig erkannt worden sind, lässt sich dadurch erkennen, dass unter dem Menüpunkt <code>Sketch/Library importieren</code> die 3 weiteren Punkte unten unter <code>beigetragen</code> auftauchen.<br />
<br />
Die Librarys sollten entweder mit dem entsprechenden Menüpunkt in die IDE integriert werden oder jeweils nach auspacken des zip files als als kompletten Ordner im Arduino <code>libraries</code> Verzeichnis abgelegt werden (siehe [http://www.arduino.cc/en/Hacking/Libraries)]).<br />
* Windows IDE only: Falls alles so bleibt, wie es heruntergeladen wurde, wechselt man wieder auf den Reiter Sketch und importiert über ->Sketch Library importieren die entsprechenden Libs für IRremote und DMX. Dadurch werden 3 neue Zeilen hinzugefügt.<br />
* Nun sollte über Sketch/Überprüften/Kompillieren die Erstellung des Sketches möglich sein.<br />
* Falls erfolgreich unter Datei/Hochladen (ohne Programmer) den Sketch auf den Panstamp laden.<br />
<br />
Für das kompilieren mit INO siehe [[panStamp_Programmierung#INO|hier]].<br />
<br />
=== Link zum Sketch ===<br />
Die aktuelle Version des RGBWW-Driver Sketches findet sich auf [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge]. {{Link2Forum|Topic=13890 |Message=201391}}<br />
Dieser muss in <code>Arduino\libraries\panstamp\examples\sketches</code> entpackt und die <code>rbgdriver.ino</code> gestartet werden. In der Arduino IDE sollte unter Tools->Board "Arduino Pro or Pro Mini (3.3V, 8MHz) w/ Atmega328" eingestellt sein. Wenn man das boards.txt file von [http://code.google.com/p/panstamp/downloads/detail?name=boards.txt&can=2&q= hier] installiert kann man in der IDE auch direkt panStamp als Plattform auswählen.<br />
<br />
==== Kompillierte hex version ====<br />
Eine kompiliertes HEX-File für drei (vier) Kanäle plus IR-Empfang und DMX ist hier im Forum zu finden: {{Link2Forum|Topic=13890 |Message=121619}}<br />
<br />
==== HEX-File ohne IR und DMX ====<br />
Eine kompiliertes HEX-File ohne IR-Empfang und DMX ist hier im Forum zu finden: {{Link2Forum|Topic=13890 |Message=201955}}<br />
<br />
=== Compilerschalter ===<br />
Welche Features der sketch bietet lässt sich im <code>config.h</code> file durch ein- oder auskommentieren der <code>#define ENABLE_...</code> Zeilen festlegen. {{Link2Forum|Topic=13890 |Message=173431}}<br />
<br />
==== #define ENABLE_DMX ====<br />
#define ENABLE_DMX<br />
Ermöglicht die Nutzung eines DMX RGB Einstellers zur Steuerung der RGB LEDs<br />
<br />
Hierbei ist darauf zu achten, dass in der DMX-Lib in der Datei <code>DMXSerial.h</code> die Zeile<br />
#define DmxModePin 2 // Arduino pin 2 for controlling the data direction<br />
in <br />
#define DmxModePin 7 // Arduino pin 7 for controlling the data direction<br />
abgeändert werden muss.<br />
<br />
==== #define HAS_SENSOR ====<br />
#define HAS_SENSOR<br />
Ermöglicht die Nutzung eines DHT22 Sensors zur Auswertung von Temperatur und Luftfeuchtigkeit<br />
Dafür sollten diese Konfigurationszeilen auskommentiert sein:<br />
USE_SOFT_PWM;<br />
ENABLE_IR_SEND;<br />
ENABLE_REPEATER;<br />
<br />
In der <code>IRremote.cpp</code> Datei in der Irremote Library muss die Zeile<br />
<pre><br />
void IRrecv::disableIRIn() <br />
{<br />
TIMER_DISABLE_INTR;<br />
}<br />
</pre><br />
<br />
sowie die <code>Irremote.h</code> Datei unter <code>Public:</code> um die Zeile <br />
void disableIRIn();<br />
erweitert werden.<br />
<br />
Der Daten-Pin des DHT22 Sensors muss hierfür an Pin <code>A2</code> des panStamps angeschlossen werden.<br />
Ein Beispiel für die Umrechnung der userReading für Spannung Temp etc. ist hier beschrieben: {{Link2Forum|Topic=12487 |Message=76489}}<br />
<br />
=== Zusammenhänge der Konfiguration ===<br />
Die Zusammenhänge der Konfiguration sind hier beschrieben {{Link2Forum|Topic=13890 |Message=175181}}<br />
<br />
=== 4. und 5. LED Kanal TBC ===<br />
http://forum.fhem.de/index.php?topic=13890.msg169741#msg169741<br />
http://forum.fhem.de/index.php?topic=13890.msg192132#msg192132<br />
http://forum.fhem.de/index.php?topic=13890.msg201922#msg201922<br />
http://forum.fhem.de/index.php?topic=13890.msg201936#msg201936<br />
<br />
=== Alternativer Fade per Patch ===<br />
Als Alternative zum im Sketch und im Modul eingebauten Fade-Befehl ist hier ein Patch vorgestellt:<br />
{{Link2Forum|Topic=12487 |Message=133096}} <br />
[http://forum.fhem.de/index.php/topic,12487.msg133096.html#msg133096]<br />
<br />
Der Patch ist '''nicht eingecheckt'''.<br />
<br />
<br />
== IR Schnittstelle TBC ==<br />
=== IR TBC ===<br />
http://forum.fhem.de/index.php?topic=13890.msg107061#msg107061<br />
http://forum.fhem.de/index.php?topic=13890.msg107197#msg107197<br />
http://forum.fhem.de/index.php?topic=13890.msg107415#msg107415<br />
http://forum.fhem.de/index.php/topic,13890.msg122021.html#msg122021<br />
http://forum.fhem.de/index.php/topic,13890.msg122077.html#msg122077<br />
http://forum.fhem.de/index.php?topic=13890.msg167351#msg167351<br />
http://forum.fhem.de/index.php?topic=13890.msg175269#msg175269<br />
http://forum.fhem.de/index.php?topic=13890.msg175285#msg175285<br />
http://forum.fhem.de/index.php?topic=13890.msg182582#msg182582<br />
http://forum.fhem.de/index.php?topic=13890.msg245597#msg245597<br />
http://forum.fhem.de/index.php?topic=13890.msg259267#msg259267<br />
<br />
=== IR-Belegung Panstamp RGB-Board TBC ===<br />
http://forum.fhem.de/index.php/topic,13890.msg163008.html#msg163008<br />
http://forum.fhem.de/index.php/topic,13890.msg163153.html#msg163153<br />
<br />
Es gibt Unterschiede in der Pinbelegung zwischen dem Panstamp rgbdriver Board und dem rgbdriver Board aus dem fhem Forum.<br />
<br />
Original Panstamp rgbdriver Board:<br />
Der IR Empfänger läuft auf Pin D0 des PanstampAVR auf.<br />
<br />
Panstamp rgbdriver Board aus dem Forum:<br />
Der IR Empfänger läuft auf Pin A0 des PanstampAVR auf.<br />
<br />
Im Sketch sollte die folgende Zeile demnach angepasst werden:<br />
# define IR_RECV_PIN 0 //Orginal Board 0; fhem Board A0<br />
<br />
=== Ircluster TBC ===<br />
http://forum.fhem.de/index.php?topic=13890.msg175331#msg175331<br />
<br />
=== Irgate TBC ===<br />
http://forum.fhem.de/index.php?topic=13890.msg175278#msg175278<br />
<br />
== DMX Schnittstelle ==<br />
Da die DMX-Schrittstelle kein direktes Interface zu FHEM hat, sondern nur die direkte Kommunikation zwischen DMX-Kontroller und RGB-Board betrifft, ist die Schnittstelle nur bei der Konfiguration des Sketches und über die Dokumentation des Boards beschrieben.<br />
<br />
== Weblinks ==<br />
* [http://www.panstamp.com/home panStamp] panStamp Hersteller<br />
* [http://itse.homeip.net/projekte/12/6/ Projektseite] für das RGB-Multi-Board.<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ rgbdriver sketch] auf sourceforge<br />
<br />
[[Kategorie:panStamp]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU/ical&diff=10807SmartVISU/ical2015-04-03T20:17:59Z<p>Fidel: </p>
<hr />
<div>Um einen Kalender in [[SmartVisu]] mit dem Widget widget_ical einzubinden, ist folgendes zu tun:<br />
<br />
* Die Datei iCalcreator.class.php aus dem Paket http://kigkonsult.se/downloads/index.php#iCalcreator unter einem beliebigen Pfad ablegen, der aber in der ical.php eingetragen werden muss.<br />
* Ablegen der Datei ical.php in das Verzeichnis /smartVISU/lib/calendar/service <br />
* Ablegen der Datei widget_ical.html in das Homeverzeichnis der eigenen Seite z.b. /smartVISU/pages/fhem<br />
* Definition der Kalender findet in den Settings statt. Die Kalender werden wie folgt definiert:<br />
: - wie bisher nur die Url<br />
: <code><nowiki>http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/calendar</nowiki></code><br />
: - die Url mit Parameter Farbe und Icon<br />
: <code><nowiki>http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/calendar(Default Farbe,Default Icon)</nowiki></code><br />
: - die Url mit Parameter Farbe<br />
: <code><nowiki>http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/calendar(Default Farbe)</nowiki></code><br />
: - die Url mit Parameter Icon<br />
: <code><nowiki>http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/calendar(,Default Icon)</nowiki></code><br />
: - zwei Kalenderurls mit unterschiedlichen Parametern<br />
: <code><nowiki>http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/calendar(,message_garbage);http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/Geburtstage(#ff69b4,scene_party)</nowiki></code><br />
: - eine lokale Url<br />
: <code><nowiki>file:/tmp/calendar.ics</nowiki></code><br />
: - zwei Kalenderurls eine lokale und eine auf einem Caldav/Webserver<br />
: <code><nowiki>file:/tmp/calendar.ics(,message_garbage);http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/Geburtstage(#ff69b4,scene_party)</nowiki></code> <br />
: Die Icons sind die Namen der png-Dateien ohne .png. Wenn keine Parameter, für Farbe und Icon mitgegeben werden und auch keine in den Terminen hinterlegt sind, wird ein Standardicon und eine Standardfarbe gesetzt. Das setzen dieser Parameter pro Termin erfolgt im Beschreibungsfeld des jeweiligen Termin.<br />
:Bei allen abgelegten Dateien muss auf die Rechte geachtet werden. Es sollten die gleichen User/Group-Rechte verwendet werden, wie auch bei den Dateien im pages Ordner.<br />
* Einbinden es Kalenders auf einer SV-Seite:<br />
: <code>{% import "widget_ical.html" as calendar %}</code><br />
: <code><nowiki>{{ calendar.list('calendarlist', 'Termine', 6, 21) }}</nowiki></code><br />
: Die erste Zahl (6) ist die Anzahl der Termine die aufgelistet werden. Die zweite Zahl (21) ist die Anzahl der Tage, die im Kalender in die Zukunft geprüft wird, ob sich ein Termin wiederholt.<br />
<br />
<br />
Quelle und Download benötigter Dateien: {{Link2Forum|Topic=35831}}</div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU/ical&diff=10806SmartVISU/ical2015-04-03T20:17:18Z<p>Fidel: </p>
<hr />
<div>Um einen Kalender in [[SmartVisu]] mit dem Widget widget_ical einzubinden, ist folgendes zu tun:<br />
<br />
* Die Datei iCalcreator.class.php aus dem Paket http://kigkonsult.se/downloads/index.php#iCalcreator unter einem beliebigen Pfad ablegen, der aber in der ical.php eingetragen werden muss.<br />
* Ablegen der Datei ical.php in das Verzeichnis /smartVISU/lib/calendar/service <br />
* Ablegen der Datei widget_ical.html in das Homeverzeichnis der eigenen Seite z.b. /smartVISU/pages/fhem<br />
* Definition der Kalender findet in den Settings statt. Die Kalender werden wie folgt definiert:<br />
: - wie bisher nur die Url<br />
: <code><nowiki>http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/calendar</nowiki></code><br />
: - die Url mit Parameter Farbe und Icon<br />
: <code><nowiki>http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/calendar(Default Farbe,Default Icon)</nowiki></code><br />
: - die Url mit Parameter Farbe<br />
: <code><nowiki>http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/calendar(Default Farbe)</nowiki></code><br />
: - die Url mit Parameter Icon<br />
: <code><nowiki>http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/calendar(,Default Icon)</nowiki></code><br />
: - zwei Kalenderurls mit unterschiedlichen Parametern<br />
: <code><nowiki>http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/calendar(,message_garbage);http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/Geburtstage(#ff69b4,scene_party)</nowiki></code><br />
: - eine lokale Url<br />
: <code><nowiki>file:/tmp/calendar.ics</nowiki></code><br />
: - zwei Kalenderurls eine lokale und eine auf einem Caldav/Webserver<br />
: <code><nowiki>file:/tmp/calendar.ics(,message_garbage);http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/Geburtstage(#ff69b4,scene_party)</nowiki></code> <br />
: Die Icons sind die Namen der png-Dateien ohne .png. Wenn keine Parameter, für Farbe und Icon mitgegeben werden und auch keine in den Terminen hinterlegt sind, wird ein Standardicon und eine Standardfarbe gesetzt. Das setzen dieser Parameter pro Termin erfolgt im Beschreibungsfeld des jeweiligen Termin.<br />
Bei allen abgelegten Dateien muss auf die Rechte geachtet werden. Es sollten die gleichen User/Group-Rechte verwendet werden, wie auch bei den Dateien im pages Ordner.<br />
* Einbinden es Kalenders auf einer SV-Seite:<br />
: <code>{% import "widget_ical.html" as calendar %}</code><br />
: <code><nowiki>{{ calendar.list('calendarlist', 'Termine', 6, 21) }}</nowiki></code><br />
: Die erste Zahl (6) ist die Anzahl der Termine die aufgelistet werden. Die zweite Zahl (21) ist die Anzahl der Tage, die im Kalender in die Zukunft geprüft wird, ob sich ein Termin wiederholt.<br />
<br />
<br />
Quelle und Download benötigter Dateien: {{Link2Forum|Topic=35831}}</div>Fidelhttp://wiki.fhem.de/w/index.php?title=Fronthem&diff=10799Fronthem2015-04-03T17:04:23Z<p>Fidel: </p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Anbindung von externen Frontends an FHEM (befindet sich in der Alpha-Phase)<br />
|ModType=x<br />
<!-- |ModCategory= (noch?) nicht verwendet --><br />
<!-- |ModCmdRef= wird automatisch generiert --><br />
|ModForumArea=Sonstige Systeme<br />
|ModTechName=01_fronthem.pm<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=769 Jörg alias herrmannj]<br />
}}<br />
Fronthem ist ein Projekt von herrmannj und wurde im fhem-Forum erstmalig angekündigt: http://forum.fhem.de/index.php/topic,27291.0.html<br />
<br />
Fronthem verfolgt die Idee, ein externes Web-Frontend (z. B. SmartVisu <br />
http://smartvisu.de) an fhem anzukoppeln und den Datenverkehr sowie die Zusammenarbeit von Befehlen und Parametern zwischen FHEM und dem Web-Frontend zu übernehmen.<br />
<br />
Eine Installation für die Verwendung von [[SmartVisu]] mit Fronthem findet man hier [[Installation Fronthem|Installation Fronthem]].<br />
<br />
Dazu besteht fronthem aus vier Bausteinen:<br />
<br />
==Bausteine==<br />
=== websocket ===<br />
Der Websocket ist eine generische http-Schnittstelle, die von einem externen Frontend aus angesprochen werden kann.<br />
<br />
Der Websocket wird durch ein fhem-Modul 01_fronthem.pm realisiert, das im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
Der Websocket ist auf Port 2121 fest eingestellt, wird implizit durch die anderen Bausteine verwendet und benötigt im Prinzip keine weitere Beachtung, außer man möchte das Webinterface auf einem anderen Device neben FHEM laufen lassen.<br />
<br />
=== device connector ===<br />
Die Device-Connectoren dienen dazu, Endgeräte des Benutzers (PCs, Tablets, Smartphones usw.) als Clients zuzulassen und deren Berechtigungen (read, write) auf der Ebene einzelner Objekte zu steuern. Damit können z. B. die lieben Kinder zwar das Licht und die eigene Heizung steuern, aber nicht die Heizung umprogrammieren oder den Alarm ausschalten. Auch ein PIN-Schutz ist vorgesehen, im Moment aber noch nicht umgesetzt.<br />
<br />
Die Device-Connectoren werden durch das fhem-Modul 31_fronthemDevice.pm realisiert, welches im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
An den einzelnen Device-Connectoren werden die durch den websocket vom externen Frontend mitgeteilten Objekte aufgelistet und können dort einerseits mit fhem devices und andererseits in den Berechtigungen des jeweiligen Endgerätes konfiguriert werden.<br />
<br />
Umgekehrt bedeutet dies, dass man die Kombination der Frontend-items mit den fhem-Devices über die Converter nur einmal pro item machen muss, die Berechtigungen der verwendeten Endgeräte muss man aber jeweils pro Endgerät einzeln setzen.<br />
<br />
=== readings converter ===<br />
Die Readings von fhem müssen in die Form der möglichen Werte des Frontends umgewandelt werden. Im umgekehrten Fall müssen Befehle des Frontends in fhem kompatible Befehle umgesetzt werden.<br />
Diese Aufgabe übernehmen die Readings Converter. Sie werden durch die Datei fhconverter.pm realisiert, die im Ordner .../fhem/FHEM/ abgelegt wird. <br />
Bisher gibt es folgende Converter:<br />
* [[#Direct]] für Übertragung ohne Konvertierung<br />
* [[#NumDirect]] für Übertragung von Zahlenwerten in einem begrenzten Werteraum zwischen Min und Max<br />
* [[#NumDisplay]] für Zahlenwerte aus fhem Readings, nur lesend<br />
* [[#WordDisplay]] ist in Planung, für Übertragung von selbst definierbaren Wörtern/Sätze<br />
* [[#OnOff]] für Schalter, Übersetzung von On in 1 und Off in 0<br />
* [[#RGBCombined]] für Übertragung von RGB-Werten so das sie FHEM akzeptiert<br />
Näheres zu denn Convertern unter [[#Converter]]<br />
<br />
Weitere Readings Converter werden noch folgen.<br />
<br />
=== fronthemEditor ===<br />
Der Javascript Editor ist eine fhem WebIF Erweiterung, um die Bindung der fremden Frontend-Objekte an FHEM Devices/Readings vorzunehmen und die dazu notwendigen Konvertierungen zu wählen.<br />
Er wird durch die Datei fronthemEditor.js repräsentiert, die in den Ordner .../fhem/www/frontend/pgm2/ kopiert wird.<br />
<br />
Der Editor erscheint in fhem als komplette gad-Liste in den Details von jedem definierten fronthemDevice. Das mag auf den ersten Blick irreführend sein, weil die Definition der gad/items/plots fhem-global geschieht, war aber wohl die beste mögliche Umsetzung zur Zeit.<br />
<br />
Man muss also durch den Editor an einem beliebigen fronthemDevice die Verknüpfung zwischen fhem-devices und smartVISU items herstellen, dann gilt diese für alle fhem Devices. Nur die Berechtigungen der einzelnen fhem Devices werden unterschiedlich gepflegt. (im Moment aber inaktiviert!)<br />
<br />
==Basic Syntax==<br />
===Websocket===<br />
:<code>define <name> fronthem</code><br />
<br />
===Device Connector===<br />
Man muss jedes Device, mit dem man zugreifen will definieren.<br />
<br />
Dadurch kann genau festgelegt werden, welches Device Rechte für eine jeweilige Schaltfunktion hat.<br />
====IP-Identify====<br />
Identifizierung per IP-Adresse. Dies ist nur im internen Netzwerk sehr sinnvoll.<br />
Ein Device wird definiert mit:<br />
:<code>define <device> fronthemDevice <ip></code><br />
====Zertificate-Identify====<br />
Das Device wird über ein Zertifikat identifiziert.<br />
Zuerst wird ein Zertifikat generiert, welches dann auf dem Device installiert werden muss.<br />
<br />
Diese Methode der Identifizierung verspricht höhere Sicherheit, wie auch denn Vorteil, das man sich nicht einloggen muss.<br />
<br />
Diese Funktion ist noch in Entwicklung.<br />
<br />
==Converter==<br />
Die Converter sind alle kompatibel mit dem oben erwähnten Frontend [[SmartVisu]] und werden auf Basis dieses Frontends erklärt.<br />
<br />
Wenn jemand ein anderes Frontend verwenden will, muss er möglicherweise die Converter anpassen.<br />
===Direct===<br />
Die Werte werden ohne Konvertierung weitergegeben.<br />
<br />
Gibt den Wert des von <reading> ohne weitere Wandlung an das Frontend weiter. In umgekehrter Richtung wird der vom Frontend geliefert Wert ohne Wandlung im hinterlegten <set> eingesetzt.<br />
<br />
Beispiel: <br />
Anzeige eines An- oder Abwesenheitszustandes im Frontend (Textanzeige, Icon, Button)<br />
<br />
===NumDirect===<br />
NumDirect arbeitet bidirektional. Die Werte werden genau wie bei Direct ohne Umwandlung weitergegeben.<br />
<br />
Der feine Unterschied zu Direct ist jedoch, das nur Zahlenwerte übergeben werden können.<br />
<br />
Desweiteren kann man einen minimalen und maximalen Wert mitangeben. Dies hat denn Sinn, das man keine Werte einstellen kann, die überhaupt nicht möglich wären.<br />
<br />
In der SmartVisu kann man z.B. -100°C einstellen, das wäre in FHEM jedoch gar nicht möglich.<br />
<br />
===NumDelayed===<br />
NumDelayed ist noch in Arbeit.<br />
<br />
Ein bidirektionaler numerischer Converter mit einstellbarer Verzögerung.<br />
<br />
Bietet bei der Ansteuerung mechanischer Aktoren (Markise, Jalousie) Vorteile gegenüber NumDirect. Als Beispiel sei die Steuerung einer Jalousie über einen Slider genannt. Da Slider ihre Werte kontinuierlich an FHEM übermitteln, würde bei der Verwendung anderer Converter dem entsprechenden Aktor (z.B. HM-BP), während der Benutzer den Slider bedient, mehrfach der vermeindliche Sollwert übermittelt werden. Gleichzeitig beginnt der Aktor seine Fahrt und übermittelt dem Slider seine aktuelle ist Position. Das führt zu einem springen des Sliders und einer "unschönen" Bedienung.<br />
<br />
NumDelayed nimmt daher die Signale des Sliders entgegen, wartet jedoch mit der Weitergabe solange, bis sich der Slider (xxx ms, konfigurierbar) nicht mehr bewegt. In Gegenrichtung wird ebenso verfahren, erst wenn der Aktor seine Endposition erreicht, wird der Slider im Frontend aktualisiert. In diesem Beispiel würde das bedeuten das der Slider im Normalfall ohnehin so steht (Soll) wie vom Aktor gemeldet (Ist). Natürlich könnte der Benutzer oder ein Hindernis die Fahrt auch unterbrochen haben, dann würde der Slider auf die gemeldete Position aktualisiert.<br />
<br />
===NumDisplay===<br />
NumDisplay arbeitet nur in eine Richting, FHEM zu Frontend. Die Werte werden ohne Umwandlung weitergegeben.<br />
<br />
Es ist dazu gedacht Zahlenwerte zu übergeben, ohne etwas zu verändern.<br />
<br />
z.B. für Temperaturwerte<br />
<br />
===WordDisplay===<br />
WordDisplay ist derzeit in Planung, es wird noch über die Umsetzung diskutiert.<br />
<br />
WordDisplay soll nur in eine Richtung arbeiten, FHEM zu Frontend. Es ist dazu gedacht Wörter oder Textpassagen zu übertragen.<br />
<br />
Jedoch soll es möglich sein, eine Umwandlung selbst festzulegen. So kann man einfach mehrere Textausgaben abhängig vom Zustand an das Frontend schicken:<br />
<br />
z.B. Geofancy: Home -> Zuhause, Underway -> Unterwegs, Work -> Arbeit<br />
<br />
===OnOff===<br />
Für einfache Ein/Aus-Funktionen.<br />
<br />
FHEM interpretiert Ein/Aus-Funktionen mit on/off, SmartVisu jedoch mit 1/0.<br />
<br />
Der OnOff-Converter wandelt diese bidirektional, damit sie richtig interpretiert werden.<br />
<br />
===RGBCombined===<br />
Ein Converter zur Steuerung von RGB Leuchtmitteln über Farbauswahlfelder (zb. Farbkreis)<br />
<br />
Bidirektional, wandelt, verwendet 3 Frontend Items<br />
<br />
reading: Name eines reading mit HEX RGB Wert des Leuchtmittels<br />
converter (mit Parameter): <code>RGBCombined <itemRed>, <itemYellow>, <itemBlue></code><br />
<br />
set: Name des set Befehls, bekommt HEX RGB Wert übergeben <br />
<br />
Dieser Converter muss gleichlautend für alle 3 RGB Kanäle des Frontends definiert werden.<br />
<br />
==Device Connector==<br />
Sobald ein fronthemDevice definiert ist, kann man über die device details in fhem die GADs definieren und die Rechte verteilen.<br />
===GAD definieren===<br />
Eine GAD-Definierung besteht aus:<br />
[[Datei:DeviceDefine.png|400px|thumb|right|GADs definieren]]<br />
*mode<br />
*device<br />
*reading<br />
*converter<br />
*cmd set<br />
====mode====<br />
Es gibt 2 Modis:<br />
*item<br />
*plot<br />
====device====<br />
Hier wird der Name des FHEM-Devices eingetragen, an das die Befehle geschickt werden. Die vorhandenen Devices in fhem werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt. <br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====reading====<br />
Das für die Anzeige zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Readings werden, wenn das Frontend dies anfordert, aktiv von fronthem gelesen und (per push) proaktiv an das Frontend gesendet wenn fhem entsprechende events erzeugt.<br />
<br />
====converter====<br />
Hier gibt man denn Namen des Converters an, denn man verwenden möchte.<br />
Es stehen unterschiedliche converter für verschiedene Aufgabenstellungen zur Verfügung. Über das Konzept der converter können fhem Device unterschiedlichster Typen und Funktionen über das Frontend bedient werden. So versorgt der gleiche converter der die Solltemperatur des virtuellen Heizungsthermostats (bidriektional) einstellt auch die Füllstandanzeige der Zisterne sowie den Dimmer. In all diesen Fällen handelt es sich um die Übertragung von numerischen Werten. Converter können dabei auch Spezialaufgaben wie die Begrenzung des Wertebereichs übernehmen. So lässt sich über NumDirect zum Beispiel die Solltemperatur Einstellung für virtuelle Heizungsregler auf Min und Max Werte begrenzen. <br />
<br />
Oben ist eine Standardliste der [[#Converter]]. Die meisten Devices können mit diesen Convertern angesteuert werden.<br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====cmd set====<br />
Das zum Schreiben zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Das gewählte Reading gibt den "set" des fhem Devices an, der die Rückgabe des Converters entgegen nimmt.<br />
<br />
Bei Lampe z.B. "state".<br />
<br />
===Devicerechte vergeben===<br />
[[Datei:DeviceRechte.png|400px|thumb|right|Devicerechte vergeben]]<br />
Devicerechte bestehen aus:<br />
*read<br />
*write<br />
*PIN GAD<br />
====read====<br />
Das Device darf die Statuswerte auslesen, jedoch nicht verändern.<br />
<br />
====write====<br />
Das Device darf Statuswerte ändern.<br />
<br />
====PIN GAD====<br />
In Entwicklung...<br />
<br />
<br />
==Universelle ZeitSchaltUhr UZSU==<br />
Es existiert ein Widget für eine universelle ZeitSchaltUhr auf GitHub unter https://github.com/mworion/uzsu_widget .<br />
<br />
Hierbei bitte die Version 2.0 des UZSU Widgets verwenden oder das UZSU Widget aus https://github.com/herrmannj/smartvisu-widgets beziehen<br />
<br />
Man muss dazu die uzsu_widget.html in das eigene Verzeichnis in ../pages/.. kopieren und die visu.js und die visu.css in seine Installation integrieren (Achtung, wenn die beiden Dateien schon bestehen, dann muss man das manuell zusammenkopieren!)<br />
<br />
Das Widget kann in SmartVISU wie gewohnt eingebunden werden:<br />
<br />
(für ein Ergebnis, das der Benutzer direkt eintippen kann, z.B. 'on' oder 'off')<br />
<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUtxt', gad_uzsu, '', '', '', '', 'text') }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis zwischen 0 und 100)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'num', 0, 100) }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis {0,1}, das aber als flip mit 'an' und 'aus' angezeigt wird)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'bool', 'an', 'aus') }}<br />
</nowiki><br />
<br />
<br />
Um die Antwort des Widgets in fhem zu verarbeiten, benötigt man <br />
<br />
1. je ein Reading uzsu an dem zu schaltenden Device, das man mit <br />
<br />
<nowiki><br />
setreading <device> uzsu {}<br />
</nowiki><br />
<br />
erzeugen MUSS.<br />
<br />
2. eine Anbindung des uzsu-GAD per UZSU Converter an das Reading uzsu des zu schaltenden Device read und write in fhem<br />
<br />
3. folgenden Code in der 99_FronthemUtils.pm:<br />
<br />
Im Package Main:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Umsetzen der UZSU-Settings für ein device<br />
#<br />
###############################################################################<br />
sub UZSU_execute($$)<br />
{<br />
my ($device, $uzsu) = @_;<br />
<br />
$uzsu = decode_json($uzsu);<br />
fhem('delete wdt_'.$device.'_uzsu');<br />
my $weekdays_part = " ";<br />
for(my $i=0; $i < @{$uzsu->{list}}; $i++) {<br />
my $weekdays = $uzsu->{list}[$i]->{rrule};<br />
$weekdays = substr($weekdays,18,50); <br />
if (($uzsu->{list}[$i]->{active})) {<br />
$weekdays_part = $weekdays_part.' '.$weekdays.'|'.$uzsu->{list}[$i]->{time}.'|'.$uzsu->{list}[$i]->{value};<br />
}<br />
}<br />
fhem('define wdt_'.$device.'_uzsu'.' WeekdayTimer '.$device.' en '.$weekdays_part);<br />
if ($uzsu->{active}){ <br />
fhem('attr wdt_'.$device.'_uzsu disable 0');<br />
} else {<br />
fhem('attr wdt_'.$device.'_uzsu disable 1');<br />
} <br />
}<br />
</nowiki><br />
<br />
Im Package fronthem, selbe Datei:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Setreading a device reading using JSON conversion (gadval => reading=decode_json() => setval => encode_json(reading) )<br />
#<br />
###############################################################################<br />
<br />
sub UZSU(@)<br />
{<br />
my ($param) = @_;<br />
my $cmd = $param->{cmd};<br />
my $gad = $param->{gad};<br />
my $gadval = $param->{gadval};<br />
<br />
my $device = $param->{device};<br />
my $reading = $param->{reading};<br />
my $event = $param->{event};<br />
<br />
my @args = @{$param->{args}};<br />
my $cache = $param->{cache};<br />
<br />
if ($param->{cmd} eq 'get')<br />
{<br />
$param->{cmd} = 'send';<br />
}<br />
if ($param->{cmd} eq 'send')<br />
{<br />
$param->{gad} = $gad;<br />
$param->{gadval} = decode_json(main::ReadingsVal($device, $reading, ''));<br />
$param->{gads} = [];<br />
return undef;<br />
}<br />
elsif ($param->{cmd} eq 'rcv')<br />
{<br />
$gadval = encode_json($gadval);<br />
$gadval =~ s/;/;;/ig;<br />
$param->{result} = main::fhem("setreading $device $reading $gadval");<br />
$param->{results} = [];<br />
return 'done';<br />
}<br />
elsif ($param->{cmd} eq '?')<br />
{<br />
return 'usage: UZSU';<br />
}<br />
return undef;<br />
}<br />
<br />
</nowiki><br />
<br />
Dieser Code erzeugt aus den Einstellungen im Widget entsprechende WeekdayTimer in fhem und löscht und erstellt neu bei jeder Änderung in SmartVISU.<br />
<br />
4. Die Funktion muss getriggert werden. Dazu ist ein notify nötig, das auf die Veränderung der uzsu Readings reagiert:<br />
<br />
<nowiki><br />
<br />
define UZSU notify .*:uzsu:.* { UZSU_execute($NAME, $EVTPART1) }<br />
<br />
</nowiki><br />
<br />
Voila!<br />
<br />
[[Kategorie: FHEM Frontends]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=Fronthem&diff=10793Fronthem2015-04-03T15:37:53Z<p>Fidel: </p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Anbindung von externen Frontends an FHEM (befindet sich in der Alpha-Phase)<br />
|ModType=x<br />
<!-- |ModCategory= (noch?) nicht verwendet --><br />
<!-- |ModCmdRef= wird automatisch generiert --><br />
|ModForumArea=Sonstige Systeme<br />
|ModTechName=01_fronthem.pm<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=769 Jörg alias herrmannj]<br />
}}<br />
Fronthem ist ein Projekt von herrmannj und wurde im fhem-Forum erstmalig angekündigt: http://forum.fhem.de/index.php/topic,27291.0.html<br />
<br />
Fronthem verfolgt die Idee, ein externes Web-Frontend (z. B. [[SmartVISU]] <br />
http://smartvisu.de) an fhem anzukoppeln und den Datenverkehr sowie die Zusammenarbeit von Befehlen und Parametern zwischen FHEM und dem Web-Frontend zu übernehmen.<br />
<br />
Eine Installation für die Verwendung von [[SmartVisu]] mit Fronthem findet man hier [[Installation Fronthem|Installation Fronthem]].<br />
<br />
Dazu besteht fronthem aus vier Bausteinen:<br />
<br />
==Bausteine==<br />
=== websocket ===<br />
Der Websocket ist eine generische http-Schnittstelle, die von einem externen Frontend aus angesprochen werden kann.<br />
<br />
Der Websocket wird durch ein fhem-Modul 01_fronthem.pm realisiert, das im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
Der Websocket ist auf Port 2121 fest eingestellt, wird implizit durch die anderen Bausteine verwendet und benötigt im Prinzip keine weitere Beachtung, außer man möchte das Webinterface auf einem anderen Device neben FHEM laufen lassen.<br />
<br />
=== device connector ===<br />
Die Device-Connectoren dienen dazu, Endgeräte des Benutzers (PCs, Tablets, Smartphones usw.) als Clients zuzulassen und deren Berechtigungen (read, write) auf der Ebene einzelner Objekte zu steuern. Damit können z. B. die lieben Kinder zwar das Licht und die eigene Heizung steuern, aber nicht die Heizung umprogrammieren oder den Alarm ausschalten. Auch ein PIN-Schutz ist vorgesehen, im Moment aber noch nicht umgesetzt.<br />
<br />
Die Device-Connectoren werden durch das fhem-Modul 31_fronthemDevice.pm realisiert, welches im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
An den einzelnen Device-Connectoren werden die durch den websocket vom externen Frontend mitgeteilten Objekte aufgelistet und können dort einerseits mit fhem devices und andererseits in den Berechtigungen des jeweiligen Endgerätes konfiguriert werden.<br />
<br />
Umgekehrt bedeutet dies, dass man die Kombination der Frontend-items mit den fhem-Devices über die Converter nur einmal pro item machen muss, die Berechtigungen der verwendeten Endgeräte muss man aber jeweils pro Endgerät einzeln setzen.<br />
<br />
=== readings converter ===<br />
Die Readings von fhem müssen in die Form der möglichen Werte des Frontends umgewandelt werden. Im umgekehrten Fall müssen Befehle des Frontends in fhem kompatible Befehle umgesetzt werden.<br />
Diese Aufgabe übernehmen die Readings Converter. Sie werden durch die Datei fhconverter.pm realisiert, die im Ordner .../fhem/FHEM/ abgelegt wird. <br />
Bisher gibt es folgende Converter:<br />
* [[#Direct]] für Übertragung ohne Konvertierung<br />
* [[#NumDirect]] für Übertragung von Zahlenwerten in einem begrenzten Werteraum zwischen Min und Max<br />
* [[#NumDisplay]] für Zahlenwerte aus fhem Readings, nur lesend<br />
* [[#WordDisplay]] ist in Planung, für Übertragung von selbst definierbaren Wörtern/Sätze<br />
* [[#OnOff]] für Schalter, Übersetzung von On in 1 und Off in 0<br />
* [[#RGBCombined]] für Übertragung von RGB-Werten so das sie FHEM akzeptiert<br />
Näheres zu denn Convertern unter [[#Converter]]<br />
<br />
Weitere Readings Converter werden noch folgen.<br />
<br />
=== fronthemEditor ===<br />
Der Javascript Editor ist eine fhem WebIF Erweiterung, um die Bindung der fremden Frontend-Objekte an FHEM Devices/Readings vorzunehmen und die dazu notwendigen Konvertierungen zu wählen.<br />
Er wird durch die Datei fronthemEditor.js repräsentiert, die in den Ordner .../fhem/www/frontend/pgm2/ kopiert wird.<br />
<br />
Der Editor erscheint in fhem als komplette gad-Liste in den Details von jedem definierten fronthemDevice. Das mag auf den ersten Blick irreführend sein, weil die Definition der gad/items/plots fhem-global geschieht, war aber wohl die beste mögliche Umsetzung zur Zeit.<br />
<br />
Man muss also durch den Editor an einem beliebigen fronthemDevice die Verknüpfung zwischen fhem-devices und smartVISU items herstellen, dann gilt diese für alle fhem Devices. Nur die Berechtigungen der einzelnen fhem Devices werden unterschiedlich gepflegt. (im Moment aber inaktiviert!)<br />
<br />
==Basic Syntax==<br />
===Websocket===<br />
:<code>define <name> fronthem</code><br />
<br />
===Device Connector===<br />
Man muss jedes Device, mit dem man zugreifen will definieren.<br />
<br />
Dadurch kann genau festgelegt werden, welches Device Rechte für eine jeweilige Schaltfunktion hat.<br />
====IP-Identify====<br />
Identifizierung per IP-Adresse. Dies ist nur im internen Netzwerk sehr sinnvoll.<br />
Ein Device wird definiert mit:<br />
:<code>define <device> fronthemDevice <ip></code><br />
====Zertificate-Identify====<br />
Das Device wird über ein Zertifikat identifiziert.<br />
Zuerst wird ein Zertifikat generiert, welches dann auf dem Device installiert werden muss.<br />
<br />
Diese Methode der Identifizierung verspricht höhere Sicherheit, wie auch denn Vorteil, das man sich nicht einloggen muss.<br />
<br />
Diese Funktion ist noch in Entwicklung.<br />
<br />
==Converter==<br />
Die Converter sind alle kompatibel mit dem oben erwähnten Frontend [[SmartVisu]] und werden auf Basis dieses Frontends erklärt.<br />
<br />
Wenn jemand ein anderes Frontend verwenden will, muss er möglicherweise die Converter anpassen.<br />
===Direct===<br />
Die Werte werden ohne Konvertierung weitergegeben.<br />
<br />
Gibt den Wert des von <reading> ohne weitere Wandlung an das Frontend weiter. In umgekehrter Richtung wird der vom Frontend geliefert Wert ohne Wandlung im hinterlegten <set> eingesetzt.<br />
<br />
Beispiel: <br />
Anzeige eines An- oder Abwesenheitszustandes im Frontend (Textanzeige, Icon, Button)<br />
<br />
===NumDirect===<br />
NumDirect arbeitet bidirektional. Die Werte werden genau wie bei Direct ohne Umwandlung weitergegeben.<br />
<br />
Der feine Unterschied zu Direct ist jedoch, das nur Zahlenwerte übergeben werden können.<br />
<br />
Desweiteren kann man einen minimalen und maximalen Wert mitangeben. Dies hat denn Sinn, das man keine Werte einstellen kann, die überhaupt nicht möglich wären.<br />
<br />
In der SmartVisu kann man z.B. -100°C einstellen, das wäre in FHEM jedoch gar nicht möglich.<br />
<br />
===NumDelayed===<br />
NumDelayed ist noch in Arbeit.<br />
<br />
Ein bidirektionaler numerischer Converter mit einstellbarer Verzögerung.<br />
<br />
Bietet bei der Ansteuerung mechanischer Aktoren (Markise, Jalousie) Vorteile gegenüber NumDirect. Als Beispiel sei die Steuerung einer Jalousie über einen Slider genannt. Da Slider ihre Werte kontinuierlich an FHEM übermitteln, würde bei der Verwendung anderer Converter dem entsprechenden Aktor (z.B. HM-BP), während der Benutzer den Slider bedient, mehrfach der vermeindliche Sollwert übermittelt werden. Gleichzeitig beginnt der Aktor seine Fahrt und übermittelt dem Slider seine aktuelle ist Position. Das führt zu einem springen des Sliders und einer "unschönen" Bedienung.<br />
<br />
NumDelayed nimmt daher die Signale des Sliders entgegen, wartet jedoch mit der Weitergabe solange, bis sich der Slider (xxx ms, konfigurierbar) nicht mehr bewegt. In Gegenrichtung wird ebenso verfahren, erst wenn der Aktor seine Endposition erreicht, wird der Slider im Frontend aktualisiert. In diesem Beispiel würde das bedeuten das der Slider im Normalfall ohnehin so steht (Soll) wie vom Aktor gemeldet (Ist). Natürlich könnte der Benutzer oder ein Hindernis die Fahrt auch unterbrochen haben, dann würde der Slider auf die gemeldete Position aktualisiert.<br />
<br />
===NumDisplay===<br />
NumDisplay arbeitet nur in eine Richting, FHEM zu Frontend. Die Werte werden ohne Umwandlung weitergegeben.<br />
<br />
Es ist dazu gedacht Zahlenwerte zu übergeben, ohne etwas zu verändern.<br />
<br />
z.B. für Temperaturwerte<br />
<br />
===WordDisplay===<br />
WordDisplay ist derzeit in Planung, es wird noch über die Umsetzung diskutiert.<br />
<br />
WordDisplay soll nur in eine Richtung arbeiten, FHEM zu Frontend. Es ist dazu gedacht Wörter oder Textpassagen zu übertragen.<br />
<br />
Jedoch soll es möglich sein, eine Umwandlung selbst festzulegen. So kann man einfach mehrere Textausgaben abhängig vom Zustand an das Frontend schicken:<br />
<br />
z.B. Geofancy: Home -> Zuhause, Underway -> Unterwegs, Work -> Arbeit<br />
<br />
===OnOff===<br />
Für einfache Ein/Aus-Funktionen.<br />
<br />
FHEM interpretiert Ein/Aus-Funktionen mit on/off, SmartVisu jedoch mit 1/0.<br />
<br />
Der OnOff-Converter wandelt diese bidirektional, damit sie richtig interpretiert werden.<br />
<br />
===RGBCombined===<br />
Ein Converter zur Steuerung von RGB Leuchtmitteln über Farbauswahlfelder (zb. Farbkreis)<br />
<br />
Bidirektional, wandelt, verwendet 3 Frontend Items<br />
<br />
reading: Name eines reading mit HEX RGB Wert des Leuchtmittels<br />
converter (mit Parameter): <code>RGBCombined <itemRed>, <itemYellow>, <itemBlue></code><br />
<br />
set: Name des set Befehls, bekommt HEX RGB Wert übergeben <br />
<br />
Dieser Converter muss gleichlautend für alle 3 RGB Kanäle des Frontends definiert werden.<br />
<br />
==Device Connector==<br />
Sobald ein fronthemDevice definiert ist, kann man über die device details in fhem die GADs definieren und die Rechte verteilen.<br />
===GAD definieren===<br />
Eine GAD-Definierung besteht aus:<br />
[[Datei:DeviceDefine.png|400px|thumb|right|GADs definieren]]<br />
*mode<br />
*device<br />
*reading<br />
*converter<br />
*cmd set<br />
====mode====<br />
Es gibt 2 Modis:<br />
*item<br />
*plot<br />
====device====<br />
Hier wird der Name des FHEM-Devices eingetragen, an das die Befehle geschickt werden. Die vorhandenen Devices in fhem werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt. <br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====reading====<br />
Das für die Anzeige zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Readings werden, wenn das Frontend dies anfordert, aktiv von fronthem gelesen und (per push) proaktiv an das Frontend gesendet wenn fhem entsprechende events erzeugt.<br />
<br />
====converter====<br />
Hier gibt man denn Namen des Converters an, denn man verwenden möchte.<br />
Es stehen unterschiedliche converter für verschiedene Aufgabenstellungen zur Verfügung. Über das Konzept der converter können fhem Device unterschiedlichster Typen und Funktionen über das Frontend bedient werden. So versorgt der gleiche converter der die Solltemperatur des virtuellen Heizungsthermostats (bidriektional) einstellt auch die Füllstandanzeige der Zisterne sowie den Dimmer. In all diesen Fällen handelt es sich um die Übertragung von numerischen Werten. Converter können dabei auch Spezialaufgaben wie die Begrenzung des Wertebereichs übernehmen. So lässt sich über NumDirect zum Beispiel die Solltemperatur Einstellung für virtuelle Heizungsregler auf Min und Max Werte begrenzen. <br />
<br />
Oben ist eine Standardliste der [[#Converter]]. Die meisten Devices können mit diesen Convertern angesteuert werden.<br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====cmd set====<br />
Das zum Schreiben zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Das gewählte Reading gibt den "set" des fhem Devices an, der die Rückgabe des Converters entgegen nimmt.<br />
<br />
Bei Lampe z.B. "state".<br />
<br />
===Devicerechte vergeben===<br />
[[Datei:DeviceRechte.png|400px|thumb|right|Devicerechte vergeben]]<br />
Devicerechte bestehen aus:<br />
*read<br />
*write<br />
*PIN GAD<br />
====read====<br />
Das Device darf die Statuswerte auslesen, jedoch nicht verändern.<br />
<br />
====write====<br />
Das Device darf Statuswerte ändern.<br />
<br />
====PIN GAD====<br />
In Entwicklung...<br />
<br />
<br />
==Universelle ZeitSchaltUhr UZSU==<br />
Es existiert ein Widget für eine universelle ZeitSchaltUhr auf GitHub unter https://github.com/mworion/uzsu_widget .<br />
<br />
Hierbei bitte die Version 2.0 des UZSU Widgets verwenden oder das UZSU Widget aus https://github.com/herrmannj/smartvisu-widgets beziehen<br />
<br />
Man muss dazu die uzsu_widget.html in das eigene Verzeichnis in ../pages/.. kopieren und die visu.js und die visu.css in seine Installation integrieren (Achtung, wenn die beiden Dateien schon bestehen, dann muss man das manuell zusammenkopieren!)<br />
<br />
Das Widget kann in SmartVISU wie gewohnt eingebunden werden:<br />
<br />
(für ein Ergebnis, das der Benutzer direkt eintippen kann, z.B. 'on' oder 'off')<br />
<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUtxt', gad_uzsu, '', '', '', '', 'text') }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis zwischen 0 und 100)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'num', 0, 100) }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis {0,1}, das aber als flip mit 'an' und 'aus' angezeigt wird)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'bool', 'an', 'aus') }}<br />
</nowiki><br />
<br />
<br />
Um die Antwort des Widgets in fhem zu verarbeiten, benötigt man <br />
<br />
1. je ein Reading uzsu an dem zu schaltenden Device, das man mit <br />
<br />
<nowiki><br />
setreading <device> uzsu {}<br />
</nowiki><br />
<br />
erzeugen MUSS.<br />
<br />
2. eine Anbindung des uzsu-GAD per UZSU Converter an das Reading uzsu des zu schaltenden Device read und write in fhem<br />
<br />
3. folgenden Code in der 99_FronthemUtils.pm:<br />
<br />
Im Package Main:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Umsetzen der UZSU-Settings für ein device<br />
#<br />
###############################################################################<br />
sub UZSU_execute($$)<br />
{<br />
my ($device, $uzsu) = @_;<br />
<br />
$uzsu = decode_json($uzsu);<br />
fhem('delete wdt_'.$device.'_uzsu');<br />
my $weekdays_part = " ";<br />
for(my $i=0; $i < @{$uzsu->{list}}; $i++) {<br />
my $weekdays = $uzsu->{list}[$i]->{rrule};<br />
$weekdays = substr($weekdays,18,50); <br />
if (($uzsu->{list}[$i]->{active})) {<br />
$weekdays_part = $weekdays_part.' '.$weekdays.'|'.$uzsu->{list}[$i]->{time}.'|'.$uzsu->{list}[$i]->{value};<br />
}<br />
}<br />
fhem('define wdt_'.$device.'_uzsu'.' WeekdayTimer '.$device.' en '.$weekdays_part);<br />
if ($uzsu->{active}){ <br />
fhem('attr wdt_'.$device.'_uzsu disable 0');<br />
} else {<br />
fhem('attr wdt_'.$device.'_uzsu disable 1');<br />
} <br />
}<br />
</nowiki><br />
<br />
Im Package fronthem, selbe Datei:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Setreading a device reading using JSON conversion (gadval => reading=decode_json() => setval => encode_json(reading) )<br />
#<br />
###############################################################################<br />
<br />
sub UZSU(@)<br />
{<br />
my ($param) = @_;<br />
my $cmd = $param->{cmd};<br />
my $gad = $param->{gad};<br />
my $gadval = $param->{gadval};<br />
<br />
my $device = $param->{device};<br />
my $reading = $param->{reading};<br />
my $event = $param->{event};<br />
<br />
my @args = @{$param->{args}};<br />
my $cache = $param->{cache};<br />
<br />
if ($param->{cmd} eq 'get')<br />
{<br />
$param->{cmd} = 'send';<br />
}<br />
if ($param->{cmd} eq 'send')<br />
{<br />
$param->{gad} = $gad;<br />
$param->{gadval} = decode_json(main::ReadingsVal($device, $reading, ''));<br />
$param->{gads} = [];<br />
return undef;<br />
}<br />
elsif ($param->{cmd} eq 'rcv')<br />
{<br />
$gadval = encode_json($gadval);<br />
$gadval =~ s/;/;;/ig;<br />
$param->{result} = main::fhem("setreading $device $reading $gadval");<br />
$param->{results} = [];<br />
return 'done';<br />
}<br />
elsif ($param->{cmd} eq '?')<br />
{<br />
return 'usage: UZSU';<br />
}<br />
return undef;<br />
}<br />
<br />
</nowiki><br />
<br />
Dieser Code erzeugt aus den Einstellungen im Widget entsprechende WeekdayTimer in fhem und löscht und erstellt neu bei jeder Änderung in SmartVISU.<br />
<br />
4. Die Funktion muss getriggert werden. Dazu ist ein notify nötig, das auf die Veränderung der uzsu Readings reagiert:<br />
<br />
<nowiki><br />
<br />
define UZSU notify .*:uzsu:.* { UZSU_execute($NAME, $EVTPART1) }<br />
<br />
</nowiki><br />
<br />
Voila!<br />
<br />
[[Kategorie: FHEM Frontends]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=Fronthem&diff=10792Fronthem2015-04-03T15:37:00Z<p>Fidel: </p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Anbindung von externen Frontends an FHEM (befindet sich in der Alpha-Phase)<br />
|ModType=x<br />
<!-- |ModCategory= (noch?) nicht verwendet --><br />
<!-- |ModCmdRef= wird automatisch generiert --><br />
|ModForumArea=Sonstige Systeme<br />
|ModTechName=01_fronthem.pm<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=769 Jörg alias herrmannj]<br />
}}<br />
Fronthem ist ein Projekt von herrmannj und wurde im fhem-Forum erstmalig angekündigt: http://forum.fhem.de/index.php/topic,27291.0.html<br />
<br />
Fronthem verfolgt die Idee, ein externes Web-Frontend (z. B. [[smartVISU]] <br />
http://smartvisu.de) an fhem anzukoppeln und den Datenverkehr sowie die Zusammenarbeit von Befehlen und Parametern zwischen FHEM und dem Web-Frontend zu übernehmen.<br />
<br />
Eine Installation für die Verwendung von [[SmartVisu]] mit Fronthem findet man hier [[Installation Fronthem|Installation Fronthem]].<br />
<br />
Dazu besteht fronthem aus vier Bausteinen:<br />
<br />
==Bausteine==<br />
=== websocket ===<br />
Der Websocket ist eine generische http-Schnittstelle, die von einem externen Frontend aus angesprochen werden kann.<br />
<br />
Der Websocket wird durch ein fhem-Modul 01_fronthem.pm realisiert, das im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
Der Websocket ist auf Port 2121 fest eingestellt, wird implizit durch die anderen Bausteine verwendet und benötigt im Prinzip keine weitere Beachtung, außer man möchte das Webinterface auf einem anderen Device neben FHEM laufen lassen.<br />
<br />
=== device connector ===<br />
Die Device-Connectoren dienen dazu, Endgeräte des Benutzers (PCs, Tablets, Smartphones usw.) als Clients zuzulassen und deren Berechtigungen (read, write) auf der Ebene einzelner Objekte zu steuern. Damit können z. B. die lieben Kinder zwar das Licht und die eigene Heizung steuern, aber nicht die Heizung umprogrammieren oder den Alarm ausschalten. Auch ein PIN-Schutz ist vorgesehen, im Moment aber noch nicht umgesetzt.<br />
<br />
Die Device-Connectoren werden durch das fhem-Modul 31_fronthemDevice.pm realisiert, welches im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
An den einzelnen Device-Connectoren werden die durch den websocket vom externen Frontend mitgeteilten Objekte aufgelistet und können dort einerseits mit fhem devices und andererseits in den Berechtigungen des jeweiligen Endgerätes konfiguriert werden.<br />
<br />
Umgekehrt bedeutet dies, dass man die Kombination der Frontend-items mit den fhem-Devices über die Converter nur einmal pro item machen muss, die Berechtigungen der verwendeten Endgeräte muss man aber jeweils pro Endgerät einzeln setzen.<br />
<br />
=== readings converter ===<br />
Die Readings von fhem müssen in die Form der möglichen Werte des Frontends umgewandelt werden. Im umgekehrten Fall müssen Befehle des Frontends in fhem kompatible Befehle umgesetzt werden.<br />
Diese Aufgabe übernehmen die Readings Converter. Sie werden durch die Datei fhconverter.pm realisiert, die im Ordner .../fhem/FHEM/ abgelegt wird. <br />
Bisher gibt es folgende Converter:<br />
* [[#Direct]] für Übertragung ohne Konvertierung<br />
* [[#NumDirect]] für Übertragung von Zahlenwerten in einem begrenzten Werteraum zwischen Min und Max<br />
* [[#NumDisplay]] für Zahlenwerte aus fhem Readings, nur lesend<br />
* [[#WordDisplay]] ist in Planung, für Übertragung von selbst definierbaren Wörtern/Sätze<br />
* [[#OnOff]] für Schalter, Übersetzung von On in 1 und Off in 0<br />
* [[#RGBCombined]] für Übertragung von RGB-Werten so das sie FHEM akzeptiert<br />
Näheres zu denn Convertern unter [[#Converter]]<br />
<br />
Weitere Readings Converter werden noch folgen.<br />
<br />
=== fronthemEditor ===<br />
Der Javascript Editor ist eine fhem WebIF Erweiterung, um die Bindung der fremden Frontend-Objekte an FHEM Devices/Readings vorzunehmen und die dazu notwendigen Konvertierungen zu wählen.<br />
Er wird durch die Datei fronthemEditor.js repräsentiert, die in den Ordner .../fhem/www/frontend/pgm2/ kopiert wird.<br />
<br />
Der Editor erscheint in fhem als komplette gad-Liste in den Details von jedem definierten fronthemDevice. Das mag auf den ersten Blick irreführend sein, weil die Definition der gad/items/plots fhem-global geschieht, war aber wohl die beste mögliche Umsetzung zur Zeit.<br />
<br />
Man muss also durch den Editor an einem beliebigen fronthemDevice die Verknüpfung zwischen fhem-devices und smartVISU items herstellen, dann gilt diese für alle fhem Devices. Nur die Berechtigungen der einzelnen fhem Devices werden unterschiedlich gepflegt. (im Moment aber inaktiviert!)<br />
<br />
==Basic Syntax==<br />
===Websocket===<br />
:<code>define <name> fronthem</code><br />
<br />
===Device Connector===<br />
Man muss jedes Device, mit dem man zugreifen will definieren.<br />
<br />
Dadurch kann genau festgelegt werden, welches Device Rechte für eine jeweilige Schaltfunktion hat.<br />
====IP-Identify====<br />
Identifizierung per IP-Adresse. Dies ist nur im internen Netzwerk sehr sinnvoll.<br />
Ein Device wird definiert mit:<br />
:<code>define <device> fronthemDevice <ip></code><br />
====Zertificate-Identify====<br />
Das Device wird über ein Zertifikat identifiziert.<br />
Zuerst wird ein Zertifikat generiert, welches dann auf dem Device installiert werden muss.<br />
<br />
Diese Methode der Identifizierung verspricht höhere Sicherheit, wie auch denn Vorteil, das man sich nicht einloggen muss.<br />
<br />
Diese Funktion ist noch in Entwicklung.<br />
<br />
==Converter==<br />
Die Converter sind alle kompatibel mit dem oben erwähnten Frontend [[SmartVisu]] und werden auf Basis dieses Frontends erklärt.<br />
<br />
Wenn jemand ein anderes Frontend verwenden will, muss er möglicherweise die Converter anpassen.<br />
===Direct===<br />
Die Werte werden ohne Konvertierung weitergegeben.<br />
<br />
Gibt den Wert des von <reading> ohne weitere Wandlung an das Frontend weiter. In umgekehrter Richtung wird der vom Frontend geliefert Wert ohne Wandlung im hinterlegten <set> eingesetzt.<br />
<br />
Beispiel: <br />
Anzeige eines An- oder Abwesenheitszustandes im Frontend (Textanzeige, Icon, Button)<br />
<br />
===NumDirect===<br />
NumDirect arbeitet bidirektional. Die Werte werden genau wie bei Direct ohne Umwandlung weitergegeben.<br />
<br />
Der feine Unterschied zu Direct ist jedoch, das nur Zahlenwerte übergeben werden können.<br />
<br />
Desweiteren kann man einen minimalen und maximalen Wert mitangeben. Dies hat denn Sinn, das man keine Werte einstellen kann, die überhaupt nicht möglich wären.<br />
<br />
In der SmartVisu kann man z.B. -100°C einstellen, das wäre in FHEM jedoch gar nicht möglich.<br />
<br />
===NumDelayed===<br />
NumDelayed ist noch in Arbeit.<br />
<br />
Ein bidirektionaler numerischer Converter mit einstellbarer Verzögerung.<br />
<br />
Bietet bei der Ansteuerung mechanischer Aktoren (Markise, Jalousie) Vorteile gegenüber NumDirect. Als Beispiel sei die Steuerung einer Jalousie über einen Slider genannt. Da Slider ihre Werte kontinuierlich an FHEM übermitteln, würde bei der Verwendung anderer Converter dem entsprechenden Aktor (z.B. HM-BP), während der Benutzer den Slider bedient, mehrfach der vermeindliche Sollwert übermittelt werden. Gleichzeitig beginnt der Aktor seine Fahrt und übermittelt dem Slider seine aktuelle ist Position. Das führt zu einem springen des Sliders und einer "unschönen" Bedienung.<br />
<br />
NumDelayed nimmt daher die Signale des Sliders entgegen, wartet jedoch mit der Weitergabe solange, bis sich der Slider (xxx ms, konfigurierbar) nicht mehr bewegt. In Gegenrichtung wird ebenso verfahren, erst wenn der Aktor seine Endposition erreicht, wird der Slider im Frontend aktualisiert. In diesem Beispiel würde das bedeuten das der Slider im Normalfall ohnehin so steht (Soll) wie vom Aktor gemeldet (Ist). Natürlich könnte der Benutzer oder ein Hindernis die Fahrt auch unterbrochen haben, dann würde der Slider auf die gemeldete Position aktualisiert.<br />
<br />
===NumDisplay===<br />
NumDisplay arbeitet nur in eine Richting, FHEM zu Frontend. Die Werte werden ohne Umwandlung weitergegeben.<br />
<br />
Es ist dazu gedacht Zahlenwerte zu übergeben, ohne etwas zu verändern.<br />
<br />
z.B. für Temperaturwerte<br />
<br />
===WordDisplay===<br />
WordDisplay ist derzeit in Planung, es wird noch über die Umsetzung diskutiert.<br />
<br />
WordDisplay soll nur in eine Richtung arbeiten, FHEM zu Frontend. Es ist dazu gedacht Wörter oder Textpassagen zu übertragen.<br />
<br />
Jedoch soll es möglich sein, eine Umwandlung selbst festzulegen. So kann man einfach mehrere Textausgaben abhängig vom Zustand an das Frontend schicken:<br />
<br />
z.B. Geofancy: Home -> Zuhause, Underway -> Unterwegs, Work -> Arbeit<br />
<br />
===OnOff===<br />
Für einfache Ein/Aus-Funktionen.<br />
<br />
FHEM interpretiert Ein/Aus-Funktionen mit on/off, SmartVisu jedoch mit 1/0.<br />
<br />
Der OnOff-Converter wandelt diese bidirektional, damit sie richtig interpretiert werden.<br />
<br />
===RGBCombined===<br />
Ein Converter zur Steuerung von RGB Leuchtmitteln über Farbauswahlfelder (zb. Farbkreis)<br />
<br />
Bidirektional, wandelt, verwendet 3 Frontend Items<br />
<br />
reading: Name eines reading mit HEX RGB Wert des Leuchtmittels<br />
converter (mit Parameter): <code>RGBCombined <itemRed>, <itemYellow>, <itemBlue></code><br />
<br />
set: Name des set Befehls, bekommt HEX RGB Wert übergeben <br />
<br />
Dieser Converter muss gleichlautend für alle 3 RGB Kanäle des Frontends definiert werden.<br />
<br />
==Device Connector==<br />
Sobald ein fronthemDevice definiert ist, kann man über die device details in fhem die GADs definieren und die Rechte verteilen.<br />
===GAD definieren===<br />
Eine GAD-Definierung besteht aus:<br />
[[Datei:DeviceDefine.png|400px|thumb|right|GADs definieren]]<br />
*mode<br />
*device<br />
*reading<br />
*converter<br />
*cmd set<br />
====mode====<br />
Es gibt 2 Modis:<br />
*item<br />
*plot<br />
====device====<br />
Hier wird der Name des FHEM-Devices eingetragen, an das die Befehle geschickt werden. Die vorhandenen Devices in fhem werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt. <br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====reading====<br />
Das für die Anzeige zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Readings werden, wenn das Frontend dies anfordert, aktiv von fronthem gelesen und (per push) proaktiv an das Frontend gesendet wenn fhem entsprechende events erzeugt.<br />
<br />
====converter====<br />
Hier gibt man denn Namen des Converters an, denn man verwenden möchte.<br />
Es stehen unterschiedliche converter für verschiedene Aufgabenstellungen zur Verfügung. Über das Konzept der converter können fhem Device unterschiedlichster Typen und Funktionen über das Frontend bedient werden. So versorgt der gleiche converter der die Solltemperatur des virtuellen Heizungsthermostats (bidriektional) einstellt auch die Füllstandanzeige der Zisterne sowie den Dimmer. In all diesen Fällen handelt es sich um die Übertragung von numerischen Werten. Converter können dabei auch Spezialaufgaben wie die Begrenzung des Wertebereichs übernehmen. So lässt sich über NumDirect zum Beispiel die Solltemperatur Einstellung für virtuelle Heizungsregler auf Min und Max Werte begrenzen. <br />
<br />
Oben ist eine Standardliste der [[#Converter]]. Die meisten Devices können mit diesen Convertern angesteuert werden.<br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====cmd set====<br />
Das zum Schreiben zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Das gewählte Reading gibt den "set" des fhem Devices an, der die Rückgabe des Converters entgegen nimmt.<br />
<br />
Bei Lampe z.B. "state".<br />
<br />
===Devicerechte vergeben===<br />
[[Datei:DeviceRechte.png|400px|thumb|right|Devicerechte vergeben]]<br />
Devicerechte bestehen aus:<br />
*read<br />
*write<br />
*PIN GAD<br />
====read====<br />
Das Device darf die Statuswerte auslesen, jedoch nicht verändern.<br />
<br />
====write====<br />
Das Device darf Statuswerte ändern.<br />
<br />
====PIN GAD====<br />
In Entwicklung...<br />
<br />
<br />
==Universelle ZeitSchaltUhr UZSU==<br />
Es existiert ein Widget für eine universelle ZeitSchaltUhr auf GitHub unter https://github.com/mworion/uzsu_widget .<br />
<br />
Hierbei bitte die Version 2.0 des UZSU Widgets verwenden oder das UZSU Widget aus https://github.com/herrmannj/smartvisu-widgets beziehen<br />
<br />
Man muss dazu die uzsu_widget.html in das eigene Verzeichnis in ../pages/.. kopieren und die visu.js und die visu.css in seine Installation integrieren (Achtung, wenn die beiden Dateien schon bestehen, dann muss man das manuell zusammenkopieren!)<br />
<br />
Das Widget kann in SmartVISU wie gewohnt eingebunden werden:<br />
<br />
(für ein Ergebnis, das der Benutzer direkt eintippen kann, z.B. 'on' oder 'off')<br />
<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUtxt', gad_uzsu, '', '', '', '', 'text') }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis zwischen 0 und 100)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'num', 0, 100) }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis {0,1}, das aber als flip mit 'an' und 'aus' angezeigt wird)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'bool', 'an', 'aus') }}<br />
</nowiki><br />
<br />
<br />
Um die Antwort des Widgets in fhem zu verarbeiten, benötigt man <br />
<br />
1. je ein Reading uzsu an dem zu schaltenden Device, das man mit <br />
<br />
<nowiki><br />
setreading <device> uzsu {}<br />
</nowiki><br />
<br />
erzeugen MUSS.<br />
<br />
2. eine Anbindung des uzsu-GAD per UZSU Converter an das Reading uzsu des zu schaltenden Device read und write in fhem<br />
<br />
3. folgenden Code in der 99_FronthemUtils.pm:<br />
<br />
Im Package Main:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Umsetzen der UZSU-Settings für ein device<br />
#<br />
###############################################################################<br />
sub UZSU_execute($$)<br />
{<br />
my ($device, $uzsu) = @_;<br />
<br />
$uzsu = decode_json($uzsu);<br />
fhem('delete wdt_'.$device.'_uzsu');<br />
my $weekdays_part = " ";<br />
for(my $i=0; $i < @{$uzsu->{list}}; $i++) {<br />
my $weekdays = $uzsu->{list}[$i]->{rrule};<br />
$weekdays = substr($weekdays,18,50); <br />
if (($uzsu->{list}[$i]->{active})) {<br />
$weekdays_part = $weekdays_part.' '.$weekdays.'|'.$uzsu->{list}[$i]->{time}.'|'.$uzsu->{list}[$i]->{value};<br />
}<br />
}<br />
fhem('define wdt_'.$device.'_uzsu'.' WeekdayTimer '.$device.' en '.$weekdays_part);<br />
if ($uzsu->{active}){ <br />
fhem('attr wdt_'.$device.'_uzsu disable 0');<br />
} else {<br />
fhem('attr wdt_'.$device.'_uzsu disable 1');<br />
} <br />
}<br />
</nowiki><br />
<br />
Im Package fronthem, selbe Datei:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Setreading a device reading using JSON conversion (gadval => reading=decode_json() => setval => encode_json(reading) )<br />
#<br />
###############################################################################<br />
<br />
sub UZSU(@)<br />
{<br />
my ($param) = @_;<br />
my $cmd = $param->{cmd};<br />
my $gad = $param->{gad};<br />
my $gadval = $param->{gadval};<br />
<br />
my $device = $param->{device};<br />
my $reading = $param->{reading};<br />
my $event = $param->{event};<br />
<br />
my @args = @{$param->{args}};<br />
my $cache = $param->{cache};<br />
<br />
if ($param->{cmd} eq 'get')<br />
{<br />
$param->{cmd} = 'send';<br />
}<br />
if ($param->{cmd} eq 'send')<br />
{<br />
$param->{gad} = $gad;<br />
$param->{gadval} = decode_json(main::ReadingsVal($device, $reading, ''));<br />
$param->{gads} = [];<br />
return undef;<br />
}<br />
elsif ($param->{cmd} eq 'rcv')<br />
{<br />
$gadval = encode_json($gadval);<br />
$gadval =~ s/;/;;/ig;<br />
$param->{result} = main::fhem("setreading $device $reading $gadval");<br />
$param->{results} = [];<br />
return 'done';<br />
}<br />
elsif ($param->{cmd} eq '?')<br />
{<br />
return 'usage: UZSU';<br />
}<br />
return undef;<br />
}<br />
<br />
</nowiki><br />
<br />
Dieser Code erzeugt aus den Einstellungen im Widget entsprechende WeekdayTimer in fhem und löscht und erstellt neu bei jeder Änderung in SmartVISU.<br />
<br />
4. Die Funktion muss getriggert werden. Dazu ist ein notify nötig, das auf die Veränderung der uzsu Readings reagiert:<br />
<br />
<nowiki><br />
<br />
define UZSU notify .*:uzsu:.* { UZSU_execute($NAME, $EVTPART1) }<br />
<br />
</nowiki><br />
<br />
Voila!<br />
<br />
[[Kategorie: FHEM Frontends]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10791SmartVISU2015-04-03T15:34:27Z<p>Fidel: /* Widgets: */</p>
<hr />
<div>SmartVisu ist ein Framework zur Visualisierung von Hausautomationssystemen, die eigentlich KNX-Installationen bedient.<br />
<br />
Durch [[Fronthem]] ist es möglich SmartVisu an Fhem anzubinden.<br />
<br />
* Ausführliche Beschreibung von Fronthem: [[Fronthem]]<br />
* Installationsanleitung für SmartVisu in Verbindung mit Fronthem: [[Installation Fronthem]]<br />
<br />
<br />
Codebeispiele:<br />
<br />
* [[SmartVisu/IconHighlights in Menus]]<br />
* [[SmartVisu/lichtSzene]]<br />
<br />
<br />
==Widgets:==<br />
<br />
zusätzliche Widgets werden im git-Repository /smartvisu-widgets breitgestellt <br />
https://github.com/herrmannj/smartvisu-widgets<br />
<br />
*ical <br />
[[SmartVisu/ical]] <br />
*fritz!box_via_TR-064 <br />
[[SmartVisu/fritz!box_via_TR-064]] <br />
*fritz!box_v6.20<br />
*<br />
<br />
[[Kategorie: FHEM Frontends]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10790SmartVISU2015-04-03T15:30:35Z<p>Fidel: </p>
<hr />
<div>SmartVisu ist ein Framework zur Visualisierung von Hausautomationssystemen, die eigentlich KNX-Installationen bedient.<br />
<br />
Durch [[Fronthem]] ist es möglich SmartVisu an Fhem anzubinden.<br />
<br />
* Ausführliche Beschreibung von Fronthem: [[Fronthem]]<br />
* Installationsanleitung für SmartVisu in Verbindung mit Fronthem: [[Installation Fronthem]]<br />
<br />
<br />
Codebeispiele:<br />
<br />
* [[SmartVisu/IconHighlights in Menus]]<br />
* [[SmartVisu/lichtSzene]]<br />
<br />
<br />
==Widgets:==<br />
<br />
zusätzliche Widgets werden im git-Repository /smartvisu-widgets breitgestellt<br />
<br />
*ical <br />
[[SmartVisu/ical]] <br />
*fritz!box_via_TR-064 <br />
[[SmartVisu/fritz!box_via_TR-064]] <br />
*fritz!box_v6.20<br />
*<br />
<br />
[[Kategorie: FHEM Frontends]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10789SmartVISU2015-04-03T15:29:01Z<p>Fidel: /* Widgets: */</p>
<hr />
<div>SmartVisu ist ein Framework zur Visualisierung von Hausautomationssystemen, die eigentlich KNX-Installationen bedient.<br />
<br />
Durch [[Fronthem]] ist es möglich SmartVisu an Fhem anzubinden.<br />
<br />
* Ausführliche Beschreibung von Fronthem: [[Fronthem]]<br />
* Installationsanleitung für SmartVisu in Verbindung mit Fronthem: [[Installation Fronthem]]<br />
<br />
<br />
Codebeispiele:<br />
<br />
* [[SmartVisu/IconHighlights in Menus]]<br />
* [[SmartVisu/lichtSzene]]<br />
<br />
<br />
==Widgets:==<br />
<br />
zusätzliche Widgets werden im git-Repository /smartvisu-widgets breitgestellt<br />
<br />
*ical http://www.fhemwiki.de/wiki/SmartVisu/ical<br />
*fritz!box_via_TR-064 <br />
http://www.fhemwiki.de/wiki/SmartVisu/fritz!box_via_TR-064<br />
*fritz!box_v6.20<br />
*<br />
<br />
[[Kategorie: FHEM Frontends]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU/fritz!box_via_TR-064&diff=10788SmartVISU/fritz!box via TR-0642015-04-03T15:28:00Z<p>Fidel: Die Seite wurde neu angelegt: „ ==fritz!box_via_TR-064== (unter phoneservice/lib/phone/service) Dieses Widget verwendet TR-064 zum Auslesen der Anruferliste. Es ist ein Protokoll das nahe…“</p>
<hr />
<div><br />
==fritz!box_via_TR-064==<br />
<br />
(unter phoneservice/lib/phone/service) <br />
<br />
Dieses Widget verwendet TR-064 zum Auslesen der Anruferliste. Es ist ein Protokoll das nahe am UPnP Standard ist (SOAP).<br />
Getestet habe ich es mit den FritzOS Versionen 6.03 und 6.20.<br />
Dieses Widget wird unter der Smartvisu-Config Seite ausgewählt und es muss gegebenenfalls Benutzer und Passwort der Fritzbox in SmartViu angegeben werden.<br />
Wichtig dabei ist, dass in der Fritzbox unter ->Heimnetz->Netzwerk->Netzwerkeinstellungen->Zugriff für Anwendungen zulassen altiviert ist.</div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10787SmartVISU2015-04-03T15:27:51Z<p>Fidel: /* Widgets: */</p>
<hr />
<div>SmartVisu ist ein Framework zur Visualisierung von Hausautomationssystemen, die eigentlich KNX-Installationen bedient.<br />
<br />
Durch [[Fronthem]] ist es möglich SmartVisu an Fhem anzubinden.<br />
<br />
* Ausführliche Beschreibung von Fronthem: [[Fronthem]]<br />
* Installationsanleitung für SmartVisu in Verbindung mit Fronthem: [[Installation Fronthem]]<br />
<br />
<br />
Codebeispiele:<br />
<br />
* [[SmartVisu/IconHighlights in Menus]]<br />
* [[SmartVisu/lichtSzene]]<br />
<br />
<br />
==Widgets:==<br />
<br />
zusätzliche Widgets werden im git-Repository /smartvisu-widgets breitgestellt<br />
<br />
*ical http://www.fhemwiki.de/wiki/SmartVisu/ical<br />
<br />
*fritz!box_via_TR-064 <br />
http://www.fhemwiki.de/wiki/SmartVisu/fritz!box_via_TR-064<br />
<br />
*fritz!box_v6.20<br />
*<br />
<br />
<br />
[[Kategorie: FHEM Frontends]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU/ical&diff=10786SmartVISU/ical2015-04-03T15:22:52Z<p>Fidel: Die Seite wurde neu angelegt: „Um einen Kalender in SV mit dem Widget widget_ical einzubinden, ist folgendes zu tun: 1. Die Datei iCalcreator.class.php aus dem Paket http://kigkonsult.se/do…“</p>
<hr />
<div>Um einen Kalender in SV mit dem Widget widget_ical einzubinden, ist folgendes zu tun:<br />
<br />
1. Die Datei iCalcreator.class.php aus dem Paket http://kigkonsult.se/downloads/index.php#iCalcreator<br />
unter einem beliebigen Pfad abgelegt werden, der aber in der ical.php eingetragen werden muss.<br />
Dabei muss auf die Rechte der Datei geachtet werden. Es sollten die gleichen User/Group-Rechte verwendet werden,<br />
wie auch bei den Dateien im pages Ordner<br />
<br />
2. Ablegen der Datei ical.php in das Verzeichnis /smartVISU/lib/calendar/service<br />
<br />
3. Ablegen der Datei widget_ical.html in das Homeverzeichnis der eigenen Seite z.b. /smartVISU/pages/fhem<br />
<br />
4. Definition der Kalender in den Settings statt. Die Kalender werden wie folgt definiert:<br />
- wie bisher nur die Url<br />
http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/calendar<br />
- die Url mit Parameter Farbe und Icon<br />
http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/calendar(Default Farbe,Default Icon)<br />
- die Url mit Parameter Farbe<br />
http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/calendar(Default Farbe)<br />
- die Url mit Parameter Icon<br />
http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/calendar(,Default Icon)<br />
- zwei Kalenderurls mit unterschiedlichen Parametern<br />
http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/calendar(,message_garbage);http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/Geburtstage(#ff69b4,scene_party)<br />
- eine lokale Url<br />
file:/tmp/calendar.ics<br />
- zwei Kalenderurls eine lokale und eine auf einem Caldav/Webserver<br />
file:/tmp/calendar.ics(,message_garbage);http://xxx:xxx@xxx.xxx.xxx.xxx/davical/caldav.php/norbert/Geburtstage(#ff69b4,scene_party)<br />
<br />
Wird eine lokale Datei verwendet, muss auf die Rechte der Datei geachtet werden. Es sollten die gleichen User/Group-Rechte verwendet werden,<br />
wie auch bei den Dateien im pages Ordner<br />
<br />
Die Icons sind die Namen der png-Dateien ohne .png. Wenn keine Parameter, für Farbe und Icon mitgegeben werden und auch keine in den Terminen hinterlegt sind,<br />
wird ein Standardicon und eine Standardfarbe gesetzt. Das setzen dieser Parameter pro Termin erfolgt im Beschreibungsfeld des jeweiligen Termin.<br />
<br />
5. Einbinden es Kalenders auf einer SV-Seite:<br />
{% import "widget_ical.html" as calendar %}<br />
{{ calendar.list('calendarlist', 'Termine', 6, 21) }}<br />
Die erste Zahl (6) ist die Anzahl der Termine die aufgelistet werden. Die zweite Zahl (21) ist die Anzahl der Tage, die<br />
im Kalender in die Zukunft geprüft wird, ob sich ein Termin wiederholt.</div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10785SmartVISU2015-04-03T15:19:45Z<p>Fidel: </p>
<hr />
<div>SmartVisu ist ein Framework zur Visualisierung von Hausautomationssystemen, die eigentlich KNX-Installationen bedient.<br />
<br />
Durch [[Fronthem]] ist es möglich SmartVisu an Fhem anzubinden.<br />
<br />
* Ausführliche Beschreibung von Fronthem: [[Fronthem]]<br />
* Installationsanleitung für SmartVisu in Verbindung mit Fronthem: [[Installation Fronthem]]<br />
<br />
<br />
Codebeispiele:<br />
<br />
* [[SmartVisu/IconHighlights in Menus]]<br />
* [[SmartVisu/lichtSzene]]<br />
<br />
<br />
==Widgets:==<br />
<br />
zusätzliche Widgets werden im git-Repository /smartvisu-widgets breitgestellt<br />
<br />
*fritz!box_via_TR-064 (unter phoneservice/lib/phone/service) <br />
<br />
Dieses Widget verwendet TR-064 zum Auslesen der Anruferliste. Es ist ein Protokoll das nahe am UPnP Standard ist (SOAP).<br />
Getestet habe ich es mit den FritzOS Versionen 6.03 und 6.20.<br />
Dieses Widget wird unter der Smartvisu-Config Seite ausgewählt und es muss gegebenenfalls Benutzer und Passwort der Fritzbox in SmartViu angegeben werden.<br />
Wichtig dabei ist, dass in der Fritzbox unter ->Heimnetz->Netzwerk->Netzwerkeinstellungen->Zugriff für Anwendungen zulassen altiviert ist.<br />
<br />
*fritz!box_v6.20<br />
*<br />
<br />
<br />
[[Kategorie: FHEM Frontends]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10784SmartVISU2015-04-03T15:15:45Z<p>Fidel: </p>
<hr />
<div>SmartVisu ist ein Framework zur Visualisierung von Hausautomationssystemen, die eigentlich KNX-Installationen bedient.<br />
<br />
Durch [[Fronthem]] ist es möglich SmartVisu an Fhem anzubinden.<br />
<br />
* Ausführliche Beschreibung von Fronthem: [[Fronthem]]<br />
* Installationsanleitung für SmartVisu in Verbindung mit Fronthem: [[Installation Fronthem]]<br />
<br />
<br />
Codebeispiele:<br />
<br />
* [[SmartVisu/IconHighlights in Menus]]<br />
* [[SmartVisu/lichtSzene]]<br />
<br />
<br />
==Widgets:==<br />
<br />
==zusätzliche Widgets werden im git-Repository /smartvisu-widgets breitgestellt==<br />
<br />
*<br />
*<br />
*<br />
<br />
==Widgets die die Config-Seite betreffen liegen bereits im git-Repository smartvisu-cleaninstall==<br />
<br />
*fritz!box_via_TR-064<br />
Dieses Widget verwendet TR-064 zum Auslesen der Anruferliste. Es ist ein Protokoll das nahe am UPnP Standard ist (SOAP).<br />
Getestet habe ich es mit den FritzOS Versionen 6.03 und 6.20.<br />
Dieses Widget wird unter der Smartvisu-Config Seite ausgewählt und es muss gegebenenfalls Benutzer und Passwort der Fritzbox in SmartViu angegeben werden.<br />
Wichtig dabei ist, dass in der Fritzbox unter ->Heimnetz->Netzwerk->Netzwerkeinstellungen->Zugriff für Anwendungen zulassen altiviert ist.<br />
<br />
*fritz!box_v6.20<br />
*<br />
<br />
<br />
[[Kategorie: FHEM Frontends]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=Fronthem&diff=10596Fronthem2015-03-22T13:06:43Z<p>Fidel: /* Universelle ZeitSchaltUhr UZSU */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Anbindung von externen Frontends an FHEM (befindet sich in der Alpha-Phase)<br />
|ModType=x<br />
<!-- |ModCategory= (noch?) nicht verwendet --><br />
<!-- |ModCmdRef= wird automatisch generiert --><br />
|ModForumArea=Sonstige Systeme<br />
|ModTechName=01_fronthem.pm<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=769 Jörg alias herrmannj]<br />
}}<br />
Fronthem ist ein Projekt von herrmannj und wurde im fhem-Forum erstmalig angekündigt: http://forum.fhem.de/index.php/topic,27291.0.html<br />
<br />
Fronthem verfolgt die Idee, ein externes Web-Frontend (z. B. smartVISU http://smartvisu.de) an fhem anzukoppeln und den Datenverkehr sowie die Zusammenarbeit von Befehlen und Parametern zwischen FHEM und dem Web-Frontend zu übernehmen.<br />
<br />
Eine Installation für die Verwendung von [[SmartVisu]] mit Fronthem findet man hier [[Installation Fronthem|Installation Fronthem]].<br />
<br />
Dazu besteht fronthem aus vier Bausteinen:<br />
<br />
==Bausteine==<br />
=== websocket ===<br />
Der Websocket ist eine generische http-Schnittstelle, die von einem externen Frontend aus angesprochen werden kann.<br />
<br />
Der Websocket wird durch ein fhem-Modul 01_fronthem.pm realisiert, das im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
Der Websocket ist auf Port 2121 fest eingestellt, wird implizit durch die anderen Bausteine verwendet und benötigt im Prinzip keine weitere Beachtung, außer man möchte das Webinterface auf einem anderen Device neben FHEM laufen lassen.<br />
<br />
=== device connector ===<br />
Die Device-Connectoren dienen dazu, Endgeräte des Benutzers (PCs, Tablets, Smartphones usw.) als Clients zuzulassen und deren Berechtigungen (read, write) auf der Ebene einzelner Objekte zu steuern. Damit können z. B. die lieben Kinder zwar das Licht und die eigene Heizung steuern, aber nicht die Heizung umprogrammieren oder den Alarm ausschalten. Auch ein PIN-Schutz ist vorgesehen, im Moment aber noch nicht umgesetzt.<br />
<br />
Die Device-Connectoren werden durch das fhem-Modul 31_fronthemDevice.pm realisiert, welches im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
An den einzelnen Device-Connectoren werden die durch den websocket vom externen Frontend mitgeteilten Objekte aufgelistet und können dort einerseits mit fhem devices und andererseits in den Berechtigungen des jeweiligen Endgerätes konfiguriert werden.<br />
<br />
Umgekehrt bedeutet dies, dass man die Kombination der Frontend-items mit den fhem-Devices über die Converter nur einmal pro item machen muss, die Berechtigungen der verwendeten Endgeräte muss man aber jeweils pro Endgerät einzeln setzen.<br />
<br />
=== readings converter ===<br />
Die Readings von fhem müssen in die Form der möglichen Werte des Frontends umgewandelt werden. Im umgekehrten Fall müssen Befehle des Frontends in fhem kompatible Befehle umgesetzt werden.<br />
Diese Aufgabe übernehmen die Readings Converter. Sie werden durch die Datei fhconverter.pm realisiert, die im Ordner .../fhem/FHEM/ abgelegt wird. <br />
Bisher gibt es folgende Converter:<br />
* [[#Direct]] für Übertragung ohne Konvertierung<br />
* [[#NumDirect]] für Übertragung von Zahlenwerten in einem begrenzten Werteraum zwischen Min und Max<br />
* [[#NumDisplay]] für Zahlenwerte aus fhem Readings, nur lesend<br />
* [[#WordDisplay]] ist in Planung, für Übertragung von selbst definierbaren Wörtern/Sätze<br />
* [[#OnOff]] für Schalter, Übersetzung von On in 1 und Off in 0<br />
* [[#RGBCombined]] für Übertragung von RGB-Werten so das sie FHEM akzeptiert<br />
Näheres zu denn Convertern unter [[#Converter]]<br />
<br />
Weitere Readings Converter werden noch folgen.<br />
<br />
=== fronthemEditor ===<br />
Der Javascript Editor ist eine fhem WebIF Erweiterung, um die Bindung der fremden Frontend-Objekte an FHEM Devices/Readings vorzunehmen und die dazu notwendigen Konvertierungen zu wählen.<br />
Er wird durch die Datei fronthemEditor.js repräsentiert, die in den Ordner .../fhem/www/frontend/pgm2/ kopiert wird.<br />
<br />
Der Editor erscheint in fhem als komplette gad-Liste in den Details von jedem definierten fronthemDevice. Das mag auf den ersten Blick irreführend sein, weil die Definition der gad/items/plots fhem-global geschieht, war aber wohl die beste mögliche Umsetzung zur Zeit.<br />
<br />
Man muss also durch den Editor an einem beliebigen fronthemDevice die Verknüpfung zwischen fhem-devices und smartVISU items herstellen, dann gilt diese für alle fhem Devices. Nur die Berechtigungen der einzelnen fhem Devices werden unterschiedlich gepflegt. (im Moment aber inaktiviert!)<br />
<br />
==Basic Syntax==<br />
===Websocket===<br />
:<code>define <name> fronthem</code><br />
<br />
===Device Connector===<br />
Man muss jedes Device, mit dem man zugreifen will definieren.<br />
<br />
Dadurch kann genau festgelegt werden, welches Device Rechte für eine jeweilige Schaltfunktion hat.<br />
====IP-Identify====<br />
Identifizierung per IP-Adresse. Dies ist nur im internen Netzwerk sehr sinnvoll.<br />
Ein Device wird definiert mit:<br />
:<code>define <device> fronthemDevice <ip></code><br />
====Zertificate-Identify====<br />
Das Device wird über ein Zertifikat identifiziert.<br />
Zuerst wird ein Zertifikat generiert, welches dann auf dem Device installiert werden muss.<br />
<br />
Diese Methode der Identifizierung verspricht höhere Sicherheit, wie auch denn Vorteil, das man sich nicht einloggen muss.<br />
<br />
Diese Funktion ist noch in Entwicklung.<br />
<br />
==Converter==<br />
Die Converter sind alle kompatibel mit dem oben erwähnten Frontend SmartVisu und werden auf Basis dieses Frontends erklärt.<br />
<br />
Wenn jemand ein anderes Frontend verwenden will, muss er möglicherweise die Converter anpassen.<br />
===Direct===<br />
Die Werte werden ohne Konvertierung weitergegeben.<br />
<br />
Gibt den Wert des von <reading> ohne weitere Wandlung an das Frontend weiter. In umgekehrter Richtung wird der vom Frontend geliefert Wert ohne Wandlung im hinterlegten <set> eingesetzt.<br />
<br />
Beispiel: <br />
Anzeige eines An- oder Abwesenheitszustandes im Frontend (Textanzeige, Icon, Button)<br />
<br />
===NumDirect===<br />
NumDirect arbeitet bidirektional. Die Werte werden genau wie bei Direct ohne Umwandlung weitergegeben.<br />
<br />
Der feine Unterschied zu Direct ist jedoch, das nur Zahlenwerte übergeben werden können.<br />
<br />
Desweiteren kann man einen minimalen und maximalen Wert mitangeben. Dies hat denn Sinn, das man keine Werte einstellen kann, die überhaupt nicht möglich wären.<br />
<br />
In der SmartVisu kann man z.B. -100°C einstellen, das wäre in FHEM jedoch gar nicht möglich.<br />
<br />
===NumDelayed===<br />
NumDelayed ist noch in Arbeit.<br />
<br />
Ein bidirektionaler numerischer Converter mit einstellbarer Verzögerung.<br />
<br />
Bietet bei der Ansteuerung mechanischer Aktoren (Markise, Jalousie) Vorteile gegenüber NumDirect. Als Beispiel sei die Steuerung einer Jalousie über einen Slider genannt. Da Slider ihre Werte kontinuierlich an FHEM übermitteln, würde bei der Verwendung anderer Converter dem entsprechenden Aktor (z.B. HM-BP), während der Benutzer den Slider bedient, mehrfach der vermeindliche Sollwert übermittelt werden. Gleichzeitig beginnt der Aktor seine Fahrt und übermittelt dem Slider seine aktuelle ist Position. Das führt zu einem springen des Sliders und einer "unschönen" Bedienung.<br />
<br />
NumDelayed nimmt daher die Signale des Sliders entgegen, wartet jedoch mit der Weitergabe solange, bis sich der Slider (xxx ms, konfigurierbar) nicht mehr bewegt. In Gegenrichtung wird ebenso verfahren, erst wenn der Aktor seine Endposition erreicht, wird der Slider im Frontend aktualisiert. In diesem Beispiel würde das bedeuten das der Slider im Normalfall ohnehin so steht (Soll) wie vom Aktor gemeldet (Ist). Natürlich könnte der Benutzer oder ein Hindernis die Fahrt auch unterbrochen haben, dann würde der Slider auf die gemeldete Position aktualisiert.<br />
<br />
===NumDisplay===<br />
NumDisplay arbeitet nur in eine Richting, FHEM zu Frontend. Die Werte werden ohne Umwandlung weitergegeben.<br />
<br />
Es ist dazu gedacht Zahlenwerte zu übergeben, ohne etwas zu verändern.<br />
<br />
z.B. für Temperaturwerte<br />
<br />
===WordDisplay===<br />
WordDisplay ist derzeit in Planung, es wird noch über die Umsetzung diskutiert.<br />
<br />
WordDisplay soll nur in eine Richtung arbeiten, FHEM zu Frontend. Es ist dazu gedacht Wörter oder Textpassagen zu übertragen.<br />
<br />
Jedoch soll es möglich sein, eine Umwandlung selbst festzulegen. So kann man einfach mehrere Textausgaben abhängig vom Zustand an das Frontend schicken:<br />
<br />
z.B. Geofancy: Home -> Zuhause, Underway -> Unterwegs, Work -> Arbeit<br />
<br />
===OnOff===<br />
Für einfache Ein/Aus-Funktionen.<br />
<br />
FHEM interpretiert Ein/Aus-Funktionen mit on/off, SmartVisu jedoch mit 1/0.<br />
<br />
Der OnOff-Converter wandelt diese bidirektional, damit sie richtig interpretiert werden.<br />
<br />
===RGBCombined===<br />
Ein Converter zur Steuerung von RGB Leuchtmitteln über Farbauswahlfelder (zb. Farbkreis)<br />
<br />
Bidirektional, wandelt, verwendet 3 Frontend Items<br />
<br />
reading: Name eines reading mit HEX RGB Wert des Leuchtmittels<br />
converter (mit Parameter): <code>RGBCombined <itemRed>, <itemYellow>, <itemBlue></code><br />
<br />
set: Name des set Befehls, bekommt HEX RGB Wert übergeben <br />
<br />
Dieser Converter muss gleichlautend für alle 3 RGB Kanäle des Frontends definiert werden.<br />
<br />
==Device Connector==<br />
Sobald ein fronthemDevice definiert ist, kann man über die device details in fhem die GADs definieren und die Rechte verteilen.<br />
===GAD definieren===<br />
Eine GAD-Definierung besteht aus:<br />
[[Datei:DeviceDefine.png|400px|thumb|right|GADs definieren]]<br />
*mode<br />
*device<br />
*reading<br />
*converter<br />
*cmd set<br />
====mode====<br />
Es gibt 2 Modis:<br />
*item<br />
*plot<br />
====device====<br />
Hier wird der Name des FHEM-Devices eingetragen, an das die Befehle geschickt werden. Die vorhandenen Devices in fhem werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt. <br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====reading====<br />
Das für die Anzeige zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Readings werden, wenn das Frontend dies anfordert, aktiv von fronthem gelesen und (per push) proaktiv an das Frontend gesendet wenn fhem entsprechende events erzeugt.<br />
<br />
====converter====<br />
Hier gibt man denn Namen des Converters an, denn man verwenden möchte.<br />
Es stehen unterschiedliche converter für verschiedene Aufgabenstellungen zur Verfügung. Über das Konzept der converter können fhem Device unterschiedlichster Typen und Funktionen über das Frontend bedient werden. So versorgt der gleiche converter der die Solltemperatur des virtuellen Heizungsthermostats (bidriektional) einstellt auch die Füllstandanzeige der Zisterne sowie den Dimmer. In all diesen Fällen handelt es sich um die Übertragung von numerischen Werten. Converter können dabei auch Spezialaufgaben wie die Begrenzung des Wertebereichs übernehmen. So lässt sich über NumDirect zum Beispiel die Solltemperatur Einstellung für virtuelle Heizungsregler auf Min und Max Werte begrenzen. <br />
<br />
Oben ist eine Standardliste der [[#Converter]]. Die meisten Devices können mit diesen Convertern angesteuert werden.<br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====cmd set====<br />
Das zum Schreiben zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Das gewählte Reading gibt den "set" des fhem Devices an, der die Rückgabe des Converters entgegen nimmt.<br />
<br />
Bei Lampe z.B. "state".<br />
<br />
===Devicerechte vergeben===<br />
[[Datei:DeviceRechte.png|400px|thumb|right|Devicerechte vergeben]]<br />
Devicerechte bestehen aus:<br />
*read<br />
*write<br />
*PIN GAD<br />
====read====<br />
Das Device darf die Statuswerte auslesen, jedoch nicht verändern.<br />
<br />
====write====<br />
Das Device darf Statuswerte ändern.<br />
<br />
====PIN GAD====<br />
In Entwicklung...<br />
<br />
<br />
==Universelle ZeitSchaltUhr UZSU==<br />
Es existiert ein Widget für eine universelle ZeitSchaltUhr auf GitHub unter https://github.com/mworion/uzsu_widget .<br />
<br />
Hierbei bitte die Version 2.0 des UZSU Widgets verwenden oder das UZSU Widget aus https://github.com/herrmannj/smartvisu-widgets beziehen<br />
<br />
Man muss dazu die uzsu_widget.html in das eigene Verzeichnis in ../pages/.. kopieren und die visu.js und die visu.css in seine Installation integrieren (Achtung, wenn die beiden Dateien schon bestehen, dann muss man das manuell zusammenkopieren!)<br />
<br />
Das Widget kann in SmartVISU wie gewohnt eingebunden werden:<br />
<br />
(für ein Ergebnis, das der Benutzer direkt eintippen kann, z.B. 'on' oder 'off')<br />
<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUtxt', gad_uzsu, '', '', '', '', 'text') }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis zwischen 0 und 100)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'num', 0, 100) }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis {0,1}, das aber als flip mit 'an' und 'aus' angezeigt wird)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'bool', 'an', 'aus') }}<br />
</nowiki><br />
<br />
<br />
Um die Antwort des Widgets in fhem zu verarbeiten, benötigt man <br />
<br />
1. je ein Reading uzsu an dem zu schaltenden Device, das man mit <br />
<br />
<nowiki><br />
setreading <device> uzsu {}<br />
</nowiki><br />
<br />
erzeugen MUSS.<br />
<br />
2. eine Anbindung des uzsu-GAD per UZSU Converter an das Reading uzsu des zu schaltenden Device read und write in fhem<br />
<br />
3. folgenden Code in der 99_FronthemUtils.pm:<br />
<br />
Im Package Main:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Umsetzen der UZSU-Settings für ein device<br />
#<br />
###############################################################################<br />
sub UZSU_execute($$)<br />
{<br />
my ($device, $uzsu) = @_;<br />
<br />
$uzsu = decode_json($uzsu);<br />
fhem('delete wdt_'.$device.'_uzsu');<br />
my $weekdays_part = " ";<br />
for(my $i=0; $i < @{$uzsu->{list}}; $i++) {<br />
my $weekdays = $uzsu->{list}[$i]->{rrule};<br />
$weekdays = substr($weekdays,18,50); <br />
if (($uzsu->{list}[$i]->{active})) {<br />
$weekdays_part = $weekdays_part.' '.$weekdays.'|'.$uzsu->{list}[$i]->{time}.'|'.$uzsu->{list}[$i]->{value};<br />
}<br />
}<br />
fhem('define wdt_'.$device.'_uzsu'.' WeekdayTimer '.$device.' en '.$weekdays_part);<br />
if ($uzsu->{active}){ <br />
fhem('attr wdt_'.$device.'_uzsu disable 0');<br />
} else {<br />
fhem('attr wdt_'.$device.'_uzsu disable 1');<br />
} <br />
}<br />
</nowiki><br />
<br />
Im Package fronthem, selbe Datei:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Setreading a device reading using JSON conversion (gadval => reading=decode_json() => setval => encode_json(reading) )<br />
#<br />
###############################################################################<br />
<br />
sub UZSU(@)<br />
{<br />
my ($param) = @_;<br />
my $cmd = $param->{cmd};<br />
my $gad = $param->{gad};<br />
my $gadval = $param->{gadval};<br />
<br />
my $device = $param->{device};<br />
my $reading = $param->{reading};<br />
my $event = $param->{event};<br />
<br />
my @args = @{$param->{args}};<br />
my $cache = $param->{cache};<br />
<br />
if ($param->{cmd} eq 'get')<br />
{<br />
$param->{cmd} = 'send';<br />
}<br />
if ($param->{cmd} eq 'send')<br />
{<br />
$param->{gad} = $gad;<br />
$param->{gadval} = decode_json(main::ReadingsVal($device, $reading, ''));<br />
$param->{gads} = [];<br />
return undef;<br />
}<br />
elsif ($param->{cmd} eq 'rcv')<br />
{<br />
$gadval = encode_json($gadval);<br />
$gadval =~ s/;/;;/ig;<br />
$param->{result} = main::fhem("setreading $device $reading $gadval");<br />
$param->{results} = [];<br />
return 'done';<br />
}<br />
elsif ($param->{cmd} eq '?')<br />
{<br />
return 'usage: UZSU';<br />
}<br />
return undef;<br />
}<br />
<br />
</nowiki><br />
<br />
Dieser Code erzeugt aus den Einstellungen im Widget entsprechende WeekdayTimer in fhem und löscht und erstellt neu bei jeder Änderung in SmartVISU.<br />
<br />
4. Die Funktion muss getriggert werden. Dazu ist ein notify nötig, das auf die Veränderung der uzsu Readings reagiert:<br />
<br />
<nowiki><br />
<br />
define UZSU notify .*:uzsu:.* { UZSU_execute($NAME, $EVTPART1) }<br />
<br />
</nowiki><br />
<br />
Voila!</div>Fidelhttp://wiki.fhem.de/w/index.php?title=Fronthem&diff=10595Fronthem2015-03-22T13:06:11Z<p>Fidel: /* Universelle ZeitSchaltUhr UZSU */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Anbindung von externen Frontends an FHEM (befindet sich in der Alpha-Phase)<br />
|ModType=x<br />
<!-- |ModCategory= (noch?) nicht verwendet --><br />
<!-- |ModCmdRef= wird automatisch generiert --><br />
|ModForumArea=Sonstige Systeme<br />
|ModTechName=01_fronthem.pm<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=769 Jörg alias herrmannj]<br />
}}<br />
Fronthem ist ein Projekt von herrmannj und wurde im fhem-Forum erstmalig angekündigt: http://forum.fhem.de/index.php/topic,27291.0.html<br />
<br />
Fronthem verfolgt die Idee, ein externes Web-Frontend (z. B. smartVISU http://smartvisu.de) an fhem anzukoppeln und den Datenverkehr sowie die Zusammenarbeit von Befehlen und Parametern zwischen FHEM und dem Web-Frontend zu übernehmen.<br />
<br />
Eine Installation für die Verwendung von [[SmartVisu]] mit Fronthem findet man hier [[Installation Fronthem|Installation Fronthem]].<br />
<br />
Dazu besteht fronthem aus vier Bausteinen:<br />
<br />
==Bausteine==<br />
=== websocket ===<br />
Der Websocket ist eine generische http-Schnittstelle, die von einem externen Frontend aus angesprochen werden kann.<br />
<br />
Der Websocket wird durch ein fhem-Modul 01_fronthem.pm realisiert, das im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
Der Websocket ist auf Port 2121 fest eingestellt, wird implizit durch die anderen Bausteine verwendet und benötigt im Prinzip keine weitere Beachtung, außer man möchte das Webinterface auf einem anderen Device neben FHEM laufen lassen.<br />
<br />
=== device connector ===<br />
Die Device-Connectoren dienen dazu, Endgeräte des Benutzers (PCs, Tablets, Smartphones usw.) als Clients zuzulassen und deren Berechtigungen (read, write) auf der Ebene einzelner Objekte zu steuern. Damit können z. B. die lieben Kinder zwar das Licht und die eigene Heizung steuern, aber nicht die Heizung umprogrammieren oder den Alarm ausschalten. Auch ein PIN-Schutz ist vorgesehen, im Moment aber noch nicht umgesetzt.<br />
<br />
Die Device-Connectoren werden durch das fhem-Modul 31_fronthemDevice.pm realisiert, welches im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
An den einzelnen Device-Connectoren werden die durch den websocket vom externen Frontend mitgeteilten Objekte aufgelistet und können dort einerseits mit fhem devices und andererseits in den Berechtigungen des jeweiligen Endgerätes konfiguriert werden.<br />
<br />
Umgekehrt bedeutet dies, dass man die Kombination der Frontend-items mit den fhem-Devices über die Converter nur einmal pro item machen muss, die Berechtigungen der verwendeten Endgeräte muss man aber jeweils pro Endgerät einzeln setzen.<br />
<br />
=== readings converter ===<br />
Die Readings von fhem müssen in die Form der möglichen Werte des Frontends umgewandelt werden. Im umgekehrten Fall müssen Befehle des Frontends in fhem kompatible Befehle umgesetzt werden.<br />
Diese Aufgabe übernehmen die Readings Converter. Sie werden durch die Datei fhconverter.pm realisiert, die im Ordner .../fhem/FHEM/ abgelegt wird. <br />
Bisher gibt es folgende Converter:<br />
* [[#Direct]] für Übertragung ohne Konvertierung<br />
* [[#NumDirect]] für Übertragung von Zahlenwerten in einem begrenzten Werteraum zwischen Min und Max<br />
* [[#NumDisplay]] für Zahlenwerte aus fhem Readings, nur lesend<br />
* [[#WordDisplay]] ist in Planung, für Übertragung von selbst definierbaren Wörtern/Sätze<br />
* [[#OnOff]] für Schalter, Übersetzung von On in 1 und Off in 0<br />
* [[#RGBCombined]] für Übertragung von RGB-Werten so das sie FHEM akzeptiert<br />
Näheres zu denn Convertern unter [[#Converter]]<br />
<br />
Weitere Readings Converter werden noch folgen.<br />
<br />
=== fronthemEditor ===<br />
Der Javascript Editor ist eine fhem WebIF Erweiterung, um die Bindung der fremden Frontend-Objekte an FHEM Devices/Readings vorzunehmen und die dazu notwendigen Konvertierungen zu wählen.<br />
Er wird durch die Datei fronthemEditor.js repräsentiert, die in den Ordner .../fhem/www/frontend/pgm2/ kopiert wird.<br />
<br />
Der Editor erscheint in fhem als komplette gad-Liste in den Details von jedem definierten fronthemDevice. Das mag auf den ersten Blick irreführend sein, weil die Definition der gad/items/plots fhem-global geschieht, war aber wohl die beste mögliche Umsetzung zur Zeit.<br />
<br />
Man muss also durch den Editor an einem beliebigen fronthemDevice die Verknüpfung zwischen fhem-devices und smartVISU items herstellen, dann gilt diese für alle fhem Devices. Nur die Berechtigungen der einzelnen fhem Devices werden unterschiedlich gepflegt. (im Moment aber inaktiviert!)<br />
<br />
==Basic Syntax==<br />
===Websocket===<br />
:<code>define <name> fronthem</code><br />
<br />
===Device Connector===<br />
Man muss jedes Device, mit dem man zugreifen will definieren.<br />
<br />
Dadurch kann genau festgelegt werden, welches Device Rechte für eine jeweilige Schaltfunktion hat.<br />
====IP-Identify====<br />
Identifizierung per IP-Adresse. Dies ist nur im internen Netzwerk sehr sinnvoll.<br />
Ein Device wird definiert mit:<br />
:<code>define <device> fronthemDevice <ip></code><br />
====Zertificate-Identify====<br />
Das Device wird über ein Zertifikat identifiziert.<br />
Zuerst wird ein Zertifikat generiert, welches dann auf dem Device installiert werden muss.<br />
<br />
Diese Methode der Identifizierung verspricht höhere Sicherheit, wie auch denn Vorteil, das man sich nicht einloggen muss.<br />
<br />
Diese Funktion ist noch in Entwicklung.<br />
<br />
==Converter==<br />
Die Converter sind alle kompatibel mit dem oben erwähnten Frontend SmartVisu und werden auf Basis dieses Frontends erklärt.<br />
<br />
Wenn jemand ein anderes Frontend verwenden will, muss er möglicherweise die Converter anpassen.<br />
===Direct===<br />
Die Werte werden ohne Konvertierung weitergegeben.<br />
<br />
Gibt den Wert des von <reading> ohne weitere Wandlung an das Frontend weiter. In umgekehrter Richtung wird der vom Frontend geliefert Wert ohne Wandlung im hinterlegten <set> eingesetzt.<br />
<br />
Beispiel: <br />
Anzeige eines An- oder Abwesenheitszustandes im Frontend (Textanzeige, Icon, Button)<br />
<br />
===NumDirect===<br />
NumDirect arbeitet bidirektional. Die Werte werden genau wie bei Direct ohne Umwandlung weitergegeben.<br />
<br />
Der feine Unterschied zu Direct ist jedoch, das nur Zahlenwerte übergeben werden können.<br />
<br />
Desweiteren kann man einen minimalen und maximalen Wert mitangeben. Dies hat denn Sinn, das man keine Werte einstellen kann, die überhaupt nicht möglich wären.<br />
<br />
In der SmartVisu kann man z.B. -100°C einstellen, das wäre in FHEM jedoch gar nicht möglich.<br />
<br />
===NumDelayed===<br />
NumDelayed ist noch in Arbeit.<br />
<br />
Ein bidirektionaler numerischer Converter mit einstellbarer Verzögerung.<br />
<br />
Bietet bei der Ansteuerung mechanischer Aktoren (Markise, Jalousie) Vorteile gegenüber NumDirect. Als Beispiel sei die Steuerung einer Jalousie über einen Slider genannt. Da Slider ihre Werte kontinuierlich an FHEM übermitteln, würde bei der Verwendung anderer Converter dem entsprechenden Aktor (z.B. HM-BP), während der Benutzer den Slider bedient, mehrfach der vermeindliche Sollwert übermittelt werden. Gleichzeitig beginnt der Aktor seine Fahrt und übermittelt dem Slider seine aktuelle ist Position. Das führt zu einem springen des Sliders und einer "unschönen" Bedienung.<br />
<br />
NumDelayed nimmt daher die Signale des Sliders entgegen, wartet jedoch mit der Weitergabe solange, bis sich der Slider (xxx ms, konfigurierbar) nicht mehr bewegt. In Gegenrichtung wird ebenso verfahren, erst wenn der Aktor seine Endposition erreicht, wird der Slider im Frontend aktualisiert. In diesem Beispiel würde das bedeuten das der Slider im Normalfall ohnehin so steht (Soll) wie vom Aktor gemeldet (Ist). Natürlich könnte der Benutzer oder ein Hindernis die Fahrt auch unterbrochen haben, dann würde der Slider auf die gemeldete Position aktualisiert.<br />
<br />
===NumDisplay===<br />
NumDisplay arbeitet nur in eine Richting, FHEM zu Frontend. Die Werte werden ohne Umwandlung weitergegeben.<br />
<br />
Es ist dazu gedacht Zahlenwerte zu übergeben, ohne etwas zu verändern.<br />
<br />
z.B. für Temperaturwerte<br />
<br />
===WordDisplay===<br />
WordDisplay ist derzeit in Planung, es wird noch über die Umsetzung diskutiert.<br />
<br />
WordDisplay soll nur in eine Richtung arbeiten, FHEM zu Frontend. Es ist dazu gedacht Wörter oder Textpassagen zu übertragen.<br />
<br />
Jedoch soll es möglich sein, eine Umwandlung selbst festzulegen. So kann man einfach mehrere Textausgaben abhängig vom Zustand an das Frontend schicken:<br />
<br />
z.B. Geofancy: Home -> Zuhause, Underway -> Unterwegs, Work -> Arbeit<br />
<br />
===OnOff===<br />
Für einfache Ein/Aus-Funktionen.<br />
<br />
FHEM interpretiert Ein/Aus-Funktionen mit on/off, SmartVisu jedoch mit 1/0.<br />
<br />
Der OnOff-Converter wandelt diese bidirektional, damit sie richtig interpretiert werden.<br />
<br />
===RGBCombined===<br />
Ein Converter zur Steuerung von RGB Leuchtmitteln über Farbauswahlfelder (zb. Farbkreis)<br />
<br />
Bidirektional, wandelt, verwendet 3 Frontend Items<br />
<br />
reading: Name eines reading mit HEX RGB Wert des Leuchtmittels<br />
converter (mit Parameter): <code>RGBCombined <itemRed>, <itemYellow>, <itemBlue></code><br />
<br />
set: Name des set Befehls, bekommt HEX RGB Wert übergeben <br />
<br />
Dieser Converter muss gleichlautend für alle 3 RGB Kanäle des Frontends definiert werden.<br />
<br />
==Device Connector==<br />
Sobald ein fronthemDevice definiert ist, kann man über die device details in fhem die GADs definieren und die Rechte verteilen.<br />
===GAD definieren===<br />
Eine GAD-Definierung besteht aus:<br />
[[Datei:DeviceDefine.png|400px|thumb|right|GADs definieren]]<br />
*mode<br />
*device<br />
*reading<br />
*converter<br />
*cmd set<br />
====mode====<br />
Es gibt 2 Modis:<br />
*item<br />
*plot<br />
====device====<br />
Hier wird der Name des FHEM-Devices eingetragen, an das die Befehle geschickt werden. Die vorhandenen Devices in fhem werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt. <br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====reading====<br />
Das für die Anzeige zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Readings werden, wenn das Frontend dies anfordert, aktiv von fronthem gelesen und (per push) proaktiv an das Frontend gesendet wenn fhem entsprechende events erzeugt.<br />
<br />
====converter====<br />
Hier gibt man denn Namen des Converters an, denn man verwenden möchte.<br />
Es stehen unterschiedliche converter für verschiedene Aufgabenstellungen zur Verfügung. Über das Konzept der converter können fhem Device unterschiedlichster Typen und Funktionen über das Frontend bedient werden. So versorgt der gleiche converter der die Solltemperatur des virtuellen Heizungsthermostats (bidriektional) einstellt auch die Füllstandanzeige der Zisterne sowie den Dimmer. In all diesen Fällen handelt es sich um die Übertragung von numerischen Werten. Converter können dabei auch Spezialaufgaben wie die Begrenzung des Wertebereichs übernehmen. So lässt sich über NumDirect zum Beispiel die Solltemperatur Einstellung für virtuelle Heizungsregler auf Min und Max Werte begrenzen. <br />
<br />
Oben ist eine Standardliste der [[#Converter]]. Die meisten Devices können mit diesen Convertern angesteuert werden.<br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====cmd set====<br />
Das zum Schreiben zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Das gewählte Reading gibt den "set" des fhem Devices an, der die Rückgabe des Converters entgegen nimmt.<br />
<br />
Bei Lampe z.B. "state".<br />
<br />
===Devicerechte vergeben===<br />
[[Datei:DeviceRechte.png|400px|thumb|right|Devicerechte vergeben]]<br />
Devicerechte bestehen aus:<br />
*read<br />
*write<br />
*PIN GAD<br />
====read====<br />
Das Device darf die Statuswerte auslesen, jedoch nicht verändern.<br />
<br />
====write====<br />
Das Device darf Statuswerte ändern.<br />
<br />
====PIN GAD====<br />
In Entwicklung...<br />
<br />
<br />
==Universelle ZeitSchaltUhr UZSU==<br />
Es existiert ein Widget für eine universelle ZeitSchaltUhr auf GitHub unter https://github.com/mworion/uzsu_widget .<br />
Hierbei bitte die Version 2.0 des UZSU Widgets verwenden oder das UZSU Widget aus https://github.com/herrmannj/smartvisu-widgets beziehen<br />
<br />
Man muss dazu die uzsu_widget.html in das eigene Verzeichnis in ../pages/.. kopieren und die visu.js und die visu.css in seine Installation integrieren (Achtung, wenn die beiden Dateien schon bestehen, dann muss man das manuell zusammenkopieren!)<br />
<br />
Das Widget kann in SmartVISU wie gewohnt eingebunden werden:<br />
<br />
(für ein Ergebnis, das der Benutzer direkt eintippen kann, z.B. 'on' oder 'off')<br />
<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUtxt', gad_uzsu, '', '', '', '', 'text') }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis zwischen 0 und 100)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'num', 0, 100) }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis {0,1}, das aber als flip mit 'an' und 'aus' angezeigt wird)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'bool', 'an', 'aus') }}<br />
</nowiki><br />
<br />
<br />
Um die Antwort des Widgets in fhem zu verarbeiten, benötigt man <br />
<br />
1. je ein Reading uzsu an dem zu schaltenden Device, das man mit <br />
<br />
<nowiki><br />
setreading <device> uzsu {}<br />
</nowiki><br />
<br />
erzeugen MUSS.<br />
<br />
2. eine Anbindung des uzsu-GAD per UZSU Converter an das Reading uzsu des zu schaltenden Device read und write in fhem<br />
<br />
3. folgenden Code in der 99_FronthemUtils.pm:<br />
<br />
Im Package Main:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Umsetzen der UZSU-Settings für ein device<br />
#<br />
###############################################################################<br />
sub UZSU_execute($$)<br />
{<br />
my ($device, $uzsu) = @_;<br />
<br />
$uzsu = decode_json($uzsu);<br />
fhem('delete wdt_'.$device.'_uzsu');<br />
my $weekdays_part = " ";<br />
for(my $i=0; $i < @{$uzsu->{list}}; $i++) {<br />
my $weekdays = $uzsu->{list}[$i]->{rrule};<br />
$weekdays = substr($weekdays,18,50); <br />
if (($uzsu->{list}[$i]->{active})) {<br />
$weekdays_part = $weekdays_part.' '.$weekdays.'|'.$uzsu->{list}[$i]->{time}.'|'.$uzsu->{list}[$i]->{value};<br />
}<br />
}<br />
fhem('define wdt_'.$device.'_uzsu'.' WeekdayTimer '.$device.' en '.$weekdays_part);<br />
if ($uzsu->{active}){ <br />
fhem('attr wdt_'.$device.'_uzsu disable 0');<br />
} else {<br />
fhem('attr wdt_'.$device.'_uzsu disable 1');<br />
} <br />
}<br />
</nowiki><br />
<br />
Im Package fronthem, selbe Datei:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Setreading a device reading using JSON conversion (gadval => reading=decode_json() => setval => encode_json(reading) )<br />
#<br />
###############################################################################<br />
<br />
sub UZSU(@)<br />
{<br />
my ($param) = @_;<br />
my $cmd = $param->{cmd};<br />
my $gad = $param->{gad};<br />
my $gadval = $param->{gadval};<br />
<br />
my $device = $param->{device};<br />
my $reading = $param->{reading};<br />
my $event = $param->{event};<br />
<br />
my @args = @{$param->{args}};<br />
my $cache = $param->{cache};<br />
<br />
if ($param->{cmd} eq 'get')<br />
{<br />
$param->{cmd} = 'send';<br />
}<br />
if ($param->{cmd} eq 'send')<br />
{<br />
$param->{gad} = $gad;<br />
$param->{gadval} = decode_json(main::ReadingsVal($device, $reading, ''));<br />
$param->{gads} = [];<br />
return undef;<br />
}<br />
elsif ($param->{cmd} eq 'rcv')<br />
{<br />
$gadval = encode_json($gadval);<br />
$gadval =~ s/;/;;/ig;<br />
$param->{result} = main::fhem("setreading $device $reading $gadval");<br />
$param->{results} = [];<br />
return 'done';<br />
}<br />
elsif ($param->{cmd} eq '?')<br />
{<br />
return 'usage: UZSU';<br />
}<br />
return undef;<br />
}<br />
<br />
</nowiki><br />
<br />
Dieser Code erzeugt aus den Einstellungen im Widget entsprechende WeekdayTimer in fhem und löscht und erstellt neu bei jeder Änderung in SmartVISU.<br />
<br />
4. Die Funktion muss getriggert werden. Dazu ist ein notify nötig, das auf die Veränderung der uzsu Readings reagiert:<br />
<br />
<nowiki><br />
<br />
define UZSU notify .*:uzsu:.* { UZSU_execute($NAME, $EVTPART1) }<br />
<br />
</nowiki><br />
<br />
Voila!</div>Fidelhttp://wiki.fhem.de/w/index.php?title=Fronthem&diff=10583Fronthem2015-03-21T22:43:26Z<p>Fidel: /* Universelle ZeitSchaltUhr UZSU */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Anbindung von externen Frontends an FHEM (befindet sich in der Alpha-Phase)<br />
|ModType=x<br />
<!-- |ModCategory= (noch?) nicht verwendet --><br />
<!-- |ModCmdRef= wird automatisch generiert --><br />
|ModForumArea=Sonstige Systeme<br />
|ModTechName=01_fronthem.pm<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=769 Jörg alias herrmannj]<br />
}}<br />
Fronthem ist ein Projekt von herrmannj und wurde im fhem-Forum erstmalig angekündigt: http://forum.fhem.de/index.php/topic,27291.0.html<br />
<br />
Fronthem verfolgt die Idee, ein externes Web-Frontend (z. B. smartVISU http://smartvisu.de) an fhem anzukoppeln und den Datenverkehr sowie die Zusammenarbeit von Befehlen und Parametern zwischen FHEM und dem Web-Frontend zu übernehmen.<br />
<br />
Eine Installation für die Verwendung von [[SmartVisu]] mit Fronthem findet man hier [[Installation Fronthem|Installation Fronthem]].<br />
<br />
Dazu besteht fronthem aus vier Bausteinen:<br />
<br />
==Bausteine==<br />
=== websocket ===<br />
Der Websocket ist eine generische http-Schnittstelle, die von einem externen Frontend aus angesprochen werden kann.<br />
<br />
Der Websocket wird durch ein fhem-Modul 01_fronthem.pm realisiert, das im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
Der Websocket ist auf Port 2121 fest eingestellt, wird implizit durch die anderen Bausteine verwendet und benötigt im Prinzip keine weitere Beachtung, außer man möchte das Webinterface auf einem anderen Device neben FHEM laufen lassen.<br />
<br />
=== device connector ===<br />
Die Device-Connectoren dienen dazu, Endgeräte des Benutzers (PCs, Tablets, Smartphones usw.) als Clients zuzulassen und deren Berechtigungen (read, write) auf der Ebene einzelner Objekte zu steuern. Damit können z. B. die lieben Kinder zwar das Licht und die eigene Heizung steuern, aber nicht die Heizung umprogrammieren oder den Alarm ausschalten. Auch ein PIN-Schutz ist vorgesehen, im Moment aber noch nicht umgesetzt.<br />
<br />
Die Device-Connectoren werden durch das fhem-Modul 31_fronthemDevice.pm realisiert, welches im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
An den einzelnen Device-Connectoren werden die durch den websocket vom externen Frontend mitgeteilten Objekte aufgelistet und können dort einerseits mit fhem devices und andererseits in den Berechtigungen des jeweiligen Endgerätes konfiguriert werden.<br />
<br />
Umgekehrt bedeutet dies, dass man die Kombination der Frontend-items mit den fhem-Devices über die Converter nur einmal pro item machen muss, die Berechtigungen der verwendeten Endgeräte muss man aber jeweils pro Endgerät einzeln setzen.<br />
<br />
=== readings converter ===<br />
Die Readings von fhem müssen in die Form der möglichen Werte des Frontends umgewandelt werden. Im umgekehrten Fall müssen Befehle des Frontends in fhem kompatible Befehle umgesetzt werden.<br />
Diese Aufgabe übernehmen die Readings Converter. Sie werden durch die Datei fhconverter.pm realisiert, die im Ordner .../fhem/FHEM/ abgelegt wird. <br />
Bisher gibt es folgende Converter:<br />
* [[#Direct]] für Übertragung ohne Konvertierung<br />
* [[#NumDirect]] für Übertragung von Zahlenwerten in einem begrenzten Werteraum zwischen Min und Max<br />
* [[#NumDisplay]] für Zahlenwerte aus fhem Readings, nur lesend<br />
* [[#WordDisplay]] ist in Planung, für Übertragung von selbst definierbaren Wörtern/Sätze<br />
* [[#OnOff]] für Schalter, Übersetzung von On in 1 und Off in 0<br />
* [[#RGBCombined]] für Übertragung von RGB-Werten so das sie FHEM akzeptiert<br />
Näheres zu denn Convertern unter [[#Converter]]<br />
<br />
Weitere Readings Converter werden noch folgen.<br />
<br />
=== fronthemEditor ===<br />
Der Javascript Editor ist eine fhem WebIF Erweiterung, um die Bindung der fremden Frontend-Objekte an FHEM Devices/Readings vorzunehmen und die dazu notwendigen Konvertierungen zu wählen.<br />
Er wird durch die Datei fronthemEditor.js repräsentiert, die in den Ordner .../fhem/www/frontend/pgm2/ kopiert wird.<br />
<br />
Der Editor erscheint in fhem als komplette gad-Liste in den Details von jedem definierten fronthemDevice. Das mag auf den ersten Blick irreführend sein, weil die Definition der gad/items/plots fhem-global geschieht, war aber wohl die beste mögliche Umsetzung zur Zeit.<br />
<br />
Man muss also durch den Editor an einem beliebigen fronthemDevice die Verknüpfung zwischen fhem-devices und smartVISU items herstellen, dann gilt diese für alle fhem Devices. Nur die Berechtigungen der einzelnen fhem Devices werden unterschiedlich gepflegt. (im Moment aber inaktiviert!)<br />
<br />
==Basic Syntax==<br />
===Websocket===<br />
:<code>define <name> fronthem</code><br />
<br />
===Device Connector===<br />
Man muss jedes Device, mit dem man zugreifen will definieren.<br />
<br />
Dadurch kann genau festgelegt werden, welches Device Rechte für eine jeweilige Schaltfunktion hat.<br />
====IP-Identify====<br />
Identifizierung per IP-Adresse. Dies ist nur im internen Netzwerk sehr sinnvoll.<br />
Ein Device wird definiert mit:<br />
:<code>define <device> fronthemDevice <ip></code><br />
====Zertificate-Identify====<br />
Das Device wird über ein Zertifikat identifiziert.<br />
Zuerst wird ein Zertifikat generiert, welches dann auf dem Device installiert werden muss.<br />
<br />
Diese Methode der Identifizierung verspricht höhere Sicherheit, wie auch denn Vorteil, das man sich nicht einloggen muss.<br />
<br />
Diese Funktion ist noch in Entwicklung.<br />
<br />
==Converter==<br />
Die Converter sind alle kompatibel mit dem oben erwähnten Frontend SmartVisu und werden auf Basis dieses Frontends erklärt.<br />
<br />
Wenn jemand ein anderes Frontend verwenden will, muss er möglicherweise die Converter anpassen.<br />
===Direct===<br />
Die Werte werden ohne Konvertierung weitergegeben.<br />
<br />
Gibt den Wert des von <reading> ohne weitere Wandlung an das Frontend weiter. In umgekehrter Richtung wird der vom Frontend geliefert Wert ohne Wandlung im hinterlegten <set> eingesetzt.<br />
<br />
Beispiel: <br />
Anzeige eines An- oder Abwesenheitszustandes im Frontend (Textanzeige, Icon, Button)<br />
<br />
===NumDirect===<br />
NumDirect arbeitet bidirektional. Die Werte werden genau wie bei Direct ohne Umwandlung weitergegeben.<br />
<br />
Der feine Unterschied zu Direct ist jedoch, das nur Zahlenwerte übergeben werden können.<br />
<br />
Desweiteren kann man einen minimalen und maximalen Wert mitangeben. Dies hat denn Sinn, das man keine Werte einstellen kann, die überhaupt nicht möglich wären.<br />
<br />
In der SmartVisu kann man z.B. -100°C einstellen, das wäre in FHEM jedoch gar nicht möglich.<br />
<br />
===NumDelayed===<br />
NumDelayed ist noch in Arbeit.<br />
<br />
Ein bidirektionaler numerischer Converter mit einstellbarer Verzögerung.<br />
<br />
Bietet bei der Ansteuerung mechanischer Aktoren (Markise, Jalousie) Vorteile gegenüber NumDirect. Als Beispiel sei die Steuerung einer Jalousie über einen Slider genannt. Da Slider ihre Werte kontinuierlich an FHEM übermitteln, würde bei der Verwendung anderer Converter dem entsprechenden Aktor (z.B. HM-BP), während der Benutzer den Slider bedient, mehrfach der vermeindliche Sollwert übermittelt werden. Gleichzeitig beginnt der Aktor seine Fahrt und übermittelt dem Slider seine aktuelle ist Position. Das führt zu einem springen des Sliders und einer "unschönen" Bedienung.<br />
<br />
NumDelayed nimmt daher die Signale des Sliders entgegen, wartet jedoch mit der Weitergabe solange, bis sich der Slider (xxx ms, konfigurierbar) nicht mehr bewegt. In Gegenrichtung wird ebenso verfahren, erst wenn der Aktor seine Endposition erreicht, wird der Slider im Frontend aktualisiert. In diesem Beispiel würde das bedeuten das der Slider im Normalfall ohnehin so steht (Soll) wie vom Aktor gemeldet (Ist). Natürlich könnte der Benutzer oder ein Hindernis die Fahrt auch unterbrochen haben, dann würde der Slider auf die gemeldete Position aktualisiert.<br />
<br />
===NumDisplay===<br />
NumDisplay arbeitet nur in eine Richting, FHEM zu Frontend. Die Werte werden ohne Umwandlung weitergegeben.<br />
<br />
Es ist dazu gedacht Zahlenwerte zu übergeben, ohne etwas zu verändern.<br />
<br />
z.B. für Temperaturwerte<br />
<br />
===WordDisplay===<br />
WordDisplay ist derzeit in Planung, es wird noch über die Umsetzung diskutiert.<br />
<br />
WordDisplay soll nur in eine Richtung arbeiten, FHEM zu Frontend. Es ist dazu gedacht Wörter oder Textpassagen zu übertragen.<br />
<br />
Jedoch soll es möglich sein, eine Umwandlung selbst festzulegen. So kann man einfach mehrere Textausgaben abhängig vom Zustand an das Frontend schicken:<br />
<br />
z.B. Geofancy: Home -> Zuhause, Underway -> Unterwegs, Work -> Arbeit<br />
<br />
===OnOff===<br />
Für einfache Ein/Aus-Funktionen.<br />
<br />
FHEM interpretiert Ein/Aus-Funktionen mit on/off, SmartVisu jedoch mit 1/0.<br />
<br />
Der OnOff-Converter wandelt diese bidirektional, damit sie richtig interpretiert werden.<br />
<br />
===RGBCombined===<br />
Ein Converter zur Steuerung von RGB Leuchtmitteln über Farbauswahlfelder (zb. Farbkreis)<br />
<br />
Bidirektional, wandelt, verwendet 3 Frontend Items<br />
<br />
reading: Name eines reading mit HEX RGB Wert des Leuchtmittels<br />
converter (mit Parameter): <code>RGBCombined <itemRed>, <itemYellow>, <itemBlue></code><br />
<br />
set: Name des set Befehls, bekommt HEX RGB Wert übergeben <br />
<br />
Dieser Converter muss gleichlautend für alle 3 RGB Kanäle des Frontends definiert werden.<br />
<br />
==Device Connector==<br />
Sobald ein fronthemDevice definiert ist, kann man über die device details in fhem die GADs definieren und die Rechte verteilen.<br />
===GAD definieren===<br />
Eine GAD-Definierung besteht aus:<br />
[[Datei:DeviceDefine.png|400px|thumb|right|GADs definieren]]<br />
*mode<br />
*device<br />
*reading<br />
*converter<br />
*cmd set<br />
====mode====<br />
Es gibt 2 Modis:<br />
*item<br />
*plot<br />
====device====<br />
Hier wird der Name des FHEM-Devices eingetragen, an das die Befehle geschickt werden. Die vorhandenen Devices in fhem werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt. <br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====reading====<br />
Das für die Anzeige zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Readings werden, wenn das Frontend dies anfordert, aktiv von fronthem gelesen und (per push) proaktiv an das Frontend gesendet wenn fhem entsprechende events erzeugt.<br />
<br />
====converter====<br />
Hier gibt man denn Namen des Converters an, denn man verwenden möchte.<br />
Es stehen unterschiedliche converter für verschiedene Aufgabenstellungen zur Verfügung. Über das Konzept der converter können fhem Device unterschiedlichster Typen und Funktionen über das Frontend bedient werden. So versorgt der gleiche converter der die Solltemperatur des virtuellen Heizungsthermostats (bidriektional) einstellt auch die Füllstandanzeige der Zisterne sowie den Dimmer. In all diesen Fällen handelt es sich um die Übertragung von numerischen Werten. Converter können dabei auch Spezialaufgaben wie die Begrenzung des Wertebereichs übernehmen. So lässt sich über NumDirect zum Beispiel die Solltemperatur Einstellung für virtuelle Heizungsregler auf Min und Max Werte begrenzen. <br />
<br />
Oben ist eine Standardliste der [[#Converter]]. Die meisten Devices können mit diesen Convertern angesteuert werden.<br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====cmd set====<br />
Das zum Schreiben zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Das gewählte Reading gibt den "set" des fhem Devices an, der die Rückgabe des Converters entgegen nimmt.<br />
<br />
Bei Lampe z.B. "state".<br />
<br />
===Devicerechte vergeben===<br />
[[Datei:DeviceRechte.png|400px|thumb|right|Devicerechte vergeben]]<br />
Devicerechte bestehen aus:<br />
*read<br />
*write<br />
*PIN GAD<br />
====read====<br />
Das Device darf die Statuswerte auslesen, jedoch nicht verändern.<br />
<br />
====write====<br />
Das Device darf Statuswerte ändern.<br />
<br />
====PIN GAD====<br />
In Entwicklung...<br />
<br />
<br />
==Universelle ZeitSchaltUhr UZSU==<br />
Es existiert ein Widget für eine universelle ZeitSchaltUhr auf GitHub unter https://github.com/mworion/uzsu_widget .<br />
<!--Hierbei bitte die Version 2.0 des UZSU Widgets verwenden oder das UZSU Widget aus https://github.com/herrmannj/smartvisu-widgets beziehen--><br />
<br />
Man muss dazu die uzsu_widget.html in das eigene Verzeichnis in ../pages/.. kopieren und die visu.js und die visu.css in seine Installation integrieren (Achtung, wenn die beiden Dateien schon bestehen, dann muss man das manuell zusammenkopieren!)<br />
<br />
Das Widget kann in SmartVISU wie gewohnt eingebunden werden:<br />
<br />
(für ein Ergebnis, das der Benutzer direkt eintippen kann, z.B. 'on' oder 'off')<br />
<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUtxt', gad_uzsu, '', '', '', '', 'text') }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis zwischen 0 und 100)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'num', 0, 100) }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis {0,1}, das aber als flip mit 'an' und 'aus' angezeigt wird)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'bool', 'an', 'aus') }}<br />
</nowiki><br />
<br />
<br />
Um die Antwort des Widgets in fhem zu verarbeiten, benötigt man <br />
<br />
1. je ein Reading uzsu an dem zu schaltenden Device, das man mit <br />
<br />
<nowiki><br />
setreading <device> uzsu {}<br />
</nowiki><br />
<br />
erzeugen MUSS.<br />
<br />
2. eine Anbindung des uzsu-GAD per UZSU Converter an das Reading uzsu des zu schaltenden Device read und write in fhem<br />
<br />
3. folgenden Code in der 99_FronthemUtils.pm:<br />
<br />
Im Package Main:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Umsetzen der UZSU-Settings für ein device<br />
#<br />
###############################################################################<br />
sub UZSU_execute($$)<br />
{<br />
my ($device, $uzsu) = @_;<br />
<br />
$uzsu = decode_json($uzsu);<br />
fhem('delete wdt_'.$device.'_uzsu');<br />
my $weekdays_part = " ";<br />
for(my $i=0; $i < @{$uzsu->{list}}; $i++) {<br />
my $weekdays = $uzsu->{list}[$i]->{rrule};<br />
$weekdays = substr($weekdays,18,50); <br />
if (($uzsu->{list}[$i]->{active})) {<br />
$weekdays_part = $weekdays_part.' '.$weekdays.'|'.$uzsu->{list}[$i]->{time}.'|'.$uzsu->{list}[$i]->{value};<br />
}<br />
}<br />
fhem('define wdt_'.$device.'_uzsu'.' WeekdayTimer '.$device.' en '.$weekdays_part);<br />
if ($uzsu->{active}){ <br />
fhem('attr wdt_'.$device.'_uzsu disable 0');<br />
} else {<br />
fhem('attr wdt_'.$device.'_uzsu disable 1');<br />
} <br />
}<br />
</nowiki><br />
<br />
Im Package fronthem, selbe Datei:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Setreading a device reading using JSON conversion (gadval => reading=decode_json() => setval => encode_json(reading) )<br />
#<br />
###############################################################################<br />
<br />
sub UZSU(@)<br />
{<br />
my ($param) = @_;<br />
my $cmd = $param->{cmd};<br />
my $gad = $param->{gad};<br />
my $gadval = $param->{gadval};<br />
<br />
my $device = $param->{device};<br />
my $reading = $param->{reading};<br />
my $event = $param->{event};<br />
<br />
my @args = @{$param->{args}};<br />
my $cache = $param->{cache};<br />
<br />
if ($param->{cmd} eq 'get')<br />
{<br />
$param->{cmd} = 'send';<br />
}<br />
if ($param->{cmd} eq 'send')<br />
{<br />
$param->{gad} = $gad;<br />
$param->{gadval} = decode_json(main::ReadingsVal($device, $reading, ''));<br />
$param->{gads} = [];<br />
return undef;<br />
}<br />
elsif ($param->{cmd} eq 'rcv')<br />
{<br />
$gadval = encode_json($gadval);<br />
$gadval =~ s/;/;;/ig;<br />
$param->{result} = main::fhem("setreading $device $reading $gadval");<br />
$param->{results} = [];<br />
return 'done';<br />
}<br />
elsif ($param->{cmd} eq '?')<br />
{<br />
return 'usage: UZSU';<br />
}<br />
return undef;<br />
}<br />
<br />
</nowiki><br />
<br />
Dieser Code erzeugt aus den Einstellungen im Widget entsprechende WeekdayTimer in fhem und löscht und erstellt neu bei jeder Änderung in SmartVISU.<br />
<br />
4. Die Funktion muss getriggert werden. Dazu ist ein notify nötig, das auf die Veränderung der uzsu Readings reagiert:<br />
<br />
<nowiki><br />
<br />
define UZSU notify .*:uzsu:.* { UZSU_execute($NAME, $EVTPART1) }<br />
<br />
</nowiki><br />
<br />
Voila!</div>Fidelhttp://wiki.fhem.de/w/index.php?title=Fronthem&diff=10582Fronthem2015-03-21T22:41:14Z<p>Fidel: /* Universelle ZeitSchaltUhr UZSU */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Anbindung von externen Frontends an FHEM (befindet sich in der Alpha-Phase)<br />
|ModType=x<br />
<!-- |ModCategory= (noch?) nicht verwendet --><br />
<!-- |ModCmdRef= wird automatisch generiert --><br />
|ModForumArea=Sonstige Systeme<br />
|ModTechName=01_fronthem.pm<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=769 Jörg alias herrmannj]<br />
}}<br />
Fronthem ist ein Projekt von herrmannj und wurde im fhem-Forum erstmalig angekündigt: http://forum.fhem.de/index.php/topic,27291.0.html<br />
<br />
Fronthem verfolgt die Idee, ein externes Web-Frontend (z. B. smartVISU http://smartvisu.de) an fhem anzukoppeln und den Datenverkehr sowie die Zusammenarbeit von Befehlen und Parametern zwischen FHEM und dem Web-Frontend zu übernehmen.<br />
<br />
Eine Installation für die Verwendung von [[SmartVisu]] mit Fronthem findet man hier [[Installation Fronthem|Installation Fronthem]].<br />
<br />
Dazu besteht fronthem aus vier Bausteinen:<br />
<br />
==Bausteine==<br />
=== websocket ===<br />
Der Websocket ist eine generische http-Schnittstelle, die von einem externen Frontend aus angesprochen werden kann.<br />
<br />
Der Websocket wird durch ein fhem-Modul 01_fronthem.pm realisiert, das im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
Der Websocket ist auf Port 2121 fest eingestellt, wird implizit durch die anderen Bausteine verwendet und benötigt im Prinzip keine weitere Beachtung, außer man möchte das Webinterface auf einem anderen Device neben FHEM laufen lassen.<br />
<br />
=== device connector ===<br />
Die Device-Connectoren dienen dazu, Endgeräte des Benutzers (PCs, Tablets, Smartphones usw.) als Clients zuzulassen und deren Berechtigungen (read, write) auf der Ebene einzelner Objekte zu steuern. Damit können z. B. die lieben Kinder zwar das Licht und die eigene Heizung steuern, aber nicht die Heizung umprogrammieren oder den Alarm ausschalten. Auch ein PIN-Schutz ist vorgesehen, im Moment aber noch nicht umgesetzt.<br />
<br />
Die Device-Connectoren werden durch das fhem-Modul 31_fronthemDevice.pm realisiert, welches im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
An den einzelnen Device-Connectoren werden die durch den websocket vom externen Frontend mitgeteilten Objekte aufgelistet und können dort einerseits mit fhem devices und andererseits in den Berechtigungen des jeweiligen Endgerätes konfiguriert werden.<br />
<br />
Umgekehrt bedeutet dies, dass man die Kombination der Frontend-items mit den fhem-Devices über die Converter nur einmal pro item machen muss, die Berechtigungen der verwendeten Endgeräte muss man aber jeweils pro Endgerät einzeln setzen.<br />
<br />
=== readings converter ===<br />
Die Readings von fhem müssen in die Form der möglichen Werte des Frontends umgewandelt werden. Im umgekehrten Fall müssen Befehle des Frontends in fhem kompatible Befehle umgesetzt werden.<br />
Diese Aufgabe übernehmen die Readings Converter. Sie werden durch die Datei fhconverter.pm realisiert, die im Ordner .../fhem/FHEM/ abgelegt wird. <br />
Bisher gibt es folgende Converter:<br />
* [[#Direct]] für Übertragung ohne Konvertierung<br />
* [[#NumDirect]] für Übertragung von Zahlenwerten in einem begrenzten Werteraum zwischen Min und Max<br />
* [[#NumDisplay]] für Zahlenwerte aus fhem Readings, nur lesend<br />
* [[#WordDisplay]] ist in Planung, für Übertragung von selbst definierbaren Wörtern/Sätze<br />
* [[#OnOff]] für Schalter, Übersetzung von On in 1 und Off in 0<br />
* [[#RGBCombined]] für Übertragung von RGB-Werten so das sie FHEM akzeptiert<br />
Näheres zu denn Convertern unter [[#Converter]]<br />
<br />
Weitere Readings Converter werden noch folgen.<br />
<br />
=== fronthemEditor ===<br />
Der Javascript Editor ist eine fhem WebIF Erweiterung, um die Bindung der fremden Frontend-Objekte an FHEM Devices/Readings vorzunehmen und die dazu notwendigen Konvertierungen zu wählen.<br />
Er wird durch die Datei fronthemEditor.js repräsentiert, die in den Ordner .../fhem/www/frontend/pgm2/ kopiert wird.<br />
<br />
Der Editor erscheint in fhem als komplette gad-Liste in den Details von jedem definierten fronthemDevice. Das mag auf den ersten Blick irreführend sein, weil die Definition der gad/items/plots fhem-global geschieht, war aber wohl die beste mögliche Umsetzung zur Zeit.<br />
<br />
Man muss also durch den Editor an einem beliebigen fronthemDevice die Verknüpfung zwischen fhem-devices und smartVISU items herstellen, dann gilt diese für alle fhem Devices. Nur die Berechtigungen der einzelnen fhem Devices werden unterschiedlich gepflegt. (im Moment aber inaktiviert!)<br />
<br />
==Basic Syntax==<br />
===Websocket===<br />
:<code>define <name> fronthem</code><br />
<br />
===Device Connector===<br />
Man muss jedes Device, mit dem man zugreifen will definieren.<br />
<br />
Dadurch kann genau festgelegt werden, welches Device Rechte für eine jeweilige Schaltfunktion hat.<br />
====IP-Identify====<br />
Identifizierung per IP-Adresse. Dies ist nur im internen Netzwerk sehr sinnvoll.<br />
Ein Device wird definiert mit:<br />
:<code>define <device> fronthemDevice <ip></code><br />
====Zertificate-Identify====<br />
Das Device wird über ein Zertifikat identifiziert.<br />
Zuerst wird ein Zertifikat generiert, welches dann auf dem Device installiert werden muss.<br />
<br />
Diese Methode der Identifizierung verspricht höhere Sicherheit, wie auch denn Vorteil, das man sich nicht einloggen muss.<br />
<br />
Diese Funktion ist noch in Entwicklung.<br />
<br />
==Converter==<br />
Die Converter sind alle kompatibel mit dem oben erwähnten Frontend SmartVisu und werden auf Basis dieses Frontends erklärt.<br />
<br />
Wenn jemand ein anderes Frontend verwenden will, muss er möglicherweise die Converter anpassen.<br />
===Direct===<br />
Die Werte werden ohne Konvertierung weitergegeben.<br />
<br />
Gibt den Wert des von <reading> ohne weitere Wandlung an das Frontend weiter. In umgekehrter Richtung wird der vom Frontend geliefert Wert ohne Wandlung im hinterlegten <set> eingesetzt.<br />
<br />
Beispiel: <br />
Anzeige eines An- oder Abwesenheitszustandes im Frontend (Textanzeige, Icon, Button)<br />
<br />
===NumDirect===<br />
NumDirect arbeitet bidirektional. Die Werte werden genau wie bei Direct ohne Umwandlung weitergegeben.<br />
<br />
Der feine Unterschied zu Direct ist jedoch, das nur Zahlenwerte übergeben werden können.<br />
<br />
Desweiteren kann man einen minimalen und maximalen Wert mitangeben. Dies hat denn Sinn, das man keine Werte einstellen kann, die überhaupt nicht möglich wären.<br />
<br />
In der SmartVisu kann man z.B. -100°C einstellen, das wäre in FHEM jedoch gar nicht möglich.<br />
<br />
===NumDelayed===<br />
NumDelayed ist noch in Arbeit.<br />
<br />
Ein bidirektionaler numerischer Converter mit einstellbarer Verzögerung.<br />
<br />
Bietet bei der Ansteuerung mechanischer Aktoren (Markise, Jalousie) Vorteile gegenüber NumDirect. Als Beispiel sei die Steuerung einer Jalousie über einen Slider genannt. Da Slider ihre Werte kontinuierlich an FHEM übermitteln, würde bei der Verwendung anderer Converter dem entsprechenden Aktor (z.B. HM-BP), während der Benutzer den Slider bedient, mehrfach der vermeindliche Sollwert übermittelt werden. Gleichzeitig beginnt der Aktor seine Fahrt und übermittelt dem Slider seine aktuelle ist Position. Das führt zu einem springen des Sliders und einer "unschönen" Bedienung.<br />
<br />
NumDelayed nimmt daher die Signale des Sliders entgegen, wartet jedoch mit der Weitergabe solange, bis sich der Slider (xxx ms, konfigurierbar) nicht mehr bewegt. In Gegenrichtung wird ebenso verfahren, erst wenn der Aktor seine Endposition erreicht, wird der Slider im Frontend aktualisiert. In diesem Beispiel würde das bedeuten das der Slider im Normalfall ohnehin so steht (Soll) wie vom Aktor gemeldet (Ist). Natürlich könnte der Benutzer oder ein Hindernis die Fahrt auch unterbrochen haben, dann würde der Slider auf die gemeldete Position aktualisiert.<br />
<br />
===NumDisplay===<br />
NumDisplay arbeitet nur in eine Richting, FHEM zu Frontend. Die Werte werden ohne Umwandlung weitergegeben.<br />
<br />
Es ist dazu gedacht Zahlenwerte zu übergeben, ohne etwas zu verändern.<br />
<br />
z.B. für Temperaturwerte<br />
<br />
===WordDisplay===<br />
WordDisplay ist derzeit in Planung, es wird noch über die Umsetzung diskutiert.<br />
<br />
WordDisplay soll nur in eine Richtung arbeiten, FHEM zu Frontend. Es ist dazu gedacht Wörter oder Textpassagen zu übertragen.<br />
<br />
Jedoch soll es möglich sein, eine Umwandlung selbst festzulegen. So kann man einfach mehrere Textausgaben abhängig vom Zustand an das Frontend schicken:<br />
<br />
z.B. Geofancy: Home -> Zuhause, Underway -> Unterwegs, Work -> Arbeit<br />
<br />
===OnOff===<br />
Für einfache Ein/Aus-Funktionen.<br />
<br />
FHEM interpretiert Ein/Aus-Funktionen mit on/off, SmartVisu jedoch mit 1/0.<br />
<br />
Der OnOff-Converter wandelt diese bidirektional, damit sie richtig interpretiert werden.<br />
<br />
===RGBCombined===<br />
Ein Converter zur Steuerung von RGB Leuchtmitteln über Farbauswahlfelder (zb. Farbkreis)<br />
<br />
Bidirektional, wandelt, verwendet 3 Frontend Items<br />
<br />
reading: Name eines reading mit HEX RGB Wert des Leuchtmittels<br />
converter (mit Parameter): <code>RGBCombined <itemRed>, <itemYellow>, <itemBlue></code><br />
<br />
set: Name des set Befehls, bekommt HEX RGB Wert übergeben <br />
<br />
Dieser Converter muss gleichlautend für alle 3 RGB Kanäle des Frontends definiert werden.<br />
<br />
==Device Connector==<br />
Sobald ein fronthemDevice definiert ist, kann man über die device details in fhem die GADs definieren und die Rechte verteilen.<br />
===GAD definieren===<br />
Eine GAD-Definierung besteht aus:<br />
[[Datei:DeviceDefine.png|400px|thumb|right|GADs definieren]]<br />
*mode<br />
*device<br />
*reading<br />
*converter<br />
*cmd set<br />
====mode====<br />
Es gibt 2 Modis:<br />
*item<br />
*plot<br />
====device====<br />
Hier wird der Name des FHEM-Devices eingetragen, an das die Befehle geschickt werden. Die vorhandenen Devices in fhem werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt. <br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====reading====<br />
Das für die Anzeige zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Readings werden, wenn das Frontend dies anfordert, aktiv von fronthem gelesen und (per push) proaktiv an das Frontend gesendet wenn fhem entsprechende events erzeugt.<br />
<br />
====converter====<br />
Hier gibt man denn Namen des Converters an, denn man verwenden möchte.<br />
Es stehen unterschiedliche converter für verschiedene Aufgabenstellungen zur Verfügung. Über das Konzept der converter können fhem Device unterschiedlichster Typen und Funktionen über das Frontend bedient werden. So versorgt der gleiche converter der die Solltemperatur des virtuellen Heizungsthermostats (bidriektional) einstellt auch die Füllstandanzeige der Zisterne sowie den Dimmer. In all diesen Fällen handelt es sich um die Übertragung von numerischen Werten. Converter können dabei auch Spezialaufgaben wie die Begrenzung des Wertebereichs übernehmen. So lässt sich über NumDirect zum Beispiel die Solltemperatur Einstellung für virtuelle Heizungsregler auf Min und Max Werte begrenzen. <br />
<br />
Oben ist eine Standardliste der [[#Converter]]. Die meisten Devices können mit diesen Convertern angesteuert werden.<br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====cmd set====<br />
Das zum Schreiben zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Das gewählte Reading gibt den "set" des fhem Devices an, der die Rückgabe des Converters entgegen nimmt.<br />
<br />
Bei Lampe z.B. "state".<br />
<br />
===Devicerechte vergeben===<br />
[[Datei:DeviceRechte.png|400px|thumb|right|Devicerechte vergeben]]<br />
Devicerechte bestehen aus:<br />
*read<br />
*write<br />
*PIN GAD<br />
====read====<br />
Das Device darf die Statuswerte auslesen, jedoch nicht verändern.<br />
<br />
====write====<br />
Das Device darf Statuswerte ändern.<br />
<br />
====PIN GAD====<br />
In Entwicklung...<br />
<br />
<br />
==Universelle ZeitSchaltUhr UZSU==<br />
Es existiert ein Widget für eine universelle ZeitSchaltUhr auf GitHub unter https://github.com/mworion/uzsu_widget .<br />
<br />
Man muss dazu die uzsu_widget.html in das eigene Verzeichnis in ../pages/.. kopieren und die visu.js und die visu.css in seine Installation integrieren (Achtung, wenn die beiden Dateien schon bestehen, dann muss man das manuell zusammenkopieren!)<br />
<br />
Das Widget kann in SmartVISU wie gewohnt eingebunden werden:<br />
<br />
(für ein Ergebnis, das der Benutzer direkt eintippen kann, z.B. 'on' oder 'off')<br />
<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUtxt', gad_uzsu, '', '', '', '', 'text') }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis zwischen 0 und 100)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'num', 0, 100) }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis {0,1}, das aber als flip mit 'an' und 'aus' angezeigt wird)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'bool', 'an', 'aus') }}<br />
</nowiki><br />
<br />
<br />
Um die Antwort des Widgets in fhem zu verarbeiten, benötigt man <br />
<br />
1. je ein Reading uzsu an dem zu schaltenden Device, das man mit <br />
<br />
<nowiki><br />
setreading <device> uzsu {}<br />
</nowiki><br />
<br />
erzeugen MUSS.<br />
<br />
2. eine Anbindung des uzsu-GAD per UZSU Converter an das Reading uzsu des zu schaltenden Device read und write in fhem<br />
<br />
3. folgenden Code in der 99_FronthemUtils.pm:<br />
<br />
Im Package Main:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Umsetzen der UZSU-Settings für ein device<br />
#<br />
###############################################################################<br />
sub UZSU_execute($$)<br />
{<br />
my ($device, $uzsu) = @_;<br />
<br />
$uzsu = decode_json($uzsu);<br />
fhem('delete wdt_'.$device.'_uzsu');<br />
my $weekdays_part = " ";<br />
for(my $i=0; $i < @{$uzsu->{list}}; $i++) {<br />
my $weekdays = $uzsu->{list}[$i]->{rrule};<br />
$weekdays = substr($weekdays,18,50); <br />
if (($uzsu->{list}[$i]->{active})) {<br />
$weekdays_part = $weekdays_part.' '.$weekdays.'|'.$uzsu->{list}[$i]->{time}.'|'.$uzsu->{list}[$i]->{value};<br />
}<br />
}<br />
fhem('define wdt_'.$device.'_uzsu'.' WeekdayTimer '.$device.' en '.$weekdays_part);<br />
if ($uzsu->{active}){ <br />
fhem('attr wdt_'.$device.'_uzsu disable 0');<br />
} else {<br />
fhem('attr wdt_'.$device.'_uzsu disable 1');<br />
} <br />
}<br />
</nowiki><br />
<br />
Im Package fronthem, selbe Datei:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Setreading a device reading using JSON conversion (gadval => reading=decode_json() => setval => encode_json(reading) )<br />
#<br />
###############################################################################<br />
<br />
sub UZSU(@)<br />
{<br />
my ($param) = @_;<br />
my $cmd = $param->{cmd};<br />
my $gad = $param->{gad};<br />
my $gadval = $param->{gadval};<br />
<br />
my $device = $param->{device};<br />
my $reading = $param->{reading};<br />
my $event = $param->{event};<br />
<br />
my @args = @{$param->{args}};<br />
my $cache = $param->{cache};<br />
<br />
if ($param->{cmd} eq 'get')<br />
{<br />
$param->{cmd} = 'send';<br />
}<br />
if ($param->{cmd} eq 'send')<br />
{<br />
$param->{gad} = $gad;<br />
$param->{gadval} = decode_json(main::ReadingsVal($device, $reading, ''));<br />
$param->{gads} = [];<br />
return undef;<br />
}<br />
elsif ($param->{cmd} eq 'rcv')<br />
{<br />
$gadval = encode_json($gadval);<br />
$gadval =~ s/;/;;/ig;<br />
$param->{result} = main::fhem("setreading $device $reading $gadval");<br />
$param->{results} = [];<br />
return 'done';<br />
}<br />
elsif ($param->{cmd} eq '?')<br />
{<br />
return 'usage: UZSU';<br />
}<br />
return undef;<br />
}<br />
<br />
</nowiki><br />
<br />
Dieser Code erzeugt aus den Einstellungen im Widget entsprechende WeekdayTimer in fhem und löscht und erstellt neu bei jeder Änderung in SmartVISU.<br />
<br />
4. Die Funktion muss getriggert werden. Dazu ist ein notify nötig, das auf die Veränderung der uzsu Readings reagiert:<br />
<br />
<nowiki><br />
<br />
define UZSU notify .*:uzsu:.* { UZSU_execute($NAME, $EVTPART1) }<br />
<br />
</nowiki><br />
<br />
Voila!</div>Fidelhttp://wiki.fhem.de/w/index.php?title=Fronthem&diff=10579Fronthem2015-03-21T00:09:09Z<p>Fidel: /* Universelle ZeitSchaltUhr UZSU */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Anbindung von externen Frontends an FHEM (befindet sich in der Alpha-Phase)<br />
|ModType=x<br />
<!-- |ModCategory= (noch?) nicht verwendet --><br />
<!-- |ModCmdRef= wird automatisch generiert --><br />
|ModForumArea=Sonstige Systeme<br />
|ModTechName=01_fronthem.pm<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=769 Jörg alias herrmannj]<br />
}}<br />
Fronthem ist ein Projekt von herrmannj und wurde im fhem-Forum erstmalig angekündigt: http://forum.fhem.de/index.php/topic,27291.0.html<br />
<br />
Fronthem verfolgt die Idee, ein externes Web-Frontend (z. B. smartVISU http://smartvisu.de) an fhem anzukoppeln und den Datenverkehr sowie die Zusammenarbeit von Befehlen und Parametern zwischen FHEM und dem Web-Frontend zu übernehmen.<br />
<br />
Eine Installation für die Verwendung von [[SmartVisu]] mit Fronthem findet man hier [[Installation Fronthem|Installation Fronthem]].<br />
<br />
Dazu besteht fronthem aus vier Bausteinen:<br />
<br />
==Bausteine==<br />
=== websocket ===<br />
Der Websocket ist eine generische http-Schnittstelle, die von einem externen Frontend aus angesprochen werden kann.<br />
<br />
Der Websocket wird durch ein fhem-Modul 01_fronthem.pm realisiert, das im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
Der Websocket ist auf Port 2121 fest eingestellt, wird implizit durch die anderen Bausteine verwendet und benötigt im Prinzip keine weitere Beachtung, außer man möchte das Webinterface auf einem anderen Device neben FHEM laufen lassen.<br />
<br />
=== device connector ===<br />
Die Device-Connectoren dienen dazu, Endgeräte des Benutzers (PCs, Tablets, Smartphones usw.) als Clients zuzulassen und deren Berechtigungen (read, write) auf der Ebene einzelner Objekte zu steuern. Damit können z. B. die lieben Kinder zwar das Licht und die eigene Heizung steuern, aber nicht die Heizung umprogrammieren oder den Alarm ausschalten. Auch ein PIN-Schutz ist vorgesehen, im Moment aber noch nicht umgesetzt.<br />
<br />
Die Device-Connectoren werden durch das fhem-Modul 31_fronthemDevice.pm realisiert, welches im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
An den einzelnen Device-Connectoren werden die durch den websocket vom externen Frontend mitgeteilten Objekte aufgelistet und können dort einerseits mit fhem devices und andererseits in den Berechtigungen des jeweiligen Endgerätes konfiguriert werden.<br />
<br />
Umgekehrt bedeutet dies, dass man die Kombination der Frontend-items mit den fhem-Devices über die Converter nur einmal pro item machen muss, die Berechtigungen der verwendeten Endgeräte muss man aber jeweils pro Endgerät einzeln setzen.<br />
<br />
=== readings converter ===<br />
Die Readings von fhem müssen in die Form der möglichen Werte des Frontends umgewandelt werden. Im umgekehrten Fall müssen Befehle des Frontends in fhem kompatible Befehle umgesetzt werden.<br />
Diese Aufgabe übernehmen die Readings Converter. Sie werden durch die Datei fhconverter.pm realisiert, die im Ordner .../fhem/FHEM/ abgelegt wird. <br />
Bisher gibt es folgende Converter:<br />
* [[#Direct]] für Übertragung ohne Konvertierung<br />
* [[#NumDirect]] für Übertragung von Zahlenwerten in einem begrenzten Werteraum zwischen Min und Max<br />
* [[#NumDisplay]] für Zahlenwerte aus fhem Readings, nur lesend<br />
* [[#WordDisplay]] ist in Planung, für Übertragung von selbst definierbaren Wörtern/Sätze<br />
* [[#OnOff]] für Schalter, Übersetzung von On in 1 und Off in 0<br />
* [[#RGBCombined]] für Übertragung von RGB-Werten so das sie FHEM akzeptiert<br />
Näheres zu denn Convertern unter [[#Converter]]<br />
<br />
Weitere Readings Converter werden noch folgen.<br />
<br />
=== fronthemEditor ===<br />
Der Javascript Editor ist eine fhem WebIF Erweiterung, um die Bindung der fremden Frontend-Objekte an FHEM Devices/Readings vorzunehmen und die dazu notwendigen Konvertierungen zu wählen.<br />
Er wird durch die Datei fronthemEditor.js repräsentiert, die in den Ordner .../fhem/www/frontend/pgm2/ kopiert wird.<br />
<br />
Der Editor erscheint in fhem als komplette gad-Liste in den Details von jedem definierten fronthemDevice. Das mag auf den ersten Blick irreführend sein, weil die Definition der gad/items/plots fhem-global geschieht, war aber wohl die beste mögliche Umsetzung zur Zeit.<br />
<br />
Man muss also durch den Editor an einem beliebigen fronthemDevice die Verknüpfung zwischen fhem-devices und smartVISU items herstellen, dann gilt diese für alle fhem Devices. Nur die Berechtigungen der einzelnen fhem Devices werden unterschiedlich gepflegt. (im Moment aber inaktiviert!)<br />
<br />
==Basic Syntax==<br />
===Websocket===<br />
:<code>define <name> fronthem</code><br />
<br />
===Device Connector===<br />
Man muss jedes Device, mit dem man zugreifen will definieren.<br />
<br />
Dadurch kann genau festgelegt werden, welches Device Rechte für eine jeweilige Schaltfunktion hat.<br />
====IP-Identify====<br />
Identifizierung per IP-Adresse. Dies ist nur im internen Netzwerk sehr sinnvoll.<br />
Ein Device wird definiert mit:<br />
:<code>define <device> fronthemDevice <ip></code><br />
====Zertificate-Identify====<br />
Das Device wird über ein Zertifikat identifiziert.<br />
Zuerst wird ein Zertifikat generiert, welches dann auf dem Device installiert werden muss.<br />
<br />
Diese Methode der Identifizierung verspricht höhere Sicherheit, wie auch denn Vorteil, das man sich nicht einloggen muss.<br />
<br />
Diese Funktion ist noch in Entwicklung.<br />
<br />
==Converter==<br />
Die Converter sind alle kompatibel mit dem oben erwähnten Frontend SmartVisu und werden auf Basis dieses Frontends erklärt.<br />
<br />
Wenn jemand ein anderes Frontend verwenden will, muss er möglicherweise die Converter anpassen.<br />
===Direct===<br />
Die Werte werden ohne Konvertierung weitergegeben.<br />
<br />
Gibt den Wert des von <reading> ohne weitere Wandlung an das Frontend weiter. In umgekehrter Richtung wird der vom Frontend geliefert Wert ohne Wandlung im hinterlegten <set> eingesetzt.<br />
<br />
Beispiel: <br />
Anzeige eines An- oder Abwesenheitszustandes im Frontend (Textanzeige, Icon, Button)<br />
<br />
===NumDirect===<br />
NumDirect arbeitet bidirektional. Die Werte werden genau wie bei Direct ohne Umwandlung weitergegeben.<br />
<br />
Der feine Unterschied zu Direct ist jedoch, das nur Zahlenwerte übergeben werden können.<br />
<br />
Desweiteren kann man einen minimalen und maximalen Wert mitangeben. Dies hat denn Sinn, das man keine Werte einstellen kann, die überhaupt nicht möglich wären.<br />
<br />
In der SmartVisu kann man z.B. -100°C einstellen, das wäre in FHEM jedoch gar nicht möglich.<br />
<br />
===NumDelayed===<br />
NumDelayed ist noch in Arbeit.<br />
<br />
Ein bidirektionaler numerischer Converter mit einstellbarer Verzögerung.<br />
<br />
Bietet bei der Ansteuerung mechanischer Aktoren (Markise, Jalousie) Vorteile gegenüber NumDirect. Als Beispiel sei die Steuerung einer Jalousie über einen Slider genannt. Da Slider ihre Werte kontinuierlich an FHEM übermitteln, würde bei der Verwendung anderer Converter dem entsprechenden Aktor (z.B. HM-BP), während der Benutzer den Slider bedient, mehrfach der vermeindliche Sollwert übermittelt werden. Gleichzeitig beginnt der Aktor seine Fahrt und übermittelt dem Slider seine aktuelle ist Position. Das führt zu einem springen des Sliders und einer "unschönen" Bedienung.<br />
<br />
NumDelayed nimmt daher die Signale des Sliders entgegen, wartet jedoch mit der Weitergabe solange, bis sich der Slider (xxx ms, konfigurierbar) nicht mehr bewegt. In Gegenrichtung wird ebenso verfahren, erst wenn der Aktor seine Endposition erreicht, wird der Slider im Frontend aktualisiert. In diesem Beispiel würde das bedeuten das der Slider im Normalfall ohnehin so steht (Soll) wie vom Aktor gemeldet (Ist). Natürlich könnte der Benutzer oder ein Hindernis die Fahrt auch unterbrochen haben, dann würde der Slider auf die gemeldete Position aktualisiert.<br />
<br />
===NumDisplay===<br />
NumDisplay arbeitet nur in eine Richting, FHEM zu Frontend. Die Werte werden ohne Umwandlung weitergegeben.<br />
<br />
Es ist dazu gedacht Zahlenwerte zu übergeben, ohne etwas zu verändern.<br />
<br />
z.B. für Temperaturwerte<br />
<br />
===WordDisplay===<br />
WordDisplay ist derzeit in Planung, es wird noch über die Umsetzung diskutiert.<br />
<br />
WordDisplay soll nur in eine Richtung arbeiten, FHEM zu Frontend. Es ist dazu gedacht Wörter oder Textpassagen zu übertragen.<br />
<br />
Jedoch soll es möglich sein, eine Umwandlung selbst festzulegen. So kann man einfach mehrere Textausgaben abhängig vom Zustand an das Frontend schicken:<br />
<br />
z.B. Geofancy: Home -> Zuhause, Underway -> Unterwegs, Work -> Arbeit<br />
<br />
===OnOff===<br />
Für einfache Ein/Aus-Funktionen.<br />
<br />
FHEM interpretiert Ein/Aus-Funktionen mit on/off, SmartVisu jedoch mit 1/0.<br />
<br />
Der OnOff-Converter wandelt diese bidirektional, damit sie richtig interpretiert werden.<br />
<br />
===RGBCombined===<br />
Ein Converter zur Steuerung von RGB Leuchtmitteln über Farbauswahlfelder (zb. Farbkreis)<br />
<br />
Bidirektional, wandelt, verwendet 3 Frontend Items<br />
<br />
reading: Name eines reading mit HEX RGB Wert des Leuchtmittels<br />
converter (mit Parameter): <code>RGBCombined <itemRed>, <itemYellow>, <itemBlue></code><br />
<br />
set: Name des set Befehls, bekommt HEX RGB Wert übergeben <br />
<br />
Dieser Converter muss gleichlautend für alle 3 RGB Kanäle des Frontends definiert werden.<br />
<br />
==Device Connector==<br />
Sobald ein fronthemDevice definiert ist, kann man über die device details in fhem die GADs definieren und die Rechte verteilen.<br />
===GAD definieren===<br />
Eine GAD-Definierung besteht aus:<br />
[[Datei:DeviceDefine.png|400px|thumb|right|GADs definieren]]<br />
*mode<br />
*device<br />
*reading<br />
*converter<br />
*cmd set<br />
====mode====<br />
Es gibt 2 Modis:<br />
*item<br />
*plot<br />
====device====<br />
Hier wird der Name des FHEM-Devices eingetragen, an das die Befehle geschickt werden. Die vorhandenen Devices in fhem werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt. <br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====reading====<br />
Das für die Anzeige zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Readings werden, wenn das Frontend dies anfordert, aktiv von fronthem gelesen und (per push) proaktiv an das Frontend gesendet wenn fhem entsprechende events erzeugt.<br />
<br />
====converter====<br />
Hier gibt man denn Namen des Converters an, denn man verwenden möchte.<br />
Es stehen unterschiedliche converter für verschiedene Aufgabenstellungen zur Verfügung. Über das Konzept der converter können fhem Device unterschiedlichster Typen und Funktionen über das Frontend bedient werden. So versorgt der gleiche converter der die Solltemperatur des virtuellen Heizungsthermostats (bidriektional) einstellt auch die Füllstandanzeige der Zisterne sowie den Dimmer. In all diesen Fällen handelt es sich um die Übertragung von numerischen Werten. Converter können dabei auch Spezialaufgaben wie die Begrenzung des Wertebereichs übernehmen. So lässt sich über NumDirect zum Beispiel die Solltemperatur Einstellung für virtuelle Heizungsregler auf Min und Max Werte begrenzen. <br />
<br />
Oben ist eine Standardliste der [[#Converter]]. Die meisten Devices können mit diesen Convertern angesteuert werden.<br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====cmd set====<br />
Das zum Schreiben zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Das gewählte Reading gibt den "set" des fhem Devices an, der die Rückgabe des Converters entgegen nimmt.<br />
<br />
Bei Lampe z.B. "state".<br />
<br />
===Devicerechte vergeben===<br />
[[Datei:DeviceRechte.png|400px|thumb|right|Devicerechte vergeben]]<br />
Devicerechte bestehen aus:<br />
*read<br />
*write<br />
*PIN GAD<br />
====read====<br />
Das Device darf die Statuswerte auslesen, jedoch nicht verändern.<br />
<br />
====write====<br />
Das Device darf Statuswerte ändern.<br />
<br />
====PIN GAD====<br />
In Entwicklung...<br />
<br />
<br />
==Universelle ZeitSchaltUhr UZSU==<br />
Es existiert ein Widget für eine universelle ZeitSchaltUhr auf GitHub unter https://github.com/mworion/uzsu_widget .<br />
<br />
Man muss dazu die uzsu_widget.html in das eigene Verzeichnis in ../pages/.. kopieren und die visu.js und die visu.css in seine Installation integrieren (Achtung, wenn die beiden Dateien schon bestehen, dann muss man das manuell zusammenkopieren!)<br />
<br />
Das Widget kann in SmartVISU wie gewohnt eingebunden werden:<br />
<br />
(für ein Ergebnis, das der Benutzer direkt eintippen kann, z.B. 'on' oder 'off')<br />
<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUtxt', gad_uzsu, '', '', '', '', 'text') }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis zwischen 0 und 100)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'num', 0, 100) }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis {0,1}, das aber als flip mit 'an' und 'aus' angezeigt wird)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'bool', 'an', 'aus') }}<br />
</nowiki><br />
<br />
<br />
Um die Antwort des Widgets in fhem zu verarbeiten, benötigt man <br />
<br />
1. je ein Reading uzsu an dem zu schaltenden Device, das man mit <br />
<br />
<nowiki><br />
setreading <device> uzsu {}<br />
</nowiki><br />
<br />
erzeugen MUSS.<br />
<br />
2. eine Anbindung des uzsu-GAD per UZSU Converter an das Reading uzsu des zu schaltenden Device read und write in fhem<br />
<br />
3. folgenden Code in der 99_FronthemUtils.pm:<br />
<br />
Im Package Main:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Umsetzen der UZSU-Settings für ein device<br />
#<br />
###############################################################################<br />
sub UZSU_execute($$)<br />
{<br />
my ($device, $uzsu) = @_;<br />
<br />
$uzsu = decode_json($uzsu);<br />
fhem('delete wdt_'.$device.'_uzsu');<br />
my $weekdays_part = " ";<br />
for(my $i=0; $i < @{$uzsu->{list}}; $i++) {<br />
my $weekdays = $uzsu->{list}[$i]->{rrule};<br />
$weekdays = substr($weekdays,18,50); <br />
if (($uzsu->{list}[$i]->{active})) {<br />
$weekdays_part = $weekdays_part.' '.$weekdays.'|'.$uzsu->{list}[$i]->{time}.'|'.$uzsu->{list}[$i]->{value};<br />
}<br />
}<br />
fhem('define wdt_'.$device.'_uzsu'.' WeekdayTimer '.$device.' en '.$weekdays_part);<br />
if ($uzsu->{active}){ <br />
fhem('attr wdt_'.$device.'_uzsu disable 0');<br />
} else {<br />
fhem('attr wdt_'.$device.'_uzsu disable 1');<br />
} <br />
}<br />
</nowiki><br />
<br />
Im Package fronthem, selbe Datei:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Setreading a device reading using JSON conversion (gadval => reading=decode_json() => setval => encode_json(reading) )<br />
#<br />
###############################################################################<br />
<br />
sub UZSU(@)<br />
{<br />
my ($param) = @_;<br />
my $cmd = $param->{cmd};<br />
my $gad = $param->{gad};<br />
my $gadval = $param->{gadval};<br />
<br />
my $device = $param->{device};<br />
my $reading = $param->{reading};<br />
my $event = $param->{event};<br />
<br />
my @args = @{$param->{args}};<br />
my $cache = $param->{cache};<br />
<br />
if ($param->{cmd} eq 'get')<br />
{<br />
$param->{cmd} = 'send';<br />
}<br />
if ($param->{cmd} eq 'send')<br />
{<br />
$param->{gad} = $gad;<br />
$param->{gadval} = decode_json(main::ReadingsVal($device, $reading, ''));<br />
$param->{gads} = [];<br />
return undef;<br />
}<br />
elsif ($param->{cmd} eq 'rcv')<br />
{<br />
$gadval = encode_json($gadval);<br />
$gadval =~ s/;/;;/ig;<br />
$param->{result} = main::fhem("setreading $device $reading $gadval");<br />
$param->{results} = [];<br />
return 'done';<br />
}<br />
elsif ($param->{cmd} eq '?')<br />
{<br />
return 'usage: UZSU';<br />
}<br />
return undef;<br />
}<br />
<br />
</nowiki><br />
<br />
Dieser Code erzeugt aus den Einstellungen im Widget entsprechende WeekdayTimer in fhem und löscht und erstellt neu bei jeder Änderung in SmartVISU.<br />
<br />
4. Die Funktion muss getriggert werden. Dazu ist ein notify nötig, das auf die Veränderung der uzsu Readings reagiert:<br />
<br />
<nowiki><br />
<br />
define UZSU notify .*:uzsu:.* { UZSU_execute($NAME, $EVTPART1) }<br />
<br />
</nowiki><br />
<br />
5. Bitte Domotiga driver in smartvisu verwenden! Stand 21.03.2015<br />
<br />
Voila!</div>Fidelhttp://wiki.fhem.de/w/index.php?title=Fronthem&diff=10578Fronthem2015-03-21T00:08:47Z<p>Fidel: /* Universelle ZeitSchaltUhr UZSU */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Anbindung von externen Frontends an FHEM (befindet sich in der Alpha-Phase)<br />
|ModType=x<br />
<!-- |ModCategory= (noch?) nicht verwendet --><br />
<!-- |ModCmdRef= wird automatisch generiert --><br />
|ModForumArea=Sonstige Systeme<br />
|ModTechName=01_fronthem.pm<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=769 Jörg alias herrmannj]<br />
}}<br />
Fronthem ist ein Projekt von herrmannj und wurde im fhem-Forum erstmalig angekündigt: http://forum.fhem.de/index.php/topic,27291.0.html<br />
<br />
Fronthem verfolgt die Idee, ein externes Web-Frontend (z. B. smartVISU http://smartvisu.de) an fhem anzukoppeln und den Datenverkehr sowie die Zusammenarbeit von Befehlen und Parametern zwischen FHEM und dem Web-Frontend zu übernehmen.<br />
<br />
Eine Installation für die Verwendung von [[SmartVisu]] mit Fronthem findet man hier [[Installation Fronthem|Installation Fronthem]].<br />
<br />
Dazu besteht fronthem aus vier Bausteinen:<br />
<br />
==Bausteine==<br />
=== websocket ===<br />
Der Websocket ist eine generische http-Schnittstelle, die von einem externen Frontend aus angesprochen werden kann.<br />
<br />
Der Websocket wird durch ein fhem-Modul 01_fronthem.pm realisiert, das im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
Der Websocket ist auf Port 2121 fest eingestellt, wird implizit durch die anderen Bausteine verwendet und benötigt im Prinzip keine weitere Beachtung, außer man möchte das Webinterface auf einem anderen Device neben FHEM laufen lassen.<br />
<br />
=== device connector ===<br />
Die Device-Connectoren dienen dazu, Endgeräte des Benutzers (PCs, Tablets, Smartphones usw.) als Clients zuzulassen und deren Berechtigungen (read, write) auf der Ebene einzelner Objekte zu steuern. Damit können z. B. die lieben Kinder zwar das Licht und die eigene Heizung steuern, aber nicht die Heizung umprogrammieren oder den Alarm ausschalten. Auch ein PIN-Schutz ist vorgesehen, im Moment aber noch nicht umgesetzt.<br />
<br />
Die Device-Connectoren werden durch das fhem-Modul 31_fronthemDevice.pm realisiert, welches im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
An den einzelnen Device-Connectoren werden die durch den websocket vom externen Frontend mitgeteilten Objekte aufgelistet und können dort einerseits mit fhem devices und andererseits in den Berechtigungen des jeweiligen Endgerätes konfiguriert werden.<br />
<br />
Umgekehrt bedeutet dies, dass man die Kombination der Frontend-items mit den fhem-Devices über die Converter nur einmal pro item machen muss, die Berechtigungen der verwendeten Endgeräte muss man aber jeweils pro Endgerät einzeln setzen.<br />
<br />
=== readings converter ===<br />
Die Readings von fhem müssen in die Form der möglichen Werte des Frontends umgewandelt werden. Im umgekehrten Fall müssen Befehle des Frontends in fhem kompatible Befehle umgesetzt werden.<br />
Diese Aufgabe übernehmen die Readings Converter. Sie werden durch die Datei fhconverter.pm realisiert, die im Ordner .../fhem/FHEM/ abgelegt wird. <br />
Bisher gibt es folgende Converter:<br />
* [[#Direct]] für Übertragung ohne Konvertierung<br />
* [[#NumDirect]] für Übertragung von Zahlenwerten in einem begrenzten Werteraum zwischen Min und Max<br />
* [[#NumDisplay]] für Zahlenwerte aus fhem Readings, nur lesend<br />
* [[#WordDisplay]] ist in Planung, für Übertragung von selbst definierbaren Wörtern/Sätze<br />
* [[#OnOff]] für Schalter, Übersetzung von On in 1 und Off in 0<br />
* [[#RGBCombined]] für Übertragung von RGB-Werten so das sie FHEM akzeptiert<br />
Näheres zu denn Convertern unter [[#Converter]]<br />
<br />
Weitere Readings Converter werden noch folgen.<br />
<br />
=== fronthemEditor ===<br />
Der Javascript Editor ist eine fhem WebIF Erweiterung, um die Bindung der fremden Frontend-Objekte an FHEM Devices/Readings vorzunehmen und die dazu notwendigen Konvertierungen zu wählen.<br />
Er wird durch die Datei fronthemEditor.js repräsentiert, die in den Ordner .../fhem/www/frontend/pgm2/ kopiert wird.<br />
<br />
Der Editor erscheint in fhem als komplette gad-Liste in den Details von jedem definierten fronthemDevice. Das mag auf den ersten Blick irreführend sein, weil die Definition der gad/items/plots fhem-global geschieht, war aber wohl die beste mögliche Umsetzung zur Zeit.<br />
<br />
Man muss also durch den Editor an einem beliebigen fronthemDevice die Verknüpfung zwischen fhem-devices und smartVISU items herstellen, dann gilt diese für alle fhem Devices. Nur die Berechtigungen der einzelnen fhem Devices werden unterschiedlich gepflegt. (im Moment aber inaktiviert!)<br />
<br />
==Basic Syntax==<br />
===Websocket===<br />
:<code>define <name> fronthem</code><br />
<br />
===Device Connector===<br />
Man muss jedes Device, mit dem man zugreifen will definieren.<br />
<br />
Dadurch kann genau festgelegt werden, welches Device Rechte für eine jeweilige Schaltfunktion hat.<br />
====IP-Identify====<br />
Identifizierung per IP-Adresse. Dies ist nur im internen Netzwerk sehr sinnvoll.<br />
Ein Device wird definiert mit:<br />
:<code>define <device> fronthemDevice <ip></code><br />
====Zertificate-Identify====<br />
Das Device wird über ein Zertifikat identifiziert.<br />
Zuerst wird ein Zertifikat generiert, welches dann auf dem Device installiert werden muss.<br />
<br />
Diese Methode der Identifizierung verspricht höhere Sicherheit, wie auch denn Vorteil, das man sich nicht einloggen muss.<br />
<br />
Diese Funktion ist noch in Entwicklung.<br />
<br />
==Converter==<br />
Die Converter sind alle kompatibel mit dem oben erwähnten Frontend SmartVisu und werden auf Basis dieses Frontends erklärt.<br />
<br />
Wenn jemand ein anderes Frontend verwenden will, muss er möglicherweise die Converter anpassen.<br />
===Direct===<br />
Die Werte werden ohne Konvertierung weitergegeben.<br />
<br />
Gibt den Wert des von <reading> ohne weitere Wandlung an das Frontend weiter. In umgekehrter Richtung wird der vom Frontend geliefert Wert ohne Wandlung im hinterlegten <set> eingesetzt.<br />
<br />
Beispiel: <br />
Anzeige eines An- oder Abwesenheitszustandes im Frontend (Textanzeige, Icon, Button)<br />
<br />
===NumDirect===<br />
NumDirect arbeitet bidirektional. Die Werte werden genau wie bei Direct ohne Umwandlung weitergegeben.<br />
<br />
Der feine Unterschied zu Direct ist jedoch, das nur Zahlenwerte übergeben werden können.<br />
<br />
Desweiteren kann man einen minimalen und maximalen Wert mitangeben. Dies hat denn Sinn, das man keine Werte einstellen kann, die überhaupt nicht möglich wären.<br />
<br />
In der SmartVisu kann man z.B. -100°C einstellen, das wäre in FHEM jedoch gar nicht möglich.<br />
<br />
===NumDelayed===<br />
NumDelayed ist noch in Arbeit.<br />
<br />
Ein bidirektionaler numerischer Converter mit einstellbarer Verzögerung.<br />
<br />
Bietet bei der Ansteuerung mechanischer Aktoren (Markise, Jalousie) Vorteile gegenüber NumDirect. Als Beispiel sei die Steuerung einer Jalousie über einen Slider genannt. Da Slider ihre Werte kontinuierlich an FHEM übermitteln, würde bei der Verwendung anderer Converter dem entsprechenden Aktor (z.B. HM-BP), während der Benutzer den Slider bedient, mehrfach der vermeindliche Sollwert übermittelt werden. Gleichzeitig beginnt der Aktor seine Fahrt und übermittelt dem Slider seine aktuelle ist Position. Das führt zu einem springen des Sliders und einer "unschönen" Bedienung.<br />
<br />
NumDelayed nimmt daher die Signale des Sliders entgegen, wartet jedoch mit der Weitergabe solange, bis sich der Slider (xxx ms, konfigurierbar) nicht mehr bewegt. In Gegenrichtung wird ebenso verfahren, erst wenn der Aktor seine Endposition erreicht, wird der Slider im Frontend aktualisiert. In diesem Beispiel würde das bedeuten das der Slider im Normalfall ohnehin so steht (Soll) wie vom Aktor gemeldet (Ist). Natürlich könnte der Benutzer oder ein Hindernis die Fahrt auch unterbrochen haben, dann würde der Slider auf die gemeldete Position aktualisiert.<br />
<br />
===NumDisplay===<br />
NumDisplay arbeitet nur in eine Richting, FHEM zu Frontend. Die Werte werden ohne Umwandlung weitergegeben.<br />
<br />
Es ist dazu gedacht Zahlenwerte zu übergeben, ohne etwas zu verändern.<br />
<br />
z.B. für Temperaturwerte<br />
<br />
===WordDisplay===<br />
WordDisplay ist derzeit in Planung, es wird noch über die Umsetzung diskutiert.<br />
<br />
WordDisplay soll nur in eine Richtung arbeiten, FHEM zu Frontend. Es ist dazu gedacht Wörter oder Textpassagen zu übertragen.<br />
<br />
Jedoch soll es möglich sein, eine Umwandlung selbst festzulegen. So kann man einfach mehrere Textausgaben abhängig vom Zustand an das Frontend schicken:<br />
<br />
z.B. Geofancy: Home -> Zuhause, Underway -> Unterwegs, Work -> Arbeit<br />
<br />
===OnOff===<br />
Für einfache Ein/Aus-Funktionen.<br />
<br />
FHEM interpretiert Ein/Aus-Funktionen mit on/off, SmartVisu jedoch mit 1/0.<br />
<br />
Der OnOff-Converter wandelt diese bidirektional, damit sie richtig interpretiert werden.<br />
<br />
===RGBCombined===<br />
Ein Converter zur Steuerung von RGB Leuchtmitteln über Farbauswahlfelder (zb. Farbkreis)<br />
<br />
Bidirektional, wandelt, verwendet 3 Frontend Items<br />
<br />
reading: Name eines reading mit HEX RGB Wert des Leuchtmittels<br />
converter (mit Parameter): <code>RGBCombined <itemRed>, <itemYellow>, <itemBlue></code><br />
<br />
set: Name des set Befehls, bekommt HEX RGB Wert übergeben <br />
<br />
Dieser Converter muss gleichlautend für alle 3 RGB Kanäle des Frontends definiert werden.<br />
<br />
==Device Connector==<br />
Sobald ein fronthemDevice definiert ist, kann man über die device details in fhem die GADs definieren und die Rechte verteilen.<br />
===GAD definieren===<br />
Eine GAD-Definierung besteht aus:<br />
[[Datei:DeviceDefine.png|400px|thumb|right|GADs definieren]]<br />
*mode<br />
*device<br />
*reading<br />
*converter<br />
*cmd set<br />
====mode====<br />
Es gibt 2 Modis:<br />
*item<br />
*plot<br />
====device====<br />
Hier wird der Name des FHEM-Devices eingetragen, an das die Befehle geschickt werden. Die vorhandenen Devices in fhem werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt. <br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====reading====<br />
Das für die Anzeige zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Readings werden, wenn das Frontend dies anfordert, aktiv von fronthem gelesen und (per push) proaktiv an das Frontend gesendet wenn fhem entsprechende events erzeugt.<br />
<br />
====converter====<br />
Hier gibt man denn Namen des Converters an, denn man verwenden möchte.<br />
Es stehen unterschiedliche converter für verschiedene Aufgabenstellungen zur Verfügung. Über das Konzept der converter können fhem Device unterschiedlichster Typen und Funktionen über das Frontend bedient werden. So versorgt der gleiche converter der die Solltemperatur des virtuellen Heizungsthermostats (bidriektional) einstellt auch die Füllstandanzeige der Zisterne sowie den Dimmer. In all diesen Fällen handelt es sich um die Übertragung von numerischen Werten. Converter können dabei auch Spezialaufgaben wie die Begrenzung des Wertebereichs übernehmen. So lässt sich über NumDirect zum Beispiel die Solltemperatur Einstellung für virtuelle Heizungsregler auf Min und Max Werte begrenzen. <br />
<br />
Oben ist eine Standardliste der [[#Converter]]. Die meisten Devices können mit diesen Convertern angesteuert werden.<br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====cmd set====<br />
Das zum Schreiben zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Das gewählte Reading gibt den "set" des fhem Devices an, der die Rückgabe des Converters entgegen nimmt.<br />
<br />
Bei Lampe z.B. "state".<br />
<br />
===Devicerechte vergeben===<br />
[[Datei:DeviceRechte.png|400px|thumb|right|Devicerechte vergeben]]<br />
Devicerechte bestehen aus:<br />
*read<br />
*write<br />
*PIN GAD<br />
====read====<br />
Das Device darf die Statuswerte auslesen, jedoch nicht verändern.<br />
<br />
====write====<br />
Das Device darf Statuswerte ändern.<br />
<br />
====PIN GAD====<br />
In Entwicklung...<br />
<br />
<br />
==Universelle ZeitSchaltUhr UZSU==<br />
Es existiert ein Widget für eine universelle ZeitSchaltUhr auf GitHub unter https://github.com/mworion/uzsu_widget .<br />
<br />
Man muss dazu die uzsu_widget.html in das eigene Verzeichnis in ../pages/.. kopieren und die visu.js und die visu.css in seine Installation integrieren (Achtung, wenn die beiden Dateien schon bestehen, dann muss man das manuell zusammenkopieren!)<br />
<br />
Das Widget kann in SmartVISU wie gewohnt eingebunden werden:<br />
<br />
(für ein Ergebnis, das der Benutzer direkt eintippen kann, z.B. 'on' oder 'off')<br />
<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUtxt', gad_uzsu, '', '', '', '', 'text') }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis zwischen 0 und 100)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'num', 0, 100) }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis {0,1}, das aber als flip mit 'an' und 'aus' angezeigt wird)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'bool', 'an', 'aus') }}<br />
</nowiki><br />
<br />
<br />
Um die Antwort des Widgets in fhem zu verarbeiten, benötigt man <br />
<br />
1. je ein Reading uzsu an dem zu schaltenden Device, das man mit <br />
<br />
<nowiki><br />
setreading <device> uzsu {}<br />
</nowiki><br />
<br />
erzeugen MUSS.<br />
<br />
2. eine Anbindung des uzsu-GAD per UZSU Converter an das Reading uzsu des zu schaltenden Device read und write in fhem<br />
<br />
3. folgenden Code in der 99_FronthemUtils.pm:<br />
<br />
Im Package Main:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Umsetzen der UZSU-Settings für ein device<br />
#<br />
###############################################################################<br />
sub UZSU_execute($$)<br />
{<br />
my ($device, $uzsu) = @_;<br />
<br />
$uzsu = decode_json($uzsu);<br />
fhem('delete wdt_'.$device.'_uzsu');<br />
my $weekdays_part = " ";<br />
for(my $i=0; $i < @{$uzsu->{list}}; $i++) {<br />
my $weekdays = $uzsu->{list}[$i]->{rrule};<br />
$weekdays = substr($weekdays,18,50); <br />
if (($uzsu->{list}[$i]->{active})) {<br />
$weekdays_part = $weekdays_part.' '.$weekdays.'|'.$uzsu->{list}[$i]->{time}.'|'.$uzsu->{list}[$i]->{value};<br />
}<br />
}<br />
fhem('define wdt_'.$device.'_uzsu'.' WeekdayTimer '.$device.' en '.$weekdays_part);<br />
if ($uzsu->{active}){ <br />
fhem('attr wdt_'.$device.'_uzsu disable 0');<br />
} else {<br />
fhem('attr wdt_'.$device.'_uzsu disable 1');<br />
} <br />
}<br />
</nowiki><br />
<br />
Im Package fronthem, selbe Datei:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Setreading a device reading using JSON conversion (gadval => reading=decode_json() => setval => encode_json(reading) )<br />
#<br />
###############################################################################<br />
<br />
sub UZSU(@)<br />
{<br />
my ($param) = @_;<br />
my $cmd = $param->{cmd};<br />
my $gad = $param->{gad};<br />
my $gadval = $param->{gadval};<br />
<br />
my $device = $param->{device};<br />
my $reading = $param->{reading};<br />
my $event = $param->{event};<br />
<br />
my @args = @{$param->{args}};<br />
my $cache = $param->{cache};<br />
<br />
if ($param->{cmd} eq 'get')<br />
{<br />
$param->{cmd} = 'send';<br />
}<br />
if ($param->{cmd} eq 'send')<br />
{<br />
$param->{gad} = $gad;<br />
$param->{gadval} = decode_json(main::ReadingsVal($device, $reading, ''));<br />
$param->{gads} = [];<br />
return undef;<br />
}<br />
elsif ($param->{cmd} eq 'rcv')<br />
{<br />
$gadval = encode_json($gadval);<br />
$gadval =~ s/;/;;/ig;<br />
$param->{result} = main::fhem("setreading $device $reading $gadval");<br />
$param->{results} = [];<br />
return 'done';<br />
}<br />
elsif ($param->{cmd} eq '?')<br />
{<br />
return 'usage: UZSU';<br />
}<br />
return undef;<br />
}<br />
<br />
</nowiki><br />
<br />
Dieser Code erzeugt aus den Einstellungen im Widget entsprechende WeekdayTimer in fhem und löscht und erstellt neu bei jeder Änderung in SmartVISU.<br />
<br />
4. Die Funktion muss getriggert werden. Dazu ist ein notify nötig, das auf die Veränderung der uzsu Readings reagiert:<br />
<br />
<nowiki><br />
<br />
define UZSU notify .*:uzsu:.* { UZSU_execute($NAME, $EVTPART1) }<br />
<br />
</nowiki><br />
<br />
5. Bitte Domotiga driver in smartvisu verwenden Stand 21.03.2015<br />
<br />
Voila!</div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10479SmartVISU2015-03-10T22:26:36Z<p>Fidel: </p>
<hr />
<div>SmartVisu ist ein Framework zur Visualisierung von Hausautomationssystemen, die eigentlich KNX-Installationen bedient.<br />
<br />
Durch [[Fronthem]] ist es möglich SmartVisu an Fhem anzubinden.<br />
Im nachfolgenden Link wird Fronthem ausführlich beschrieben: http://www.fhemwiki.de/wiki/Fronthem<br />
<br />
Eine Installationsanleitung für SmartVisu in Verbindung mit Fronthem findet sich unter folgendem Link: http://www.fhemwiki.de/wiki/Installation_Fronthem<br />
<br />
<br />
Codebeispiele:<br />
<br />
http://www.fhemwiki.de/wiki/SmartVisu/IconHighlights_in_Menus<br />
<br />
http://www.fhemwiki.de/wiki/SmartVisu/lichtSzene<br />
<br />
<!--<br />
==Widgets:==<br />
<br />
==zusätzliche Widgets werden im git-Repository /smartvisu-widgets breitgestellt==<br />
<br />
*<br />
*<br />
*<br />
<br />
==Widgets die die Config-Seite betreffen liegen bereits im git-Repository smartvisu-cleaninstall==<br />
<br />
*fritz!box_via_TR-064<br />
Dieses Widget verwendet TR-064 zum Auslesen der Anruferliste. Es ist ein Protokoll das nahe am UPnP Standard ist (SOAP).<br />
Getestet habe ich es mit den FritzOS Versionen 6.03 und 6.20.<br />
Dieses Widget wird unter der Smartvisu-Config Seite ausgewählt und es muss gegebenenfalls Benutzer und Passwort der Fritzbox in SmartViu angegeben werden.<br />
Wichtig dabei ist, dass in der Fritzbox unter ->Heimnetz->Netzwerk->Netzwerkeinstellungen->Zugriff für Anwendungen zulassen altiviert ist.<br />
<br />
*fritz!box_v6.20<br />
*<br />
--></div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10478SmartVISU2015-03-10T22:21:47Z<p>Fidel: </p>
<hr />
<div>SmartVisu ist ein Framework zur Visualisierung von Hausautomationssystemen, die eigentlich KNX-Installationen bedient.<br />
<br />
Durch [[Fronthem]] ist es möglich SmartVisu an Fhem anzubinden.<br />
Im nachfolgenden Link wird Fronthem ausführlich beschrieben: http://www.fhemwiki.de/wiki/Fronthem<br />
<br />
Eine Installationsanleitung für SmartVisu in Verbindung mit Fronthem findet sich unter folgendem Link: http://www.fhemwiki.de/wiki/Installation_Fronthem<br />
<br />
<br />
Codebeispiele:<br />
<br />
http://www.fhemwiki.de/wiki/SmartVisu/IconHighlights_in_Menus<br />
<br />
http://www.fhemwiki.de/wiki/SmartVisu/lichtSzene<br />
<br />
==Widgets:==<br />
<br />
==Widgets werden im git-Repository von herrmannj bereitgestellt: https://github.com/herrmannj/smartvisu-widgets==<br />
<br />
*<br />
*<br />
*<br />
<br />
==Widgets die die Config-Seite betreffen leigen bereits in der SmartVisu cleaninstall bei.==<br />
<br />
*fritz!box_via_TR-064<br />
Dieses Widget verwendet TR-064 zum Auslesen der Anruferliste. Es ist ein Protokoll das nahe am UPnP Standard ist (SOAP).<br />
Getestet habe ich es mit den FritzOS Versionen 6.03 und 6.20.<br />
Dieses Widget wird unter der Smartvisu-Config Seite ausgewählt und es muss gegebenenfalls Benutzer und Passwort der Fritzbox in SmartViu angegeben werden.<br />
Wichtig dabei ist, dass in der Fritzbox unter ->Heimnetz->Netzwerk->Netzwerkeinstellungen->Zugriff für Anwendungen zulassen altiviert ist.<br />
<br />
*<br />
*</div>Fidelhttp://wiki.fhem.de/w/index.php?title=Fronthem&diff=10477Fronthem2015-03-10T22:06:30Z<p>Fidel: </p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Anbindung von externen Frontends an FHEM (befindet sich in der Alpha-Phase)<br />
|ModType=x<br />
<!-- |ModCategory= (noch?) nicht verwendet --><br />
<!-- |ModCmdRef= wird automatisch generiert --><br />
|ModForumArea=Sonstige Systeme<br />
|ModTechName=01_fronthem.pm<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=769 Jörg alias herrmannj]<br />
}}<br />
Fronthem ist ein Projekt von herrmannj und wurde im fhem-Forum erstmalig angekündigt: http://forum.fhem.de/index.php/topic,27291.0.html<br />
<br />
Fronthem verfolgt die Idee, ein externes Web-Frontend (z. B. smartVISU http://smartvisu.de) an fhem anzukoppeln und den Datenverkehr sowie die Zusammenarbeit von Befehlen und Parametern zwischen FHEM und dem Web-Frontend zu übernehmen.<br />
<br />
Eine Installation für die Verwendung von [[SmartVisu]] mit Fronthem findet man hier [[Installation Fronthem|Installation Fronthem]].<br />
<br />
Dazu besteht fronthem aus vier Bausteinen:<br />
<br />
==Bausteine==<br />
=== websocket ===<br />
Der Websocket ist eine generische http-Schnittstelle, die von einem externen Frontend aus angesprochen werden kann.<br />
<br />
Der Websocket wird durch ein fhem-Modul 01_fronthem.pm realisiert, das im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
Der Websocket ist auf Port 2121 fest eingestellt, wird implizit durch die anderen Bausteine verwendet und benötigt im Prinzip keine weitere Beachtung, außer man möchte das Webinterface auf einem anderen Device neben FHEM laufen lassen.<br />
<br />
=== device connector ===<br />
Die Device-Connectoren dienen dazu, Endgeräte des Benutzers (PCs, Tablets, Smartphones usw.) als Clients zuzulassen und deren Berechtigungen (read, write) auf der Ebene einzelner Objekte zu steuern. Damit können z. B. die lieben Kinder zwar das Licht und die eigene Heizung steuern, aber nicht die Heizung umprogrammieren oder den Alarm ausschalten. Auch ein PIN-Schutz ist vorgesehen, im Moment aber noch nicht umgesetzt.<br />
<br />
Die Device-Connectoren werden durch das fhem-Modul 31_fronthemDevice.pm realisiert, welches im Ordner .../fhem/FHEM/ abgelegt wird.<br />
<br />
An den einzelnen Device-Connectoren werden die durch den websocket vom externen Frontend mitgeteilten Objekte aufgelistet und können dort einerseits mit fhem devices und andererseits in den Berechtigungen des jeweiligen Endgerätes konfiguriert werden.<br />
<br />
Umgekehrt bedeutet dies, dass man die Kombination der Frontend-items mit den fhem-Devices über die Converter nur einmal pro item machen muss, die Berechtigungen der verwendeten Endgeräte muss man aber jeweils pro Endgerät einzeln setzen.<br />
<br />
=== readings converter ===<br />
Die Readings von fhem müssen in die Form der möglichen Werte des Frontends umgewandelt werden. Im umgekehrten Fall müssen Befehle des Frontends in fhem kompatible Befehle umgesetzt werden.<br />
Diese Aufgabe übernehmen die Readings Converter. Sie werden durch die Datei fhconverter.pm realisiert, die im Ordner .../fhem/FHEM/ abgelegt wird. <br />
Bisher gibt es folgende Converter:<br />
* [[#Direct]] für Übertragung ohne Konvertierung<br />
* [[#NumDirect]] für Übertragung von Zahlenwerten in einem begrenzten Werteraum zwischen Min und Max<br />
* [[#NumDisplay]] für Zahlenwerte aus fhem Readings, nur lesend<br />
* [[#WordDisplay]] ist in Planung, für Übertragung von selbst definierbaren Wörtern/Sätze<br />
* [[#OnOff]] für Schalter, Übersetzung von On in 1 und Off in 0<br />
* [[#RGBCombined]] für Übertragung von RGB-Werten so das sie FHEM akzeptiert<br />
Näheres zu denn Convertern unter [[#Converter]]<br />
<br />
Weitere Readings Converter werden noch folgen.<br />
<br />
=== fronthemEditor ===<br />
Der Javascript Editor ist eine fhem WebIF Erweiterung, um die Bindung der fremden Frontend-Objekte an FHEM Devices/Readings vorzunehmen und die dazu notwendigen Konvertierungen zu wählen.<br />
Er wird durch die Datei fronthemEditor.js repräsentiert, die in den Ordner .../fhem/www/frontend/pgm2/ kopiert wird.<br />
<br />
Der Editor erscheint in fhem als komplette gad-Liste in den Details von jedem definierten fronthemDevice. Das mag auf den ersten Blick irreführend sein, weil die Definition der gad/items/plots fhem-global geschieht, war aber wohl die beste mögliche Umsetzung zur Zeit.<br />
<br />
Man muss also durch den Editor an einem beliebigen fronthemDevice die Verknüpfung zwischen fhem-devices und smartVISU items herstellen, dann gilt diese für alle fhem Devices. Nur die Berechtigungen der einzelnen fhem Devices werden unterschiedlich gepflegt. (im Moment aber inaktiviert!)<br />
<br />
==Basic Syntax==<br />
===Websocket===<br />
:<code>define <name> fronthem</code><br />
<br />
===Device Connector===<br />
Man muss jedes Device, mit dem man zugreifen will definieren.<br />
<br />
Dadurch kann genau festgelegt werden, welches Device Rechte für eine jeweilige Schaltfunktion hat.<br />
====IP-Identify====<br />
Identifizierung per IP-Adresse. Dies ist nur im internen Netzwerk sehr sinnvoll.<br />
Ein Device wird definiert mit:<br />
:<code>define <device> fronthemDevice <ip></code><br />
====Zertificate-Identify====<br />
Das Device wird über ein Zertifikat identifiziert.<br />
Zuerst wird ein Zertifikat generiert, welches dann auf dem Device installiert werden muss.<br />
<br />
Diese Methode der Identifizierung verspricht höhere Sicherheit, wie auch denn Vorteil, das man sich nicht einloggen muss.<br />
<br />
Diese Funktion ist noch in Entwicklung.<br />
<br />
==Converter==<br />
Die Converter sind alle kompatibel mit dem oben erwähnten Frontend SmartVisu und werden auf Basis dieses Frontends erklärt.<br />
<br />
Wenn jemand ein anderes Frontend verwenden will, muss er möglicherweise die Converter anpassen.<br />
===Direct===<br />
Die Werte werden ohne Konvertierung weitergegeben.<br />
<br />
Gibt den Wert des von <reading> ohne weitere Wandlung an das Frontend weiter. In umgekehrter Richtung wird der vom Frontend geliefert Wert ohne Wandlung im hinterlegten <set> eingesetzt.<br />
<br />
Beispiel: <br />
Anzeige eines An- oder Abwesenheitszustandes im Frontend (Textanzeige, Icon, Button)<br />
<br />
===NumDirect===<br />
NumDirect arbeitet bidirektional. Die Werte werden genau wie bei Direct ohne Umwandlung weitergegeben.<br />
<br />
Der feine Unterschied zu Direct ist jedoch, das nur Zahlenwerte übergeben werden können.<br />
<br />
Desweiteren kann man einen minimalen und maximalen Wert mitangeben. Dies hat denn Sinn, das man keine Werte einstellen kann, die überhaupt nicht möglich wären.<br />
<br />
In der SmartVisu kann man z.B. -100°C einstellen, das wäre in FHEM jedoch gar nicht möglich.<br />
<br />
===NumDelayed===<br />
NumDelayed ist noch in Arbeit.<br />
<br />
Ein bidirektionaler numerischer Converter mit einstellbarer Verzögerung.<br />
<br />
Bietet bei der Ansteuerung mechanischer Aktoren (Markise, Jalousie) Vorteile gegenüber NumDirect. Als Beispiel sei die Steuerung einer Jalousie über einen Slider genannt. Da Slider ihre Werte kontinuierlich an FHEM übermitteln, würde bei der Verwendung anderer Converter dem entsprechenden Aktor (z.B. HM-BP), während der Benutzer den Slider bedient, mehrfach der vermeindliche Sollwert übermittelt werden. Gleichzeitig beginnt der Aktor seine Fahrt und übermittelt dem Slider seine aktuelle ist Position. Das führt zu einem springen des Sliders und einer "unschönen" Bedienung.<br />
<br />
NumDelayed nimmt daher die Signale des Sliders entgegen, wartet jedoch mit der Weitergabe solange, bis sich der Slider (xxx ms, konfigurierbar) nicht mehr bewegt. In Gegenrichtung wird ebenso verfahren, erst wenn der Aktor seine Endposition erreicht, wird der Slider im Frontend aktualisiert. In diesem Beispiel würde das bedeuten das der Slider im Normalfall ohnehin so steht (Soll) wie vom Aktor gemeldet (Ist). Natürlich könnte der Benutzer oder ein Hindernis die Fahrt auch unterbrochen haben, dann würde der Slider auf die gemeldete Position aktualisiert.<br />
<br />
===NumDisplay===<br />
NumDisplay arbeitet nur in eine Richting, FHEM zu Frontend. Die Werte werden ohne Umwandlung weitergegeben.<br />
<br />
Es ist dazu gedacht Zahlenwerte zu übergeben, ohne etwas zu verändern.<br />
<br />
z.B. für Temperaturwerte<br />
<br />
===WordDisplay===<br />
WordDisplay ist derzeit in Planung, es wird noch über die Umsetzung diskutiert.<br />
<br />
WordDisplay soll nur in eine Richtung arbeiten, FHEM zu Frontend. Es ist dazu gedacht Wörter oder Textpassagen zu übertragen.<br />
<br />
Jedoch soll es möglich sein, eine Umwandlung selbst festzulegen. So kann man einfach mehrere Textausgaben abhängig vom Zustand an das Frontend schicken:<br />
<br />
z.B. Geofancy: Home -> Zuhause, Underway -> Unterwegs, Work -> Arbeit<br />
<br />
===OnOff===<br />
Für einfache Ein/Aus-Funktionen.<br />
<br />
FHEM interpretiert Ein/Aus-Funktionen mit on/off, SmartVisu jedoch mit 1/0.<br />
<br />
Der OnOff-Converter wandelt diese bidirektional, damit sie richtig interpretiert werden.<br />
<br />
===RGBCombined===<br />
Ein Converter zur Steuerung von RGB Leuchtmitteln über Farbauswahlfelder (zb. Farbkreis)<br />
<br />
Bidirektional, wandelt, verwendet 3 Frontend Items<br />
<br />
reading: Name eines reading mit HEX RGB Wert des Leuchtmittels<br />
converter (mit Parameter): <code>RGBCombined <itemRed>, <itemYellow>, <itemBlue></code><br />
<br />
set: Name des set Befehls, bekommt HEX RGB Wert übergeben <br />
<br />
Dieser Converter muss gleichlautend für alle 3 RGB Kanäle des Frontends definiert werden.<br />
<br />
==Device Connector==<br />
Sobald ein fronthemDevice definiert ist, kann man über die device details in fhem die GADs definieren und die Rechte verteilen.<br />
===GAD definieren===<br />
Eine GAD-Definierung besteht aus:<br />
[[Datei:DeviceDefine.png|400px|thumb|right|GADs definieren]]<br />
*mode<br />
*device<br />
*reading<br />
*converter<br />
*cmd set<br />
====mode====<br />
Es gibt 2 Modis:<br />
*item<br />
*plot<br />
====device====<br />
Hier wird der Name des FHEM-Devices eingetragen, an das die Befehle geschickt werden. Die vorhandenen Devices in fhem werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt. <br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====reading====<br />
Das für die Anzeige zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Readings werden, wenn das Frontend dies anfordert, aktiv von fronthem gelesen und (per push) proaktiv an das Frontend gesendet wenn fhem entsprechende events erzeugt.<br />
<br />
====converter====<br />
Hier gibt man denn Namen des Converters an, denn man verwenden möchte.<br />
Es stehen unterschiedliche converter für verschiedene Aufgabenstellungen zur Verfügung. Über das Konzept der converter können fhem Device unterschiedlichster Typen und Funktionen über das Frontend bedient werden. So versorgt der gleiche converter der die Solltemperatur des virtuellen Heizungsthermostats (bidriektional) einstellt auch die Füllstandanzeige der Zisterne sowie den Dimmer. In all diesen Fällen handelt es sich um die Übertragung von numerischen Werten. Converter können dabei auch Spezialaufgaben wie die Begrenzung des Wertebereichs übernehmen. So lässt sich über NumDirect zum Beispiel die Solltemperatur Einstellung für virtuelle Heizungsregler auf Min und Max Werte begrenzen. <br />
<br />
Oben ist eine Standardliste der [[#Converter]]. Die meisten Devices können mit diesen Convertern angesteuert werden.<br />
<br />
Groß/Kleinschreibung muss beachtet werden!<br />
<br />
====cmd set====<br />
Das zum Schreiben zu verwendende Reading des fhem Devices, z. B. "state" oder "Level". Die vorhandenen Readings des gewählten fhem-Devices werden als Liste unter dem Eingabefeld angezeigt, sobald man mit der Eingabe beginnt.<br />
<br />
Das gewählte Reading gibt den "set" des fhem Devices an, der die Rückgabe des Converters entgegen nimmt.<br />
<br />
Bei Lampe z.B. "state".<br />
<br />
===Devicerechte vergeben===<br />
[[Datei:DeviceRechte.png|400px|thumb|right|Devicerechte vergeben]]<br />
Devicerechte bestehen aus:<br />
*read<br />
*write<br />
*PIN GAD<br />
====read====<br />
Das Device darf die Statuswerte auslesen, jedoch nicht verändern.<br />
<br />
====write====<br />
Das Device darf Statuswerte ändern.<br />
<br />
====PIN GAD====<br />
In Entwicklung...<br />
<br />
<br />
==Universelle ZeitSchaltUhr UZSU==<br />
Es existiert ein Widget für eine universelle ZeitSchaltUhr auf GitHub unter https://github.com/mworion/uzsu_widget .<br />
<br />
Man muss dazu die uzsu_widget.html in das eigene Verzeichnis in ../pages/.. kopieren und die visu.js und die visu.css in seine Installation integrieren (Achtung, wenn die beiden Dateien schon bestehen, dann muss man das manuell zusammenkopieren!)<br />
<br />
Das Widget kann in SmartVISU wie gewohnt eingebunden werden:<br />
<br />
(für ein Ergebnis, das der Benutzer direkt eintippen kann, z.B. 'on' oder 'off')<br />
<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUtxt', gad_uzsu, '', '', '', '', 'text') }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis zwischen 0 und 100)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'num', 0, 100) }}<br />
</nowiki><br />
<br />
oder (für ein Ergebnis {0,1}, das aber als flip mit 'an' und 'aus' angezeigt wird)<br />
<nowiki><br />
{% import "widget_uzsu.html" as visu %}<br />
<br />
{{ visu.uzsu_icon('UZSUnum', gad_uzsu, '', '', '', '', 'bool', 'an', 'aus') }}<br />
</nowiki><br />
<br />
<br />
Um die Antwort des Widgets in fhem zu verarbeiten, benötigt man <br />
<br />
1. je ein Reading uzsu an dem zu schaltenden Device, das man mit <br />
<br />
<nowiki><br />
setreading <device> uzsu {}<br />
</nowiki><br />
<br />
erzeugen MUSS.<br />
<br />
2. eine Anbindung des uzsu-GAD per UZSU Converter an das Reading uzsu des zu schaltenden Device read und write in fhem<br />
<br />
3. folgenden Code in der 99_FronthemUtils.pm:<br />
<br />
Im Package Main:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Umsetzen der UZSU-Settings für ein device<br />
#<br />
###############################################################################<br />
sub UZSU_execute($$)<br />
{<br />
my ($device, $uzsu) = @_;<br />
<br />
$uzsu = decode_json($uzsu);<br />
fhem('delete wdt_'.$device.'_uzsu');<br />
my $weekdays_part = " ";<br />
for(my $i=0; $i < @{$uzsu->{list}}; $i++) {<br />
my $weekdays = $uzsu->{list}[$i]->{rrule};<br />
$weekdays = substr($weekdays,18,50); <br />
if (($uzsu->{list}[$i]->{active})) {<br />
$weekdays_part = $weekdays_part.' '.$weekdays.'|'.$uzsu->{list}[$i]->{time}.'|'.$uzsu->{list}[$i]->{value};<br />
}<br />
}<br />
fhem('define wdt_'.$device.'_uzsu'.' WeekdayTimer '.$device.' en '.$weekdays_part);<br />
if ($uzsu->{active}){ <br />
fhem('attr wdt_'.$device.'_uzsu disable 0');<br />
} else {<br />
fhem('attr wdt_'.$device.'_uzsu disable 1');<br />
} <br />
}<br />
</nowiki><br />
<br />
Im Package fronthem, selbe Datei:<br />
<br />
<nowiki><br />
<br />
use JSON;<br />
<br />
###############################################################################<br />
#<br />
# Setreading a device reading using JSON conversion (gadval => reading=decode_json() => setval => encode_json(reading) )<br />
#<br />
###############################################################################<br />
<br />
sub UZSU(@)<br />
{<br />
my ($param) = @_;<br />
my $cmd = $param->{cmd};<br />
my $gad = $param->{gad};<br />
my $gadval = $param->{gadval};<br />
<br />
my $device = $param->{device};<br />
my $reading = $param->{reading};<br />
my $event = $param->{event};<br />
<br />
my @args = @{$param->{args}};<br />
my $cache = $param->{cache};<br />
<br />
if ($param->{cmd} eq 'get')<br />
{<br />
$param->{cmd} = 'send';<br />
}<br />
if ($param->{cmd} eq 'send')<br />
{<br />
$param->{gad} = $gad;<br />
$param->{gadval} = decode_json(main::ReadingsVal($device, $reading, ''));<br />
$param->{gads} = [];<br />
return undef;<br />
}<br />
elsif ($param->{cmd} eq 'rcv')<br />
{<br />
$gadval = encode_json($gadval);<br />
$gadval =~ s/;/;;/ig;<br />
$param->{result} = main::fhem("setreading $device $reading $gadval");<br />
$param->{results} = [];<br />
return 'done';<br />
}<br />
elsif ($param->{cmd} eq '?')<br />
{<br />
return 'usage: UZSU';<br />
}<br />
return undef;<br />
}<br />
<br />
</nowiki><br />
<br />
Dieser Code erzeugt aus den Einstellungen im Widget entsprechende WeekdayTimer in fhem und löscht und erstellt neu bei jeder Änderung in SmartVISU.<br />
<br />
4. Die Funktion muss getriggert werden. Dazu ist ein notify nötig, das auf die Veränderung der uzsu Readings reagiert:<br />
<br />
<nowiki><br />
<br />
define UZSU notify .*:uzsu:.* { UZSU_execute($NAME, $EVTPART1) }<br />
<br />
</nowiki><br />
<br />
Voila!</div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10476SmartVISU2015-03-10T22:04:01Z<p>Fidel: </p>
<hr />
<div>SmartVisu ist ein Framework zur Visualisierung von Hausautomationssystemen, die eigentlich KNX-Installationen bedient.<br />
<br />
Durch [[Fronthem]] ist es möglich SmartVisu an Fhem anzubinden.<br />
Im nachfolgenden Link wird Fronthem ausführlich beschrieben: http://www.fhemwiki.de/wiki/Fronthem<br />
<br />
Eine Installationsanleitung für SmartVisu in Verbindung mit Fronthem findet sich unter folgendem Link: http://www.fhemwiki.de/wiki/Installation_Fronthem<br />
<br />
<br />
Codebeispiele:<br />
<br />
http://www.fhemwiki.de/wiki/SmartVisu/IconHighlights_in_Menus<br />
<br />
http://www.fhemwiki.de/wiki/SmartVisu/lichtSzene<br />
<br />
<!--Widgets:--></div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10475SmartVISU2015-03-10T21:59:45Z<p>Fidel: </p>
<hr />
<div>SmartVisu ist ein Framework zur Visualisierung von Hausautomationssystemen, die eigentlich KNX-Installationen bedient.<br />
<br />
Durch Fronthem ist es möglich SmartVisu an Fhem anzubinden.<br />
Im nachfolgenden Link wird Fronthem ausführlich beschrieben: http://www.fhemwiki.de/wiki/Fronthem<br />
<br />
Eine Installationsanleitung für SmartVisu in Verbindung mit Fronthem findet sich unter folgendem Link: http://www.fhemwiki.de/wiki/Installation_Fronthem<br />
<br />
<br />
Codebeispiele:<br />
<br />
http://www.fhemwiki.de/wiki/SmartVisu/IconHighlights_in_Menus<br />
<br />
http://www.fhemwiki.de/wiki/SmartVisu/lichtSzene<br />
<br />
<!--Widgets:--></div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10474SmartVISU2015-03-10T21:59:20Z<p>Fidel: </p>
<hr />
<div>SmartVisu ist ein Framework zur Visualisierung von Hausautomationssystemen, die eigentlich KNX-Installationen bedient.<br />
<br />
Durch Fronthem ist es möglich SmartVisu an Fhem anzubinden.<br />
Im nachfolgenden Link wird Fronthem ausführlich beschrieben: http://www.fhemwiki.de/wiki/Fronthem<br />
Eine Installationsanleitung für SmartVisu in Verbindung mit Fronthem findet sich unter folgendem Link: http://www.fhemwiki.de/wiki/Installation_Fronthem<br />
<br />
<br />
Codebeispiele:<br />
<br />
http://www.fhemwiki.de/wiki/SmartVisu/IconHighlights_in_Menus<br />
<br />
http://www.fhemwiki.de/wiki/SmartVisu/lichtSzene<br />
<br />
<!--Widgets:--></div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10472SmartVISU2015-03-10T21:20:05Z<p>Fidel: </p>
<hr />
<div><br />
<br />
<br />
Codebeispiele:<br />
<br />
http://www.fhemwiki.de/wiki/SmartVisu/IconHighlights_in_Menus<br />
<br />
http://www.fhemwiki.de/wiki/SmartVisu/lichtSzene<br />
<br />
<!--Widgets:--></div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10471SmartVISU2015-03-10T21:16:50Z<p>Fidel: </p>
<hr />
<div><br />
<br />
<br />
Codebeispiele:<br />
<br />
http://www.fhemwiki.de/wiki/SmartVisu/IconHighlights_in_Menus<br />
<br />
http://www.fhemwiki.de/wiki/Smartvisu/lichtSzene<br />
<br />
<!--Widgets:--></div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10470SmartVISU2015-03-10T21:13:18Z<p>Fidel: </p>
<hr />
<div><br />
http://www.fhemwiki.de/wiki/SmartVisu/IconHighlights_in_Menus<br />
<br />
http://www.fhemwiki.de/wiki/Smartvisu/lichtSzene</div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU/lichtSzene&diff=10468SmartVISU/lichtSzene2015-03-10T21:12:56Z<p>Fidel: Fidel verschob die Seite Smartvisu/lichtSzene nach SmartVisu/lichtSzene: verschiedene Pfade Smartvisu und SmartVisu</p>
<hr />
<div>mit dem folgenden Code lässt sich eine Auswahl für Lichtszenen in smartVisu / fhem erstellen.<br />
<br />
So soll es aussehen:<br />
<br />
[[Datei:Smartvisu_Lichtszene_radio_buttons.png|600px|thumb|left|Screenshot Frontend smartVISU]]<br />
<br />
Die Radio Buttons sollen dabei in einem Raum folgende Lichtszenen steuern:<br />
<br />
* automatische Beleuchtung <br />
* Fernsehen<br />
* Arbeitsbeleuchtung <br />
* Essen<br />
* Party<br />
* volle Beleuchtung<br />
* Weihnachtsbeleuchtung<br />
* alles Aus<br />
<br />
Die gewünschte Funktionalität ist dabei das sich die Lichtszenen umschalten lassen. Wenn eine bereits aktivierte Funktion nochmal betätigt wird entspricht das "aus". Die Weihnachtsbeleuchtung soll sich unabhängig von den anderen Beleuchtungs Szenen aktivieren oder deaktivieren lassen.<br />
<br />
Als Referenz ein Link auf die Online Hilfe von sv zu den hierfür eingesetzten button (typ dual)<br />
[http://www.smartvisu.de/docu/2.7/index.php?page=basic/widget_basic.dual]<br />
<br />
Der Screenshot oben wird mit diesem code in sv erzeugt:<br />
<nowiki><br />
<div class="cells"><br />
<div class="cell4 ui-btn-up-a">Lichtszene</div><br />
<div class="cell6 ui-btn-up-a"><br />
<span data-role="controlgroup" data-type="horizontal"><br />
{{ basic.dual('light.a', 'wz.light.szene.auto', icon1~'time_automatic.png', icon0~'time_automatic.png', 'auto', 'off', 'midi') }}<br />
{{ basic.dual('light.b', 'wz.light.szene.tv', icon1~'it_television.png', icon0~'it_television.png', 'tv', 'off', 'midi') }}<br />
{{ basic.dual('light.c', 'wz.light.szene.work', icon1~'light_ceiling_light.png', icon0~'light_ceiling_light.png', 'work', 'off', 'midi') }}<br />
{{ basic.dual('light.d', 'wz.light.szene.eat', icon1~'light_dinner_table.png', icon0~'light_dinner_table.png', 'eat', 'off', 'midi') }}<br />
{{ basic.dual('light.e', 'wz.light.szene.party', icon1~'light_party.png', icon0~'light_party.png', 'party', 'off', 'midi') }}<br />
{{ basic.dual('light.f', 'wz.light.szene.full', icon1~'light_light_dim_100.png', icon0~'light_light_dim_100.png', 'full', 'off', 'midi') }}<br />
{{ basic.dual('light.g', 'wz.light.szene.xmas', icon1~'scene_x-mas.png', icon0~'scene_x-mas.png', 'on', 'off', 'midi') }}<br />
{{ basic.dual('light.h', 'wz.light.szene.off', icon1~'control_on_off.png', icon0~'control_on_off.png', 'off', 'off', 'midi') }}<br />
</span><br />
</div><br />
</div><br />
</nowiki><br />
<br />
In diesem Beispiel wird in fhem dazu ein dummy erzeugt über den die Lichtszenen gesteuert werden. Natürlich gäbe es auch alternative Umsetzungen, bspw mit lightscene)<br />
<br />
Der dummy (name wz.licht.scene) bekommt diese setlist<br />
<nowiki><br />
define wz.licht.scene dummy<br />
attr wz.licht.scene setList off auto tv eat work party full<br />
</nowiki><br />
<br />
[[Datei:fronthem_gadeditor_lichtszene.png|600px|thumb|right|ronthem Editor]]<br />
<br />
Nach einem reload der sv Seite werden die oben definierten GADs vom fronthemDevice in fhem angezeigt (hier mit bereits definierten GAD). Jetzt müssen die buttons (über ihr GAD) mit der fhem Funktionalität verbunden werden. Hier soll jeder button mit seinem Value den dummy setzen. <br />
<br />
Mit den folgenden Einstellungen, die für jedes GAD der Button Group durchgefühert werden müssen, wird das erwünschte Verhalten erreicht. Jeder Button der Group setzt das dummy jetzt auf den den seinen "ON-VALUE" (dritt - vorletzter Wert in der definition oben). Ein weiterer Click (oder der rechte Button) setzt alles aus.<br />
<br />
Für die Weihanchtsbeleuchtung wird unabhängig ein Steckdose geschaltet, das ist hier nicht dargestellt.</div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10467SmartVISU2015-03-10T21:10:00Z<p>Fidel: </p>
<hr />
<div><br />
http://www.fhemwiki.de/wiki/SmartVisu/IconHighlights_in_Menus<br />
http://www.fhemwiki.de/wiki/Smartvisu/lichtSzene</div>Fidelhttp://wiki.fhem.de/w/index.php?title=SmartVISU&diff=10466SmartVISU2015-03-10T21:07:05Z<p>Fidel: Die Seite wurde neu angelegt: „http://www.fhemwiki.de/wiki/SmartVisu/IconHighlights_in_Menus“</p>
<hr />
<div>http://www.fhemwiki.de/wiki/SmartVisu/IconHighlights_in_Menus</div>Fidelhttp://wiki.fhem.de/w/index.php?title=Fronthem_Installation&diff=9966Fronthem Installation2015-02-08T12:31:09Z<p>Fidel: /* I/O-Connection */</p>
<hr />
<div><br />
Einen Überblick über Fronthem findet man auf der Seite zu [[Fronthem|Fronthem]]<br />
<br />
== Allgemein ==<br />
=== Fhem ===<br />
Ein lauffähiges Fhem mit einem aktuellen Update sollte installiert sein.<br />
<br />
=== Webserver ===<br />
Für smartVISU muss ein Webserver (z.B. Apache oder nginx) installiert sein.<br />
<br />
==== nginx ====<br />
Folgende Pakete werden benötigt:<br />
$ apt-get install nginx php5-fpm<br />
<br />
Die Konfiguration für nginx kann man unter<br />
sudo nano /etc/nginx/sites-enabled/default<br />
vornehmen.<br />
<br />
Folgende Konfiguration sollte direkt funktionieren:<br />
server {<br />
listen 80;<br />
root /var/www;<br />
index index.html index.php;<br />
server_name localhost;<br />
location / {<br />
try_files $uri $uri/ /index.php?$args;<br />
}<br />
location ~ \.php$ {<br />
try_files $uri =404;<br />
fastcgi_pass unix:/var/run/php5-fpm.sock;<br />
fastcgi_index index.php;<br />
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;<br />
include fastcgi_params;<br />
}<br />
}<br />
<br />
== Installation smartVISU ==<br />
Die Installation stammt aus Jörg Herrmanns git-Repo: https://github.com/herrmannj/smartvisu-cleaninstall<br />
<br />
Folgende Pakete werden benötigt:<br />
$ apt-get install git<br />
<br />
Hierbei handelt es sich um das original smartVISU inkl. diverser Anpassungen (fhem-Treiber, ...).<br />
<br />
'''Download:'''<br />
$ mkdir ~/install<br />
$ cd ~/install<br />
$ git clone https://github.com/herrmannj/smartvisu-cleaninstall.git<br />
<br />
'''Installation:'''<br />
$ sudo cp -rp smartVISU /var/www/smartvisu<br />
$ cd /var/www<br />
$ sudo chown -R www-data:www-data smartvisu<br />
<br />
'''Installation überprüfen:'''<br />
<br />
Beim Aufruf der Seite http://<IP-Adresse>/smartvisu sollte folgende Seite angezeigt werden:<br />
<br />
[[Datei:Installation_SmartVISU.png]]<br />
<br />
== Installation Fronthem ==<br />
Folgende Pakete werden benötigt:<br />
curl -L https://cpanmin.us | perl - --sudo App::cpanminus<br />
sudo cpanm Net::WebSocket::Server<br />
sudo cpanm JSON<br />
<br />
Mit folgendem Befehl kann man Fronthem installieren / updaten:<br />
update force https://raw.githubusercontent.com/herrmannj/fronthem/master/controls_fronthem.txt<br />
<br />
Konfiguration von Fronthem in Fhem (Eingabe in der Fhem Web Kommandozeile):<br />
define <Name Webservice> fronthem<br />
define <Name Endgerät> fronthemDevice <ip><br />
<br />
Beispiel:<br />
define meinfronthem fronthem<br />
define meiniphone fronthemDevice 192.168.178.25<br />
<br />
"Save" nicht vergessen!<br />
Näheres dazu findet man auch unter http://www.fhemwiki.de/wiki/Fronthem#Basic_Syntax<br />
<br />
== Eigenes smartVISU Projekt ==<br />
TODO<br />
<br />
== Verbindung smartVISU mit Fhem ==<br />
<br />
=== Konfiguration smartVISU-Treiber ===<br />
==== Interface ====<br />
TODO<br />
<br />
==== I/O-Connection ====<br />
Unter smartVISU in die Konfigurationsoberfläche wechseln (http://<IP-Adresse>/smartvisu/index.php?page=config)<br />
<br />
Driver: ''Fhem'' (wird in Github von hermmanj bereitgestellt, falls smartvisu nicht von dort bezogen wird)<br />
<br />
Adresse: ''<IP-Adresse Fhem-Server>''<br />
<br />
Port: ''2121''<br />
<br />
== Bekannte Probleme ==<br />
TODO</div>Fidelhttp://wiki.fhem.de/w/index.php?title=Dashboard&diff=7929Dashboard2014-09-16T22:31:15Z<p>Fidel: /* Letzte Änderungen / Dashboard-Historie */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Beliebiges anordnen von Gruppen<br />
|ModType=h<br />
<!-- |ModCategory=?? --><br />
<!-- |ModCmdRef=?? --><br />
|ModTechName=95_Dashboard.pm<br />
|ModOwner=svenson08<br />
}}<br />
<br />
'''Dieser Artikel wird überarbeitet'''<br />
<br />
<br />
Das '''Dashboard''' ist ein [[:Kategorie:Hilfsmodul|Hilfsmodul]], das umfangreiche Gestaltungsmöglichkeiten für das [[PGM2]] Web-Frontend bietet. So z.B. die Anordnung von Gerätegruppen in mehreren Tabs und jeweils in mehreren Spalten mittels Drag'n Drop.<br />
<br />
== Voraussetzungen ==<br />
Keine speziellen Voraussetzungen erforderlich.<br />
<br />
== Anwendung ==<br />
<br />
=== Define ===<br />
Die Syntax für die Definition eines Dashboards:<br />
:<code>define <name> Dashboard</code><br />
Parameterbedeutung:<br />
;name<br />
:Eindeutiger Name des anzulegenden Dashboards.<br />
<br />
=== Attribute ===<br />
Das Dashboard unterstützt die folgenden Attribute:<br />
<br />
;dashboard_activetab<br />
:Bestimmt welches der Tabs beim Aufruf des Dashboards ausgewählt ist.<br />
;dashboard_customcss<br />
:Über dieses Attribut können CSS Definitionen eingegeben werden, um z.B. mit dem Wert ''body {background-image: none !important;}'' das Hintergrundbild im Dashboard zu deaktiviert werden.<br />
;dashboard_tabcount<br />
:Bestimmt die Anzahl der verfügbaren Tabs im Dashboard.<br />
;dashboard_showtabs<br />
:Bestimmt die Position der Tabs. Diese kann oben oder unten angezeigt oder komplett ausgeblendet werden. Letzteres führt dazu das dass Dashboard den Lockstate auf lock ändert.<br />
;dashboard_showfullsize<br />
:Zeigt das Dashboard ohne die Raumliste von FHEMWEB. Es wird dabei der gesamte linke Bereich (inkl. Raumliste und evtl. gesetzten Logo) und dem Header der Seite (inkl. Eingabezeile) ausgeblendet.<br />
;dashboard_showtooglebuttons<br />
:Wer die vergrößern/verkleinern nicht nutzen möchte kann dies mittels diesem Attribut deaktivieren.<br />
;dashboard_width<br />
:Bestimmt die Breite des Dashboards. Die Breite kann in Prozent (z.B. 80%) oder in Pixel (z.B. 1200) angegeben werden.<br />
;dashboard_tab1groups (dashboard_tab2groups dashboard_tab3groups dashboard_tab4groups dashboard_tab5groups dashboard_tab6groups dashboard_tab7groups)<br />
:Enthält die Auflistung der Gruppen, die im Dashboardtab angezeigt werden. Die Gruppen sind mit einem Komma zu trennen. Einer Gruppe kann ein Icons zugewiesen werden. Hierzu muss nach dem Gruppennamen '':<icon>@<farbe>'' eingefügt werden. z.B. <code>Light:Icon_Fisch@blue,AVIcon_Fisch@red,Single Lights:Icon_Fisch@yellow</code><br />
;dashboard_tab1name (dashboard_tab2name dashboard_tab3name dashboard_tab4name dashboard_tab5name dashboard_tab6name dashboard_tab7name)<br />
:Bestimmt den Titel des Tabs.<br />
;dashboard_tab1icon (dashboard_tab2icon dashboard_tab3icon dashboard_tab4icon dashboard_tab5icon dashboard_tab6icon dashboard_tab7icon)<br />
:Anzuzeigendes Icon neben dem Titel des Tabs.<br />
;dashboard_rowtopheight<br />
:dashboard_webfrontendfilter<br />
;Dem Attribut ist der Name einer FHEMWEB Instanz zu hinterlegen(z.B. WEB), möchte man das Dashboard darauf beschränken. Es können mehrere Instanzen, durch Komma getrennt, angegeben werden.<br />
:Festlegen der Höhe der oberen Reihe des Dashboards.<br />
;dashboard_rowbottomheight<br />
:Festlegen der Höhe der unteren Reihe des Dashboards.<br />
;dashboard_rowcenterheight<br />
:Festlegen der Höhe der mittleren Reihe des Dashboards.<br />
;dashboard_row<br />
:Bestimmt welche Reihen im Dashboard angezeigt werden.<br />
;dashboard_rowcentercolwidth<br />
:Bestimmt die Breite der einzelnen Spalten der mittleren Dashboardreihe. Je Spalte kann ein separater Wert, durch Komma getrennt, hinterlegt werden. Jeder Wert bestimmt die Spaltenbreite in %.<br />
;dashboard_colcount<br />
:Legt die Anzahl der Spalten in der mittleren Reihe des Dashboards festgelegt.<br />
;dashboard_tab1sorting (dashboard_tab2sorting dashboard_tab3sorting dashboard_tab4sorting dashboard_tab5sorting dashboard_tab6sorting dashboard_tab7sorting)<br />
:Enthält die Positionierung der Gruppen im jeweiligen Tab. Es wird nicht empfohlen, dieses Attribut zu editieren.<br />
<br />
== Anwendungsbeispiel(e) ==<br />
<br />
<br />
<br />
<br />
== Allgemeine Hinweise ==<br />
<br />
<br />
;Unterstützte Styles<br />
Es werden die Styles Default, Dark und IOS7 unterstützt.<br />
<br />
{| class="wikitable"<br />
|Dashboard-Styles<br />
|-<br />
|[[Datei:dashboard_dark.png|thumb|500px|Dashboard im Style Dark]]<br />
|-<br />
|[[Datei:dashboard_default.png|thumb|500px|Dashboard im Default Style]]<br />
|-<br />
|[[Datei:dashboard_ios.png|thumb|500px|Dashboard im IOS7]] <br />
<br />
|}<br />
<br />
;Benötigte Dateien<br />
Wenn vom Dashboard benötigte Dateien fehlen zeigt der STATUS des Dashboards den Hinweis ''Missing File, see LogFile for Details''. Weitere Einzelheiten zu diesem Fehler finden sich dann im Logfile. Es sollte klar sein, dass das Dashboard dann nicht (richtig) funktionieren kann.<br />
<br />
== Erklärung / Internes ==<br />
[[Datei:Dashboard_Menulink.png|mini|120px|Darstellung des Dashboard Menüs]]<br />
<br />
Das Dashboard besteht in FHEM eigentlich aus zwei "Komponenten". Dem eigentlichen definierten Dashboard und einem Weblink. Es muss sich aber nicht um den Weblink für das Dashboard kümmern werden, da dieser bei Bedarf vom Dashboard eigenständig erstellt wird.<br />
<br />
== Kleines Howto ==<br />
;Schritt 1: Erstellen des Dashboards<br />
:<code>define anyViews Dashboard</code><br />
FHEM neu starten.<br />
<br />
;Schritt 2: Grundkonfiguration<br />
<br />
:attr anyViews dashboard_width 80%<br />
:attr anyViews dashboard_tabcount 1<br />
:attr anyViews dashboard_tab1groups <GRUPPE1>,<GRUPPE2>,<GRUPPE3><br />
<br />
<GRUPPE1>, etc. sind durch richtige Gruppennamen zu ersetzen, z.B. Licht,Wetter oder ähnliches<br />
<br />
<br />
<br />
[[Datei:Dashboard-KeinGruppe.png|mini|250px|"Objekt" ohne Gruppe]]<br />
[[Datei:Dashboard-Gruppe.png|mini|250px|"Objekt" in einer Gruppe]]<br />
<br />
Danach sollen die beiden Gruppen im 1. Tab im Dashboard angezeigt werden. Zwar noch etwas chaotisch, aber das wird in den nächsten Schritten bearbeitet.<br><br />
[[#dashboard_tab1groups| Siehe dashboard_tab1groups]]<br />
<br />
Das Dashboard zeigt neben den beiden Gruppen bereits einiges andere mit an. Hier werden erst einmal diese "Nebensächlichkeiten" erklärt. Für die weiteren Schritte dieser Anleitung sollten die nun genannten Einstellungen unverändert bleiben. <br />
<br />
[[Datei:Dashboard_FirstGroup.png|mini|300px|Erste Gruppe im Dashboard]]<br />
Am rechten Rand des Dashboards erscheinen einige Schalter ("Set", "Detail"). Der Schalter "Detail" springt in die Detailansicht des Dashboards um dort z.B. weiter Attribute hinzuzufügen. <br><br />
Der Schalter "Set" speichert die per Drag'n Drop vorgenommenen Änderungen '''temporär''' (diese sind dann noch nicht gespeichert!). "Set" wird in rot geschrieben wenn die Positionierung einer Gruppe geändert wurde, aber noch nicht mit dem "Set"-Schalter gesichert wurden! Ebenso wird mit dem Schalter "Set" das aktuell [[#dashboard_activetab|aktive Tab]] gesichert <br><br />
Die Schalterleiste kann über das Attribut ''dashboard_showtabs'' deaktiviert werden, oder wahlweise über oder unter dem Dashboard platziert werden.<br><br />
[[#dashboard_showtabs| Siehe dashboard_showtabs]]<br />
<br><br><br />
Im Gruppentitel erscheint an deren rechten Rand ein Symbol (+/-). Mit diesem kann man die Gruppe minimieren oder die voreingestellte Größe wieder herstellen.<br><br />
[[#dashboard_showtooglebuttons| Siehe dashboard_showtooglebuttons]]<br />
<br><br><br />
[[Datei:Dashboard_Helper.png|mini|300px|Dashboard Helper]]<br />
Zum besseren Ausrichten der einzelnen Gruppen werden zur Unterstützung einige Hilfen angezeigt. Die Erste ist die Anzeige eines Rahmens um das Dashboard. Genauer gesagt um die einzelnen Reihen/Spalten des Dashboards. Eine weitere Hilfe ist der Hintergrund der Gruppen. Dieser kann über die Mindestgröße der Gruppe hinaus gezogen werden. Damit können beliebig große Abstände zwischen den einzelnen Gruppen eingestellt werden.<br><br />
[[#dashboard_showhelper| Siehe dashboard_showhelper]]<br />
<br />
Da nun die ersten Gruppen im Dashboard angezeigt werden, geht es nun darum, diese an die gewünschten Stellen zu platzieren. Dazu werden erst noch die verschiedenen Reihen und Spalten eingerichtet.<br><br />
<br />
Das Dashboard verfügt über drei Reihen. Oben, Mitte und Unten. In der Standardeinstellung wird nur die mittlere Reihe angezeigt. Die mittlere Reihe sollte auch immer eingesetzt werden, da diese die Breite des Dashboard vorgibt. Für dieses kleine HowTo werden aber die obere und die mittlere Reihe eingeblendet, indem das Attribut '''dashboard_row''' auf '''top-center''' gestellt wird. Diese Einstellung gilt für das gesamte Dashboard und somit für alle verwendeten Tabs. Es ist nicht möglich, je Tab eine andere Einstellung zu wählen.<br> <br />
[[#dashboard_row| Siehe dashboard_row]]<br><br><br />
<br />
Die Breite, die das Dashboard auf dem Bildschirm einnimmt, kann über das Attribut '''dashboard_width''' festgelegt werden. Standard ist die Breite von 100%. Es kann neben einem Prozentwert auch eine Breite in Pixel angegeben werden.<br><br />
[[#dashboard_width| Siehe dashboard_width]]<br><br><br />
<br />
Die Höhe der einzelnen Reihen kann über die Attribute dashboard_rowtopheight für die obere Reihe, dashboard_rowbottomheight für die untere Reihe und dashboard_rowcenterheight für die mittlere Reihe festgelegt werden. Damit können die Reihen nach den eigenen Bedürfnissen angepasst werden. Für dieses HowTo wird '''dashboard_rowtopheight''' auf '''300''' und '''dashboard_rowcenterheight''' auf '''400''' eingestellt. Diese Einstellung gilt für das gesamte Dashboard und somit für alle verwendeten Tabs. Es ist nicht möglich je Tab eine andere Einstellung zu wählen.<br><br />
[[#dashboard_rowtopheight| Siehe dashboard_rowtopheight]]<br><br />
[[#dashboard_rowbottomheight| Siehe dashboard_rowbottomheight]]<br><br />
[[#dashboard_rowcenterheight| Siehe dashboard_rowheight]]<br><br><br />
<br />
Die mittlere Reihe hat (historisch bedingt) eine Besonderheit. Diese kann in maximal 5 Spalten unterteilt werden. Für unser Beispiel setzten wird das Attribut '''dashboard_colcount''' auf '''2'''. Diese Einstellung gilt für das gesamte Dashboard und somit für alle verwendeten Tabs. Es ist nicht möglich je Tab eine andere Einstellung zu wählen.<br> Weiter legen wir mit dem Attribut [[#dashboard_rowcentercolwidth|dashboard_rowcentercolwidth]] die Breite der ersten Spalte mit 30% und die der zweiten Spalte mit 70% fest in dem wir dem Attribut '''dashboard_rowcentercolwidth''' den Wert '''30,70''' zuteilen.<br><br />
[[#dashboard_colcount | Siehe dashboard_colcount ]]<br><br />
<br />
Sicherlich ist das positionieren einfach, und jeder wird das hin bekommen. Zwei, drei Worte möchte ich trotzdem darüber verlieren.<br><br />
<br />
:<ins>Verschieben</ins><br><br />
:Gruppen können in andere Reihen oder Spalten des Dashboards verschoben werden. Dazu muss in die Gruppe angeklickt werden und die Maustaste gedrückt gehalten werden. Los lässt man diese wenn man an der richtige Stelle ist. Das war wohl schon jedem klar.<br><br />
:Ein möglicher Zielort wird mit einem abgerundeten Platzhalter markiert. Dieser verschiebt auch, falls notwendig, andere Gruppen. Manchen wundert es warum dieser Zielort manchmal recht spät angezeigt wird. Dies hängt von der Position des Mauszeigers ab. Aha?! Je weiter oben man eine Gruppe anpackt, desto höher muss man die Maus schieben. Oder anders formuliert, wenn sich ca. 50% der Gruppenfläche im Zielbereich befinden wird dieser Zielort erst markiert. Das verschieben eine Gruppe von einem Tab in das andere ist nicht möglich. Letztendlich bleibt jedem nur <ins>ausprobieren</ins>.<br><br><br />
<br />
:Gruppen können über, unter, neben und vor anderen Gruppen verschoben werden. Auch das erfolgt wie bereits oben aufgeführt. Dies ist für viele nicht neues. Zu beachten ist aber das sich eine Gruppe nur dann vor oder neben eine anderen positionieren lässt wenn diese von der Breite in das Dashboard passen. Wenn Ihr also Gruppen nebeneinander positionieren wollt dürfen diese in Summe nicht breiter als das Dashboard sein.<br><br />
:Dies gilt nicht für die Höhen der Gruppen. Diese können in Summe höher als das Dashboard und höher als eine Reihe sein. Hier findet keine Begrenzung statt wie bei der Breite. Um jedoch das ein oder andere optisch nicht so schöne Ergebnis zu bekommen sollte darauf geachtet werden das keine Gruppe über eine Reihe hinaus ragt.<br><br><br><br />
<br />
Für unser Beispiel verschieben wir zum Testen die Gruppen in beliebige Reihen bzw. Spalten der mittleren Reihe. Danach bitte den "Set" Schalter drücken, dieser hat sich durch die verschiebe Aktionen bereits rot markiert.<br />
<br />
[[Datei:Dashboard_Positionieren.png|mini|200px|Ausrichtung von einzelnen Gruppen]]<br />
Das Ausrichten ist gleichermaßen einfach wie das Positionieren und sollte auch nichts Neues sein. Aber auch hier möchte ich darüber zwei, drei Worte verlieren.<br><br />
<br />
:Das Positionieren ist nur möglich, wenn das Dashboard nicht gesperrt ist (Lock/Unlock). Dann wird ein abgeschrägte Ecke an der Gruppe angezeigt, mit der die Größe gezogen werden kann.<br />
:Jede Gruppe kann in Höhe und Breite beliebig gezogen werden, wobei genau das wieder einen Hacken hat: Das Größerziehen ist nur bedingt möglich. Die Breite/Höhe ist auf die Breite/Höhe der Dashboard Reihe (oder Spalte) begrenzt. Damit kann man eine Gruppe nicht über den Rand des Dashboards hinaus vergrößern.<br><br />
:Das Kleinerziehen ist auch nur bis zu einer Mindestgröße möglich. Die Mindestgröße ist abhängig vom Inhalt der Gruppe, kann also von Gruppe zu Gruppe unterschiedlich sein.<br><br />
:Ein Sonderverhalten beim Vergrößern/Verkleinern gibt es auch: Ist ein Gruppe höher als die Reihe, lässt sich die Gruppe zwar dort positionieren. Beim Ausrichten springt dann der untere Rand nicht auf die Mindesthöhe der Gruppe, sondern auf die maximale Höhe der Reihe. In diesem Fall sollte die Höhe der Reihe geändert werden. Ähnliches kann auch in der Breite auftreten.<br><br />
:Ändert sich der Inhalt einer Gruppe (wird z.B. ein Dummy dazugepackt), ändert sich die Positionierung der Gruppe '''nicht''' automatisch. In diesem Fall ist man immer gezwungen auch die Größe der Gruppe im Dashboard an die neue Gegebenheit anzupassen.<br />
<br />
Für unser Beispiel ziehen wir die Gruppen beliebig größer. Danach bitte den "Set"-Schalter drücken. Dieser hat sich durch die Verschiebeaktionen bereits rot markiert.<br />
<br />
Wie bereits etwas weiter oben erklärt wird die Positionierung der Gruppen im Dashboard durch die Betätigung des Schalters "Set" temporär zwischengespeichert. Dadurch wird die Positionierung bereits für einen Seitenrefresh gespeichert. Solange bis das Browserfenster geschlossen wird. Danach wären diese Einstellungen verloren.<br><br />
Darum ist es notwendig die Positionierung permanent zu speichern, damit auch nach einem Neustart von Fhem die getroffenen Einstellungen und Positionierungen vorhanden sind. Dies geht über den in Fhem bekannten weg über ''Save config''.<br><br />
Wird der Schalter "Set" nicht betätigt, wird auch über ''Save config'' die Positionierung nicht gespeichert. Daher ist es wichtig, immer '''zuerst''' mit dem Schalter '''"Set"''' die Einstellung zwischenzuspeichern und '''danach mit ''Save config''''' den Zwischenspeicher permanent zu sichern.<br><br />
<br />
Durch den Schalter "Set" wird für jedes Tab die Einstellung in das für das jeweilige Tab zuständige Attribut geschrieben. Für Tab 1 ist das Attribut ''dashboard_tab1sorting'' zuständig, für Tab 2 das Attribut ''dashboard_tab2sorting'', usw. '''Diese Attribute sollten nicht editiert werden!'''<br />
<br />
Es ist möglich jedem Tab einen eigenen individuellen Namen zu vergeben. Dazu ist für das jeweilige Tab das entsprechende Attribut zu befüllen. Z.B. für Tab 1 ist das Attribut ''dashboard_tab1name'' mit dem gewünschten Titel zu füllen.<br><br />
[[#dashboard_tab1name| Siehe dashboard_tab1name]]<br />
<br />
== Letzte Änderungen / Dashboard-Historie ==<br />
<br />
* (03.03.2014) Anzeigefehler bei readingGroups in einem Hiddenroom behoben<br />
* (17.03.2014) Fehlerausgabe durch dashboard_webfrontendfilter behoben<br />
* (26.03.2014) dashboard_showfullsize wird nicht im Raum "all" bzw. Everything angewendet<br />
* (18.04.2014) Attribut dashboard_lock State entfernt. Kann nur noch in der Detailansicht verändert werden.<br />
* (24.04.2014) Attribut dashboard_showhelper wird nicht mehr genutzt. Der Helper wird nur angezeigt wenn lockstate unlock ist.<br />
* (24.04.2014) Schalter Detail und Set werden nun rechts angezeigt.<br />
* (24.04.2014) Attribut dashboard_showtabs kann nicht mehr tabs-at-the-top-buttonbar-hidden oder tabs-on-the-bottom-buttonbar-hidden sein.<br />
* (17.09.2014) Vertauschungen von attr dashboard_width anyViews 80% zu attr anyViews dashboard_width 80% berichtigt<br />
<br />
== Links ==<br />
* [http://forum.fhem.de/index.php/topic,16503.0.html Forenthread] über ''Dashboard''<br />
<br />
[[Kategorie:Hilfsmodul]]<br />
[[Kategorie:HOWTOS]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=Dashboard&diff=7928Dashboard2014-09-16T22:28:10Z<p>Fidel: /* Kleines Howto */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Beliebiges anordnen von Gruppen<br />
|ModType=h<br />
<!-- |ModCategory=?? --><br />
<!-- |ModCmdRef=?? --><br />
|ModTechName=95_Dashboard.pm<br />
|ModOwner=svenson08<br />
}}<br />
<br />
'''Dieser Artikel wird überarbeitet'''<br />
<br />
<br />
Das '''Dashboard''' ist ein [[:Kategorie:Hilfsmodul|Hilfsmodul]], das umfangreiche Gestaltungsmöglichkeiten für das [[PGM2]] Web-Frontend bietet. So z.B. die Anordnung von Gerätegruppen in mehreren Tabs und jeweils in mehreren Spalten mittels Drag'n Drop.<br />
<br />
== Voraussetzungen ==<br />
Keine speziellen Voraussetzungen erforderlich.<br />
<br />
== Anwendung ==<br />
<br />
=== Define ===<br />
Die Syntax für die Definition eines Dashboards:<br />
:<code>define <name> Dashboard</code><br />
Parameterbedeutung:<br />
;name<br />
:Eindeutiger Name des anzulegenden Dashboards.<br />
<br />
=== Attribute ===<br />
Das Dashboard unterstützt die folgenden Attribute:<br />
<br />
;dashboard_activetab<br />
:Bestimmt welches der Tabs beim Aufruf des Dashboards ausgewählt ist.<br />
;dashboard_customcss<br />
:Über dieses Attribut können CSS Definitionen eingegeben werden, um z.B. mit dem Wert ''body {background-image: none !important;}'' das Hintergrundbild im Dashboard zu deaktiviert werden.<br />
;dashboard_tabcount<br />
:Bestimmt die Anzahl der verfügbaren Tabs im Dashboard.<br />
;dashboard_showtabs<br />
:Bestimmt die Position der Tabs. Diese kann oben oder unten angezeigt oder komplett ausgeblendet werden. Letzteres führt dazu das dass Dashboard den Lockstate auf lock ändert.<br />
;dashboard_showfullsize<br />
:Zeigt das Dashboard ohne die Raumliste von FHEMWEB. Es wird dabei der gesamte linke Bereich (inkl. Raumliste und evtl. gesetzten Logo) und dem Header der Seite (inkl. Eingabezeile) ausgeblendet.<br />
;dashboard_showtooglebuttons<br />
:Wer die vergrößern/verkleinern nicht nutzen möchte kann dies mittels diesem Attribut deaktivieren.<br />
;dashboard_width<br />
:Bestimmt die Breite des Dashboards. Die Breite kann in Prozent (z.B. 80%) oder in Pixel (z.B. 1200) angegeben werden.<br />
;dashboard_tab1groups (dashboard_tab2groups dashboard_tab3groups dashboard_tab4groups dashboard_tab5groups dashboard_tab6groups dashboard_tab7groups)<br />
:Enthält die Auflistung der Gruppen, die im Dashboardtab angezeigt werden. Die Gruppen sind mit einem Komma zu trennen. Einer Gruppe kann ein Icons zugewiesen werden. Hierzu muss nach dem Gruppennamen '':<icon>@<farbe>'' eingefügt werden. z.B. <code>Light:Icon_Fisch@blue,AVIcon_Fisch@red,Single Lights:Icon_Fisch@yellow</code><br />
;dashboard_tab1name (dashboard_tab2name dashboard_tab3name dashboard_tab4name dashboard_tab5name dashboard_tab6name dashboard_tab7name)<br />
:Bestimmt den Titel des Tabs.<br />
;dashboard_tab1icon (dashboard_tab2icon dashboard_tab3icon dashboard_tab4icon dashboard_tab5icon dashboard_tab6icon dashboard_tab7icon)<br />
:Anzuzeigendes Icon neben dem Titel des Tabs.<br />
;dashboard_rowtopheight<br />
:dashboard_webfrontendfilter<br />
;Dem Attribut ist der Name einer FHEMWEB Instanz zu hinterlegen(z.B. WEB), möchte man das Dashboard darauf beschränken. Es können mehrere Instanzen, durch Komma getrennt, angegeben werden.<br />
:Festlegen der Höhe der oberen Reihe des Dashboards.<br />
;dashboard_rowbottomheight<br />
:Festlegen der Höhe der unteren Reihe des Dashboards.<br />
;dashboard_rowcenterheight<br />
:Festlegen der Höhe der mittleren Reihe des Dashboards.<br />
;dashboard_row<br />
:Bestimmt welche Reihen im Dashboard angezeigt werden.<br />
;dashboard_rowcentercolwidth<br />
:Bestimmt die Breite der einzelnen Spalten der mittleren Dashboardreihe. Je Spalte kann ein separater Wert, durch Komma getrennt, hinterlegt werden. Jeder Wert bestimmt die Spaltenbreite in %.<br />
;dashboard_colcount<br />
:Legt die Anzahl der Spalten in der mittleren Reihe des Dashboards festgelegt.<br />
;dashboard_tab1sorting (dashboard_tab2sorting dashboard_tab3sorting dashboard_tab4sorting dashboard_tab5sorting dashboard_tab6sorting dashboard_tab7sorting)<br />
:Enthält die Positionierung der Gruppen im jeweiligen Tab. Es wird nicht empfohlen, dieses Attribut zu editieren.<br />
<br />
== Anwendungsbeispiel(e) ==<br />
<br />
<br />
<br />
<br />
== Allgemeine Hinweise ==<br />
<br />
<br />
;Unterstützte Styles<br />
Es werden die Styles Default, Dark und IOS7 unterstützt.<br />
<br />
{| class="wikitable"<br />
|Dashboard-Styles<br />
|-<br />
|[[Datei:dashboard_dark.png|thumb|500px|Dashboard im Style Dark]]<br />
|-<br />
|[[Datei:dashboard_default.png|thumb|500px|Dashboard im Default Style]]<br />
|-<br />
|[[Datei:dashboard_ios.png|thumb|500px|Dashboard im IOS7]] <br />
<br />
|}<br />
<br />
;Benötigte Dateien<br />
Wenn vom Dashboard benötigte Dateien fehlen zeigt der STATUS des Dashboards den Hinweis ''Missing File, see LogFile for Details''. Weitere Einzelheiten zu diesem Fehler finden sich dann im Logfile. Es sollte klar sein, dass das Dashboard dann nicht (richtig) funktionieren kann.<br />
<br />
== Erklärung / Internes ==<br />
[[Datei:Dashboard_Menulink.png|mini|120px|Darstellung des Dashboard Menüs]]<br />
<br />
Das Dashboard besteht in FHEM eigentlich aus zwei "Komponenten". Dem eigentlichen definierten Dashboard und einem Weblink. Es muss sich aber nicht um den Weblink für das Dashboard kümmern werden, da dieser bei Bedarf vom Dashboard eigenständig erstellt wird.<br />
<br />
== Kleines Howto ==<br />
;Schritt 1: Erstellen des Dashboards<br />
:<code>define anyViews Dashboard</code><br />
FHEM neu starten.<br />
<br />
;Schritt 2: Grundkonfiguration<br />
<br />
:attr anyViews dashboard_width 80%<br />
:attr anyViews dashboard_tabcount 1<br />
:attr anyViews dashboard_tab1groups <GRUPPE1>,<GRUPPE2>,<GRUPPE3><br />
<br />
<GRUPPE1>, etc. sind durch richtige Gruppennamen zu ersetzen, z.B. Licht,Wetter oder ähnliches<br />
<br />
<br />
<br />
[[Datei:Dashboard-KeinGruppe.png|mini|250px|"Objekt" ohne Gruppe]]<br />
[[Datei:Dashboard-Gruppe.png|mini|250px|"Objekt" in einer Gruppe]]<br />
<br />
Danach sollen die beiden Gruppen im 1. Tab im Dashboard angezeigt werden. Zwar noch etwas chaotisch, aber das wird in den nächsten Schritten bearbeitet.<br><br />
[[#dashboard_tab1groups| Siehe dashboard_tab1groups]]<br />
<br />
Das Dashboard zeigt neben den beiden Gruppen bereits einiges andere mit an. Hier werden erst einmal diese "Nebensächlichkeiten" erklärt. Für die weiteren Schritte dieser Anleitung sollten die nun genannten Einstellungen unverändert bleiben. <br />
<br />
[[Datei:Dashboard_FirstGroup.png|mini|300px|Erste Gruppe im Dashboard]]<br />
Am rechten Rand des Dashboards erscheinen einige Schalter ("Set", "Detail"). Der Schalter "Detail" springt in die Detailansicht des Dashboards um dort z.B. weiter Attribute hinzuzufügen. <br><br />
Der Schalter "Set" speichert die per Drag'n Drop vorgenommenen Änderungen '''temporär''' (diese sind dann noch nicht gespeichert!). "Set" wird in rot geschrieben wenn die Positionierung einer Gruppe geändert wurde, aber noch nicht mit dem "Set"-Schalter gesichert wurden! Ebenso wird mit dem Schalter "Set" das aktuell [[#dashboard_activetab|aktive Tab]] gesichert <br><br />
Die Schalterleiste kann über das Attribut ''dashboard_showtabs'' deaktiviert werden, oder wahlweise über oder unter dem Dashboard platziert werden.<br><br />
[[#dashboard_showtabs| Siehe dashboard_showtabs]]<br />
<br><br><br />
Im Gruppentitel erscheint an deren rechten Rand ein Symbol (+/-). Mit diesem kann man die Gruppe minimieren oder die voreingestellte Größe wieder herstellen.<br><br />
[[#dashboard_showtooglebuttons| Siehe dashboard_showtooglebuttons]]<br />
<br><br><br />
[[Datei:Dashboard_Helper.png|mini|300px|Dashboard Helper]]<br />
Zum besseren Ausrichten der einzelnen Gruppen werden zur Unterstützung einige Hilfen angezeigt. Die Erste ist die Anzeige eines Rahmens um das Dashboard. Genauer gesagt um die einzelnen Reihen/Spalten des Dashboards. Eine weitere Hilfe ist der Hintergrund der Gruppen. Dieser kann über die Mindestgröße der Gruppe hinaus gezogen werden. Damit können beliebig große Abstände zwischen den einzelnen Gruppen eingestellt werden.<br><br />
[[#dashboard_showhelper| Siehe dashboard_showhelper]]<br />
<br />
Da nun die ersten Gruppen im Dashboard angezeigt werden, geht es nun darum, diese an die gewünschten Stellen zu platzieren. Dazu werden erst noch die verschiedenen Reihen und Spalten eingerichtet.<br><br />
<br />
Das Dashboard verfügt über drei Reihen. Oben, Mitte und Unten. In der Standardeinstellung wird nur die mittlere Reihe angezeigt. Die mittlere Reihe sollte auch immer eingesetzt werden, da diese die Breite des Dashboard vorgibt. Für dieses kleine HowTo werden aber die obere und die mittlere Reihe eingeblendet, indem das Attribut '''dashboard_row''' auf '''top-center''' gestellt wird. Diese Einstellung gilt für das gesamte Dashboard und somit für alle verwendeten Tabs. Es ist nicht möglich, je Tab eine andere Einstellung zu wählen.<br> <br />
[[#dashboard_row| Siehe dashboard_row]]<br><br><br />
<br />
Die Breite, die das Dashboard auf dem Bildschirm einnimmt, kann über das Attribut '''dashboard_width''' festgelegt werden. Standard ist die Breite von 100%. Es kann neben einem Prozentwert auch eine Breite in Pixel angegeben werden.<br><br />
[[#dashboard_width| Siehe dashboard_width]]<br><br><br />
<br />
Die Höhe der einzelnen Reihen kann über die Attribute dashboard_rowtopheight für die obere Reihe, dashboard_rowbottomheight für die untere Reihe und dashboard_rowcenterheight für die mittlere Reihe festgelegt werden. Damit können die Reihen nach den eigenen Bedürfnissen angepasst werden. Für dieses HowTo wird '''dashboard_rowtopheight''' auf '''300''' und '''dashboard_rowcenterheight''' auf '''400''' eingestellt. Diese Einstellung gilt für das gesamte Dashboard und somit für alle verwendeten Tabs. Es ist nicht möglich je Tab eine andere Einstellung zu wählen.<br><br />
[[#dashboard_rowtopheight| Siehe dashboard_rowtopheight]]<br><br />
[[#dashboard_rowbottomheight| Siehe dashboard_rowbottomheight]]<br><br />
[[#dashboard_rowcenterheight| Siehe dashboard_rowheight]]<br><br><br />
<br />
Die mittlere Reihe hat (historisch bedingt) eine Besonderheit. Diese kann in maximal 5 Spalten unterteilt werden. Für unser Beispiel setzten wird das Attribut '''dashboard_colcount''' auf '''2'''. Diese Einstellung gilt für das gesamte Dashboard und somit für alle verwendeten Tabs. Es ist nicht möglich je Tab eine andere Einstellung zu wählen.<br> Weiter legen wir mit dem Attribut [[#dashboard_rowcentercolwidth|dashboard_rowcentercolwidth]] die Breite der ersten Spalte mit 30% und die der zweiten Spalte mit 70% fest in dem wir dem Attribut '''dashboard_rowcentercolwidth''' den Wert '''30,70''' zuteilen.<br><br />
[[#dashboard_colcount | Siehe dashboard_colcount ]]<br><br />
<br />
Sicherlich ist das positionieren einfach, und jeder wird das hin bekommen. Zwei, drei Worte möchte ich trotzdem darüber verlieren.<br><br />
<br />
:<ins>Verschieben</ins><br><br />
:Gruppen können in andere Reihen oder Spalten des Dashboards verschoben werden. Dazu muss in die Gruppe angeklickt werden und die Maustaste gedrückt gehalten werden. Los lässt man diese wenn man an der richtige Stelle ist. Das war wohl schon jedem klar.<br><br />
:Ein möglicher Zielort wird mit einem abgerundeten Platzhalter markiert. Dieser verschiebt auch, falls notwendig, andere Gruppen. Manchen wundert es warum dieser Zielort manchmal recht spät angezeigt wird. Dies hängt von der Position des Mauszeigers ab. Aha?! Je weiter oben man eine Gruppe anpackt, desto höher muss man die Maus schieben. Oder anders formuliert, wenn sich ca. 50% der Gruppenfläche im Zielbereich befinden wird dieser Zielort erst markiert. Das verschieben eine Gruppe von einem Tab in das andere ist nicht möglich. Letztendlich bleibt jedem nur <ins>ausprobieren</ins>.<br><br><br />
<br />
:Gruppen können über, unter, neben und vor anderen Gruppen verschoben werden. Auch das erfolgt wie bereits oben aufgeführt. Dies ist für viele nicht neues. Zu beachten ist aber das sich eine Gruppe nur dann vor oder neben eine anderen positionieren lässt wenn diese von der Breite in das Dashboard passen. Wenn Ihr also Gruppen nebeneinander positionieren wollt dürfen diese in Summe nicht breiter als das Dashboard sein.<br><br />
:Dies gilt nicht für die Höhen der Gruppen. Diese können in Summe höher als das Dashboard und höher als eine Reihe sein. Hier findet keine Begrenzung statt wie bei der Breite. Um jedoch das ein oder andere optisch nicht so schöne Ergebnis zu bekommen sollte darauf geachtet werden das keine Gruppe über eine Reihe hinaus ragt.<br><br><br><br />
<br />
Für unser Beispiel verschieben wir zum Testen die Gruppen in beliebige Reihen bzw. Spalten der mittleren Reihe. Danach bitte den "Set" Schalter drücken, dieser hat sich durch die verschiebe Aktionen bereits rot markiert.<br />
<br />
[[Datei:Dashboard_Positionieren.png|mini|200px|Ausrichtung von einzelnen Gruppen]]<br />
Das Ausrichten ist gleichermaßen einfach wie das Positionieren und sollte auch nichts Neues sein. Aber auch hier möchte ich darüber zwei, drei Worte verlieren.<br><br />
<br />
:Das Positionieren ist nur möglich, wenn das Dashboard nicht gesperrt ist (Lock/Unlock). Dann wird ein abgeschrägte Ecke an der Gruppe angezeigt, mit der die Größe gezogen werden kann.<br />
:Jede Gruppe kann in Höhe und Breite beliebig gezogen werden, wobei genau das wieder einen Hacken hat: Das Größerziehen ist nur bedingt möglich. Die Breite/Höhe ist auf die Breite/Höhe der Dashboard Reihe (oder Spalte) begrenzt. Damit kann man eine Gruppe nicht über den Rand des Dashboards hinaus vergrößern.<br><br />
:Das Kleinerziehen ist auch nur bis zu einer Mindestgröße möglich. Die Mindestgröße ist abhängig vom Inhalt der Gruppe, kann also von Gruppe zu Gruppe unterschiedlich sein.<br><br />
:Ein Sonderverhalten beim Vergrößern/Verkleinern gibt es auch: Ist ein Gruppe höher als die Reihe, lässt sich die Gruppe zwar dort positionieren. Beim Ausrichten springt dann der untere Rand nicht auf die Mindesthöhe der Gruppe, sondern auf die maximale Höhe der Reihe. In diesem Fall sollte die Höhe der Reihe geändert werden. Ähnliches kann auch in der Breite auftreten.<br><br />
:Ändert sich der Inhalt einer Gruppe (wird z.B. ein Dummy dazugepackt), ändert sich die Positionierung der Gruppe '''nicht''' automatisch. In diesem Fall ist man immer gezwungen auch die Größe der Gruppe im Dashboard an die neue Gegebenheit anzupassen.<br />
<br />
Für unser Beispiel ziehen wir die Gruppen beliebig größer. Danach bitte den "Set"-Schalter drücken. Dieser hat sich durch die Verschiebeaktionen bereits rot markiert.<br />
<br />
Wie bereits etwas weiter oben erklärt wird die Positionierung der Gruppen im Dashboard durch die Betätigung des Schalters "Set" temporär zwischengespeichert. Dadurch wird die Positionierung bereits für einen Seitenrefresh gespeichert. Solange bis das Browserfenster geschlossen wird. Danach wären diese Einstellungen verloren.<br><br />
Darum ist es notwendig die Positionierung permanent zu speichern, damit auch nach einem Neustart von Fhem die getroffenen Einstellungen und Positionierungen vorhanden sind. Dies geht über den in Fhem bekannten weg über ''Save config''.<br><br />
Wird der Schalter "Set" nicht betätigt, wird auch über ''Save config'' die Positionierung nicht gespeichert. Daher ist es wichtig, immer '''zuerst''' mit dem Schalter '''"Set"''' die Einstellung zwischenzuspeichern und '''danach mit ''Save config''''' den Zwischenspeicher permanent zu sichern.<br><br />
<br />
Durch den Schalter "Set" wird für jedes Tab die Einstellung in das für das jeweilige Tab zuständige Attribut geschrieben. Für Tab 1 ist das Attribut ''dashboard_tab1sorting'' zuständig, für Tab 2 das Attribut ''dashboard_tab2sorting'', usw. '''Diese Attribute sollten nicht editiert werden!'''<br />
<br />
Es ist möglich jedem Tab einen eigenen individuellen Namen zu vergeben. Dazu ist für das jeweilige Tab das entsprechende Attribut zu befüllen. Z.B. für Tab 1 ist das Attribut ''dashboard_tab1name'' mit dem gewünschten Titel zu füllen.<br><br />
[[#dashboard_tab1name| Siehe dashboard_tab1name]]<br />
<br />
== Letzte Änderungen / Dashboard-Historie ==<br />
<br />
* (03.03.2014) Anzeigefehler bei readingGroups in einem Hiddenroom behoben<br />
* (17.03.2014) Fehlerausgabe durch dashboard_webfrontendfilter behoben<br />
* (26.03.2014) dashboard_showfullsize wird nicht im Raum "all" bzw. Everything angewendet<br />
* (18.04.2014) Attribut dashboard_lock State entfernt. Kann nur noch in der Detailansicht verändert werden.<br />
* (24.04.2014) Attribut dashboard_showhelper wird nicht mehr genutzt. Der Helper wird nur angezeigt wenn lockstate unlock ist.<br />
* (24.04.2014) Schalter Detail und Set werden nun rechts angezeigt.<br />
* (24.04.2014) Attribut dashboard_showtabs kann nicht mehr tabs-at-the-top-buttonbar-hidden oder tabs-on-the-bottom-buttonbar-hidden sein.<br />
<br />
== Links ==<br />
* [http://forum.fhem.de/index.php/topic,16503.0.html Forenthread] über ''Dashboard''<br />
<br />
[[Kategorie:Hilfsmodul]]<br />
[[Kategorie:HOWTOS]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=PanStamp&diff=6811PanStamp2014-07-09T19:21:15Z<p>Fidel: /* Arduino Sketches */</p>
<hr />
<div>{{Baustelle}}<br />
{{SEITENTITEL:panStamp}}<br />
<br />
{{Infobox Hardware<br />
|Bild=panStamp.jpg<br />
|Bildbeschreibung=panStamp<br />
|HWProtocol=SWAP<br />
|HWType=Sender, Empfänger, Sensor, [[Interface]]<br />
|HWCategory=<br />
|HWComm=868MHz (433/915MHz)<br />
|HWChannels=<br />
|HWVoltage=3.3V (panStick: 5V USB)<br />
|HWPowerConsumption=<br />
|HWPoweredBy=Battery (panStick: USB)<br />
|HWSize=17.7 x 30.5 mm<br />
|HWDeviceFHEM=[http://fhem.de/commandref.html#panStamp 35_panStamp.pm] [http://fhem.de/commandref.html#SWAP 35_SWAP.pm]<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=430 Andre / justme1968]<br />
|HWManufacturer=panStamp<br />
}}<br />
<br />
<br />
[http://www.panstamp.com/home PanStamps] sind [[Arduino]] Clones, die ein CC1101 Funkmodul beinhalten. Mit ihnen lassen sich Sensoren und Aktoren drahtlos an FHEM anbinden. Sie lassen sich genau wie Arduinos über die Ardunio IDE oder mit dem ino Kommandozeilen Binary programmieren.<br />
<br />
Der panStamp Software Stack unterstützt einen stromsparenden Power-Down- oder Sleep-Modus für batteriebetriebene Sensoren, aus dem diese dann nur zur eigentlichen Messung und Übertragung "aufwachen".<br />
<br />
Zur Kommunikation in einem panStamp Netzwerk dient das ''Simple Wireless Abstract Protocol'' ([http://code.google.com/p/panstamp/wiki/SWAP SWAP]).<br />
<br />
Um einen panStamp in Betrieb zu nehmen muss er unbedingt mit einer Antenne oder einem stück Draht in der [https://code.google.com/p/panstamp/wiki/antennalengths richtigen Länge] bestückt sein. Ohne Antenne funktioniert die Übertragung nicht. Auch nicht auf kurze Distanzen.<br />
<br />
== Simple Wireless Abstract Protocol (SWAP) ==<br />
Die komplette SWAP- Kommunikation ist registerbasiert und erfolgt mit Nachrichten um diese Register abzufragen, zu setzen und deren Inhalt zu senden. Alle Register lassen sich lesen, manche auch beschreiben.<br />
<br />
Jeder panStamp stellt elf Systemregister (00-0A) [http://code.google.com/p/panstamp/wiki/SWAPregisters] und beliebig viele sketchabängige Userregister (0B-)bereit. Die Beschreibung der jeweils von einem Sketch bereitgestellten Userregister erfolgt in ''Device Description Files'', die in .../FHEM/lib/SWAP zu finden sind. Die Identifikation der Art eines panStamp und die Zuordnung zu einem bestimmten Device Description File erfolgt über den productCode der aus ''Hersteller''- und ''Produkt''-Id gebildet wird.<br />
<br />
In den Systemregistern steht z.&nbsp;B. der productCode, die Deviceadresse und das Übertragungsintervall. Konfigurierbare Register werden im EEPROM gesichert, so dass die Werte auch bei einem Neustart nicht verlorengehen. Beim ersten Starten eines panStamp ist das EEPROM mit FF initialisiert und alle konfigurierbaren Register haben diesen Wert, also z.&nbsp;B. die Adresse FF und das Intervall FFFF (zwischen 18 und 19 Stunden).<br />
<br />
Die Systemregister werden in der Device Detailansicht bei den InternalValues im oberen Bereich angezeigt und die User-Register als reading im unteren Bereich.<br />
<br />
Jeder panStamp durchläuft beim Start eine definierte Einschaltsequenz und überträgt als erstes seinen productCode. Batteriebetriebene panStamps warten anschließend drei Sekunden auf Konfigurationskommandos. Danach werden bestimmte Systemregister und aktuelle Messwerte gesendet.<br />
<br />
== FHEM Integration ==<br />
Die Integration in FHEM erfolgt über eine reihe von Modulen die im folgenden genauer beschrieben werden.<br />
=== panStamp ===<br />
Als Schnittstelle zwischen FHEM und einem panStamp Netzwerk dient entweder ein panStick (USB Stick mit aufgestecktem panStamp) oder ein panStamp Shield mit integriertem panStamp an einem Raspberry PI. Der so angebundene panStamp wird mit einem Modem-Sketch als RF Modem verwenden und über das FHEM Modul panStamp angesprochen. Hierzu ist in FHEM ein entsprechendes Device anzulegen: <pre>define panStick panStamp /dev/ttyUSBx@38400</pre><br />
<br />
Dieses panStamp Device versucht dann als erstes alle panStamps im Netz zu finden und per autocreate anzulegen.<br />
<br />
=== SWAP ===<br />
[[Datei:SWAP_ 0000000100000005-detail.png|mini|hochkant=2.5|Readings]]<br />
Das SWAP Modul ermöglicht die generische Integration beliebiger panStamp Sensoren und Aktoren in FHEM. Mit Hilfe der im jeweiligen Device Description File hinterlegten Beschreibung werden hierzu automatisch userReadings angelegt die neben den reinen Registerwerten in hex auch 'menschenlesbare' readings der Sensorwerte erzeugen. Damit dies funktioniert, muss das Attribut ProductCode korrekt gesetzt sein. Das geschieht normalerweise automatisch beim Anlegen des Device.<br />
<br />
Hier Beispielhaft anhand eines BMP085 Temperatur- und Luftdrucksensors dargestellt:<br />
<br />
:<code>attr temppress userReadings voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, temperature:0C.0-Temperature {hex(ReadingsVal($name,"0C.0-Temperature","0"))*0.1-50}, pressure:0C.1-Pressure {hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01}, pressureNN:0C.1-Pressure {sprintf("%.2f",hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01 + AttrVal("global", "altitude", 0)/8.5)}</code><br />
<br />
[[Datei:SWAP_ 0000000100000005.png|mini|hochkant=2.5|Resultat eines stateFormat]]<br />
Aus diesen readings kann dann mit stateFormat die gewünschte Darstellung für die Raumübersicht erzeugt werden:<br />
<br />
:<code>attr temppress stateFormat {sprintf("%.1f",ReadingsVal($name,"temperature",0))."°C ".sprintf("%.1f",ReadingsVal($name,"pressureNN",0))."mbar"}</code><br />
<br />
<br />
Sobald ein SWAP Device mit dem productCode korrekt angelegt wurde, können die Userregister bzw. alle Register aufgelistet werden: <br />
get <device> regList<br />
get <device> regListALL<br />
<br />
und einzelne Register abgefragt und gesetzt werden:<br />
set <device> regGet <ID><br />
set <device> regSet <ID> <value><br />
Für die Systemregister kann hierzu statt der RegisterID auch der Registername (siehe regListAll) verwendet werden.<br />
<br />
==== Neue panStamps in Betrieb nehmen ====<br />
'''Info: Das SWAP Modul unterstützt autocreate. Bei der Inbetriebnahme ist autocreate zu aktivieren!'''<br />
<br />
Neue panStamps sollten nur Einer nach dem Anderen in Betrieb genommen werden, da sie zuerst mit einer eindeutigen Device-Adresse (ungleich FF und grösser 01) versehen werden müssen. Bei batteriebetriebenen Sensoren sollte auch das Sendeintervall auf einen sinnvollen Wert gesetzt werden:<br />
set <device> regSet 09 <device adresse als 2 stellige hex zahl><br />
set <device> regSet 0A <intervall in sekunden als 4 stellige hex zahl><br />
Für Devices im Power-Down-Modus werden diese Kommandos in eine Warteschlange gestellt und übertragen, sobald das Device seine Initialisierungssequenz durchläuft. Hierzu ist nach Absetzen der Kommandos Reset zu drücken oder die Stromquelle erneut zu verbinden.<br />
<br />
Das SWAP modul versucht, ein Device mit der default Adresse <code>FF</code> automatisch auf die erste freie Adresse im Bereich <code>F0</code>-<code>FE</code> zu ändern.<br />
<br />
Für batteriebetriebene Devices (genauer: Devices die den Power-Down-Modus unterstützen) wird das Default Sendeintervall von <code>FFFF</code> zu <code>0384</code> (900 Sekunden) geändert.<br />
Es gibt mit bestimmten panstamp lib Versionen das Problem das ein wert von FFFF in 0A zum Überlauf führt und dann ununterbrochen gesendet wird. Im fhem Modul wird versucht das abzufangen. Das funktioniert auf manchen langsamen host systemen (z.B. FritzBox) nicht, weil der panstamp so schnell sendet das fhem so mit dem abarbeiten beschäftigt ist das es selber nicht zum senden kommt.<br />
Zur Abhilfe kann im sketch in setup() ganz am Anfang ein<br />
EEPROM.write(EEPROM_TX_INTERVAL, 0x55);<br />
EEPROM.write(EEPROM_TX_INTERVAL+1, 0x55);<br />
eingefügt werden und noch mal flashen. Wenn der Sketch damit ein mal durchgelaufen ist können diese beiden Zeilen wieder entfernen und der panstamp noch mal geflasht.<br />
<br />
Automatisch gesetzte Werte sollten danach manuell auf die jeweilige Installation angepasst werden.<br />
<br />
==== Beispiele ====<br />
===== Bodenfeuchte =====<br />
Der panStamp soilmoisture Sketch aus dem examples Verzeichnis ist mit dem Standard SWAP Modul kompatibel. <br />
<br />
Eine für einen Vegetronix sensor angepasste Version kann von [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge] heruntergeladen werden. Das Übertragungsintervall ist wie üblich über das regsiter 0A konfigurierbar. Der Sensor wird and GND, D7 für die Versorgungsspannung und A4 für den Messwert angeschlossen. Erfahrungen haben gezeigt, dass bei einem fünfminütigen Übertragungsintervall nach 12 Monaten Laufzeit die Batteriespannung von 1.55V auf 1.4V abfällt. Das würde bedeuten, dass eine Batterie im Batterieboard mindestens eine Laufzeit von drei Jahren haben sollte.<br />
<br />
set <MyBodenfeuchte> stateFormat VWC_A%<br />
set <MyBodenfeuchte> userReadings Level0_Voltage {hex(ReadingsVal($name,"0C.0-Moisture_level_0","0"))*(3.3/1024)}, <br />
VWC_A:0C.0-Moisture_level_0 {sprintf("%.0f",(11.6552 * (ReadingsVal($name,"Level0_Voltage","0"))**4 + 7.10835 * <br />
(ReadingsVal($name,"Level0_Voltage","0"))**2 - 0.569557) / ((ReadingsVal($name,"Level0_Voltage","0"))**2 + 1))}, <br />
voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, <br />
battery:0B-Voltage {(ReadingsVal($name,"voltage","0")<1?"low":"ok")}<br />
<br />
[[Datei:SWAP_ soilmositure-plot.jpg|mini|x100px|Bodenfeuchte]]<br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix1.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix2.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<br />
Mit einem entsprechend erweiterten Sketch lassen sich auch mehrere Sensoren an einem panStamp auslesen.<br />
<br />
Die folgenden Bilder zeigen eine Panstamp/Vegetronix Außeneinheit im IP65-Gehäuse. Dieser Aufbau wird ganzjährig den Witterungseinflüssen ausgesetzt. Die auf den Stab aufgesetzte Antenne muss nicht verwendet werden, bei kürzeren Funkstrecken ist eine innenliegende Drahtantenne ausreichend. Bitte in FHEM den RSSI- und LQI-Wert sowie die Gleichmäßigkeit des Empfangens der 5 Minuten Sendeintervalle dementsprechend beobachten.<br />
<br />
=== SWAP_XXXXXXXXXXXXXXXX ===<br />
Besonders bei Aktoren ist oft eine engere FHEM-Integration sinnvoll, um FHEM Konzepte wie on/off/on-for-timer direkt abzubilden und nicht mehr nur auf die Registerebene und regSet und regGet Kommandos beschränkt zu sein.<br />
<br />
Um per autocreate automatisch das passende Modul laden zu können, müssen diese Module nach dem Schema SWAP_XXXXXXXXXXXXXXXX.pm benannt sein wobei XXXXXXXXXXXXXXXX für den jeweiligen productCode steht.<br />
<br />
==== SWAP_0000002200000003 ====<br />
[[Datei:SWAP_0000002200000003.png|mini|rechts|hochkant=2.5|RGB LED Driver Board]]<br />
Ein FHEM Modul für das modifizierte panStamp RGB LED Driver Board. <br />
<br />
Das Board unterstützt RGBW LEDs und lässt sich per Infrarot Fernbedienung, DMX Controller (z.&nbsp;B. als Unterputz Touchpanel) und FHEM bedienen.<br />
<br />
Der Funktionsumfang wird in diesem [http://forum.fhem.de/index.php/topic,12487.msg81923.html#msg81923 Forenthread] vorgestellt. Die Hardware für das Board wird [http://forum.fhem.de/index.php/topic,13890.0.html hier] im FHEM Forum vorgestellt und ein Prototyp ist [http://forum.fhem.de/index.php/topic,12487.msg85777.html#msg85777 hier] zu sehen.<br />
=====Upate 2014-01-11===== <br />
Zur Zeit ist Version 2 des Boards in Vorbereiteung. Die Projektseite zur Hardware findet sich [http://itse.homeip.net/projekte/12/6/ hier]. <br />
<br />
Demnächst wird eine aktualisiert Version des Fhem Moduls und panStamp Sketches eingecheckt. Eine Übersicht über die dann vorhandene Funktionalität:<br />
<br />
was geht:<br />
* bis zu vier led kanäle (je nach kombination von ir und soft pwm)<br />
* ir senden<br />
* ir empfangen<br />
* messen ob die led versorgung an ist<br />
* helligkeit eines an A2 angeschlossenen helligkeits sensors<br />
* konfiguration der dmx basis adresse über das swap register 0x12<br />
* optional soft on auf letzten wert<br />
* alles was auch vorher schon ging: dimmen, faden, ir fernbedienungen anlernen, ...<br />
<br />
wichtig zu wissen:<br />
* wenn ir aktiv ist und kein soft pwm lässt sich der 4. kanal nur ein und aus schalten<br />
* wenn ir aktiv ist muss soft pwm aktiv sein um den 4. kanäle auch zu dimmen<br />
* es wird nur ein zusätzlicher kanal tatsächlich schon unterstützt. der fünfte kommt noch<br />
* bei ir senden sind nur die aufrufe für sony und nec tatsächlich eingebaut. die anderen sind aber einfach zu ergänzen<br />
* beim ir senden sind noch keine Wiederholungen eingebaut. die müssen laut protokoll aber eigentlich sein<br />
<br />
was noch kommt:<br />
* besseres soft pwm<br />
* mehr konfiguration bezüglich default verhalten. ramp zeiten, delays, ...<br />
* hsv farb modell um besser zu faden und vor allem um den weiss anteil automatisch auf die weiss leds zu legen<br />
* die virtuellen channel <br />
* fhem kompatibles ir senden<br />
* sofortiges senden von helligkeit und led spannung bei änderung<br />
* andere ir lib mit sehr viel besserer geräte unterstützung<br />
<br />
wie gehabt muss alles über config.h konfiguriert werden.<br />
<br />
<br />
===== weitrere Screenshots =====<br />
<gallery><br />
File:SWAP_0000002200000003-internal.png|InternalValues<br />
File:SWAP_0000002200000003-readings.png|Readings<br />
File:SWAP_0000002200000003-attributes.png|Attributes<br />
</gallery><br />
<br />
== Arduino Sketches ==<br />
Zum Flashen der Panstamps wird die Arduino IDE benötigt. Eine Installationsanleitung ist unter folgendem Link zu finden:<br />
:https://code.google.com/p/panstamp/wiki/firststeps<br />
<br />
Für den RGB-Driver sketch sind je nach gewünschtem Funktionsumfang noch folgende libs zu installieren:<br />
<br />
* IR lib - https://github.com/shirriff/Arduino-IRremote<br />
* DMX lib- http://www.mathertel.de/Arduino/DMXSerial.aspx<br />
<br />
Die Librarys sollten entweder mit dem entsprechenden Menüpunkt in die IDE integriert werden oder jeweils nach auspacken des zip files als als kompletten Ordner im Arduino libraries verzeichnis abgelegt werden (siehe [http://www.arduino.cc/en/Hacking/Libraries)]).<br />
<br />
Die aktuelle Version des RGB-Driver Sketches findet sich auf [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge].<br />
<br />
Dieser muss in Arduino\libraries\panstamp\examples\sketches entpackt und die rbgdriver.ino gestartet werden. In der Arduino IDE sollte unter Tools->Board "Arduino Pro or Pro Mini (3.3V, 8MHz) w/ Atmega328" eingestellt sein. Wenn man das boards.txt file von [http://code.google.com/p/panstamp/downloads/detail?name=boards.txt&can=2&q= hier] installiert kann man in der IDE auch direkt PanStamp als Plattform auswählen.<br />
<br />
Welche Features der sketch bietet lässt sich im config.h file durch ein- oder auskommentieren der #define ENABLE_... Zeilen festlegen.<br />
<br />
<br />
'''Besonderheiten bei der Nutzung einiger Funktionen'''<br />
<br />
<br />
* #define ENABLE_DMX<br />
<br />
<br />
Hierbei ist darauf zu achten, dass in der DMX-Lib in der Datei DMXSerial.h die Zeile<br />
<br />
<nowiki>#define DmxModePin 2 // Arduino pin 2 for controlling the data direction</nowiki><br />
<br />
in <br />
<br />
<nowiki>#define DmxModePin 7 // Arduino pin 7 for controlling the data direction</nowiki><br />
<br />
abgeändert werden muss.<br />
<br />
<br />
<br />
<br />
<br />
* #define HAS_SENSOR (ermöglicht die Nutzung eines DHT22 Sensors zur Auswerung von Temperatur und Luftfeuchtigkeit)<br />
<br />
<br />
USE_SOFT_PWM;<br />
ENABLE_IR_SEND;<br />
ENABLE_REPEATER;<br />
<br />
sollte hierfür auskommentiert sein.<br />
<br />
In der IRremote.cpp Datei in der Irremote Library muss die Zeile<br />
<br />
void IRrecv::disableIRIn() <br />
{<br />
TIMER_DISABLE_INTR;<br />
}<br />
<br />
sowie die Irremote.h Datei unter Public: um die Zeile <br />
<br />
void disableIRIn();<br />
<br />
erweitert werden.<br />
<br />
Der Daten-Pin des DHT22 Sensors muss hierfür an A2 des Panstamps angeschlossen werden.<br />
<br />
== Weblinks ==<br />
* [http://www.panstamp.com/home panStamp] panStamp Hersteller<br />
* [http://itse.homeip.net/projekte/12/6/ Projektseite] für das RGB-Multi-Board.<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ rgbdriver sketch] auf sourceforge<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ soilmoisture sketch] auf sourceforge<br />
<br />
[[Kategorie:Interfaces]]<br />
[[Kategorie:Other Components]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=PanStamp&diff=6810PanStamp2014-07-09T19:20:36Z<p>Fidel: /* Arduino Sketches */</p>
<hr />
<div>{{Baustelle}}<br />
{{SEITENTITEL:panStamp}}<br />
<br />
{{Infobox Hardware<br />
|Bild=panStamp.jpg<br />
|Bildbeschreibung=panStamp<br />
|HWProtocol=SWAP<br />
|HWType=Sender, Empfänger, Sensor, [[Interface]]<br />
|HWCategory=<br />
|HWComm=868MHz (433/915MHz)<br />
|HWChannels=<br />
|HWVoltage=3.3V (panStick: 5V USB)<br />
|HWPowerConsumption=<br />
|HWPoweredBy=Battery (panStick: USB)<br />
|HWSize=17.7 x 30.5 mm<br />
|HWDeviceFHEM=[http://fhem.de/commandref.html#panStamp 35_panStamp.pm] [http://fhem.de/commandref.html#SWAP 35_SWAP.pm]<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=430 Andre / justme1968]<br />
|HWManufacturer=panStamp<br />
}}<br />
<br />
<br />
[http://www.panstamp.com/home PanStamps] sind [[Arduino]] Clones, die ein CC1101 Funkmodul beinhalten. Mit ihnen lassen sich Sensoren und Aktoren drahtlos an FHEM anbinden. Sie lassen sich genau wie Arduinos über die Ardunio IDE oder mit dem ino Kommandozeilen Binary programmieren.<br />
<br />
Der panStamp Software Stack unterstützt einen stromsparenden Power-Down- oder Sleep-Modus für batteriebetriebene Sensoren, aus dem diese dann nur zur eigentlichen Messung und Übertragung "aufwachen".<br />
<br />
Zur Kommunikation in einem panStamp Netzwerk dient das ''Simple Wireless Abstract Protocol'' ([http://code.google.com/p/panstamp/wiki/SWAP SWAP]).<br />
<br />
Um einen panStamp in Betrieb zu nehmen muss er unbedingt mit einer Antenne oder einem stück Draht in der [https://code.google.com/p/panstamp/wiki/antennalengths richtigen Länge] bestückt sein. Ohne Antenne funktioniert die Übertragung nicht. Auch nicht auf kurze Distanzen.<br />
<br />
== Simple Wireless Abstract Protocol (SWAP) ==<br />
Die komplette SWAP- Kommunikation ist registerbasiert und erfolgt mit Nachrichten um diese Register abzufragen, zu setzen und deren Inhalt zu senden. Alle Register lassen sich lesen, manche auch beschreiben.<br />
<br />
Jeder panStamp stellt elf Systemregister (00-0A) [http://code.google.com/p/panstamp/wiki/SWAPregisters] und beliebig viele sketchabängige Userregister (0B-)bereit. Die Beschreibung der jeweils von einem Sketch bereitgestellten Userregister erfolgt in ''Device Description Files'', die in .../FHEM/lib/SWAP zu finden sind. Die Identifikation der Art eines panStamp und die Zuordnung zu einem bestimmten Device Description File erfolgt über den productCode der aus ''Hersteller''- und ''Produkt''-Id gebildet wird.<br />
<br />
In den Systemregistern steht z.&nbsp;B. der productCode, die Deviceadresse und das Übertragungsintervall. Konfigurierbare Register werden im EEPROM gesichert, so dass die Werte auch bei einem Neustart nicht verlorengehen. Beim ersten Starten eines panStamp ist das EEPROM mit FF initialisiert und alle konfigurierbaren Register haben diesen Wert, also z.&nbsp;B. die Adresse FF und das Intervall FFFF (zwischen 18 und 19 Stunden).<br />
<br />
Die Systemregister werden in der Device Detailansicht bei den InternalValues im oberen Bereich angezeigt und die User-Register als reading im unteren Bereich.<br />
<br />
Jeder panStamp durchläuft beim Start eine definierte Einschaltsequenz und überträgt als erstes seinen productCode. Batteriebetriebene panStamps warten anschließend drei Sekunden auf Konfigurationskommandos. Danach werden bestimmte Systemregister und aktuelle Messwerte gesendet.<br />
<br />
== FHEM Integration ==<br />
Die Integration in FHEM erfolgt über eine reihe von Modulen die im folgenden genauer beschrieben werden.<br />
=== panStamp ===<br />
Als Schnittstelle zwischen FHEM und einem panStamp Netzwerk dient entweder ein panStick (USB Stick mit aufgestecktem panStamp) oder ein panStamp Shield mit integriertem panStamp an einem Raspberry PI. Der so angebundene panStamp wird mit einem Modem-Sketch als RF Modem verwenden und über das FHEM Modul panStamp angesprochen. Hierzu ist in FHEM ein entsprechendes Device anzulegen: <pre>define panStick panStamp /dev/ttyUSBx@38400</pre><br />
<br />
Dieses panStamp Device versucht dann als erstes alle panStamps im Netz zu finden und per autocreate anzulegen.<br />
<br />
=== SWAP ===<br />
[[Datei:SWAP_ 0000000100000005-detail.png|mini|hochkant=2.5|Readings]]<br />
Das SWAP Modul ermöglicht die generische Integration beliebiger panStamp Sensoren und Aktoren in FHEM. Mit Hilfe der im jeweiligen Device Description File hinterlegten Beschreibung werden hierzu automatisch userReadings angelegt die neben den reinen Registerwerten in hex auch 'menschenlesbare' readings der Sensorwerte erzeugen. Damit dies funktioniert, muss das Attribut ProductCode korrekt gesetzt sein. Das geschieht normalerweise automatisch beim Anlegen des Device.<br />
<br />
Hier Beispielhaft anhand eines BMP085 Temperatur- und Luftdrucksensors dargestellt:<br />
<br />
:<code>attr temppress userReadings voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, temperature:0C.0-Temperature {hex(ReadingsVal($name,"0C.0-Temperature","0"))*0.1-50}, pressure:0C.1-Pressure {hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01}, pressureNN:0C.1-Pressure {sprintf("%.2f",hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01 + AttrVal("global", "altitude", 0)/8.5)}</code><br />
<br />
[[Datei:SWAP_ 0000000100000005.png|mini|hochkant=2.5|Resultat eines stateFormat]]<br />
Aus diesen readings kann dann mit stateFormat die gewünschte Darstellung für die Raumübersicht erzeugt werden:<br />
<br />
:<code>attr temppress stateFormat {sprintf("%.1f",ReadingsVal($name,"temperature",0))."°C ".sprintf("%.1f",ReadingsVal($name,"pressureNN",0))."mbar"}</code><br />
<br />
<br />
Sobald ein SWAP Device mit dem productCode korrekt angelegt wurde, können die Userregister bzw. alle Register aufgelistet werden: <br />
get <device> regList<br />
get <device> regListALL<br />
<br />
und einzelne Register abgefragt und gesetzt werden:<br />
set <device> regGet <ID><br />
set <device> regSet <ID> <value><br />
Für die Systemregister kann hierzu statt der RegisterID auch der Registername (siehe regListAll) verwendet werden.<br />
<br />
==== Neue panStamps in Betrieb nehmen ====<br />
'''Info: Das SWAP Modul unterstützt autocreate. Bei der Inbetriebnahme ist autocreate zu aktivieren!'''<br />
<br />
Neue panStamps sollten nur Einer nach dem Anderen in Betrieb genommen werden, da sie zuerst mit einer eindeutigen Device-Adresse (ungleich FF und grösser 01) versehen werden müssen. Bei batteriebetriebenen Sensoren sollte auch das Sendeintervall auf einen sinnvollen Wert gesetzt werden:<br />
set <device> regSet 09 <device adresse als 2 stellige hex zahl><br />
set <device> regSet 0A <intervall in sekunden als 4 stellige hex zahl><br />
Für Devices im Power-Down-Modus werden diese Kommandos in eine Warteschlange gestellt und übertragen, sobald das Device seine Initialisierungssequenz durchläuft. Hierzu ist nach Absetzen der Kommandos Reset zu drücken oder die Stromquelle erneut zu verbinden.<br />
<br />
Das SWAP modul versucht, ein Device mit der default Adresse <code>FF</code> automatisch auf die erste freie Adresse im Bereich <code>F0</code>-<code>FE</code> zu ändern.<br />
<br />
Für batteriebetriebene Devices (genauer: Devices die den Power-Down-Modus unterstützen) wird das Default Sendeintervall von <code>FFFF</code> zu <code>0384</code> (900 Sekunden) geändert.<br />
Es gibt mit bestimmten panstamp lib Versionen das Problem das ein wert von FFFF in 0A zum Überlauf führt und dann ununterbrochen gesendet wird. Im fhem Modul wird versucht das abzufangen. Das funktioniert auf manchen langsamen host systemen (z.B. FritzBox) nicht, weil der panstamp so schnell sendet das fhem so mit dem abarbeiten beschäftigt ist das es selber nicht zum senden kommt.<br />
Zur Abhilfe kann im sketch in setup() ganz am Anfang ein<br />
EEPROM.write(EEPROM_TX_INTERVAL, 0x55);<br />
EEPROM.write(EEPROM_TX_INTERVAL+1, 0x55);<br />
eingefügt werden und noch mal flashen. Wenn der Sketch damit ein mal durchgelaufen ist können diese beiden Zeilen wieder entfernen und der panstamp noch mal geflasht.<br />
<br />
Automatisch gesetzte Werte sollten danach manuell auf die jeweilige Installation angepasst werden.<br />
<br />
==== Beispiele ====<br />
===== Bodenfeuchte =====<br />
Der panStamp soilmoisture Sketch aus dem examples Verzeichnis ist mit dem Standard SWAP Modul kompatibel. <br />
<br />
Eine für einen Vegetronix sensor angepasste Version kann von [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge] heruntergeladen werden. Das Übertragungsintervall ist wie üblich über das regsiter 0A konfigurierbar. Der Sensor wird and GND, D7 für die Versorgungsspannung und A4 für den Messwert angeschlossen. Erfahrungen haben gezeigt, dass bei einem fünfminütigen Übertragungsintervall nach 12 Monaten Laufzeit die Batteriespannung von 1.55V auf 1.4V abfällt. Das würde bedeuten, dass eine Batterie im Batterieboard mindestens eine Laufzeit von drei Jahren haben sollte.<br />
<br />
set <MyBodenfeuchte> stateFormat VWC_A%<br />
set <MyBodenfeuchte> userReadings Level0_Voltage {hex(ReadingsVal($name,"0C.0-Moisture_level_0","0"))*(3.3/1024)}, <br />
VWC_A:0C.0-Moisture_level_0 {sprintf("%.0f",(11.6552 * (ReadingsVal($name,"Level0_Voltage","0"))**4 + 7.10835 * <br />
(ReadingsVal($name,"Level0_Voltage","0"))**2 - 0.569557) / ((ReadingsVal($name,"Level0_Voltage","0"))**2 + 1))}, <br />
voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, <br />
battery:0B-Voltage {(ReadingsVal($name,"voltage","0")<1?"low":"ok")}<br />
<br />
[[Datei:SWAP_ soilmositure-plot.jpg|mini|x100px|Bodenfeuchte]]<br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix1.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix2.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<br />
Mit einem entsprechend erweiterten Sketch lassen sich auch mehrere Sensoren an einem panStamp auslesen.<br />
<br />
Die folgenden Bilder zeigen eine Panstamp/Vegetronix Außeneinheit im IP65-Gehäuse. Dieser Aufbau wird ganzjährig den Witterungseinflüssen ausgesetzt. Die auf den Stab aufgesetzte Antenne muss nicht verwendet werden, bei kürzeren Funkstrecken ist eine innenliegende Drahtantenne ausreichend. Bitte in FHEM den RSSI- und LQI-Wert sowie die Gleichmäßigkeit des Empfangens der 5 Minuten Sendeintervalle dementsprechend beobachten.<br />
<br />
=== SWAP_XXXXXXXXXXXXXXXX ===<br />
Besonders bei Aktoren ist oft eine engere FHEM-Integration sinnvoll, um FHEM Konzepte wie on/off/on-for-timer direkt abzubilden und nicht mehr nur auf die Registerebene und regSet und regGet Kommandos beschränkt zu sein.<br />
<br />
Um per autocreate automatisch das passende Modul laden zu können, müssen diese Module nach dem Schema SWAP_XXXXXXXXXXXXXXXX.pm benannt sein wobei XXXXXXXXXXXXXXXX für den jeweiligen productCode steht.<br />
<br />
==== SWAP_0000002200000003 ====<br />
[[Datei:SWAP_0000002200000003.png|mini|rechts|hochkant=2.5|RGB LED Driver Board]]<br />
Ein FHEM Modul für das modifizierte panStamp RGB LED Driver Board. <br />
<br />
Das Board unterstützt RGBW LEDs und lässt sich per Infrarot Fernbedienung, DMX Controller (z.&nbsp;B. als Unterputz Touchpanel) und FHEM bedienen.<br />
<br />
Der Funktionsumfang wird in diesem [http://forum.fhem.de/index.php/topic,12487.msg81923.html#msg81923 Forenthread] vorgestellt. Die Hardware für das Board wird [http://forum.fhem.de/index.php/topic,13890.0.html hier] im FHEM Forum vorgestellt und ein Prototyp ist [http://forum.fhem.de/index.php/topic,12487.msg85777.html#msg85777 hier] zu sehen.<br />
=====Upate 2014-01-11===== <br />
Zur Zeit ist Version 2 des Boards in Vorbereiteung. Die Projektseite zur Hardware findet sich [http://itse.homeip.net/projekte/12/6/ hier]. <br />
<br />
Demnächst wird eine aktualisiert Version des Fhem Moduls und panStamp Sketches eingecheckt. Eine Übersicht über die dann vorhandene Funktionalität:<br />
<br />
was geht:<br />
* bis zu vier led kanäle (je nach kombination von ir und soft pwm)<br />
* ir senden<br />
* ir empfangen<br />
* messen ob die led versorgung an ist<br />
* helligkeit eines an A2 angeschlossenen helligkeits sensors<br />
* konfiguration der dmx basis adresse über das swap register 0x12<br />
* optional soft on auf letzten wert<br />
* alles was auch vorher schon ging: dimmen, faden, ir fernbedienungen anlernen, ...<br />
<br />
wichtig zu wissen:<br />
* wenn ir aktiv ist und kein soft pwm lässt sich der 4. kanal nur ein und aus schalten<br />
* wenn ir aktiv ist muss soft pwm aktiv sein um den 4. kanäle auch zu dimmen<br />
* es wird nur ein zusätzlicher kanal tatsächlich schon unterstützt. der fünfte kommt noch<br />
* bei ir senden sind nur die aufrufe für sony und nec tatsächlich eingebaut. die anderen sind aber einfach zu ergänzen<br />
* beim ir senden sind noch keine Wiederholungen eingebaut. die müssen laut protokoll aber eigentlich sein<br />
<br />
was noch kommt:<br />
* besseres soft pwm<br />
* mehr konfiguration bezüglich default verhalten. ramp zeiten, delays, ...<br />
* hsv farb modell um besser zu faden und vor allem um den weiss anteil automatisch auf die weiss leds zu legen<br />
* die virtuellen channel <br />
* fhem kompatibles ir senden<br />
* sofortiges senden von helligkeit und led spannung bei änderung<br />
* andere ir lib mit sehr viel besserer geräte unterstützung<br />
<br />
wie gehabt muss alles über config.h konfiguriert werden.<br />
<br />
<br />
===== weitrere Screenshots =====<br />
<gallery><br />
File:SWAP_0000002200000003-internal.png|InternalValues<br />
File:SWAP_0000002200000003-readings.png|Readings<br />
File:SWAP_0000002200000003-attributes.png|Attributes<br />
</gallery><br />
<br />
== Arduino Sketches ==<br />
Zum Flashen der Panstamps wird die Arduino IDE benötigt. Eine Installationsanleitung ist unter folgendem Link zu finden:<br />
:https://code.google.com/p/panstamp/wiki/firststeps<br />
<br />
Für den RGB-Driver sketch sind je nach gewünschtem Funktionsumfang noch folgende libs zu installieren:<br />
<br />
* IR lib - https://github.com/shirriff/Arduino-IRremote<br />
* DMX lib- http://www.mathertel.de/Arduino/DMXSerial.aspx<br />
<br />
Die Librarys sollten entweder mit dem entsprechenden Menüpunkt in die IDE integriert werden oder jeweils nach auspacken des zip files als als kompletten Ordner im Arduino libraries verzeichnis abgelegt werden (siehe [http://www.arduino.cc/en/Hacking/Libraries)]).<br />
<br />
Die aktuelle Version des RGB-Driver Sketches findet sich auf [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge].<br />
<br />
Dieser muss in Arduino\libraries\panstamp\examples\sketches entpackt und die rbgdriver.ino gestartet werden. In der Arduino IDE sollte unter Tools->Board "Arduino Pro or Pro Mini (3.3V, 8MHz) w/ Atmega328" eingestellt sein. Wenn man das boards.txt file von [http://code.google.com/p/panstamp/downloads/detail?name=boards.txt&can=2&q= hier] installiert kann man in der IDE auch direkt PanStamp als Plattform auswählen.<br />
<br />
Welche Features der sketch bietet lässt sich im config.h file durch ein- oder auskommentieren der #define ENABLE_... Zeilen festlegen.<br />
<br />
<br />
'''Besonderheiten bei der Nutzung einiger Funktionen'''<br />
<br />
<br />
* #define ENABLE_DMX<br />
<br />
<br />
Hierbei ist darauf zu achten, dass in der DMX-Lib in der Datei DMXSerial.h die Zeile<br />
<br />
<nowiki>#define DmxModePin 2 // Arduino pin 2 for controlling the data direction</nowiki><br />
<br />
in <br />
<br />
<nowiki>#define DmxModePin 7 // Arduino pin 7 for controlling the data direction</nowiki><br />
<br />
abgeändert werden muss.<br />
<br />
<br />
<br />
* #define HAS_SENSOR (ermöglicht die Nutzung eines DHT22 Sensors zur Auswerung von Temperatur und Luftfeuchtigkeit)<br />
<br />
<br />
USE_SOFT_PWM;<br />
ENABLE_IR_SEND;<br />
ENABLE_REPEATER;<br />
<br />
sollte hierfür auskommentiert sein.<br />
<br />
In der IRremote.cpp Datei in der Irremote Library muss die Zeile<br />
<br />
void IRrecv::disableIRIn() <br />
{<br />
TIMER_DISABLE_INTR;<br />
}<br />
<br />
sowie die Irremote.h Datei unter Public: um die Zeile <br />
<br />
void disableIRIn();<br />
<br />
erweitert werden.<br />
<br />
Der Daten-Pin des DHT22 Sensors muss hierfür an A2 des Panstamps angeschlossen werden.<br />
<br />
== Weblinks ==<br />
* [http://www.panstamp.com/home panStamp] panStamp Hersteller<br />
* [http://itse.homeip.net/projekte/12/6/ Projektseite] für das RGB-Multi-Board.<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ rgbdriver sketch] auf sourceforge<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ soilmoisture sketch] auf sourceforge<br />
<br />
[[Kategorie:Interfaces]]<br />
[[Kategorie:Other Components]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=PanStamp&diff=6809PanStamp2014-07-09T19:20:09Z<p>Fidel: /* Arduino Sketches */</p>
<hr />
<div>{{Baustelle}}<br />
{{SEITENTITEL:panStamp}}<br />
<br />
{{Infobox Hardware<br />
|Bild=panStamp.jpg<br />
|Bildbeschreibung=panStamp<br />
|HWProtocol=SWAP<br />
|HWType=Sender, Empfänger, Sensor, [[Interface]]<br />
|HWCategory=<br />
|HWComm=868MHz (433/915MHz)<br />
|HWChannels=<br />
|HWVoltage=3.3V (panStick: 5V USB)<br />
|HWPowerConsumption=<br />
|HWPoweredBy=Battery (panStick: USB)<br />
|HWSize=17.7 x 30.5 mm<br />
|HWDeviceFHEM=[http://fhem.de/commandref.html#panStamp 35_panStamp.pm] [http://fhem.de/commandref.html#SWAP 35_SWAP.pm]<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=430 Andre / justme1968]<br />
|HWManufacturer=panStamp<br />
}}<br />
<br />
<br />
[http://www.panstamp.com/home PanStamps] sind [[Arduino]] Clones, die ein CC1101 Funkmodul beinhalten. Mit ihnen lassen sich Sensoren und Aktoren drahtlos an FHEM anbinden. Sie lassen sich genau wie Arduinos über die Ardunio IDE oder mit dem ino Kommandozeilen Binary programmieren.<br />
<br />
Der panStamp Software Stack unterstützt einen stromsparenden Power-Down- oder Sleep-Modus für batteriebetriebene Sensoren, aus dem diese dann nur zur eigentlichen Messung und Übertragung "aufwachen".<br />
<br />
Zur Kommunikation in einem panStamp Netzwerk dient das ''Simple Wireless Abstract Protocol'' ([http://code.google.com/p/panstamp/wiki/SWAP SWAP]).<br />
<br />
Um einen panStamp in Betrieb zu nehmen muss er unbedingt mit einer Antenne oder einem stück Draht in der [https://code.google.com/p/panstamp/wiki/antennalengths richtigen Länge] bestückt sein. Ohne Antenne funktioniert die Übertragung nicht. Auch nicht auf kurze Distanzen.<br />
<br />
== Simple Wireless Abstract Protocol (SWAP) ==<br />
Die komplette SWAP- Kommunikation ist registerbasiert und erfolgt mit Nachrichten um diese Register abzufragen, zu setzen und deren Inhalt zu senden. Alle Register lassen sich lesen, manche auch beschreiben.<br />
<br />
Jeder panStamp stellt elf Systemregister (00-0A) [http://code.google.com/p/panstamp/wiki/SWAPregisters] und beliebig viele sketchabängige Userregister (0B-)bereit. Die Beschreibung der jeweils von einem Sketch bereitgestellten Userregister erfolgt in ''Device Description Files'', die in .../FHEM/lib/SWAP zu finden sind. Die Identifikation der Art eines panStamp und die Zuordnung zu einem bestimmten Device Description File erfolgt über den productCode der aus ''Hersteller''- und ''Produkt''-Id gebildet wird.<br />
<br />
In den Systemregistern steht z.&nbsp;B. der productCode, die Deviceadresse und das Übertragungsintervall. Konfigurierbare Register werden im EEPROM gesichert, so dass die Werte auch bei einem Neustart nicht verlorengehen. Beim ersten Starten eines panStamp ist das EEPROM mit FF initialisiert und alle konfigurierbaren Register haben diesen Wert, also z.&nbsp;B. die Adresse FF und das Intervall FFFF (zwischen 18 und 19 Stunden).<br />
<br />
Die Systemregister werden in der Device Detailansicht bei den InternalValues im oberen Bereich angezeigt und die User-Register als reading im unteren Bereich.<br />
<br />
Jeder panStamp durchläuft beim Start eine definierte Einschaltsequenz und überträgt als erstes seinen productCode. Batteriebetriebene panStamps warten anschließend drei Sekunden auf Konfigurationskommandos. Danach werden bestimmte Systemregister und aktuelle Messwerte gesendet.<br />
<br />
== FHEM Integration ==<br />
Die Integration in FHEM erfolgt über eine reihe von Modulen die im folgenden genauer beschrieben werden.<br />
=== panStamp ===<br />
Als Schnittstelle zwischen FHEM und einem panStamp Netzwerk dient entweder ein panStick (USB Stick mit aufgestecktem panStamp) oder ein panStamp Shield mit integriertem panStamp an einem Raspberry PI. Der so angebundene panStamp wird mit einem Modem-Sketch als RF Modem verwenden und über das FHEM Modul panStamp angesprochen. Hierzu ist in FHEM ein entsprechendes Device anzulegen: <pre>define panStick panStamp /dev/ttyUSBx@38400</pre><br />
<br />
Dieses panStamp Device versucht dann als erstes alle panStamps im Netz zu finden und per autocreate anzulegen.<br />
<br />
=== SWAP ===<br />
[[Datei:SWAP_ 0000000100000005-detail.png|mini|hochkant=2.5|Readings]]<br />
Das SWAP Modul ermöglicht die generische Integration beliebiger panStamp Sensoren und Aktoren in FHEM. Mit Hilfe der im jeweiligen Device Description File hinterlegten Beschreibung werden hierzu automatisch userReadings angelegt die neben den reinen Registerwerten in hex auch 'menschenlesbare' readings der Sensorwerte erzeugen. Damit dies funktioniert, muss das Attribut ProductCode korrekt gesetzt sein. Das geschieht normalerweise automatisch beim Anlegen des Device.<br />
<br />
Hier Beispielhaft anhand eines BMP085 Temperatur- und Luftdrucksensors dargestellt:<br />
<br />
:<code>attr temppress userReadings voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, temperature:0C.0-Temperature {hex(ReadingsVal($name,"0C.0-Temperature","0"))*0.1-50}, pressure:0C.1-Pressure {hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01}, pressureNN:0C.1-Pressure {sprintf("%.2f",hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01 + AttrVal("global", "altitude", 0)/8.5)}</code><br />
<br />
[[Datei:SWAP_ 0000000100000005.png|mini|hochkant=2.5|Resultat eines stateFormat]]<br />
Aus diesen readings kann dann mit stateFormat die gewünschte Darstellung für die Raumübersicht erzeugt werden:<br />
<br />
:<code>attr temppress stateFormat {sprintf("%.1f",ReadingsVal($name,"temperature",0))."°C ".sprintf("%.1f",ReadingsVal($name,"pressureNN",0))."mbar"}</code><br />
<br />
<br />
Sobald ein SWAP Device mit dem productCode korrekt angelegt wurde, können die Userregister bzw. alle Register aufgelistet werden: <br />
get <device> regList<br />
get <device> regListALL<br />
<br />
und einzelne Register abgefragt und gesetzt werden:<br />
set <device> regGet <ID><br />
set <device> regSet <ID> <value><br />
Für die Systemregister kann hierzu statt der RegisterID auch der Registername (siehe regListAll) verwendet werden.<br />
<br />
==== Neue panStamps in Betrieb nehmen ====<br />
'''Info: Das SWAP Modul unterstützt autocreate. Bei der Inbetriebnahme ist autocreate zu aktivieren!'''<br />
<br />
Neue panStamps sollten nur Einer nach dem Anderen in Betrieb genommen werden, da sie zuerst mit einer eindeutigen Device-Adresse (ungleich FF und grösser 01) versehen werden müssen. Bei batteriebetriebenen Sensoren sollte auch das Sendeintervall auf einen sinnvollen Wert gesetzt werden:<br />
set <device> regSet 09 <device adresse als 2 stellige hex zahl><br />
set <device> regSet 0A <intervall in sekunden als 4 stellige hex zahl><br />
Für Devices im Power-Down-Modus werden diese Kommandos in eine Warteschlange gestellt und übertragen, sobald das Device seine Initialisierungssequenz durchläuft. Hierzu ist nach Absetzen der Kommandos Reset zu drücken oder die Stromquelle erneut zu verbinden.<br />
<br />
Das SWAP modul versucht, ein Device mit der default Adresse <code>FF</code> automatisch auf die erste freie Adresse im Bereich <code>F0</code>-<code>FE</code> zu ändern.<br />
<br />
Für batteriebetriebene Devices (genauer: Devices die den Power-Down-Modus unterstützen) wird das Default Sendeintervall von <code>FFFF</code> zu <code>0384</code> (900 Sekunden) geändert.<br />
Es gibt mit bestimmten panstamp lib Versionen das Problem das ein wert von FFFF in 0A zum Überlauf führt und dann ununterbrochen gesendet wird. Im fhem Modul wird versucht das abzufangen. Das funktioniert auf manchen langsamen host systemen (z.B. FritzBox) nicht, weil der panstamp so schnell sendet das fhem so mit dem abarbeiten beschäftigt ist das es selber nicht zum senden kommt.<br />
Zur Abhilfe kann im sketch in setup() ganz am Anfang ein<br />
EEPROM.write(EEPROM_TX_INTERVAL, 0x55);<br />
EEPROM.write(EEPROM_TX_INTERVAL+1, 0x55);<br />
eingefügt werden und noch mal flashen. Wenn der Sketch damit ein mal durchgelaufen ist können diese beiden Zeilen wieder entfernen und der panstamp noch mal geflasht.<br />
<br />
Automatisch gesetzte Werte sollten danach manuell auf die jeweilige Installation angepasst werden.<br />
<br />
==== Beispiele ====<br />
===== Bodenfeuchte =====<br />
Der panStamp soilmoisture Sketch aus dem examples Verzeichnis ist mit dem Standard SWAP Modul kompatibel. <br />
<br />
Eine für einen Vegetronix sensor angepasste Version kann von [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge] heruntergeladen werden. Das Übertragungsintervall ist wie üblich über das regsiter 0A konfigurierbar. Der Sensor wird and GND, D7 für die Versorgungsspannung und A4 für den Messwert angeschlossen. Erfahrungen haben gezeigt, dass bei einem fünfminütigen Übertragungsintervall nach 12 Monaten Laufzeit die Batteriespannung von 1.55V auf 1.4V abfällt. Das würde bedeuten, dass eine Batterie im Batterieboard mindestens eine Laufzeit von drei Jahren haben sollte.<br />
<br />
set <MyBodenfeuchte> stateFormat VWC_A%<br />
set <MyBodenfeuchte> userReadings Level0_Voltage {hex(ReadingsVal($name,"0C.0-Moisture_level_0","0"))*(3.3/1024)}, <br />
VWC_A:0C.0-Moisture_level_0 {sprintf("%.0f",(11.6552 * (ReadingsVal($name,"Level0_Voltage","0"))**4 + 7.10835 * <br />
(ReadingsVal($name,"Level0_Voltage","0"))**2 - 0.569557) / ((ReadingsVal($name,"Level0_Voltage","0"))**2 + 1))}, <br />
voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, <br />
battery:0B-Voltage {(ReadingsVal($name,"voltage","0")<1?"low":"ok")}<br />
<br />
[[Datei:SWAP_ soilmositure-plot.jpg|mini|x100px|Bodenfeuchte]]<br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix1.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix2.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<br />
Mit einem entsprechend erweiterten Sketch lassen sich auch mehrere Sensoren an einem panStamp auslesen.<br />
<br />
Die folgenden Bilder zeigen eine Panstamp/Vegetronix Außeneinheit im IP65-Gehäuse. Dieser Aufbau wird ganzjährig den Witterungseinflüssen ausgesetzt. Die auf den Stab aufgesetzte Antenne muss nicht verwendet werden, bei kürzeren Funkstrecken ist eine innenliegende Drahtantenne ausreichend. Bitte in FHEM den RSSI- und LQI-Wert sowie die Gleichmäßigkeit des Empfangens der 5 Minuten Sendeintervalle dementsprechend beobachten.<br />
<br />
=== SWAP_XXXXXXXXXXXXXXXX ===<br />
Besonders bei Aktoren ist oft eine engere FHEM-Integration sinnvoll, um FHEM Konzepte wie on/off/on-for-timer direkt abzubilden und nicht mehr nur auf die Registerebene und regSet und regGet Kommandos beschränkt zu sein.<br />
<br />
Um per autocreate automatisch das passende Modul laden zu können, müssen diese Module nach dem Schema SWAP_XXXXXXXXXXXXXXXX.pm benannt sein wobei XXXXXXXXXXXXXXXX für den jeweiligen productCode steht.<br />
<br />
==== SWAP_0000002200000003 ====<br />
[[Datei:SWAP_0000002200000003.png|mini|rechts|hochkant=2.5|RGB LED Driver Board]]<br />
Ein FHEM Modul für das modifizierte panStamp RGB LED Driver Board. <br />
<br />
Das Board unterstützt RGBW LEDs und lässt sich per Infrarot Fernbedienung, DMX Controller (z.&nbsp;B. als Unterputz Touchpanel) und FHEM bedienen.<br />
<br />
Der Funktionsumfang wird in diesem [http://forum.fhem.de/index.php/topic,12487.msg81923.html#msg81923 Forenthread] vorgestellt. Die Hardware für das Board wird [http://forum.fhem.de/index.php/topic,13890.0.html hier] im FHEM Forum vorgestellt und ein Prototyp ist [http://forum.fhem.de/index.php/topic,12487.msg85777.html#msg85777 hier] zu sehen.<br />
=====Upate 2014-01-11===== <br />
Zur Zeit ist Version 2 des Boards in Vorbereiteung. Die Projektseite zur Hardware findet sich [http://itse.homeip.net/projekte/12/6/ hier]. <br />
<br />
Demnächst wird eine aktualisiert Version des Fhem Moduls und panStamp Sketches eingecheckt. Eine Übersicht über die dann vorhandene Funktionalität:<br />
<br />
was geht:<br />
* bis zu vier led kanäle (je nach kombination von ir und soft pwm)<br />
* ir senden<br />
* ir empfangen<br />
* messen ob die led versorgung an ist<br />
* helligkeit eines an A2 angeschlossenen helligkeits sensors<br />
* konfiguration der dmx basis adresse über das swap register 0x12<br />
* optional soft on auf letzten wert<br />
* alles was auch vorher schon ging: dimmen, faden, ir fernbedienungen anlernen, ...<br />
<br />
wichtig zu wissen:<br />
* wenn ir aktiv ist und kein soft pwm lässt sich der 4. kanal nur ein und aus schalten<br />
* wenn ir aktiv ist muss soft pwm aktiv sein um den 4. kanäle auch zu dimmen<br />
* es wird nur ein zusätzlicher kanal tatsächlich schon unterstützt. der fünfte kommt noch<br />
* bei ir senden sind nur die aufrufe für sony und nec tatsächlich eingebaut. die anderen sind aber einfach zu ergänzen<br />
* beim ir senden sind noch keine Wiederholungen eingebaut. die müssen laut protokoll aber eigentlich sein<br />
<br />
was noch kommt:<br />
* besseres soft pwm<br />
* mehr konfiguration bezüglich default verhalten. ramp zeiten, delays, ...<br />
* hsv farb modell um besser zu faden und vor allem um den weiss anteil automatisch auf die weiss leds zu legen<br />
* die virtuellen channel <br />
* fhem kompatibles ir senden<br />
* sofortiges senden von helligkeit und led spannung bei änderung<br />
* andere ir lib mit sehr viel besserer geräte unterstützung<br />
<br />
wie gehabt muss alles über config.h konfiguriert werden.<br />
<br />
<br />
===== weitrere Screenshots =====<br />
<gallery><br />
File:SWAP_0000002200000003-internal.png|InternalValues<br />
File:SWAP_0000002200000003-readings.png|Readings<br />
File:SWAP_0000002200000003-attributes.png|Attributes<br />
</gallery><br />
<br />
== Arduino Sketches ==<br />
Zum Flashen der Panstamps wird die Arduino IDE benötigt. Eine Installationsanleitung ist unter folgendem Link zu finden:<br />
:https://code.google.com/p/panstamp/wiki/firststeps<br />
<br />
Für den RGB-Driver sketch sind je nach gewünschtem Funktionsumfang noch folgende libs zu installieren:<br />
<br />
* IR lib - https://github.com/shirriff/Arduino-IRremote<br />
* DMX lib- http://www.mathertel.de/Arduino/DMXSerial.aspx<br />
<br />
Die Librarys sollten entweder mit dem entsprechenden Menüpunkt in die IDE integriert werden oder jeweils nach auspacken des zip files als als kompletten Ordner im Arduino libraries verzeichnis abgelegt werden (siehe [http://www.arduino.cc/en/Hacking/Libraries)]).<br />
<br />
Die aktuelle Version des RGB-Driver Sketches findet sich auf [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge].<br />
<br />
Dieser muss in Arduino\libraries\panstamp\examples\sketches entpackt und die rbgdriver.ino gestartet werden. In der Arduino IDE sollte unter Tools->Board "Arduino Pro or Pro Mini (3.3V, 8MHz) w/ Atmega328" eingestellt sein. Wenn man das boards.txt file von [http://code.google.com/p/panstamp/downloads/detail?name=boards.txt&can=2&q= hier] installiert kann man in der IDE auch direkt PanStamp als Plattform auswählen.<br />
<br />
Welche Features der sketch bietet lässt sich im config.h file durch ein- oder auskommentieren der #define ENABLE_... Zeilen festlegen.<br />
<br />
<br />
'''Besonderheiten bei der Nutzung einiger Funktionen'''<br />
<br />
<br />
* #define ENABLE_DMX<br />
<br />
Hierbei ist darauf zu achten, dass in der DMX-Lib in der Datei DMXSerial.h die Zeile<br />
<br />
<nowiki>#define DmxModePin 2 // Arduino pin 2 for controlling the data direction</nowiki><br />
<br />
in <br />
<br />
<nowiki>#define DmxModePin 7 // Arduino pin 7 for controlling the data direction</nowiki><br />
<br />
abgeändert werden muss.<br />
<br />
<br />
<br />
* #define HAS_SENSOR (ermöglicht die Nutzung eines DHT22 Sensors zur Auswerung von Temperatur und Luftfeuchtigkeit)<br />
<br />
USE_SOFT_PWM;<br />
ENABLE_IR_SEND;<br />
ENABLE_REPEATER;<br />
<br />
sollte hierfür auskommentiert sein.<br />
<br />
In der IRremote.cpp Datei in der Irremote Library muss die Zeile<br />
<br />
void IRrecv::disableIRIn() <br />
{<br />
TIMER_DISABLE_INTR;<br />
}<br />
<br />
sowie die Irremote.h Datei unter Public: um die Zeile <br />
<br />
void disableIRIn();<br />
<br />
erweitert werden.<br />
<br />
Der Daten-Pin des DHT22 Sensors muss hierfür an A2 des Panstamps angeschlossen werden.<br />
<br />
== Weblinks ==<br />
* [http://www.panstamp.com/home panStamp] panStamp Hersteller<br />
* [http://itse.homeip.net/projekte/12/6/ Projektseite] für das RGB-Multi-Board.<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ rgbdriver sketch] auf sourceforge<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ soilmoisture sketch] auf sourceforge<br />
<br />
[[Kategorie:Interfaces]]<br />
[[Kategorie:Other Components]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=PanStamp&diff=6808PanStamp2014-07-09T19:19:27Z<p>Fidel: /* Arduino Sketches */</p>
<hr />
<div>{{Baustelle}}<br />
{{SEITENTITEL:panStamp}}<br />
<br />
{{Infobox Hardware<br />
|Bild=panStamp.jpg<br />
|Bildbeschreibung=panStamp<br />
|HWProtocol=SWAP<br />
|HWType=Sender, Empfänger, Sensor, [[Interface]]<br />
|HWCategory=<br />
|HWComm=868MHz (433/915MHz)<br />
|HWChannels=<br />
|HWVoltage=3.3V (panStick: 5V USB)<br />
|HWPowerConsumption=<br />
|HWPoweredBy=Battery (panStick: USB)<br />
|HWSize=17.7 x 30.5 mm<br />
|HWDeviceFHEM=[http://fhem.de/commandref.html#panStamp 35_panStamp.pm] [http://fhem.de/commandref.html#SWAP 35_SWAP.pm]<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=430 Andre / justme1968]<br />
|HWManufacturer=panStamp<br />
}}<br />
<br />
<br />
[http://www.panstamp.com/home PanStamps] sind [[Arduino]] Clones, die ein CC1101 Funkmodul beinhalten. Mit ihnen lassen sich Sensoren und Aktoren drahtlos an FHEM anbinden. Sie lassen sich genau wie Arduinos über die Ardunio IDE oder mit dem ino Kommandozeilen Binary programmieren.<br />
<br />
Der panStamp Software Stack unterstützt einen stromsparenden Power-Down- oder Sleep-Modus für batteriebetriebene Sensoren, aus dem diese dann nur zur eigentlichen Messung und Übertragung "aufwachen".<br />
<br />
Zur Kommunikation in einem panStamp Netzwerk dient das ''Simple Wireless Abstract Protocol'' ([http://code.google.com/p/panstamp/wiki/SWAP SWAP]).<br />
<br />
Um einen panStamp in Betrieb zu nehmen muss er unbedingt mit einer Antenne oder einem stück Draht in der [https://code.google.com/p/panstamp/wiki/antennalengths richtigen Länge] bestückt sein. Ohne Antenne funktioniert die Übertragung nicht. Auch nicht auf kurze Distanzen.<br />
<br />
== Simple Wireless Abstract Protocol (SWAP) ==<br />
Die komplette SWAP- Kommunikation ist registerbasiert und erfolgt mit Nachrichten um diese Register abzufragen, zu setzen und deren Inhalt zu senden. Alle Register lassen sich lesen, manche auch beschreiben.<br />
<br />
Jeder panStamp stellt elf Systemregister (00-0A) [http://code.google.com/p/panstamp/wiki/SWAPregisters] und beliebig viele sketchabängige Userregister (0B-)bereit. Die Beschreibung der jeweils von einem Sketch bereitgestellten Userregister erfolgt in ''Device Description Files'', die in .../FHEM/lib/SWAP zu finden sind. Die Identifikation der Art eines panStamp und die Zuordnung zu einem bestimmten Device Description File erfolgt über den productCode der aus ''Hersteller''- und ''Produkt''-Id gebildet wird.<br />
<br />
In den Systemregistern steht z.&nbsp;B. der productCode, die Deviceadresse und das Übertragungsintervall. Konfigurierbare Register werden im EEPROM gesichert, so dass die Werte auch bei einem Neustart nicht verlorengehen. Beim ersten Starten eines panStamp ist das EEPROM mit FF initialisiert und alle konfigurierbaren Register haben diesen Wert, also z.&nbsp;B. die Adresse FF und das Intervall FFFF (zwischen 18 und 19 Stunden).<br />
<br />
Die Systemregister werden in der Device Detailansicht bei den InternalValues im oberen Bereich angezeigt und die User-Register als reading im unteren Bereich.<br />
<br />
Jeder panStamp durchläuft beim Start eine definierte Einschaltsequenz und überträgt als erstes seinen productCode. Batteriebetriebene panStamps warten anschließend drei Sekunden auf Konfigurationskommandos. Danach werden bestimmte Systemregister und aktuelle Messwerte gesendet.<br />
<br />
== FHEM Integration ==<br />
Die Integration in FHEM erfolgt über eine reihe von Modulen die im folgenden genauer beschrieben werden.<br />
=== panStamp ===<br />
Als Schnittstelle zwischen FHEM und einem panStamp Netzwerk dient entweder ein panStick (USB Stick mit aufgestecktem panStamp) oder ein panStamp Shield mit integriertem panStamp an einem Raspberry PI. Der so angebundene panStamp wird mit einem Modem-Sketch als RF Modem verwenden und über das FHEM Modul panStamp angesprochen. Hierzu ist in FHEM ein entsprechendes Device anzulegen: <pre>define panStick panStamp /dev/ttyUSBx@38400</pre><br />
<br />
Dieses panStamp Device versucht dann als erstes alle panStamps im Netz zu finden und per autocreate anzulegen.<br />
<br />
=== SWAP ===<br />
[[Datei:SWAP_ 0000000100000005-detail.png|mini|hochkant=2.5|Readings]]<br />
Das SWAP Modul ermöglicht die generische Integration beliebiger panStamp Sensoren und Aktoren in FHEM. Mit Hilfe der im jeweiligen Device Description File hinterlegten Beschreibung werden hierzu automatisch userReadings angelegt die neben den reinen Registerwerten in hex auch 'menschenlesbare' readings der Sensorwerte erzeugen. Damit dies funktioniert, muss das Attribut ProductCode korrekt gesetzt sein. Das geschieht normalerweise automatisch beim Anlegen des Device.<br />
<br />
Hier Beispielhaft anhand eines BMP085 Temperatur- und Luftdrucksensors dargestellt:<br />
<br />
:<code>attr temppress userReadings voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, temperature:0C.0-Temperature {hex(ReadingsVal($name,"0C.0-Temperature","0"))*0.1-50}, pressure:0C.1-Pressure {hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01}, pressureNN:0C.1-Pressure {sprintf("%.2f",hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01 + AttrVal("global", "altitude", 0)/8.5)}</code><br />
<br />
[[Datei:SWAP_ 0000000100000005.png|mini|hochkant=2.5|Resultat eines stateFormat]]<br />
Aus diesen readings kann dann mit stateFormat die gewünschte Darstellung für die Raumübersicht erzeugt werden:<br />
<br />
:<code>attr temppress stateFormat {sprintf("%.1f",ReadingsVal($name,"temperature",0))."°C ".sprintf("%.1f",ReadingsVal($name,"pressureNN",0))."mbar"}</code><br />
<br />
<br />
Sobald ein SWAP Device mit dem productCode korrekt angelegt wurde, können die Userregister bzw. alle Register aufgelistet werden: <br />
get <device> regList<br />
get <device> regListALL<br />
<br />
und einzelne Register abgefragt und gesetzt werden:<br />
set <device> regGet <ID><br />
set <device> regSet <ID> <value><br />
Für die Systemregister kann hierzu statt der RegisterID auch der Registername (siehe regListAll) verwendet werden.<br />
<br />
==== Neue panStamps in Betrieb nehmen ====<br />
'''Info: Das SWAP Modul unterstützt autocreate. Bei der Inbetriebnahme ist autocreate zu aktivieren!'''<br />
<br />
Neue panStamps sollten nur Einer nach dem Anderen in Betrieb genommen werden, da sie zuerst mit einer eindeutigen Device-Adresse (ungleich FF und grösser 01) versehen werden müssen. Bei batteriebetriebenen Sensoren sollte auch das Sendeintervall auf einen sinnvollen Wert gesetzt werden:<br />
set <device> regSet 09 <device adresse als 2 stellige hex zahl><br />
set <device> regSet 0A <intervall in sekunden als 4 stellige hex zahl><br />
Für Devices im Power-Down-Modus werden diese Kommandos in eine Warteschlange gestellt und übertragen, sobald das Device seine Initialisierungssequenz durchläuft. Hierzu ist nach Absetzen der Kommandos Reset zu drücken oder die Stromquelle erneut zu verbinden.<br />
<br />
Das SWAP modul versucht, ein Device mit der default Adresse <code>FF</code> automatisch auf die erste freie Adresse im Bereich <code>F0</code>-<code>FE</code> zu ändern.<br />
<br />
Für batteriebetriebene Devices (genauer: Devices die den Power-Down-Modus unterstützen) wird das Default Sendeintervall von <code>FFFF</code> zu <code>0384</code> (900 Sekunden) geändert.<br />
Es gibt mit bestimmten panstamp lib Versionen das Problem das ein wert von FFFF in 0A zum Überlauf führt und dann ununterbrochen gesendet wird. Im fhem Modul wird versucht das abzufangen. Das funktioniert auf manchen langsamen host systemen (z.B. FritzBox) nicht, weil der panstamp so schnell sendet das fhem so mit dem abarbeiten beschäftigt ist das es selber nicht zum senden kommt.<br />
Zur Abhilfe kann im sketch in setup() ganz am Anfang ein<br />
EEPROM.write(EEPROM_TX_INTERVAL, 0x55);<br />
EEPROM.write(EEPROM_TX_INTERVAL+1, 0x55);<br />
eingefügt werden und noch mal flashen. Wenn der Sketch damit ein mal durchgelaufen ist können diese beiden Zeilen wieder entfernen und der panstamp noch mal geflasht.<br />
<br />
Automatisch gesetzte Werte sollten danach manuell auf die jeweilige Installation angepasst werden.<br />
<br />
==== Beispiele ====<br />
===== Bodenfeuchte =====<br />
Der panStamp soilmoisture Sketch aus dem examples Verzeichnis ist mit dem Standard SWAP Modul kompatibel. <br />
<br />
Eine für einen Vegetronix sensor angepasste Version kann von [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge] heruntergeladen werden. Das Übertragungsintervall ist wie üblich über das regsiter 0A konfigurierbar. Der Sensor wird and GND, D7 für die Versorgungsspannung und A4 für den Messwert angeschlossen. Erfahrungen haben gezeigt, dass bei einem fünfminütigen Übertragungsintervall nach 12 Monaten Laufzeit die Batteriespannung von 1.55V auf 1.4V abfällt. Das würde bedeuten, dass eine Batterie im Batterieboard mindestens eine Laufzeit von drei Jahren haben sollte.<br />
<br />
set <MyBodenfeuchte> stateFormat VWC_A%<br />
set <MyBodenfeuchte> userReadings Level0_Voltage {hex(ReadingsVal($name,"0C.0-Moisture_level_0","0"))*(3.3/1024)}, <br />
VWC_A:0C.0-Moisture_level_0 {sprintf("%.0f",(11.6552 * (ReadingsVal($name,"Level0_Voltage","0"))**4 + 7.10835 * <br />
(ReadingsVal($name,"Level0_Voltage","0"))**2 - 0.569557) / ((ReadingsVal($name,"Level0_Voltage","0"))**2 + 1))}, <br />
voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, <br />
battery:0B-Voltage {(ReadingsVal($name,"voltage","0")<1?"low":"ok")}<br />
<br />
[[Datei:SWAP_ soilmositure-plot.jpg|mini|x100px|Bodenfeuchte]]<br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix1.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix2.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<br />
Mit einem entsprechend erweiterten Sketch lassen sich auch mehrere Sensoren an einem panStamp auslesen.<br />
<br />
Die folgenden Bilder zeigen eine Panstamp/Vegetronix Außeneinheit im IP65-Gehäuse. Dieser Aufbau wird ganzjährig den Witterungseinflüssen ausgesetzt. Die auf den Stab aufgesetzte Antenne muss nicht verwendet werden, bei kürzeren Funkstrecken ist eine innenliegende Drahtantenne ausreichend. Bitte in FHEM den RSSI- und LQI-Wert sowie die Gleichmäßigkeit des Empfangens der 5 Minuten Sendeintervalle dementsprechend beobachten.<br />
<br />
=== SWAP_XXXXXXXXXXXXXXXX ===<br />
Besonders bei Aktoren ist oft eine engere FHEM-Integration sinnvoll, um FHEM Konzepte wie on/off/on-for-timer direkt abzubilden und nicht mehr nur auf die Registerebene und regSet und regGet Kommandos beschränkt zu sein.<br />
<br />
Um per autocreate automatisch das passende Modul laden zu können, müssen diese Module nach dem Schema SWAP_XXXXXXXXXXXXXXXX.pm benannt sein wobei XXXXXXXXXXXXXXXX für den jeweiligen productCode steht.<br />
<br />
==== SWAP_0000002200000003 ====<br />
[[Datei:SWAP_0000002200000003.png|mini|rechts|hochkant=2.5|RGB LED Driver Board]]<br />
Ein FHEM Modul für das modifizierte panStamp RGB LED Driver Board. <br />
<br />
Das Board unterstützt RGBW LEDs und lässt sich per Infrarot Fernbedienung, DMX Controller (z.&nbsp;B. als Unterputz Touchpanel) und FHEM bedienen.<br />
<br />
Der Funktionsumfang wird in diesem [http://forum.fhem.de/index.php/topic,12487.msg81923.html#msg81923 Forenthread] vorgestellt. Die Hardware für das Board wird [http://forum.fhem.de/index.php/topic,13890.0.html hier] im FHEM Forum vorgestellt und ein Prototyp ist [http://forum.fhem.de/index.php/topic,12487.msg85777.html#msg85777 hier] zu sehen.<br />
=====Upate 2014-01-11===== <br />
Zur Zeit ist Version 2 des Boards in Vorbereiteung. Die Projektseite zur Hardware findet sich [http://itse.homeip.net/projekte/12/6/ hier]. <br />
<br />
Demnächst wird eine aktualisiert Version des Fhem Moduls und panStamp Sketches eingecheckt. Eine Übersicht über die dann vorhandene Funktionalität:<br />
<br />
was geht:<br />
* bis zu vier led kanäle (je nach kombination von ir und soft pwm)<br />
* ir senden<br />
* ir empfangen<br />
* messen ob die led versorgung an ist<br />
* helligkeit eines an A2 angeschlossenen helligkeits sensors<br />
* konfiguration der dmx basis adresse über das swap register 0x12<br />
* optional soft on auf letzten wert<br />
* alles was auch vorher schon ging: dimmen, faden, ir fernbedienungen anlernen, ...<br />
<br />
wichtig zu wissen:<br />
* wenn ir aktiv ist und kein soft pwm lässt sich der 4. kanal nur ein und aus schalten<br />
* wenn ir aktiv ist muss soft pwm aktiv sein um den 4. kanäle auch zu dimmen<br />
* es wird nur ein zusätzlicher kanal tatsächlich schon unterstützt. der fünfte kommt noch<br />
* bei ir senden sind nur die aufrufe für sony und nec tatsächlich eingebaut. die anderen sind aber einfach zu ergänzen<br />
* beim ir senden sind noch keine Wiederholungen eingebaut. die müssen laut protokoll aber eigentlich sein<br />
<br />
was noch kommt:<br />
* besseres soft pwm<br />
* mehr konfiguration bezüglich default verhalten. ramp zeiten, delays, ...<br />
* hsv farb modell um besser zu faden und vor allem um den weiss anteil automatisch auf die weiss leds zu legen<br />
* die virtuellen channel <br />
* fhem kompatibles ir senden<br />
* sofortiges senden von helligkeit und led spannung bei änderung<br />
* andere ir lib mit sehr viel besserer geräte unterstützung<br />
<br />
wie gehabt muss alles über config.h konfiguriert werden.<br />
<br />
<br />
===== weitrere Screenshots =====<br />
<gallery><br />
File:SWAP_0000002200000003-internal.png|InternalValues<br />
File:SWAP_0000002200000003-readings.png|Readings<br />
File:SWAP_0000002200000003-attributes.png|Attributes<br />
</gallery><br />
<br />
== Arduino Sketches ==<br />
Zum Flashen der Panstamps wird die Arduino IDE benötigt. Eine Installationsanleitung ist unter folgendem Link zu finden:<br />
:https://code.google.com/p/panstamp/wiki/firststeps<br />
<br />
Für den RGB-Driver sketch sind je nach gewünschtem Funktionsumfang noch folgende libs zu installieren:<br />
<br />
* IR lib - https://github.com/shirriff/Arduino-IRremote<br />
* DMX lib- http://www.mathertel.de/Arduino/DMXSerial.aspx<br />
<br />
Die Librarys sollten entweder mit dem entsprechenden Menüpunkt in die IDE integriert werden oder jeweils nach auspacken des zip files als als kompletten Ordner im Arduino libraries verzeichnis abgelegt werden (siehe [http://www.arduino.cc/en/Hacking/Libraries)]).<br />
<br />
Die aktuelle Version des RGB-Driver Sketches findet sich auf [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge].<br />
<br />
Dieser muss in Arduino\libraries\panstamp\examples\sketches entpackt und die rbgdriver.ino gestartet werden. In der Arduino IDE sollte unter Tools->Board "Arduino Pro or Pro Mini (3.3V, 8MHz) w/ Atmega328" eingestellt sein. Wenn man das boards.txt file von [http://code.google.com/p/panstamp/downloads/detail?name=boards.txt&can=2&q= hier] installiert kann man in der IDE auch direkt PanStamp als Plattform auswählen.<br />
<br />
Welche Features der sketch bietet lässt sich im config.h file durch ein- oder auskommentieren der #define ENABLE_... Zeilen festlegen.<br />
<br />
<br />
'''Besonderheiten bei der Nutzung einiger Funktionen'''<br />
<br />
<br />
* #define ENABLE_DMX<br />
<br />
Hierbei ist darauf zu achten, dass in der DMX-Lib in der Datei DMXSerial.h die Zeile<br />
<nowiki>#define DmxModePin 2 // Arduino pin 2 for controlling the data direction</nowiki><br />
in <br />
<nowiki>#define DmxModePin 7 // Arduino pin 7 for controlling the data direction</nowiki><br />
abgeändert werden muss.<br />
<br />
<br />
<br />
* #define HAS_SENSOR (ermöglicht die Nutzung eines DHT22 Sensors zur Auswerung von Temperatur und Luftfeuchtigkeit)<br />
<br />
USE_SOFT_PWM;<br />
ENABLE_IR_SEND;<br />
ENABLE_REPEATER;<br />
<br />
sollte hierfür auskommentiert sein.<br />
<br />
In der IRremote.cpp Datei in der Irremote Library muss die Zeile<br />
<br />
void IRrecv::disableIRIn() <br />
{<br />
TIMER_DISABLE_INTR;<br />
}<br />
<br />
sowie die Irremote.h Datei unter Public: um die Zeile <br />
<br />
void disableIRIn();<br />
<br />
erweitert werden.<br />
<br />
Der Daten-Pin des DHT22 Sensors muss hierfür an A2 des Panstamps angeschlossen werden.<br />
<br />
== Weblinks ==<br />
* [http://www.panstamp.com/home panStamp] panStamp Hersteller<br />
* [http://itse.homeip.net/projekte/12/6/ Projektseite] für das RGB-Multi-Board.<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ rgbdriver sketch] auf sourceforge<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ soilmoisture sketch] auf sourceforge<br />
<br />
[[Kategorie:Interfaces]]<br />
[[Kategorie:Other Components]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=PanStamp&diff=6807PanStamp2014-07-09T19:18:31Z<p>Fidel: /* Arduino Sketches */</p>
<hr />
<div>{{Baustelle}}<br />
{{SEITENTITEL:panStamp}}<br />
<br />
{{Infobox Hardware<br />
|Bild=panStamp.jpg<br />
|Bildbeschreibung=panStamp<br />
|HWProtocol=SWAP<br />
|HWType=Sender, Empfänger, Sensor, [[Interface]]<br />
|HWCategory=<br />
|HWComm=868MHz (433/915MHz)<br />
|HWChannels=<br />
|HWVoltage=3.3V (panStick: 5V USB)<br />
|HWPowerConsumption=<br />
|HWPoweredBy=Battery (panStick: USB)<br />
|HWSize=17.7 x 30.5 mm<br />
|HWDeviceFHEM=[http://fhem.de/commandref.html#panStamp 35_panStamp.pm] [http://fhem.de/commandref.html#SWAP 35_SWAP.pm]<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=430 Andre / justme1968]<br />
|HWManufacturer=panStamp<br />
}}<br />
<br />
<br />
[http://www.panstamp.com/home PanStamps] sind [[Arduino]] Clones, die ein CC1101 Funkmodul beinhalten. Mit ihnen lassen sich Sensoren und Aktoren drahtlos an FHEM anbinden. Sie lassen sich genau wie Arduinos über die Ardunio IDE oder mit dem ino Kommandozeilen Binary programmieren.<br />
<br />
Der panStamp Software Stack unterstützt einen stromsparenden Power-Down- oder Sleep-Modus für batteriebetriebene Sensoren, aus dem diese dann nur zur eigentlichen Messung und Übertragung "aufwachen".<br />
<br />
Zur Kommunikation in einem panStamp Netzwerk dient das ''Simple Wireless Abstract Protocol'' ([http://code.google.com/p/panstamp/wiki/SWAP SWAP]).<br />
<br />
Um einen panStamp in Betrieb zu nehmen muss er unbedingt mit einer Antenne oder einem stück Draht in der [https://code.google.com/p/panstamp/wiki/antennalengths richtigen Länge] bestückt sein. Ohne Antenne funktioniert die Übertragung nicht. Auch nicht auf kurze Distanzen.<br />
<br />
== Simple Wireless Abstract Protocol (SWAP) ==<br />
Die komplette SWAP- Kommunikation ist registerbasiert und erfolgt mit Nachrichten um diese Register abzufragen, zu setzen und deren Inhalt zu senden. Alle Register lassen sich lesen, manche auch beschreiben.<br />
<br />
Jeder panStamp stellt elf Systemregister (00-0A) [http://code.google.com/p/panstamp/wiki/SWAPregisters] und beliebig viele sketchabängige Userregister (0B-)bereit. Die Beschreibung der jeweils von einem Sketch bereitgestellten Userregister erfolgt in ''Device Description Files'', die in .../FHEM/lib/SWAP zu finden sind. Die Identifikation der Art eines panStamp und die Zuordnung zu einem bestimmten Device Description File erfolgt über den productCode der aus ''Hersteller''- und ''Produkt''-Id gebildet wird.<br />
<br />
In den Systemregistern steht z.&nbsp;B. der productCode, die Deviceadresse und das Übertragungsintervall. Konfigurierbare Register werden im EEPROM gesichert, so dass die Werte auch bei einem Neustart nicht verlorengehen. Beim ersten Starten eines panStamp ist das EEPROM mit FF initialisiert und alle konfigurierbaren Register haben diesen Wert, also z.&nbsp;B. die Adresse FF und das Intervall FFFF (zwischen 18 und 19 Stunden).<br />
<br />
Die Systemregister werden in der Device Detailansicht bei den InternalValues im oberen Bereich angezeigt und die User-Register als reading im unteren Bereich.<br />
<br />
Jeder panStamp durchläuft beim Start eine definierte Einschaltsequenz und überträgt als erstes seinen productCode. Batteriebetriebene panStamps warten anschließend drei Sekunden auf Konfigurationskommandos. Danach werden bestimmte Systemregister und aktuelle Messwerte gesendet.<br />
<br />
== FHEM Integration ==<br />
Die Integration in FHEM erfolgt über eine reihe von Modulen die im folgenden genauer beschrieben werden.<br />
=== panStamp ===<br />
Als Schnittstelle zwischen FHEM und einem panStamp Netzwerk dient entweder ein panStick (USB Stick mit aufgestecktem panStamp) oder ein panStamp Shield mit integriertem panStamp an einem Raspberry PI. Der so angebundene panStamp wird mit einem Modem-Sketch als RF Modem verwenden und über das FHEM Modul panStamp angesprochen. Hierzu ist in FHEM ein entsprechendes Device anzulegen: <pre>define panStick panStamp /dev/ttyUSBx@38400</pre><br />
<br />
Dieses panStamp Device versucht dann als erstes alle panStamps im Netz zu finden und per autocreate anzulegen.<br />
<br />
=== SWAP ===<br />
[[Datei:SWAP_ 0000000100000005-detail.png|mini|hochkant=2.5|Readings]]<br />
Das SWAP Modul ermöglicht die generische Integration beliebiger panStamp Sensoren und Aktoren in FHEM. Mit Hilfe der im jeweiligen Device Description File hinterlegten Beschreibung werden hierzu automatisch userReadings angelegt die neben den reinen Registerwerten in hex auch 'menschenlesbare' readings der Sensorwerte erzeugen. Damit dies funktioniert, muss das Attribut ProductCode korrekt gesetzt sein. Das geschieht normalerweise automatisch beim Anlegen des Device.<br />
<br />
Hier Beispielhaft anhand eines BMP085 Temperatur- und Luftdrucksensors dargestellt:<br />
<br />
:<code>attr temppress userReadings voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, temperature:0C.0-Temperature {hex(ReadingsVal($name,"0C.0-Temperature","0"))*0.1-50}, pressure:0C.1-Pressure {hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01}, pressureNN:0C.1-Pressure {sprintf("%.2f",hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01 + AttrVal("global", "altitude", 0)/8.5)}</code><br />
<br />
[[Datei:SWAP_ 0000000100000005.png|mini|hochkant=2.5|Resultat eines stateFormat]]<br />
Aus diesen readings kann dann mit stateFormat die gewünschte Darstellung für die Raumübersicht erzeugt werden:<br />
<br />
:<code>attr temppress stateFormat {sprintf("%.1f",ReadingsVal($name,"temperature",0))."°C ".sprintf("%.1f",ReadingsVal($name,"pressureNN",0))."mbar"}</code><br />
<br />
<br />
Sobald ein SWAP Device mit dem productCode korrekt angelegt wurde, können die Userregister bzw. alle Register aufgelistet werden: <br />
get <device> regList<br />
get <device> regListALL<br />
<br />
und einzelne Register abgefragt und gesetzt werden:<br />
set <device> regGet <ID><br />
set <device> regSet <ID> <value><br />
Für die Systemregister kann hierzu statt der RegisterID auch der Registername (siehe regListAll) verwendet werden.<br />
<br />
==== Neue panStamps in Betrieb nehmen ====<br />
'''Info: Das SWAP Modul unterstützt autocreate. Bei der Inbetriebnahme ist autocreate zu aktivieren!'''<br />
<br />
Neue panStamps sollten nur Einer nach dem Anderen in Betrieb genommen werden, da sie zuerst mit einer eindeutigen Device-Adresse (ungleich FF und grösser 01) versehen werden müssen. Bei batteriebetriebenen Sensoren sollte auch das Sendeintervall auf einen sinnvollen Wert gesetzt werden:<br />
set <device> regSet 09 <device adresse als 2 stellige hex zahl><br />
set <device> regSet 0A <intervall in sekunden als 4 stellige hex zahl><br />
Für Devices im Power-Down-Modus werden diese Kommandos in eine Warteschlange gestellt und übertragen, sobald das Device seine Initialisierungssequenz durchläuft. Hierzu ist nach Absetzen der Kommandos Reset zu drücken oder die Stromquelle erneut zu verbinden.<br />
<br />
Das SWAP modul versucht, ein Device mit der default Adresse <code>FF</code> automatisch auf die erste freie Adresse im Bereich <code>F0</code>-<code>FE</code> zu ändern.<br />
<br />
Für batteriebetriebene Devices (genauer: Devices die den Power-Down-Modus unterstützen) wird das Default Sendeintervall von <code>FFFF</code> zu <code>0384</code> (900 Sekunden) geändert.<br />
Es gibt mit bestimmten panstamp lib Versionen das Problem das ein wert von FFFF in 0A zum Überlauf führt und dann ununterbrochen gesendet wird. Im fhem Modul wird versucht das abzufangen. Das funktioniert auf manchen langsamen host systemen (z.B. FritzBox) nicht, weil der panstamp so schnell sendet das fhem so mit dem abarbeiten beschäftigt ist das es selber nicht zum senden kommt.<br />
Zur Abhilfe kann im sketch in setup() ganz am Anfang ein<br />
EEPROM.write(EEPROM_TX_INTERVAL, 0x55);<br />
EEPROM.write(EEPROM_TX_INTERVAL+1, 0x55);<br />
eingefügt werden und noch mal flashen. Wenn der Sketch damit ein mal durchgelaufen ist können diese beiden Zeilen wieder entfernen und der panstamp noch mal geflasht.<br />
<br />
Automatisch gesetzte Werte sollten danach manuell auf die jeweilige Installation angepasst werden.<br />
<br />
==== Beispiele ====<br />
===== Bodenfeuchte =====<br />
Der panStamp soilmoisture Sketch aus dem examples Verzeichnis ist mit dem Standard SWAP Modul kompatibel. <br />
<br />
Eine für einen Vegetronix sensor angepasste Version kann von [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge] heruntergeladen werden. Das Übertragungsintervall ist wie üblich über das regsiter 0A konfigurierbar. Der Sensor wird and GND, D7 für die Versorgungsspannung und A4 für den Messwert angeschlossen. Erfahrungen haben gezeigt, dass bei einem fünfminütigen Übertragungsintervall nach 12 Monaten Laufzeit die Batteriespannung von 1.55V auf 1.4V abfällt. Das würde bedeuten, dass eine Batterie im Batterieboard mindestens eine Laufzeit von drei Jahren haben sollte.<br />
<br />
set <MyBodenfeuchte> stateFormat VWC_A%<br />
set <MyBodenfeuchte> userReadings Level0_Voltage {hex(ReadingsVal($name,"0C.0-Moisture_level_0","0"))*(3.3/1024)}, <br />
VWC_A:0C.0-Moisture_level_0 {sprintf("%.0f",(11.6552 * (ReadingsVal($name,"Level0_Voltage","0"))**4 + 7.10835 * <br />
(ReadingsVal($name,"Level0_Voltage","0"))**2 - 0.569557) / ((ReadingsVal($name,"Level0_Voltage","0"))**2 + 1))}, <br />
voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, <br />
battery:0B-Voltage {(ReadingsVal($name,"voltage","0")<1?"low":"ok")}<br />
<br />
[[Datei:SWAP_ soilmositure-plot.jpg|mini|x100px|Bodenfeuchte]]<br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix1.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix2.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<br />
Mit einem entsprechend erweiterten Sketch lassen sich auch mehrere Sensoren an einem panStamp auslesen.<br />
<br />
Die folgenden Bilder zeigen eine Panstamp/Vegetronix Außeneinheit im IP65-Gehäuse. Dieser Aufbau wird ganzjährig den Witterungseinflüssen ausgesetzt. Die auf den Stab aufgesetzte Antenne muss nicht verwendet werden, bei kürzeren Funkstrecken ist eine innenliegende Drahtantenne ausreichend. Bitte in FHEM den RSSI- und LQI-Wert sowie die Gleichmäßigkeit des Empfangens der 5 Minuten Sendeintervalle dementsprechend beobachten.<br />
<br />
=== SWAP_XXXXXXXXXXXXXXXX ===<br />
Besonders bei Aktoren ist oft eine engere FHEM-Integration sinnvoll, um FHEM Konzepte wie on/off/on-for-timer direkt abzubilden und nicht mehr nur auf die Registerebene und regSet und regGet Kommandos beschränkt zu sein.<br />
<br />
Um per autocreate automatisch das passende Modul laden zu können, müssen diese Module nach dem Schema SWAP_XXXXXXXXXXXXXXXX.pm benannt sein wobei XXXXXXXXXXXXXXXX für den jeweiligen productCode steht.<br />
<br />
==== SWAP_0000002200000003 ====<br />
[[Datei:SWAP_0000002200000003.png|mini|rechts|hochkant=2.5|RGB LED Driver Board]]<br />
Ein FHEM Modul für das modifizierte panStamp RGB LED Driver Board. <br />
<br />
Das Board unterstützt RGBW LEDs und lässt sich per Infrarot Fernbedienung, DMX Controller (z.&nbsp;B. als Unterputz Touchpanel) und FHEM bedienen.<br />
<br />
Der Funktionsumfang wird in diesem [http://forum.fhem.de/index.php/topic,12487.msg81923.html#msg81923 Forenthread] vorgestellt. Die Hardware für das Board wird [http://forum.fhem.de/index.php/topic,13890.0.html hier] im FHEM Forum vorgestellt und ein Prototyp ist [http://forum.fhem.de/index.php/topic,12487.msg85777.html#msg85777 hier] zu sehen.<br />
=====Upate 2014-01-11===== <br />
Zur Zeit ist Version 2 des Boards in Vorbereiteung. Die Projektseite zur Hardware findet sich [http://itse.homeip.net/projekte/12/6/ hier]. <br />
<br />
Demnächst wird eine aktualisiert Version des Fhem Moduls und panStamp Sketches eingecheckt. Eine Übersicht über die dann vorhandene Funktionalität:<br />
<br />
was geht:<br />
* bis zu vier led kanäle (je nach kombination von ir und soft pwm)<br />
* ir senden<br />
* ir empfangen<br />
* messen ob die led versorgung an ist<br />
* helligkeit eines an A2 angeschlossenen helligkeits sensors<br />
* konfiguration der dmx basis adresse über das swap register 0x12<br />
* optional soft on auf letzten wert<br />
* alles was auch vorher schon ging: dimmen, faden, ir fernbedienungen anlernen, ...<br />
<br />
wichtig zu wissen:<br />
* wenn ir aktiv ist und kein soft pwm lässt sich der 4. kanal nur ein und aus schalten<br />
* wenn ir aktiv ist muss soft pwm aktiv sein um den 4. kanäle auch zu dimmen<br />
* es wird nur ein zusätzlicher kanal tatsächlich schon unterstützt. der fünfte kommt noch<br />
* bei ir senden sind nur die aufrufe für sony und nec tatsächlich eingebaut. die anderen sind aber einfach zu ergänzen<br />
* beim ir senden sind noch keine Wiederholungen eingebaut. die müssen laut protokoll aber eigentlich sein<br />
<br />
was noch kommt:<br />
* besseres soft pwm<br />
* mehr konfiguration bezüglich default verhalten. ramp zeiten, delays, ...<br />
* hsv farb modell um besser zu faden und vor allem um den weiss anteil automatisch auf die weiss leds zu legen<br />
* die virtuellen channel <br />
* fhem kompatibles ir senden<br />
* sofortiges senden von helligkeit und led spannung bei änderung<br />
* andere ir lib mit sehr viel besserer geräte unterstützung<br />
<br />
wie gehabt muss alles über config.h konfiguriert werden.<br />
<br />
<br />
===== weitrere Screenshots =====<br />
<gallery><br />
File:SWAP_0000002200000003-internal.png|InternalValues<br />
File:SWAP_0000002200000003-readings.png|Readings<br />
File:SWAP_0000002200000003-attributes.png|Attributes<br />
</gallery><br />
<br />
== Arduino Sketches ==<br />
Zum Flashen der Panstamps wird die Arduino IDE benötigt. Eine Installationsanleitung ist unter folgendem Link zu finden:<br />
:https://code.google.com/p/panstamp/wiki/firststeps<br />
<br />
Für den RGB-Driver sketch sind je nach gewünschtem Funktionsumfang noch folgende libs zu installieren:<br />
<br />
* IR lib - https://github.com/shirriff/Arduino-IRremote<br />
* DMX lib- http://www.mathertel.de/Arduino/DMXSerial.aspx<br />
<br />
Die Librarys sollten entweder mit dem entsprechenden Menüpunkt in die IDE integriert werden oder jeweils nach auspacken des zip files als als kompletten Ordner im Arduino libraries verzeichnis abgelegt werden (siehe [http://www.arduino.cc/en/Hacking/Libraries)]).<br />
<br />
Die aktuelle Version des RGB-Driver Sketches findet sich auf [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge].<br />
<br />
Dieser muss in Arduino\libraries\panstamp\examples\sketches entpackt und die rbgdriver.ino gestartet werden. In der Arduino IDE sollte unter Tools->Board "Arduino Pro or Pro Mini (3.3V, 8MHz) w/ Atmega328" eingestellt sein. Wenn man das boards.txt file von [http://code.google.com/p/panstamp/downloads/detail?name=boards.txt&can=2&q= hier] installiert kann man in der IDE auch direkt PanStamp als Plattform auswählen.<br />
<br />
Welche Features der sketch bietet lässt sich im config.h file durch ein- oder auskommentieren der #define ENABLE_... Zeilen festlegen.<br />
<br />
<br />
'''Besonderheiten bei der Nutzung einiger Funktionen'''<br />
<br />
<br />
* #define ENABLE_DMX<br />
<br />
Hierbei ist darauf zu achten, dass in der DMX-Lib in der Datei DMXSerial.h die Zeile<br />
#define DmxModePin 2 // Arduino pin 2 for controlling the data direction<br />
in <br />
#define DmxModePin 7 // Arduino pin 7 for controlling the data direction<br />
abgeändert werden muss.<br />
<br />
<br />
<br />
* #define HAS_SENSOR (ermöglicht die Nutzung eines DHT22 Sensors zur Auswerung von Temperatur und Luftfeuchtigkeit)<br />
<br />
USE_SOFT_PWM;<br />
ENABLE_IR_SEND;<br />
ENABLE_REPEATER;<br />
<br />
sollte hierfür auskommentiert sein.<br />
<br />
In der IRremote.cpp Datei in der Irremote Library muss die Zeile<br />
<br />
void IRrecv::disableIRIn() <br />
{<br />
TIMER_DISABLE_INTR;<br />
}<br />
<br />
sowie die Irremote.h Datei unter Public: um die Zeile <br />
<br />
void disableIRIn();<br />
<br />
erweitert werden.<br />
<br />
Der Daten-Pin des DHT22 Sensors muss hierfür an A2 des Panstamps angeschlossen werden.<br />
<br />
== Weblinks ==<br />
* [http://www.panstamp.com/home panStamp] panStamp Hersteller<br />
* [http://itse.homeip.net/projekte/12/6/ Projektseite] für das RGB-Multi-Board.<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ rgbdriver sketch] auf sourceforge<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ soilmoisture sketch] auf sourceforge<br />
<br />
[[Kategorie:Interfaces]]<br />
[[Kategorie:Other Components]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=PanStamp&diff=6806PanStamp2014-07-09T19:17:29Z<p>Fidel: /* Arduino Sketches */</p>
<hr />
<div>{{Baustelle}}<br />
{{SEITENTITEL:panStamp}}<br />
<br />
{{Infobox Hardware<br />
|Bild=panStamp.jpg<br />
|Bildbeschreibung=panStamp<br />
|HWProtocol=SWAP<br />
|HWType=Sender, Empfänger, Sensor, [[Interface]]<br />
|HWCategory=<br />
|HWComm=868MHz (433/915MHz)<br />
|HWChannels=<br />
|HWVoltage=3.3V (panStick: 5V USB)<br />
|HWPowerConsumption=<br />
|HWPoweredBy=Battery (panStick: USB)<br />
|HWSize=17.7 x 30.5 mm<br />
|HWDeviceFHEM=[http://fhem.de/commandref.html#panStamp 35_panStamp.pm] [http://fhem.de/commandref.html#SWAP 35_SWAP.pm]<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=430 Andre / justme1968]<br />
|HWManufacturer=panStamp<br />
}}<br />
<br />
<br />
[http://www.panstamp.com/home PanStamps] sind [[Arduino]] Clones, die ein CC1101 Funkmodul beinhalten. Mit ihnen lassen sich Sensoren und Aktoren drahtlos an FHEM anbinden. Sie lassen sich genau wie Arduinos über die Ardunio IDE oder mit dem ino Kommandozeilen Binary programmieren.<br />
<br />
Der panStamp Software Stack unterstützt einen stromsparenden Power-Down- oder Sleep-Modus für batteriebetriebene Sensoren, aus dem diese dann nur zur eigentlichen Messung und Übertragung "aufwachen".<br />
<br />
Zur Kommunikation in einem panStamp Netzwerk dient das ''Simple Wireless Abstract Protocol'' ([http://code.google.com/p/panstamp/wiki/SWAP SWAP]).<br />
<br />
Um einen panStamp in Betrieb zu nehmen muss er unbedingt mit einer Antenne oder einem stück Draht in der [https://code.google.com/p/panstamp/wiki/antennalengths richtigen Länge] bestückt sein. Ohne Antenne funktioniert die Übertragung nicht. Auch nicht auf kurze Distanzen.<br />
<br />
== Simple Wireless Abstract Protocol (SWAP) ==<br />
Die komplette SWAP- Kommunikation ist registerbasiert und erfolgt mit Nachrichten um diese Register abzufragen, zu setzen und deren Inhalt zu senden. Alle Register lassen sich lesen, manche auch beschreiben.<br />
<br />
Jeder panStamp stellt elf Systemregister (00-0A) [http://code.google.com/p/panstamp/wiki/SWAPregisters] und beliebig viele sketchabängige Userregister (0B-)bereit. Die Beschreibung der jeweils von einem Sketch bereitgestellten Userregister erfolgt in ''Device Description Files'', die in .../FHEM/lib/SWAP zu finden sind. Die Identifikation der Art eines panStamp und die Zuordnung zu einem bestimmten Device Description File erfolgt über den productCode der aus ''Hersteller''- und ''Produkt''-Id gebildet wird.<br />
<br />
In den Systemregistern steht z.&nbsp;B. der productCode, die Deviceadresse und das Übertragungsintervall. Konfigurierbare Register werden im EEPROM gesichert, so dass die Werte auch bei einem Neustart nicht verlorengehen. Beim ersten Starten eines panStamp ist das EEPROM mit FF initialisiert und alle konfigurierbaren Register haben diesen Wert, also z.&nbsp;B. die Adresse FF und das Intervall FFFF (zwischen 18 und 19 Stunden).<br />
<br />
Die Systemregister werden in der Device Detailansicht bei den InternalValues im oberen Bereich angezeigt und die User-Register als reading im unteren Bereich.<br />
<br />
Jeder panStamp durchläuft beim Start eine definierte Einschaltsequenz und überträgt als erstes seinen productCode. Batteriebetriebene panStamps warten anschließend drei Sekunden auf Konfigurationskommandos. Danach werden bestimmte Systemregister und aktuelle Messwerte gesendet.<br />
<br />
== FHEM Integration ==<br />
Die Integration in FHEM erfolgt über eine reihe von Modulen die im folgenden genauer beschrieben werden.<br />
=== panStamp ===<br />
Als Schnittstelle zwischen FHEM und einem panStamp Netzwerk dient entweder ein panStick (USB Stick mit aufgestecktem panStamp) oder ein panStamp Shield mit integriertem panStamp an einem Raspberry PI. Der so angebundene panStamp wird mit einem Modem-Sketch als RF Modem verwenden und über das FHEM Modul panStamp angesprochen. Hierzu ist in FHEM ein entsprechendes Device anzulegen: <pre>define panStick panStamp /dev/ttyUSBx@38400</pre><br />
<br />
Dieses panStamp Device versucht dann als erstes alle panStamps im Netz zu finden und per autocreate anzulegen.<br />
<br />
=== SWAP ===<br />
[[Datei:SWAP_ 0000000100000005-detail.png|mini|hochkant=2.5|Readings]]<br />
Das SWAP Modul ermöglicht die generische Integration beliebiger panStamp Sensoren und Aktoren in FHEM. Mit Hilfe der im jeweiligen Device Description File hinterlegten Beschreibung werden hierzu automatisch userReadings angelegt die neben den reinen Registerwerten in hex auch 'menschenlesbare' readings der Sensorwerte erzeugen. Damit dies funktioniert, muss das Attribut ProductCode korrekt gesetzt sein. Das geschieht normalerweise automatisch beim Anlegen des Device.<br />
<br />
Hier Beispielhaft anhand eines BMP085 Temperatur- und Luftdrucksensors dargestellt:<br />
<br />
:<code>attr temppress userReadings voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, temperature:0C.0-Temperature {hex(ReadingsVal($name,"0C.0-Temperature","0"))*0.1-50}, pressure:0C.1-Pressure {hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01}, pressureNN:0C.1-Pressure {sprintf("%.2f",hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01 + AttrVal("global", "altitude", 0)/8.5)}</code><br />
<br />
[[Datei:SWAP_ 0000000100000005.png|mini|hochkant=2.5|Resultat eines stateFormat]]<br />
Aus diesen readings kann dann mit stateFormat die gewünschte Darstellung für die Raumübersicht erzeugt werden:<br />
<br />
:<code>attr temppress stateFormat {sprintf("%.1f",ReadingsVal($name,"temperature",0))."°C ".sprintf("%.1f",ReadingsVal($name,"pressureNN",0))."mbar"}</code><br />
<br />
<br />
Sobald ein SWAP Device mit dem productCode korrekt angelegt wurde, können die Userregister bzw. alle Register aufgelistet werden: <br />
get <device> regList<br />
get <device> regListALL<br />
<br />
und einzelne Register abgefragt und gesetzt werden:<br />
set <device> regGet <ID><br />
set <device> regSet <ID> <value><br />
Für die Systemregister kann hierzu statt der RegisterID auch der Registername (siehe regListAll) verwendet werden.<br />
<br />
==== Neue panStamps in Betrieb nehmen ====<br />
'''Info: Das SWAP Modul unterstützt autocreate. Bei der Inbetriebnahme ist autocreate zu aktivieren!'''<br />
<br />
Neue panStamps sollten nur Einer nach dem Anderen in Betrieb genommen werden, da sie zuerst mit einer eindeutigen Device-Adresse (ungleich FF und grösser 01) versehen werden müssen. Bei batteriebetriebenen Sensoren sollte auch das Sendeintervall auf einen sinnvollen Wert gesetzt werden:<br />
set <device> regSet 09 <device adresse als 2 stellige hex zahl><br />
set <device> regSet 0A <intervall in sekunden als 4 stellige hex zahl><br />
Für Devices im Power-Down-Modus werden diese Kommandos in eine Warteschlange gestellt und übertragen, sobald das Device seine Initialisierungssequenz durchläuft. Hierzu ist nach Absetzen der Kommandos Reset zu drücken oder die Stromquelle erneut zu verbinden.<br />
<br />
Das SWAP modul versucht, ein Device mit der default Adresse <code>FF</code> automatisch auf die erste freie Adresse im Bereich <code>F0</code>-<code>FE</code> zu ändern.<br />
<br />
Für batteriebetriebene Devices (genauer: Devices die den Power-Down-Modus unterstützen) wird das Default Sendeintervall von <code>FFFF</code> zu <code>0384</code> (900 Sekunden) geändert.<br />
Es gibt mit bestimmten panstamp lib Versionen das Problem das ein wert von FFFF in 0A zum Überlauf führt und dann ununterbrochen gesendet wird. Im fhem Modul wird versucht das abzufangen. Das funktioniert auf manchen langsamen host systemen (z.B. FritzBox) nicht, weil der panstamp so schnell sendet das fhem so mit dem abarbeiten beschäftigt ist das es selber nicht zum senden kommt.<br />
Zur Abhilfe kann im sketch in setup() ganz am Anfang ein<br />
EEPROM.write(EEPROM_TX_INTERVAL, 0x55);<br />
EEPROM.write(EEPROM_TX_INTERVAL+1, 0x55);<br />
eingefügt werden und noch mal flashen. Wenn der Sketch damit ein mal durchgelaufen ist können diese beiden Zeilen wieder entfernen und der panstamp noch mal geflasht.<br />
<br />
Automatisch gesetzte Werte sollten danach manuell auf die jeweilige Installation angepasst werden.<br />
<br />
==== Beispiele ====<br />
===== Bodenfeuchte =====<br />
Der panStamp soilmoisture Sketch aus dem examples Verzeichnis ist mit dem Standard SWAP Modul kompatibel. <br />
<br />
Eine für einen Vegetronix sensor angepasste Version kann von [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge] heruntergeladen werden. Das Übertragungsintervall ist wie üblich über das regsiter 0A konfigurierbar. Der Sensor wird and GND, D7 für die Versorgungsspannung und A4 für den Messwert angeschlossen. Erfahrungen haben gezeigt, dass bei einem fünfminütigen Übertragungsintervall nach 12 Monaten Laufzeit die Batteriespannung von 1.55V auf 1.4V abfällt. Das würde bedeuten, dass eine Batterie im Batterieboard mindestens eine Laufzeit von drei Jahren haben sollte.<br />
<br />
set <MyBodenfeuchte> stateFormat VWC_A%<br />
set <MyBodenfeuchte> userReadings Level0_Voltage {hex(ReadingsVal($name,"0C.0-Moisture_level_0","0"))*(3.3/1024)}, <br />
VWC_A:0C.0-Moisture_level_0 {sprintf("%.0f",(11.6552 * (ReadingsVal($name,"Level0_Voltage","0"))**4 + 7.10835 * <br />
(ReadingsVal($name,"Level0_Voltage","0"))**2 - 0.569557) / ((ReadingsVal($name,"Level0_Voltage","0"))**2 + 1))}, <br />
voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, <br />
battery:0B-Voltage {(ReadingsVal($name,"voltage","0")<1?"low":"ok")}<br />
<br />
[[Datei:SWAP_ soilmositure-plot.jpg|mini|x100px|Bodenfeuchte]]<br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix1.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix2.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<br />
Mit einem entsprechend erweiterten Sketch lassen sich auch mehrere Sensoren an einem panStamp auslesen.<br />
<br />
Die folgenden Bilder zeigen eine Panstamp/Vegetronix Außeneinheit im IP65-Gehäuse. Dieser Aufbau wird ganzjährig den Witterungseinflüssen ausgesetzt. Die auf den Stab aufgesetzte Antenne muss nicht verwendet werden, bei kürzeren Funkstrecken ist eine innenliegende Drahtantenne ausreichend. Bitte in FHEM den RSSI- und LQI-Wert sowie die Gleichmäßigkeit des Empfangens der 5 Minuten Sendeintervalle dementsprechend beobachten.<br />
<br />
=== SWAP_XXXXXXXXXXXXXXXX ===<br />
Besonders bei Aktoren ist oft eine engere FHEM-Integration sinnvoll, um FHEM Konzepte wie on/off/on-for-timer direkt abzubilden und nicht mehr nur auf die Registerebene und regSet und regGet Kommandos beschränkt zu sein.<br />
<br />
Um per autocreate automatisch das passende Modul laden zu können, müssen diese Module nach dem Schema SWAP_XXXXXXXXXXXXXXXX.pm benannt sein wobei XXXXXXXXXXXXXXXX für den jeweiligen productCode steht.<br />
<br />
==== SWAP_0000002200000003 ====<br />
[[Datei:SWAP_0000002200000003.png|mini|rechts|hochkant=2.5|RGB LED Driver Board]]<br />
Ein FHEM Modul für das modifizierte panStamp RGB LED Driver Board. <br />
<br />
Das Board unterstützt RGBW LEDs und lässt sich per Infrarot Fernbedienung, DMX Controller (z.&nbsp;B. als Unterputz Touchpanel) und FHEM bedienen.<br />
<br />
Der Funktionsumfang wird in diesem [http://forum.fhem.de/index.php/topic,12487.msg81923.html#msg81923 Forenthread] vorgestellt. Die Hardware für das Board wird [http://forum.fhem.de/index.php/topic,13890.0.html hier] im FHEM Forum vorgestellt und ein Prototyp ist [http://forum.fhem.de/index.php/topic,12487.msg85777.html#msg85777 hier] zu sehen.<br />
=====Upate 2014-01-11===== <br />
Zur Zeit ist Version 2 des Boards in Vorbereiteung. Die Projektseite zur Hardware findet sich [http://itse.homeip.net/projekte/12/6/ hier]. <br />
<br />
Demnächst wird eine aktualisiert Version des Fhem Moduls und panStamp Sketches eingecheckt. Eine Übersicht über die dann vorhandene Funktionalität:<br />
<br />
was geht:<br />
* bis zu vier led kanäle (je nach kombination von ir und soft pwm)<br />
* ir senden<br />
* ir empfangen<br />
* messen ob die led versorgung an ist<br />
* helligkeit eines an A2 angeschlossenen helligkeits sensors<br />
* konfiguration der dmx basis adresse über das swap register 0x12<br />
* optional soft on auf letzten wert<br />
* alles was auch vorher schon ging: dimmen, faden, ir fernbedienungen anlernen, ...<br />
<br />
wichtig zu wissen:<br />
* wenn ir aktiv ist und kein soft pwm lässt sich der 4. kanal nur ein und aus schalten<br />
* wenn ir aktiv ist muss soft pwm aktiv sein um den 4. kanäle auch zu dimmen<br />
* es wird nur ein zusätzlicher kanal tatsächlich schon unterstützt. der fünfte kommt noch<br />
* bei ir senden sind nur die aufrufe für sony und nec tatsächlich eingebaut. die anderen sind aber einfach zu ergänzen<br />
* beim ir senden sind noch keine Wiederholungen eingebaut. die müssen laut protokoll aber eigentlich sein<br />
<br />
was noch kommt:<br />
* besseres soft pwm<br />
* mehr konfiguration bezüglich default verhalten. ramp zeiten, delays, ...<br />
* hsv farb modell um besser zu faden und vor allem um den weiss anteil automatisch auf die weiss leds zu legen<br />
* die virtuellen channel <br />
* fhem kompatibles ir senden<br />
* sofortiges senden von helligkeit und led spannung bei änderung<br />
* andere ir lib mit sehr viel besserer geräte unterstützung<br />
<br />
wie gehabt muss alles über config.h konfiguriert werden.<br />
<br />
<br />
===== weitrere Screenshots =====<br />
<gallery><br />
File:SWAP_0000002200000003-internal.png|InternalValues<br />
File:SWAP_0000002200000003-readings.png|Readings<br />
File:SWAP_0000002200000003-attributes.png|Attributes<br />
</gallery><br />
<br />
== Arduino Sketches ==<br />
Zum Flashen der Panstamps wird die Arduino IDE benötigt. Eine Installationsanleitung ist unter folgendem Link zu finden:<br />
:https://code.google.com/p/panstamp/wiki/firststeps<br />
<br />
Für den RGB-Driver sketch sind je nach gewünschtem Funktionsumfang noch folgende libs zu installieren:<br />
<br />
* IR lib - https://github.com/shirriff/Arduino-IRremote<br />
* DMX lib- http://www.mathertel.de/Arduino/DMXSerial.aspx<br />
<br />
Die Librarys sollten entweder mit dem entsprechenden Menüpunkt in die IDE integriert werden oder jeweils nach auspacken des zip files als als kompletten Ordner im Arduino libraries verzeichnis abgelegt werden (siehe [http://www.arduino.cc/en/Hacking/Libraries)]).<br />
<br />
Die aktuelle Version des RGB-Driver Sketches findet sich auf [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge].<br />
<br />
Dieser muss in Arduino\libraries\panstamp\examples\sketches entpackt und die rbgdriver.ino gestartet werden. In der Arduino IDE sollte unter Tools->Board "Arduino Pro or Pro Mini (3.3V, 8MHz) w/ Atmega328" eingestellt sein. Wenn man das boards.txt file von [http://code.google.com/p/panstamp/downloads/detail?name=boards.txt&can=2&q= hier] installiert kann man in der IDE auch direkt PanStamp als Plattform auswählen.<br />
<br />
Welche Features der sketch bietet lässt sich im config.h file durch ein- oder auskommentieren der #define ENABLE_... Zeilen festlegen.<br />
<br />
<br />
'''Besonderheiten bei der Nutzung einiger Funktionen'''<br />
<br />
<br />
<nowiki>- #define ENABLE_DMX</nowiki><br />
<br />
Hierbei ist darauf zu achten, dass in der DMX-Lib in der Datei DMXSerial.h die Zeile<br />
* #define DmxModePin 2 // Arduino pin 2 for controlling the data direction<br />
in <br />
* #define DmxModePin 7 // Arduino pin 7 for controlling the data direction<br />
abgeändert werden muss.<br />
<br />
<br />
<br />
<nowiki>- #define HAS_SENSOR (ermöglicht die Nutzung eines DHT22 Sensors zur Auswerung von Temperatur und Luftfeuchtigkeit)</nowiki><br />
<br />
USE_SOFT_PWM;<br />
ENABLE_IR_SEND;<br />
ENABLE_REPEATER;<br />
<br />
sollte hierfür auskommentiert sein.<br />
<br />
In der IRremote.cpp Datei in der Irremote Library muss die Zeile<br />
<br />
void IRrecv::disableIRIn() <br />
{<br />
TIMER_DISABLE_INTR;<br />
}<br />
<br />
sowie die Irremote.h Datei unter Public: um die Zeile <br />
<br />
void disableIRIn();<br />
<br />
erweitert werden.<br />
<br />
Der Daten-Pin des DHT22 Sensors muss hierfür an A2 des Panstamps angeschlossen werden.<br />
<br />
== Weblinks ==<br />
* [http://www.panstamp.com/home panStamp] panStamp Hersteller<br />
* [http://itse.homeip.net/projekte/12/6/ Projektseite] für das RGB-Multi-Board.<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ rgbdriver sketch] auf sourceforge<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ soilmoisture sketch] auf sourceforge<br />
<br />
[[Kategorie:Interfaces]]<br />
[[Kategorie:Other Components]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=PanStamp&diff=6805PanStamp2014-07-09T19:15:40Z<p>Fidel: /* Arduino Sketches */</p>
<hr />
<div>{{Baustelle}}<br />
{{SEITENTITEL:panStamp}}<br />
<br />
{{Infobox Hardware<br />
|Bild=panStamp.jpg<br />
|Bildbeschreibung=panStamp<br />
|HWProtocol=SWAP<br />
|HWType=Sender, Empfänger, Sensor, [[Interface]]<br />
|HWCategory=<br />
|HWComm=868MHz (433/915MHz)<br />
|HWChannels=<br />
|HWVoltage=3.3V (panStick: 5V USB)<br />
|HWPowerConsumption=<br />
|HWPoweredBy=Battery (panStick: USB)<br />
|HWSize=17.7 x 30.5 mm<br />
|HWDeviceFHEM=[http://fhem.de/commandref.html#panStamp 35_panStamp.pm] [http://fhem.de/commandref.html#SWAP 35_SWAP.pm]<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=430 Andre / justme1968]<br />
|HWManufacturer=panStamp<br />
}}<br />
<br />
<br />
[http://www.panstamp.com/home PanStamps] sind [[Arduino]] Clones, die ein CC1101 Funkmodul beinhalten. Mit ihnen lassen sich Sensoren und Aktoren drahtlos an FHEM anbinden. Sie lassen sich genau wie Arduinos über die Ardunio IDE oder mit dem ino Kommandozeilen Binary programmieren.<br />
<br />
Der panStamp Software Stack unterstützt einen stromsparenden Power-Down- oder Sleep-Modus für batteriebetriebene Sensoren, aus dem diese dann nur zur eigentlichen Messung und Übertragung "aufwachen".<br />
<br />
Zur Kommunikation in einem panStamp Netzwerk dient das ''Simple Wireless Abstract Protocol'' ([http://code.google.com/p/panstamp/wiki/SWAP SWAP]).<br />
<br />
Um einen panStamp in Betrieb zu nehmen muss er unbedingt mit einer Antenne oder einem stück Draht in der [https://code.google.com/p/panstamp/wiki/antennalengths richtigen Länge] bestückt sein. Ohne Antenne funktioniert die Übertragung nicht. Auch nicht auf kurze Distanzen.<br />
<br />
== Simple Wireless Abstract Protocol (SWAP) ==<br />
Die komplette SWAP- Kommunikation ist registerbasiert und erfolgt mit Nachrichten um diese Register abzufragen, zu setzen und deren Inhalt zu senden. Alle Register lassen sich lesen, manche auch beschreiben.<br />
<br />
Jeder panStamp stellt elf Systemregister (00-0A) [http://code.google.com/p/panstamp/wiki/SWAPregisters] und beliebig viele sketchabängige Userregister (0B-)bereit. Die Beschreibung der jeweils von einem Sketch bereitgestellten Userregister erfolgt in ''Device Description Files'', die in .../FHEM/lib/SWAP zu finden sind. Die Identifikation der Art eines panStamp und die Zuordnung zu einem bestimmten Device Description File erfolgt über den productCode der aus ''Hersteller''- und ''Produkt''-Id gebildet wird.<br />
<br />
In den Systemregistern steht z.&nbsp;B. der productCode, die Deviceadresse und das Übertragungsintervall. Konfigurierbare Register werden im EEPROM gesichert, so dass die Werte auch bei einem Neustart nicht verlorengehen. Beim ersten Starten eines panStamp ist das EEPROM mit FF initialisiert und alle konfigurierbaren Register haben diesen Wert, also z.&nbsp;B. die Adresse FF und das Intervall FFFF (zwischen 18 und 19 Stunden).<br />
<br />
Die Systemregister werden in der Device Detailansicht bei den InternalValues im oberen Bereich angezeigt und die User-Register als reading im unteren Bereich.<br />
<br />
Jeder panStamp durchläuft beim Start eine definierte Einschaltsequenz und überträgt als erstes seinen productCode. Batteriebetriebene panStamps warten anschließend drei Sekunden auf Konfigurationskommandos. Danach werden bestimmte Systemregister und aktuelle Messwerte gesendet.<br />
<br />
== FHEM Integration ==<br />
Die Integration in FHEM erfolgt über eine reihe von Modulen die im folgenden genauer beschrieben werden.<br />
=== panStamp ===<br />
Als Schnittstelle zwischen FHEM und einem panStamp Netzwerk dient entweder ein panStick (USB Stick mit aufgestecktem panStamp) oder ein panStamp Shield mit integriertem panStamp an einem Raspberry PI. Der so angebundene panStamp wird mit einem Modem-Sketch als RF Modem verwenden und über das FHEM Modul panStamp angesprochen. Hierzu ist in FHEM ein entsprechendes Device anzulegen: <pre>define panStick panStamp /dev/ttyUSBx@38400</pre><br />
<br />
Dieses panStamp Device versucht dann als erstes alle panStamps im Netz zu finden und per autocreate anzulegen.<br />
<br />
=== SWAP ===<br />
[[Datei:SWAP_ 0000000100000005-detail.png|mini|hochkant=2.5|Readings]]<br />
Das SWAP Modul ermöglicht die generische Integration beliebiger panStamp Sensoren und Aktoren in FHEM. Mit Hilfe der im jeweiligen Device Description File hinterlegten Beschreibung werden hierzu automatisch userReadings angelegt die neben den reinen Registerwerten in hex auch 'menschenlesbare' readings der Sensorwerte erzeugen. Damit dies funktioniert, muss das Attribut ProductCode korrekt gesetzt sein. Das geschieht normalerweise automatisch beim Anlegen des Device.<br />
<br />
Hier Beispielhaft anhand eines BMP085 Temperatur- und Luftdrucksensors dargestellt:<br />
<br />
:<code>attr temppress userReadings voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, temperature:0C.0-Temperature {hex(ReadingsVal($name,"0C.0-Temperature","0"))*0.1-50}, pressure:0C.1-Pressure {hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01}, pressureNN:0C.1-Pressure {sprintf("%.2f",hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01 + AttrVal("global", "altitude", 0)/8.5)}</code><br />
<br />
[[Datei:SWAP_ 0000000100000005.png|mini|hochkant=2.5|Resultat eines stateFormat]]<br />
Aus diesen readings kann dann mit stateFormat die gewünschte Darstellung für die Raumübersicht erzeugt werden:<br />
<br />
:<code>attr temppress stateFormat {sprintf("%.1f",ReadingsVal($name,"temperature",0))."°C ".sprintf("%.1f",ReadingsVal($name,"pressureNN",0))."mbar"}</code><br />
<br />
<br />
Sobald ein SWAP Device mit dem productCode korrekt angelegt wurde, können die Userregister bzw. alle Register aufgelistet werden: <br />
get <device> regList<br />
get <device> regListALL<br />
<br />
und einzelne Register abgefragt und gesetzt werden:<br />
set <device> regGet <ID><br />
set <device> regSet <ID> <value><br />
Für die Systemregister kann hierzu statt der RegisterID auch der Registername (siehe regListAll) verwendet werden.<br />
<br />
==== Neue panStamps in Betrieb nehmen ====<br />
'''Info: Das SWAP Modul unterstützt autocreate. Bei der Inbetriebnahme ist autocreate zu aktivieren!'''<br />
<br />
Neue panStamps sollten nur Einer nach dem Anderen in Betrieb genommen werden, da sie zuerst mit einer eindeutigen Device-Adresse (ungleich FF und grösser 01) versehen werden müssen. Bei batteriebetriebenen Sensoren sollte auch das Sendeintervall auf einen sinnvollen Wert gesetzt werden:<br />
set <device> regSet 09 <device adresse als 2 stellige hex zahl><br />
set <device> regSet 0A <intervall in sekunden als 4 stellige hex zahl><br />
Für Devices im Power-Down-Modus werden diese Kommandos in eine Warteschlange gestellt und übertragen, sobald das Device seine Initialisierungssequenz durchläuft. Hierzu ist nach Absetzen der Kommandos Reset zu drücken oder die Stromquelle erneut zu verbinden.<br />
<br />
Das SWAP modul versucht, ein Device mit der default Adresse <code>FF</code> automatisch auf die erste freie Adresse im Bereich <code>F0</code>-<code>FE</code> zu ändern.<br />
<br />
Für batteriebetriebene Devices (genauer: Devices die den Power-Down-Modus unterstützen) wird das Default Sendeintervall von <code>FFFF</code> zu <code>0384</code> (900 Sekunden) geändert.<br />
Es gibt mit bestimmten panstamp lib Versionen das Problem das ein wert von FFFF in 0A zum Überlauf führt und dann ununterbrochen gesendet wird. Im fhem Modul wird versucht das abzufangen. Das funktioniert auf manchen langsamen host systemen (z.B. FritzBox) nicht, weil der panstamp so schnell sendet das fhem so mit dem abarbeiten beschäftigt ist das es selber nicht zum senden kommt.<br />
Zur Abhilfe kann im sketch in setup() ganz am Anfang ein<br />
EEPROM.write(EEPROM_TX_INTERVAL, 0x55);<br />
EEPROM.write(EEPROM_TX_INTERVAL+1, 0x55);<br />
eingefügt werden und noch mal flashen. Wenn der Sketch damit ein mal durchgelaufen ist können diese beiden Zeilen wieder entfernen und der panstamp noch mal geflasht.<br />
<br />
Automatisch gesetzte Werte sollten danach manuell auf die jeweilige Installation angepasst werden.<br />
<br />
==== Beispiele ====<br />
===== Bodenfeuchte =====<br />
Der panStamp soilmoisture Sketch aus dem examples Verzeichnis ist mit dem Standard SWAP Modul kompatibel. <br />
<br />
Eine für einen Vegetronix sensor angepasste Version kann von [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge] heruntergeladen werden. Das Übertragungsintervall ist wie üblich über das regsiter 0A konfigurierbar. Der Sensor wird and GND, D7 für die Versorgungsspannung und A4 für den Messwert angeschlossen. Erfahrungen haben gezeigt, dass bei einem fünfminütigen Übertragungsintervall nach 12 Monaten Laufzeit die Batteriespannung von 1.55V auf 1.4V abfällt. Das würde bedeuten, dass eine Batterie im Batterieboard mindestens eine Laufzeit von drei Jahren haben sollte.<br />
<br />
set <MyBodenfeuchte> stateFormat VWC_A%<br />
set <MyBodenfeuchte> userReadings Level0_Voltage {hex(ReadingsVal($name,"0C.0-Moisture_level_0","0"))*(3.3/1024)}, <br />
VWC_A:0C.0-Moisture_level_0 {sprintf("%.0f",(11.6552 * (ReadingsVal($name,"Level0_Voltage","0"))**4 + 7.10835 * <br />
(ReadingsVal($name,"Level0_Voltage","0"))**2 - 0.569557) / ((ReadingsVal($name,"Level0_Voltage","0"))**2 + 1))}, <br />
voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, <br />
battery:0B-Voltage {(ReadingsVal($name,"voltage","0")<1?"low":"ok")}<br />
<br />
[[Datei:SWAP_ soilmositure-plot.jpg|mini|x100px|Bodenfeuchte]]<br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix1.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix2.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<br />
Mit einem entsprechend erweiterten Sketch lassen sich auch mehrere Sensoren an einem panStamp auslesen.<br />
<br />
Die folgenden Bilder zeigen eine Panstamp/Vegetronix Außeneinheit im IP65-Gehäuse. Dieser Aufbau wird ganzjährig den Witterungseinflüssen ausgesetzt. Die auf den Stab aufgesetzte Antenne muss nicht verwendet werden, bei kürzeren Funkstrecken ist eine innenliegende Drahtantenne ausreichend. Bitte in FHEM den RSSI- und LQI-Wert sowie die Gleichmäßigkeit des Empfangens der 5 Minuten Sendeintervalle dementsprechend beobachten.<br />
<br />
=== SWAP_XXXXXXXXXXXXXXXX ===<br />
Besonders bei Aktoren ist oft eine engere FHEM-Integration sinnvoll, um FHEM Konzepte wie on/off/on-for-timer direkt abzubilden und nicht mehr nur auf die Registerebene und regSet und regGet Kommandos beschränkt zu sein.<br />
<br />
Um per autocreate automatisch das passende Modul laden zu können, müssen diese Module nach dem Schema SWAP_XXXXXXXXXXXXXXXX.pm benannt sein wobei XXXXXXXXXXXXXXXX für den jeweiligen productCode steht.<br />
<br />
==== SWAP_0000002200000003 ====<br />
[[Datei:SWAP_0000002200000003.png|mini|rechts|hochkant=2.5|RGB LED Driver Board]]<br />
Ein FHEM Modul für das modifizierte panStamp RGB LED Driver Board. <br />
<br />
Das Board unterstützt RGBW LEDs und lässt sich per Infrarot Fernbedienung, DMX Controller (z.&nbsp;B. als Unterputz Touchpanel) und FHEM bedienen.<br />
<br />
Der Funktionsumfang wird in diesem [http://forum.fhem.de/index.php/topic,12487.msg81923.html#msg81923 Forenthread] vorgestellt. Die Hardware für das Board wird [http://forum.fhem.de/index.php/topic,13890.0.html hier] im FHEM Forum vorgestellt und ein Prototyp ist [http://forum.fhem.de/index.php/topic,12487.msg85777.html#msg85777 hier] zu sehen.<br />
=====Upate 2014-01-11===== <br />
Zur Zeit ist Version 2 des Boards in Vorbereiteung. Die Projektseite zur Hardware findet sich [http://itse.homeip.net/projekte/12/6/ hier]. <br />
<br />
Demnächst wird eine aktualisiert Version des Fhem Moduls und panStamp Sketches eingecheckt. Eine Übersicht über die dann vorhandene Funktionalität:<br />
<br />
was geht:<br />
* bis zu vier led kanäle (je nach kombination von ir und soft pwm)<br />
* ir senden<br />
* ir empfangen<br />
* messen ob die led versorgung an ist<br />
* helligkeit eines an A2 angeschlossenen helligkeits sensors<br />
* konfiguration der dmx basis adresse über das swap register 0x12<br />
* optional soft on auf letzten wert<br />
* alles was auch vorher schon ging: dimmen, faden, ir fernbedienungen anlernen, ...<br />
<br />
wichtig zu wissen:<br />
* wenn ir aktiv ist und kein soft pwm lässt sich der 4. kanal nur ein und aus schalten<br />
* wenn ir aktiv ist muss soft pwm aktiv sein um den 4. kanäle auch zu dimmen<br />
* es wird nur ein zusätzlicher kanal tatsächlich schon unterstützt. der fünfte kommt noch<br />
* bei ir senden sind nur die aufrufe für sony und nec tatsächlich eingebaut. die anderen sind aber einfach zu ergänzen<br />
* beim ir senden sind noch keine Wiederholungen eingebaut. die müssen laut protokoll aber eigentlich sein<br />
<br />
was noch kommt:<br />
* besseres soft pwm<br />
* mehr konfiguration bezüglich default verhalten. ramp zeiten, delays, ...<br />
* hsv farb modell um besser zu faden und vor allem um den weiss anteil automatisch auf die weiss leds zu legen<br />
* die virtuellen channel <br />
* fhem kompatibles ir senden<br />
* sofortiges senden von helligkeit und led spannung bei änderung<br />
* andere ir lib mit sehr viel besserer geräte unterstützung<br />
<br />
wie gehabt muss alles über config.h konfiguriert werden.<br />
<br />
<br />
===== weitrere Screenshots =====<br />
<gallery><br />
File:SWAP_0000002200000003-internal.png|InternalValues<br />
File:SWAP_0000002200000003-readings.png|Readings<br />
File:SWAP_0000002200000003-attributes.png|Attributes<br />
</gallery><br />
<br />
== Arduino Sketches ==<br />
Zum Flashen der Panstamps wird die Arduino IDE benötigt. Eine Installationsanleitung ist unter folgendem Link zu finden:<br />
:https://code.google.com/p/panstamp/wiki/firststeps<br />
<br />
Für den RGB-Driver sketch sind je nach gewünschtem Funktionsumfang noch folgende libs zu installieren:<br />
<br />
* IR lib - https://github.com/shirriff/Arduino-IRremote<br />
* DMX lib- http://www.mathertel.de/Arduino/DMXSerial.aspx<br />
<br />
Die Librarys sollten entweder mit dem entsprechenden Menüpunkt in die IDE integriert werden oder jeweils nach auspacken des zip files als als kompletten Ordner im Arduino libraries verzeichnis abgelegt werden (siehe [http://www.arduino.cc/en/Hacking/Libraries)]).<br />
<br />
Die aktuelle Version des RGB-Driver Sketches findet sich auf [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge].<br />
<br />
Dieser muss in Arduino\libraries\panstamp\examples\sketches entpackt und die rbgdriver.ino gestartet werden. In der Arduino IDE sollte unter Tools->Board "Arduino Pro or Pro Mini (3.3V, 8MHz) w/ Atmega328" eingestellt sein. Wenn man das boards.txt file von [http://code.google.com/p/panstamp/downloads/detail?name=boards.txt&can=2&q= hier] installiert kann man in der IDE auch direkt PanStamp als Plattform auswählen.<br />
<br />
Welche Features der sketch bietet lässt sich im config.h file durch ein- oder auskommentieren der #define ENABLE_... Zeilen festlegen.<br />
<br />
<br />
'''Besonderheiten bei der Nutzung einiger Funktionen'''<br />
<br />
<br />
<nowiki>- #define ENABLE_DMX</nowiki><br />
<br />
Hierbei ist darauf zu achten, dass in der DMX-Lib in der Datei DMXSerial.h die Zeile<br />
* #define DmxModePin 2 // Arduino pin 2 for controlling the data direction<br />
in <br />
* #define DmxModePin 7 // Arduino pin 7 for controlling the data direction<br />
abgeändert werden muss.<br />
<br />
<nowiki>- #define HAS_SENSOR (ermöglicht die Nutzung eines DHT22 Sensors zur Auswerung von Temperatur und Luftfeuchtigkeit)</nowiki><br />
<br />
USE_SOFT_PWM;<br />
ENABLE_IR_SEND;<br />
ENABLE_REPEATER;<br />
<br />
sollte hierfür auskommentiert sein.<br />
<br />
In der IRremote.cpp Datei in der Irremote Library muss die Zeile<br />
<br />
void IRrecv::disableIRIn() <br />
{<br />
TIMER_DISABLE_INTR;<br />
}<br />
<br />
sowie die Irremote.h Datei unter Public: um die Zeile <br />
<br />
void disableIRIn();<br />
<br />
erweitert werden.<br />
<br />
Der Daten-Pin des DHT22 Sensors muss hierfür an A2 des Panstamps angeschlossen werden.<br />
<br />
== Weblinks ==<br />
* [http://www.panstamp.com/home panStamp] panStamp Hersteller<br />
* [http://itse.homeip.net/projekte/12/6/ Projektseite] für das RGB-Multi-Board.<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ rgbdriver sketch] auf sourceforge<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ soilmoisture sketch] auf sourceforge<br />
<br />
[[Kategorie:Interfaces]]<br />
[[Kategorie:Other Components]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=PanStamp&diff=6804PanStamp2014-07-09T19:13:47Z<p>Fidel: /* Arduino Sketches */</p>
<hr />
<div>{{Baustelle}}<br />
{{SEITENTITEL:panStamp}}<br />
<br />
{{Infobox Hardware<br />
|Bild=panStamp.jpg<br />
|Bildbeschreibung=panStamp<br />
|HWProtocol=SWAP<br />
|HWType=Sender, Empfänger, Sensor, [[Interface]]<br />
|HWCategory=<br />
|HWComm=868MHz (433/915MHz)<br />
|HWChannels=<br />
|HWVoltage=3.3V (panStick: 5V USB)<br />
|HWPowerConsumption=<br />
|HWPoweredBy=Battery (panStick: USB)<br />
|HWSize=17.7 x 30.5 mm<br />
|HWDeviceFHEM=[http://fhem.de/commandref.html#panStamp 35_panStamp.pm] [http://fhem.de/commandref.html#SWAP 35_SWAP.pm]<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=430 Andre / justme1968]<br />
|HWManufacturer=panStamp<br />
}}<br />
<br />
<br />
[http://www.panstamp.com/home PanStamps] sind [[Arduino]] Clones, die ein CC1101 Funkmodul beinhalten. Mit ihnen lassen sich Sensoren und Aktoren drahtlos an FHEM anbinden. Sie lassen sich genau wie Arduinos über die Ardunio IDE oder mit dem ino Kommandozeilen Binary programmieren.<br />
<br />
Der panStamp Software Stack unterstützt einen stromsparenden Power-Down- oder Sleep-Modus für batteriebetriebene Sensoren, aus dem diese dann nur zur eigentlichen Messung und Übertragung "aufwachen".<br />
<br />
Zur Kommunikation in einem panStamp Netzwerk dient das ''Simple Wireless Abstract Protocol'' ([http://code.google.com/p/panstamp/wiki/SWAP SWAP]).<br />
<br />
Um einen panStamp in Betrieb zu nehmen muss er unbedingt mit einer Antenne oder einem stück Draht in der [https://code.google.com/p/panstamp/wiki/antennalengths richtigen Länge] bestückt sein. Ohne Antenne funktioniert die Übertragung nicht. Auch nicht auf kurze Distanzen.<br />
<br />
== Simple Wireless Abstract Protocol (SWAP) ==<br />
Die komplette SWAP- Kommunikation ist registerbasiert und erfolgt mit Nachrichten um diese Register abzufragen, zu setzen und deren Inhalt zu senden. Alle Register lassen sich lesen, manche auch beschreiben.<br />
<br />
Jeder panStamp stellt elf Systemregister (00-0A) [http://code.google.com/p/panstamp/wiki/SWAPregisters] und beliebig viele sketchabängige Userregister (0B-)bereit. Die Beschreibung der jeweils von einem Sketch bereitgestellten Userregister erfolgt in ''Device Description Files'', die in .../FHEM/lib/SWAP zu finden sind. Die Identifikation der Art eines panStamp und die Zuordnung zu einem bestimmten Device Description File erfolgt über den productCode der aus ''Hersteller''- und ''Produkt''-Id gebildet wird.<br />
<br />
In den Systemregistern steht z.&nbsp;B. der productCode, die Deviceadresse und das Übertragungsintervall. Konfigurierbare Register werden im EEPROM gesichert, so dass die Werte auch bei einem Neustart nicht verlorengehen. Beim ersten Starten eines panStamp ist das EEPROM mit FF initialisiert und alle konfigurierbaren Register haben diesen Wert, also z.&nbsp;B. die Adresse FF und das Intervall FFFF (zwischen 18 und 19 Stunden).<br />
<br />
Die Systemregister werden in der Device Detailansicht bei den InternalValues im oberen Bereich angezeigt und die User-Register als reading im unteren Bereich.<br />
<br />
Jeder panStamp durchläuft beim Start eine definierte Einschaltsequenz und überträgt als erstes seinen productCode. Batteriebetriebene panStamps warten anschließend drei Sekunden auf Konfigurationskommandos. Danach werden bestimmte Systemregister und aktuelle Messwerte gesendet.<br />
<br />
== FHEM Integration ==<br />
Die Integration in FHEM erfolgt über eine reihe von Modulen die im folgenden genauer beschrieben werden.<br />
=== panStamp ===<br />
Als Schnittstelle zwischen FHEM und einem panStamp Netzwerk dient entweder ein panStick (USB Stick mit aufgestecktem panStamp) oder ein panStamp Shield mit integriertem panStamp an einem Raspberry PI. Der so angebundene panStamp wird mit einem Modem-Sketch als RF Modem verwenden und über das FHEM Modul panStamp angesprochen. Hierzu ist in FHEM ein entsprechendes Device anzulegen: <pre>define panStick panStamp /dev/ttyUSBx@38400</pre><br />
<br />
Dieses panStamp Device versucht dann als erstes alle panStamps im Netz zu finden und per autocreate anzulegen.<br />
<br />
=== SWAP ===<br />
[[Datei:SWAP_ 0000000100000005-detail.png|mini|hochkant=2.5|Readings]]<br />
Das SWAP Modul ermöglicht die generische Integration beliebiger panStamp Sensoren und Aktoren in FHEM. Mit Hilfe der im jeweiligen Device Description File hinterlegten Beschreibung werden hierzu automatisch userReadings angelegt die neben den reinen Registerwerten in hex auch 'menschenlesbare' readings der Sensorwerte erzeugen. Damit dies funktioniert, muss das Attribut ProductCode korrekt gesetzt sein. Das geschieht normalerweise automatisch beim Anlegen des Device.<br />
<br />
Hier Beispielhaft anhand eines BMP085 Temperatur- und Luftdrucksensors dargestellt:<br />
<br />
:<code>attr temppress userReadings voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, temperature:0C.0-Temperature {hex(ReadingsVal($name,"0C.0-Temperature","0"))*0.1-50}, pressure:0C.1-Pressure {hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01}, pressureNN:0C.1-Pressure {sprintf("%.2f",hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01 + AttrVal("global", "altitude", 0)/8.5)}</code><br />
<br />
[[Datei:SWAP_ 0000000100000005.png|mini|hochkant=2.5|Resultat eines stateFormat]]<br />
Aus diesen readings kann dann mit stateFormat die gewünschte Darstellung für die Raumübersicht erzeugt werden:<br />
<br />
:<code>attr temppress stateFormat {sprintf("%.1f",ReadingsVal($name,"temperature",0))."°C ".sprintf("%.1f",ReadingsVal($name,"pressureNN",0))."mbar"}</code><br />
<br />
<br />
Sobald ein SWAP Device mit dem productCode korrekt angelegt wurde, können die Userregister bzw. alle Register aufgelistet werden: <br />
get <device> regList<br />
get <device> regListALL<br />
<br />
und einzelne Register abgefragt und gesetzt werden:<br />
set <device> regGet <ID><br />
set <device> regSet <ID> <value><br />
Für die Systemregister kann hierzu statt der RegisterID auch der Registername (siehe regListAll) verwendet werden.<br />
<br />
==== Neue panStamps in Betrieb nehmen ====<br />
'''Info: Das SWAP Modul unterstützt autocreate. Bei der Inbetriebnahme ist autocreate zu aktivieren!'''<br />
<br />
Neue panStamps sollten nur Einer nach dem Anderen in Betrieb genommen werden, da sie zuerst mit einer eindeutigen Device-Adresse (ungleich FF und grösser 01) versehen werden müssen. Bei batteriebetriebenen Sensoren sollte auch das Sendeintervall auf einen sinnvollen Wert gesetzt werden:<br />
set <device> regSet 09 <device adresse als 2 stellige hex zahl><br />
set <device> regSet 0A <intervall in sekunden als 4 stellige hex zahl><br />
Für Devices im Power-Down-Modus werden diese Kommandos in eine Warteschlange gestellt und übertragen, sobald das Device seine Initialisierungssequenz durchläuft. Hierzu ist nach Absetzen der Kommandos Reset zu drücken oder die Stromquelle erneut zu verbinden.<br />
<br />
Das SWAP modul versucht, ein Device mit der default Adresse <code>FF</code> automatisch auf die erste freie Adresse im Bereich <code>F0</code>-<code>FE</code> zu ändern.<br />
<br />
Für batteriebetriebene Devices (genauer: Devices die den Power-Down-Modus unterstützen) wird das Default Sendeintervall von <code>FFFF</code> zu <code>0384</code> (900 Sekunden) geändert.<br />
Es gibt mit bestimmten panstamp lib Versionen das Problem das ein wert von FFFF in 0A zum Überlauf führt und dann ununterbrochen gesendet wird. Im fhem Modul wird versucht das abzufangen. Das funktioniert auf manchen langsamen host systemen (z.B. FritzBox) nicht, weil der panstamp so schnell sendet das fhem so mit dem abarbeiten beschäftigt ist das es selber nicht zum senden kommt.<br />
Zur Abhilfe kann im sketch in setup() ganz am Anfang ein<br />
EEPROM.write(EEPROM_TX_INTERVAL, 0x55);<br />
EEPROM.write(EEPROM_TX_INTERVAL+1, 0x55);<br />
eingefügt werden und noch mal flashen. Wenn der Sketch damit ein mal durchgelaufen ist können diese beiden Zeilen wieder entfernen und der panstamp noch mal geflasht.<br />
<br />
Automatisch gesetzte Werte sollten danach manuell auf die jeweilige Installation angepasst werden.<br />
<br />
==== Beispiele ====<br />
===== Bodenfeuchte =====<br />
Der panStamp soilmoisture Sketch aus dem examples Verzeichnis ist mit dem Standard SWAP Modul kompatibel. <br />
<br />
Eine für einen Vegetronix sensor angepasste Version kann von [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge] heruntergeladen werden. Das Übertragungsintervall ist wie üblich über das regsiter 0A konfigurierbar. Der Sensor wird and GND, D7 für die Versorgungsspannung und A4 für den Messwert angeschlossen. Erfahrungen haben gezeigt, dass bei einem fünfminütigen Übertragungsintervall nach 12 Monaten Laufzeit die Batteriespannung von 1.55V auf 1.4V abfällt. Das würde bedeuten, dass eine Batterie im Batterieboard mindestens eine Laufzeit von drei Jahren haben sollte.<br />
<br />
set <MyBodenfeuchte> stateFormat VWC_A%<br />
set <MyBodenfeuchte> userReadings Level0_Voltage {hex(ReadingsVal($name,"0C.0-Moisture_level_0","0"))*(3.3/1024)}, <br />
VWC_A:0C.0-Moisture_level_0 {sprintf("%.0f",(11.6552 * (ReadingsVal($name,"Level0_Voltage","0"))**4 + 7.10835 * <br />
(ReadingsVal($name,"Level0_Voltage","0"))**2 - 0.569557) / ((ReadingsVal($name,"Level0_Voltage","0"))**2 + 1))}, <br />
voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, <br />
battery:0B-Voltage {(ReadingsVal($name,"voltage","0")<1?"low":"ok")}<br />
<br />
[[Datei:SWAP_ soilmositure-plot.jpg|mini|x100px|Bodenfeuchte]]<br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix1.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix2.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<br />
Mit einem entsprechend erweiterten Sketch lassen sich auch mehrere Sensoren an einem panStamp auslesen.<br />
<br />
Die folgenden Bilder zeigen eine Panstamp/Vegetronix Außeneinheit im IP65-Gehäuse. Dieser Aufbau wird ganzjährig den Witterungseinflüssen ausgesetzt. Die auf den Stab aufgesetzte Antenne muss nicht verwendet werden, bei kürzeren Funkstrecken ist eine innenliegende Drahtantenne ausreichend. Bitte in FHEM den RSSI- und LQI-Wert sowie die Gleichmäßigkeit des Empfangens der 5 Minuten Sendeintervalle dementsprechend beobachten.<br />
<br />
=== SWAP_XXXXXXXXXXXXXXXX ===<br />
Besonders bei Aktoren ist oft eine engere FHEM-Integration sinnvoll, um FHEM Konzepte wie on/off/on-for-timer direkt abzubilden und nicht mehr nur auf die Registerebene und regSet und regGet Kommandos beschränkt zu sein.<br />
<br />
Um per autocreate automatisch das passende Modul laden zu können, müssen diese Module nach dem Schema SWAP_XXXXXXXXXXXXXXXX.pm benannt sein wobei XXXXXXXXXXXXXXXX für den jeweiligen productCode steht.<br />
<br />
==== SWAP_0000002200000003 ====<br />
[[Datei:SWAP_0000002200000003.png|mini|rechts|hochkant=2.5|RGB LED Driver Board]]<br />
Ein FHEM Modul für das modifizierte panStamp RGB LED Driver Board. <br />
<br />
Das Board unterstützt RGBW LEDs und lässt sich per Infrarot Fernbedienung, DMX Controller (z.&nbsp;B. als Unterputz Touchpanel) und FHEM bedienen.<br />
<br />
Der Funktionsumfang wird in diesem [http://forum.fhem.de/index.php/topic,12487.msg81923.html#msg81923 Forenthread] vorgestellt. Die Hardware für das Board wird [http://forum.fhem.de/index.php/topic,13890.0.html hier] im FHEM Forum vorgestellt und ein Prototyp ist [http://forum.fhem.de/index.php/topic,12487.msg85777.html#msg85777 hier] zu sehen.<br />
=====Upate 2014-01-11===== <br />
Zur Zeit ist Version 2 des Boards in Vorbereiteung. Die Projektseite zur Hardware findet sich [http://itse.homeip.net/projekte/12/6/ hier]. <br />
<br />
Demnächst wird eine aktualisiert Version des Fhem Moduls und panStamp Sketches eingecheckt. Eine Übersicht über die dann vorhandene Funktionalität:<br />
<br />
was geht:<br />
* bis zu vier led kanäle (je nach kombination von ir und soft pwm)<br />
* ir senden<br />
* ir empfangen<br />
* messen ob die led versorgung an ist<br />
* helligkeit eines an A2 angeschlossenen helligkeits sensors<br />
* konfiguration der dmx basis adresse über das swap register 0x12<br />
* optional soft on auf letzten wert<br />
* alles was auch vorher schon ging: dimmen, faden, ir fernbedienungen anlernen, ...<br />
<br />
wichtig zu wissen:<br />
* wenn ir aktiv ist und kein soft pwm lässt sich der 4. kanal nur ein und aus schalten<br />
* wenn ir aktiv ist muss soft pwm aktiv sein um den 4. kanäle auch zu dimmen<br />
* es wird nur ein zusätzlicher kanal tatsächlich schon unterstützt. der fünfte kommt noch<br />
* bei ir senden sind nur die aufrufe für sony und nec tatsächlich eingebaut. die anderen sind aber einfach zu ergänzen<br />
* beim ir senden sind noch keine Wiederholungen eingebaut. die müssen laut protokoll aber eigentlich sein<br />
<br />
was noch kommt:<br />
* besseres soft pwm<br />
* mehr konfiguration bezüglich default verhalten. ramp zeiten, delays, ...<br />
* hsv farb modell um besser zu faden und vor allem um den weiss anteil automatisch auf die weiss leds zu legen<br />
* die virtuellen channel <br />
* fhem kompatibles ir senden<br />
* sofortiges senden von helligkeit und led spannung bei änderung<br />
* andere ir lib mit sehr viel besserer geräte unterstützung<br />
<br />
wie gehabt muss alles über config.h konfiguriert werden.<br />
<br />
<br />
===== weitrere Screenshots =====<br />
<gallery><br />
File:SWAP_0000002200000003-internal.png|InternalValues<br />
File:SWAP_0000002200000003-readings.png|Readings<br />
File:SWAP_0000002200000003-attributes.png|Attributes<br />
</gallery><br />
<br />
== Arduino Sketches ==<br />
Zum Flashen der Panstamps wird die Arduino IDE benötigt. Eine Installationsanleitung ist unter folgendem Link zu finden:<br />
:https://code.google.com/p/panstamp/wiki/firststeps<br />
<br />
Für den RGB-Driver sketch sind je nach gewünschtem Funktionsumfang noch folgende libs zu installieren:<br />
<br />
* IR lib - https://github.com/shirriff/Arduino-IRremote<br />
* DMX lib- http://www.mathertel.de/Arduino/DMXSerial.aspx<br />
<br />
Die Librarys sollten entweder mit dem entsprechenden Menüpunkt in die IDE integriert werden oder jeweils nach auspacken des zip files als als kompletten Ordner im Arduino libraries verzeichnis abgelegt werden (siehe [http://www.arduino.cc/en/Hacking/Libraries)]).<br />
<br />
Die aktuelle Version des RGB-Driver Sketches findet sich auf [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge].<br />
<br />
Dieser muss in Arduino\libraries\panstamp\examples\sketches entpackt und die rbgdriver.ino gestartet werden. In der Arduino IDE sollte unter Tools->Board "Arduino Pro or Pro Mini (3.3V, 8MHz) w/ Atmega328" eingestellt sein. Wenn man das boards.txt file von [http://code.google.com/p/panstamp/downloads/detail?name=boards.txt&can=2&q= hier] installiert kann man in der IDE auch direkt PanStamp als Plattform auswählen.<br />
<br />
Welche Features der sketch bietet lässt sich im config.h file durch ein- oder auskommentieren der #define ENABLE_... Zeilen festlegen.<br />
<br />
<br />
'''Besonderheiten bei der Nutzung einiger Funktionen'''<br />
<br />
<br />
<nowiki>- #define ENABLE_DMX</nowiki><br />
<br />
Hierbei ist darauf zu achten, dass in der DMX-Lib in der Datei DMXSerial.h die Zeile<br />
* #define DmxModePin 2 // Arduino pin 2 for controlling the data direction<br />
in <br />
* #define DmxModePin 7 // Arduino pin 7 for controlling the data direction<br />
abgeändert werden muss.<br />
<br />
#define HAS_SENSOR (ermöglicht die Nutzung eines DHT22 Sensors zur Auswerung von Temperatur und Luftfeuchtigkeit)<br />
<br />
USE_SOFT_PWM<br />
ENABLE_IR_SEND<br />
ENABLE_REPEATER<br />
<br />
Sollte hierfür auskommentiert sein.<br />
<br />
In der IRremote.cpp Datei in der Irremote Library muss die Zeile<br />
<br />
void IRrecv::disableIRIn() <br />
{<br />
TIMER_DISABLE_INTR;<br />
}<br />
<br />
sowie die Irremote.h Datei unter Public: um die Zeile <br />
<br />
void disableIRIn();<br />
<br />
erweitert werden.<br />
<br />
Der Daten-Pin des DHT22 Sensors muss hierfür an A2 des Panstamps angeschlossen werden.<br />
<br />
== Weblinks ==<br />
* [http://www.panstamp.com/home panStamp] panStamp Hersteller<br />
* [http://itse.homeip.net/projekte/12/6/ Projektseite] für das RGB-Multi-Board.<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ rgbdriver sketch] auf sourceforge<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ soilmoisture sketch] auf sourceforge<br />
<br />
[[Kategorie:Interfaces]]<br />
[[Kategorie:Other Components]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=PanStamp&diff=6666PanStamp2014-06-27T09:31:59Z<p>Fidel: /* Arduino Sketches */</p>
<hr />
<div>{{Baustelle}}<br />
{{SEITENTITEL:panStamp}}<br />
<br />
{{Infobox Hardware<br />
|Bild=panStamp.jpg<br />
|Bildbeschreibung=panStamp<br />
|HWProtocol=SWAP<br />
|HWType=Sender, Empfänger, Sensor, [[Interface]]<br />
|HWCategory=<br />
|HWComm=868MHz (433/915MHz)<br />
|HWChannels=<br />
|HWVoltage=3.3V (panStick: 5V USB)<br />
|HWPowerConsumption=<br />
|HWPoweredBy=Battery (panStick: USB)<br />
|HWSize=17.7 x 30.5 mm<br />
|HWDeviceFHEM=[http://fhem.de/commandref.html#panStamp 35_panStamp.pm] [http://fhem.de/commandref.html#SWAP 35_SWAP.pm]<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=430 Andre / justme1968]<br />
|HWManufacturer=panStamp<br />
}}<br />
<br />
<br />
[http://www.panstamp.com/home PanStamps] sind [[Arduino]] Clones, die ein CC1101 Funkmodul beinhalten. Mit ihnen lassen sich Sensoren und Aktoren drahtlos an FHEM anbinden. Sie lassen sich genau wie Arduinos über die Ardunio IDE oder mit dem ino Kommandozeilen Binary programmieren.<br />
<br />
Der panStamp Software Stack unterstützt einen stromsparenden Power-Down- oder Sleep-Modus für batteriebetriebene Sensoren, aus dem diese dann nur zur eigentlichen Messung und Übertragung "aufwachen".<br />
<br />
Zur Kommunikation in einem panStamp Netzwerk dient das ''Simple Wireless Abstract Protocol'' ([http://code.google.com/p/panstamp/wiki/SWAP SWAP]).<br />
<br />
Um einen panStamp in Betrieb zu nehmen muss er unbedingt mit einer Antenne oder einem stück Draht in der [https://code.google.com/p/panstamp/wiki/antennalengths richtigen Länge] bestückt sein. Ohne Antenne funktioniert die Übertragung nicht. Auch nicht auf kurze Distanzen.<br />
<br />
== Simple Wireless Abstract Protocol (SWAP) ==<br />
Die komplette SWAP- Kommunikation ist registerbasiert und erfolgt mit Nachrichten um diese Register abzufragen, zu setzen und deren Inhalt zu senden. Alle Register lassen sich lesen, manche auch beschreiben.<br />
<br />
Jeder panStamp stellt elf Systemregister (00-0A) [http://code.google.com/p/panstamp/wiki/SWAPregisters] und beliebig viele sketchabängige Userregister (0B-)bereit. Die Beschreibung der jeweils von einem Sketch bereitgestellten Userregister erfolgt in ''Device Description Files'', die in .../FHEM/lib/SWAP zu finden sind. Die Identifikation der Art eines panStamp und die Zuordnung zu einem bestimmten Device Description File erfolgt über den productCode der aus ''Hersteller''- und ''Produkt''-Id gebildet wird.<br />
<br />
In den Systemregistern steht z.&nbsp;B. der productCode, die Deviceadresse und das Übertragungsintervall. Konfigurierbare Register werden im EEPROM gesichert, so dass die Werte auch bei einem Neustart nicht verlorengehen. Beim ersten Starten eines panStamp ist das EEPROM mit FF initialisiert und alle konfigurierbaren Register haben diesen Wert, also z.&nbsp;B. die Adresse FF und das Intervall FFFF (zwischen 18 und 19 Stunden).<br />
<br />
Die Systemregister werden in der Device Detailansicht bei den InternalValues im oberen Bereich angezeigt und die User-Register als reading im unteren Bereich.<br />
<br />
Jeder panStamp durchläuft beim Start eine definierte Einschaltsequenz und überträgt als erstes seinen productCode. Batteriebetriebene panStamps warten anschließend drei Sekunden auf Konfigurationskommandos. Danach werden bestimmte Systemregister und aktuelle Messwerte gesendet.<br />
<br />
== FHEM Integration ==<br />
Die Integration in FHEM erfolgt über eine reihe von Modulen die im folgenden genauer beschrieben werden.<br />
=== panStamp ===<br />
Als Schnittstelle zwischen FHEM und einem panStamp Netzwerk dient entweder ein panStick (USB Stick mit aufgestecktem panStamp) oder ein panStamp Shield mit integriertem panStamp an einem Raspberry PI. Der so angebundene panStamp wird mit einem Modem-Sketch als RF Modem verwenden und über das FHEM Modul panStamp angesprochen. Hierzu ist in FHEM ein entsprechendes Device anzulegen: <pre>define panStick panStamp /dev/ttyUSBx@38400</pre><br />
<br />
Dieses panStamp Device versucht dann als erstes alle panStamps im Netz zu finden und per autocreate anzulegen.<br />
<br />
=== SWAP ===<br />
[[Datei:SWAP_ 0000000100000005-detail.png|mini|hochkant=2.5|Readings]]<br />
Das SWAP Modul ermöglicht die generische Integration beliebiger panStamp Sensoren und Aktoren in FHEM. Mit Hilfe der im jeweiligen Device Description File hinterlegten Beschreibung werden hierzu automatisch userReadings angelegt die neben den reinen Registerwerten in hex auch 'menschenlesbare' readings der Sensorwerte erzeugen. Damit dies funktioniert, muss das Attribut ProductCode korrekt gesetzt sein. Das geschieht normalerweise automatisch beim Anlegen des Device.<br />
<br />
Hier Beispielhaft anhand eines BMP085 Temperatur- und Luftdrucksensors dargestellt:<br />
<br />
:<code>attr temppress userReadings voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, temperature:0C.0-Temperature {hex(ReadingsVal($name,"0C.0-Temperature","0"))*0.1-50}, pressure:0C.1-Pressure {hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01}, pressureNN:0C.1-Pressure {sprintf("%.2f",hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01 + AttrVal("global", "altitude", 0)/8.5)}</code><br />
<br />
[[Datei:SWAP_ 0000000100000005.png|mini|hochkant=2.5|Resultat eines stateFormat]]<br />
Aus diesen readings kann dann mit stateFormat die gewünschte Darstellung für die Raumübersicht erzeugt werden:<br />
<br />
:<code>attr temppress stateFormat {sprintf("%.1f",ReadingsVal($name,"temperature",0))."°C ".sprintf("%.1f",ReadingsVal($name,"pressureNN",0))."mbar"}</code><br />
<br />
<br />
Sobald ein SWAP Device mit dem productCode korrekt angelegt wurde, können die Userregister bzw. alle Register aufgelistet werden: <br />
get <device> regList<br />
get <device> regListALL<br />
<br />
und einzelne Register abgefragt und gesetzt werden:<br />
set <device> regGet <ID><br />
set <device> regSet <ID> <value><br />
Für die Systemregister kann hierzu statt der RegisterID auch der Registername (siehe regListAll) verwendet werden.<br />
<br />
==== Neue panStamps in Betrieb nehmen ====<br />
'''Info: Das SWAP Modul unterstützt autocreate. Bei der Inbetriebnahme ist autocreate zu aktivieren!'''<br />
<br />
Neue panStamps sollten nur Einer nach dem Anderen in Betrieb genommen werden, da sie zuerst mit einer eindeutigen Device-Adresse (ungleich FF und grösser 01) versehen werden müssen. Bei batteriebetriebenen Sensoren sollte auch das Sendeintervall auf einen sinnvollen Wert gesetzt werden:<br />
set <device> regSet 09 <device adresse als 2 stellige hex zahl><br />
set <device> regSet 0A <intervall in sekunden als 4 stellige hex zahl><br />
Für Devices im Power-Down-Modus werden diese Kommandos in eine Warteschlange gestellt und übertragen, sobald das Device seine Initialisierungssequenz durchläuft. Hierzu ist nach Absetzen der Kommandos Reset zu drücken oder die Stromquelle erneut zu verbinden.<br />
<br />
Das SWAP modul versucht, ein Device mit der default Adresse <code>FF</code> automatisch auf die erste freie Adresse im Bereich <code>F0</code>-<code>FE</code> zu ändern.<br />
<br />
Für batteriebetriebene Devices (genauer: Devices die den Power-Down-Modus unterstützen) wird das Default Sendeintervall von <code>FFFF</code> zu <code>0384</code> (900 Sekunden) geändert.<br />
Es gibt mit bestimmten panstamp lib Versionen das Problem das ein wert von FFFF in 0A zum Überlauf führt und dann ununterbrochen gesendet wird. Im fhem Modul wird versucht das abzufangen. Das funktioniert auf manchen langsamen host systemen (z.B. FritzBox) nicht, weil der panstamp so schnell sendet das fhem so mit dem abarbeiten beschäftigt ist das es selber nicht zum senden kommt.<br />
Zur Abhilfe kann im sketch in setup() ganz am Anfang ein<br />
EEPROM.write(EEPROM_TX_INTERVAL, 0x55);<br />
EEPROM.write(EEPROM_TX_INTERVAL+1, 0x55);<br />
eingefügt werden und noch mal flashen. Wenn der Sketch damit ein mal durchgelaufen ist können diese beiden Zeilen wieder entfernen und der panstamp noch mal geflasht.<br />
<br />
Automatisch gesetzte Werte sollten danach manuell auf die jeweilige Installation angepasst werden.<br />
<br />
==== Beispiele ====<br />
===== Bodenfeuchte =====<br />
Der panStamp soilmoisture Sketch aus dem examples Verzeichnis ist mit dem Standard SWAP Modul kompatibel. <br />
<br />
Eine für einen Vegetronix sensor angepasste Version kann von [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge] heruntergeladen werden. Das Übertragungsintervall ist wie üblich über das regsiter 0A konfigurierbar. Der Sensor wird and GND, D7 für die Versorgungsspannung und A4 für den Messwert angeschlossen. Erfahrungen haben gezeigt, dass bei einem fünfminütigen Übertragungsintervall nach 12 Monaten Laufzeit die Batteriespannung von 1.55V auf 1.4V abfällt. Das würde bedeuten, dass eine Batterie im Batterieboard mindestens eine Laufzeit von drei Jahren haben sollte.<br />
<br />
set <MyBodenfeuchte> stateFormat VWC_A%<br />
set <MyBodenfeuchte> userReadings Level0_Voltage {hex(ReadingsVal($name,"0C.0-Moisture_level_0","0"))*(3.3/1024)}, <br />
VWC_A:0C.0-Moisture_level_0 {sprintf("%.0f",(11.6552 * (ReadingsVal($name,"Level0_Voltage","0"))**4 + 7.10835 * <br />
(ReadingsVal($name,"Level0_Voltage","0"))**2 - 0.569557) / ((ReadingsVal($name,"Level0_Voltage","0"))**2 + 1))}, <br />
voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, <br />
battery:0B-Voltage {(ReadingsVal($name,"voltage","0")<1?"low":"ok")}<br />
<br />
[[Datei:SWAP_ soilmositure-plot.jpg|mini|x100px|Bodenfeuchte]]<br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix1.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<div class="tright" style="clear:none">[[Datei:panstamp_vegetronix2.jpg|mini|ohne|x130px|Vegetronix Bodenfeuchtesensor an Panstamp]]</div><br />
<br />
Mit einem entsprechend erweiterten Sketch lassen sich auch mehrere Sensoren an einem panStamp auslesen.<br />
<br />
Die folgenden Bilder zeigen eine Panstamp/Vegetronix Außeneinheit im IP65-Gehäuse. Dieser Aufbau wird ganzjährig den Witterungseinflüssen ausgesetzt. Die auf den Stab aufgesetzte Antenne muss nicht verwendet werden, bei kürzeren Funkstrecken ist eine innenliegende Drahtantenne ausreichend. Bitte in FHEM den RSSI- und LQI-Wert sowie die Gleichmäßigkeit des Empfangens der 5 Minuten Sendeintervalle dementsprechend beobachten.<br />
<br />
=== SWAP_XXXXXXXXXXXXXXXX ===<br />
Besonders bei Aktoren ist oft eine engere FHEM-Integration sinnvoll, um FHEM Konzepte wie on/off/on-for-timer direkt abzubilden und nicht mehr nur auf die Registerebene und regSet und regGet Kommandos beschränkt zu sein.<br />
<br />
Um per autocreate automatisch das passende Modul laden zu können, müssen diese Module nach dem Schema SWAP_XXXXXXXXXXXXXXXX.pm benannt sein wobei XXXXXXXXXXXXXXXX für den jeweiligen productCode steht.<br />
<br />
==== SWAP_0000002200000003 ====<br />
[[Datei:SWAP_0000002200000003.png|mini|rechts|hochkant=2.5|RGB LED Driver Board]]<br />
Ein FHEM Modul für das modifizierte panStamp RGB LED Driver Board. <br />
<br />
Das Board unterstützt RGBW LEDs und lässt sich per Infrarot Fernbedienung, DMX Controller (z.&nbsp;B. als Unterputz Touchpanel) und FHEM bedienen.<br />
<br />
Der Funktionsumfang wird in diesem [http://forum.fhem.de/index.php/topic,12487.msg81923.html#msg81923 Forenthread] vorgestellt. Die Hardware für das Board wird [http://forum.fhem.de/index.php/topic,13890.0.html hier] im FHEM Forum vorgestellt und ein Prototyp ist [http://forum.fhem.de/index.php/topic,12487.msg85777.html#msg85777 hier] zu sehen.<br />
=====Upate 2014-01-11===== <br />
Zur Zeit ist Version 2 des Boards in Vorbereiteung. Die Projektseite zur Hardware findet sich [http://itse.homeip.net/projekte/12/6/ hier]. <br />
<br />
Demnächst wird eine aktualisiert Version des Fhem Moduls und panStamp Sketches eingecheckt. Eine Übersicht über die dann vorhandene Funktionalität:<br />
<br />
was geht:<br />
* bis zu vier led kanäle (je nach kombination von ir und soft pwm)<br />
* ir senden<br />
* ir empfangen<br />
* messen ob die led versorgung an ist<br />
* helligkeit eines an A2 angeschlossenen helligkeits sensors<br />
* konfiguration der dmx basis adresse über das swap register 0x12<br />
* optional soft on auf letzten wert<br />
* alles was auch vorher schon ging: dimmen, faden, ir fernbedienungen anlernen, ...<br />
<br />
wichtig zu wissen:<br />
* wenn ir aktiv ist und kein soft pwm lässt sich der 4. kanal nur ein und aus schalten<br />
* wenn ir aktiv ist muss soft pwm aktiv sein um den 4. kanäle auch zu dimmen<br />
* es wird nur ein zusätzlicher kanal tatsächlich schon unterstützt. der fünfte kommt noch<br />
* bei ir senden sind nur die aufrufe für sony und nec tatsächlich eingebaut. die anderen sind aber einfach zu ergänzen<br />
* beim ir senden sind noch keine Wiederholungen eingebaut. die müssen laut protokoll aber eigentlich sein<br />
<br />
was noch kommt:<br />
* besseres soft pwm<br />
* mehr konfiguration bezüglich default verhalten. ramp zeiten, delays, ...<br />
* hsv farb modell um besser zu faden und vor allem um den weiss anteil automatisch auf die weiss leds zu legen<br />
* die virtuellen channel <br />
* fhem kompatibles ir senden<br />
* sofortiges senden von helligkeit und led spannung bei änderung<br />
* andere ir lib mit sehr viel besserer geräte unterstützung<br />
<br />
wie gehabt muss alles über config.h konfiguriert werden.<br />
<br />
<br />
===== weitrere Screenshots =====<br />
<gallery><br />
File:SWAP_0000002200000003-internal.png|InternalValues<br />
File:SWAP_0000002200000003-readings.png|Readings<br />
File:SWAP_0000002200000003-attributes.png|Attributes<br />
</gallery><br />
<br />
== Arduino Sketches ==<br />
Zum Flashen der Panstamps wird die Arduino IDE benötigt. Eine Installationsanleitung ist unter folgendem Link zu finden:<br />
:https://code.google.com/p/panstamp/wiki/firststeps<br />
<br />
Für den RGB-Driver sketch sind je nach gewünschtem Funktionsumfang noch folgende libs zu installieren:<br />
<br />
* IR lib - https://github.com/shirriff/Arduino-IRremote<br />
* DMX lib- http://www.mathertel.de/Arduino/DMXSerial.aspx<br />
<br />
Die Librarys sollten entweder mit dem entsprechenden Menüpunkt in die IDE integriert werden oder jeweils nach auspacken des zip files als als kompletten Ordner im Arduino libraries verzeichnis abgelegt werden (siehe [http://www.arduino.cc/en/Hacking/Libraries)]).<br />
<br />
Die aktuelle Version des RGB-Driver Sketches findet sich auf [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge].<br />
<br />
Dieser muss in Arduino\libraries\panstamp\examples\sketches entpackt und die rbgdriver.ino gestartet werden. In der Arduino IDE sollte unter Tools->Board "Arduino Pro or Pro Mini (3.3V, 8MHz) w/ Atmega328" eingestellt sein. Wenn man das boards.txt file von [http://code.google.com/p/panstamp/downloads/detail?name=boards.txt&can=2&q= hier] installiert kann man in der IDE auch direkt PanStamp als Plattform auswählen.<br />
<br />
Welche Features der sketch bietet lässt sich im config.h file durch ein- oder auskommentieren der #define ENABLE_... Zeilen festlegen.<br />
<br />
<br />
'''Besonderheiten bei der Nutzung einiger Funktionen'''<br />
<br />
<br />
<nowiki>- #define ENABLE_DMX</nowiki><br />
<br />
Hierbei ist darauf zu achten, dass in der DMX-Lib in der Datei DMXSerial.h die Zeile<br />
* #define DmxModePin 2 // Arduino pin 2 for controlling the data direction<br />
in <br />
* #define DmxModePin 7 // Arduino pin 7 for controlling the data direction<br />
abgeändert werden muss.<br />
<br />
#define HAS_SENSOR (ermöglicht die Nutzung eines DHT22 Sensors zur Auswerung von Temperatur und Luftfeuchtigkeit)<br />
<br />
Hierzu muss<br />
<br />
USE_SOFT_PWM muss auskommentiert sein.<br />
<br />
In der IRremote.cpp Datei in der Irremote Library muss die Zeile<br />
<br />
void IRrecv::disableIRIn() <br />
{<br />
TIMER_DISABLE_INTR;<br />
}<br />
<br />
sowie die Irremote.h Datei unter Public: um die Zeile <br />
<br />
void disableIRIn();<br />
<br />
erweitert werden.<br />
<br />
Der Daten-Pin des DHT22 Sensors muss hierfür an A2 des Panstamps angeschlossen werden.<br />
<br />
== Weblinks ==<br />
* [http://www.panstamp.com/home panStamp] panStamp Hersteller<br />
* [http://itse.homeip.net/projekte/12/6/ Projektseite] für das RGB-Multi-Board.<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ rgbdriver sketch] auf sourceforge<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ soilmoisture sketch] auf sourceforge<br />
<br />
[[Kategorie:Interfaces]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=PanStamp&diff=6581PanStamp2014-06-18T23:08:38Z<p>Fidel: /* Arduino Sketches */</p>
<hr />
<div>{{Baustelle}}<br />
{{SEITENTITEL:panStamp}}<br />
<br />
{{Infobox Hardware<br />
|Bild=panStamp.jpg<br />
|Bildbeschreibung=panStamp<br />
|HWProtocol=SWAP<br />
|HWType=Sender, Empfänger, Sensor, [[Interface]]<br />
|HWCategory=<br />
|HWComm=868MHz (433/915MHz)<br />
|HWChannels=<br />
|HWVoltage=3.3V (panStick: 5V USB)<br />
|HWPowerConsumption=<br />
|HWPoweredBy=Battery (panStick: USB)<br />
|HWSize=17.7 x 30.5 mm<br />
|HWDeviceFHEM=[http://fhem.de/commandref.html#panStamp 35_panStamp.pm] [http://fhem.de/commandref.html#SWAP 35_SWAP.pm]<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=430 Andre / justme1968]<br />
|HWManufacturer=panStamp<br />
}}<br />
<br />
<br />
[http://www.panstamp.com/home PanStamps] sind [[Arduino]] Clones, die ein CC1101 Funkmodul beinhalten. Mit ihnen lassen sich Sensoren und Aktoren drahtlos an FHEM anbinden. Sie lassen sich genau wie Arduinos über die Ardunio IDE oder mit dem ino Kommandozeilen Binary programmieren.<br />
<br />
Der panStamp Software Stack unterstützt einen stromsparenden Power-Down- oder Sleep-Modus für batteriebetriebene Sensoren, aus dem diese dann nur zur eigentlichen Messung und Übertragung "aufwachen".<br />
<br />
Zur Kommunikation in einem panStamp Netzwerk dient das ''Simple Wireless Abstract Protocol'' ([http://code.google.com/p/panstamp/wiki/SWAP SWAP]).<br />
<br />
Um einen panStamp in Betrieb zu nehmen muss er unbedingt mit einer Antenne oder einem stück Draht in der [https://code.google.com/p/panstamp/wiki/antennalengths richtigen Länge] bestückt sein. Ohne Antenne funktioniert die Übertragung nicht. Auch nicht auf kurze Distanzen.<br />
<br />
== Simple Wireless Abstract Protocol (SWAP) ==<br />
Die komplette SWAP- Kommunikation ist registerbasiert und erfolgt mit Nachrichten um diese Register abzufragen, zu setzen und deren Inhalt zu senden. Alle Register lassen sich lesen, manche auch beschreiben.<br />
<br />
Jeder panStamp stellt elf Systemregister (00-0A) [http://code.google.com/p/panstamp/wiki/SWAPregisters] und beliebig viele sketchabängige Userregister (0B-)bereit. Die Beschreibung der jeweils von einem Sketch bereitgestellten Userregister erfolgt in ''Device Description Files'', die in .../FHEM/lib/SWAP zu finden sind. Die Identifikation der Art eines panStamp und die Zuordnung zu einem bestimmten Device Description File erfolgt über den productCode der aus ''Hersteller''- und ''Produkt''-Id gebildet wird.<br />
<br />
In den Systemregistern steht z.&nbsp;B. der productCode, die Deviceadresse und das Übertragungsintervall. Konfigurierbare Register werden im EEPROM gesichert, so dass die Werte auch bei einem Neustart nicht verlorengehen. Beim ersten Starten eines panStamp ist das EEPROM mit FF initialisiert und alle konfigurierbaren Register haben diesen Wert, also z.&nbsp;B. die Adresse FF und das Intervall FFFF (zwischen 18 und 19 Stunden).<br />
<br />
Die Systemregister werden in der Device Detailansicht bei den InternalValues im oberen Bereich angezeigt und die User-Register als reading im unteren Bereich.<br />
<br />
Jeder panStamp durchläuft beim Start eine definierte Einschaltsequenz und überträgt als erstes seinen productCode. Batteriebetriebene panStamps warten anschließend drei Sekunden auf Konfigurationskommandos. Danach werden bestimmte Systemregister und aktuelle Messwerte gesendet.<br />
<br />
== FHEM Integration ==<br />
Die Integration in FHEM erfolgt über eine reihe von Modulen die im folgenden genauer beschrieben werden.<br />
=== panStamp ===<br />
Als Schnittstelle zwischen FHEM und einem panStamp Netzwerk dient entweder ein panStick (USB Stick mit aufgestecktem panStamp) oder ein panStamp Shield mit integriertem panStamp an einem Raspberry PI. Der so angebundene panStamp wird mit einem Modem-Sketch als RF Modem verwenden und über das FHEM Modul panStamp angesprochen. Hierzu ist in FHEM ein entsprechendes Device anzulegen: <pre>define panStick panStamp /dev/ttyUSBx@38400</pre><br />
<br />
Dieses panStamp Device versucht dann als erstes alle panStamps im Netz zu finden und per autocreate anzulegen.<br />
<br />
=== SWAP ===<br />
[[Datei:SWAP_ 0000000100000005-detail.png|mini|hochkant=2.5|Readings]]<br />
Das SWAP Modul ermöglicht die generische Integration beliebiger panStamp Sensoren und Aktoren in FHEM. Mit Hilfe der im jeweiligen Device Description File hinterlegten Beschreibung werden hierzu automatisch userReadings angelegt die neben den reinen Registerwerten in hex auch 'menschenlesbare' readings der Sensorwerte erzeugen. Damit dies funktioniert, muss das Attribut ProductCode korrekt gesetzt sein. Das geschieht normalerweise automatisch beim Anlegen des Device.<br />
<br />
Hier Beispielhaft anhand eines BMP085 Temperatur- und Luftdrucksensors dargestellt:<br />
<br />
:<code>attr temppress userReadings voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, temperature:0C.0-Temperature {hex(ReadingsVal($name,"0C.0-Temperature","0"))*0.1-50}, pressure:0C.1-Pressure {hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01}, pressureNN:0C.1-Pressure {sprintf("%.2f",hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01 + AttrVal("global", "altitude", 0)/8.5)}</code><br />
<br />
[[Datei:SWAP_ 0000000100000005.png|mini|hochkant=2.5|Resultat eines stateFormat]]<br />
Aus diesen readings kann dann mit stateFormat die gewünschte Darstellung für die Raumübersicht erzeugt werden:<br />
<br />
:<code>attr temppress stateFormat {sprintf("%.1f",ReadingsVal($name,"temperature",0))."°C ".sprintf("%.1f",ReadingsVal($name,"pressureNN",0))."mbar"}</code><br />
<br />
<br />
Sobald ein SWAP Device mit dem productCode korrekt angelegt wurde, können die Userregister bzw. alle Register aufgelistet werden: <br />
get <device> regList<br />
get <device> regListALL<br />
<br />
und einzelne Register abgefragt und gesetzt werden:<br />
set <device> regGet <ID><br />
set <device> regSet <ID> <value><br />
Für die Systemregister kann hierzu statt der RegisterID auch der Registername (siehe regListAll) verwendet werden.<br />
<br />
==== Neue panStamps in Betrieb nehmen ====<br />
'''Info: Das SWAP Modul unterstützt autocreate. Bei der Inbetriebnahme ist autocreate zu aktivieren!'''<br />
<br />
Neue panStamps sollten nur Einer nach dem Anderen in Betrieb genommen werden, da sie zuerst mit einer eindeutigen Device-Adresse (ungleich FF und grösser 01) versehen werden müssen. Bei batteriebetriebenen Sensoren sollte auch das Sendeintervall auf einen sinnvollen Wert gesetzt werden:<br />
set <device> regSet 09 <device adresse als 2 stellige hex zahl><br />
set <device> regSet 0A <intervall in sekunden als 4 stellige hex zahl><br />
Für Devices im Power-Down-Modus werden diese Kommandos in eine Warteschlange gestellt und übertragen, sobald das Device seine Initialisierungssequenz durchläuft. Hierzu ist nach Absetzen der Kommandos Reset zu drücken oder die Stromquelle erneut zu verbinden.<br />
<br />
Das SWAP modul versucht, ein Device mit der default Adresse <code>FF</code> automatisch auf die erste freie Adresse im Bereich <code>F0</code>-<code>FE</code> zu ändern.<br />
<br />
Für batteriebetriebene Devices (genauer: Devices die den Power-Down-Modus unterstützen) wird das Default Sendeintervall von <code>FFFF</code> zu <code>0384</code> (900 Sekunden) geändert.<br />
Es gibt mit bestimmten panstamp lib Versionen das Problem das ein wert von FFFF in 0A zum Überlauf führt und dann ununterbrochen gesendet wird. Im fhem Modul wird versucht das abzufangen. Das funktioniert auf manchen langsamen host systemen (z.B. FritzBox) nicht, weil der panstamp so schnell sendet das fhem so mit dem abarbeiten beschäftigt ist das es selber nicht zum senden kommt.<br />
Zur Abhilfe kann im sketch in setup() ganz am Anfang ein<br />
EEPROM.write(EEPROM_TX_INTERVAL, 0x55);<br />
EEPROM.write(EEPROM_TX_INTERVAL+1, 0x55);<br />
eingefügt werden und noch mal flashen. Wenn der Sketch damit ein mal durchgelaufen ist können diese beiden Zeilen wieder entfernen und der panstamp noch mal geflasht.<br />
<br />
Automatisch gesetzte Werte sollten danach manuell auf die jeweilige Installation angepasst werden.<br />
<br />
==== Beispiele ====<br />
===== Bodenfeuchte =====<br />
[[Datei:SWAP_ soilmositure-plot.jpg|mini|hochkant=2.5|Bodenfeuchte]]<br />
<br />
Der panStamp soilmoisture Sketch aus dem examples Verzeichnis ist mit dem Standard SWAP Modul kompatibel. <br />
<br />
Eine für einen Vegetronix sensor angepasste Version kann von [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge] heruntergeladen werden. Das Übertragungsintervall ist wie üblich über das regsiter 0A konfigurierbar. Der Sensor wird and GND, D7 für die Versorgungsspannung und A4 für den Messwert angeschlossen.<br />
<br />
set <MyBodenfeuchte> stateFormat VWC_A%<br />
set <MyBodenfeuchte> userReadings Level0_Voltage {hex(ReadingsVal($name,"0C.0-Moisture_level_0","0"))*(3.3/1024)}, VWC_A:0C.0-Moisture_level_0 {sprintf("%.0f",(11.6552 * (ReadingsVal($name,"Level0_Voltage","0"))**4 + 7.10835 * (ReadingsVal($name,"Level0_Voltage","0"))**2 - 0.569557) / ((ReadingsVal($name,"Level0_Voltage","0"))**2 + 1))}, voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, battery:0B-Voltage {(ReadingsVal($name,"voltage","0")<1?"low":"ok")}<br />
<br />
Mit einem entsprechend erweiterten Sketch lassen sich auch mehrere Sensoren an einem panStamp auslesen.<br />
<br />
=== SWAP_XXXXXXXXXXXXXXXX ===<br />
Besonders bei Aktoren ist oft eine engere FHEM-Integration sinnvoll, um FHEM Konzepte wie on/off/on-for-timer direkt abzubilden und nicht mehr nur auf die Registerebene und regSet und regGet Kommandos beschränkt zu sein.<br />
<br />
Um per autocreate automatisch das passende Modul laden zu können, müssen diese Module nach dem Schema SWAP_XXXXXXXXXXXXXXXX.pm benannt sein wobei XXXXXXXXXXXXXXXX für den jeweiligen productCode steht.<br />
<br />
==== SWAP_0000002200000003 ====<br />
[[Datei:SWAP_0000002200000003.png|mini|rechts|hochkant=2.5|RGB LED Driver Board]]<br />
Ein FHEM Modul für das modifizierte panStamp RGB LED Driver Board. <br />
<br />
Das Board unterstützt RGBW LEDs und lässt sich per Infrarot Fernbedienung, DMX Controller (z.&nbsp;B. als Unterputz Touchpanel) und FHEM bedienen.<br />
<br />
Der Funktionsumfang wird in diesem [http://forum.fhem.de/index.php/topic,12487.msg81923.html#msg81923 Forenthread] vorgestellt. Die Hardware für das Board wird [http://forum.fhem.de/index.php/topic,13890.0.html hier] im FHEM Forum vorgestellt und ein Prototyp ist [http://forum.fhem.de/index.php/topic,12487.msg85777.html#msg85777 hier] zu sehen.<br />
=====Upate 2014-01-11===== <br />
Zur Zeit ist Version 2 des Boards in Vorbereiteung. Die Projektseite zur Hardware findet sich [http://itse.homeip.net/projekte/12/6/ hier]. <br />
<br />
Demnächst wird eine aktualisiert Version des Fhem Moduls und panStamp Sketches eingecheckt. Eine Übersicht über die dann vorhandene Funktionalität:<br />
<br />
was geht:<br />
* bis zu vier led kanäle (je nach kombination von ir und soft pwm)<br />
* ir senden<br />
* ir empfangen<br />
* messen ob die led versorgung an ist<br />
* helligkeit eines an A2 angeschlossenen helligkeits sensors<br />
* konfiguration der dmx basis adresse über das swap register 0x12<br />
* optional soft on auf letzten wert<br />
* alles was auch vorher schon ging: dimmen, faden, ir fernbedienungen anlernen, ...<br />
<br />
wichtig zu wissen:<br />
* wenn ir aktiv ist und kein soft pwm lässt sich der 4. kanal nur ein und aus schalten<br />
* wenn ir aktiv ist muss soft pwm aktiv sein um den 4. kanäle auch zu dimmen<br />
* es wird nur ein zusätzlicher kanal tatsächlich schon unterstützt. der fünfte kommt noch<br />
* bei ir senden sind nur die aufrufe für sony und nec tatsächlich eingebaut. die anderen sind aber einfach zu ergänzen<br />
* beim ir senden sind noch keine Wiederholungen eingebaut. die müssen laut protokoll aber eigentlich sein<br />
<br />
was noch kommt:<br />
* besseres soft pwm<br />
* mehr konfiguration bezüglich default verhalten. ramp zeiten, delays, ...<br />
* hsv farb modell um besser zu faden und vor allem um den weiss anteil automatisch auf die weiss leds zu legen<br />
* die virtuellen channel <br />
* fhem kompatibles ir senden<br />
* sofortiges senden von helligkeit und led spannung bei änderung<br />
* andere ir lib mit sehr viel besserer geräte unterstützung<br />
<br />
wie gehabt muss alles über config.h konfiguriert werden.<br />
<br />
<br />
===== weitrere Screenshots =====<br />
<gallery><br />
File:SWAP_0000002200000003-internal.png|InternalValues<br />
File:SWAP_0000002200000003-readings.png|Readings<br />
File:SWAP_0000002200000003-attributes.png|Attributes<br />
</gallery><br />
<br />
== Arduino Sketches ==<br />
Zum Flashen der Panstamps wird die Arduino IDE benötigt. Eine Installationsanleitung ist unter folgendem Link zu finden:<br />
:https://code.google.com/p/panstamp/wiki/firststeps<br />
<br />
Für den RGB-Driver sketch sind je nach gewünschtem Funktionsumfang noch folgende libs zu installieren:<br />
<br />
* IR lib - https://github.com/shirriff/Arduino-IRremote<br />
* DMX lib- http://www.mathertel.de/Arduino/DMXSerial.aspx<br />
<br />
Die Librarys sollten entweder mit dem entsprechenden Menüpunkt in die IDE integriert werden oder jeweils nach auspacken des zip files als als kompletten Ordner im Arduino libraries verzeichnis abgelegt werden (siehe [http://www.arduino.cc/en/Hacking/Libraries)]).<br />
<br />
Die aktuelle Version des RGB-Driver Sketches findet sich auf [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge].<br />
<br />
Dieser muss in Arduino\libraries\panstamp\examples\sketches entpackt und die rbgdriver.ino gestartet werden. In der Arduino IDE sollte unter Tools->Board "Arduino Pro or Pro Mini (3.3V, 8MHz) w/ Atmega328" eingestellt sein. Wenn man das boards.txt file von [http://code.google.com/p/panstamp/downloads/detail?name=boards.txt&can=2&q= hier] installiert kann man in der IDE auch direkt PanStamp als Plattform auswählen.<br />
<br />
Welche Features der sketch bietet lässt sich im config.h file durch ein- oder auskommentieren der #define ENABLE_... Zeilen festlegen.<br />
<br />
<br />
'''Besonderheiten bei der Nutzung einiger Funktionen'''<br />
<br />
<br />
<nowiki>- #define ENABLE_DMX</nowiki><br />
<br />
Hierbei ist darauf zu achten, dass in der DMX-Lib in der Datei DMXSerial.h die Zeile<br />
* #define DmxModePin 2 // Arduino pin 2 for controlling the data direction<br />
in <br />
* #define DmxModePin 7 // Arduino pin 7 for controlling the data direction<br />
abgeändert werden muss.<br />
<br />
<!--#define HAS_SENSOR (ermöglicht die Nutzung eines DHT22 Sensors zur Auswerung von Temperatur und Luftfeuchtigkeit)<br />
<br />
Hierzu muss<br />
<br />
USE_SOFT_PWM muss auskommentiert sein.<br />
<br />
In der IRremote.cpp Datei in der Irremote Library muss die Zeile<br />
<br />
void IRrecv::disableIRIn() <br />
{<br />
TIMER_DISABLE_INTR;<br />
}<br />
<br />
sowie die Irremote.h Datei unter Public: um die Zeile <br />
<br />
void disableIRIn();<br />
<br />
erweitert werden.<br />
<br />
Der Daten-Pin des DHT22 Sensors muss hierfür an A2 des Panstamps angeschlossen werden.<br />
<br />
--><br />
<br />
== Weblinks ==<br />
* [http://www.panstamp.com/home panStamp] panStamp Hersteller<br />
* [http://itse.homeip.net/projekte/12/6/ Projektseite] für das RGB-Multi-Board.<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ rgbdriver sketch] auf sourceforge<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ soilmoisture sketch] auf sourceforge<br />
<br />
[[Kategorie:Interfaces]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=PanStamp&diff=6580PanStamp2014-06-18T23:02:41Z<p>Fidel: /* Arduino Sketches */</p>
<hr />
<div>{{Baustelle}}<br />
{{SEITENTITEL:panStamp}}<br />
<br />
{{Infobox Hardware<br />
|Bild=panStamp.jpg<br />
|Bildbeschreibung=panStamp<br />
|HWProtocol=SWAP<br />
|HWType=Sender, Empfänger, Sensor, [[Interface]]<br />
|HWCategory=<br />
|HWComm=868MHz (433/915MHz)<br />
|HWChannels=<br />
|HWVoltage=3.3V (panStick: 5V USB)<br />
|HWPowerConsumption=<br />
|HWPoweredBy=Battery (panStick: USB)<br />
|HWSize=17.7 x 30.5 mm<br />
|HWDeviceFHEM=[http://fhem.de/commandref.html#panStamp 35_panStamp.pm] [http://fhem.de/commandref.html#SWAP 35_SWAP.pm]<br />
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=430 Andre / justme1968]<br />
|HWManufacturer=panStamp<br />
}}<br />
<br />
<br />
[http://www.panstamp.com/home PanStamps] sind [[Arduino]] Clones, die ein CC1101 Funkmodul beinhalten. Mit ihnen lassen sich Sensoren und Aktoren drahtlos an FHEM anbinden. Sie lassen sich genau wie Arduinos über die Ardunio IDE oder mit dem ino Kommandozeilen Binary programmieren.<br />
<br />
Der panStamp Software Stack unterstützt einen stromsparenden Power-Down- oder Sleep-Modus für batteriebetriebene Sensoren, aus dem diese dann nur zur eigentlichen Messung und Übertragung "aufwachen".<br />
<br />
Zur Kommunikation in einem panStamp Netzwerk dient das ''Simple Wireless Abstract Protocol'' ([http://code.google.com/p/panstamp/wiki/SWAP SWAP]).<br />
<br />
Um einen panStamp in Betrieb zu nehmen muss er unbedingt mit einer Antenne oder einem stück Draht in der [https://code.google.com/p/panstamp/wiki/antennalengths richtigen Länge] bestückt sein. Ohne Antenne funktioniert die Übertragung nicht. Auch nicht auf kurze Distanzen.<br />
<br />
== Simple Wireless Abstract Protocol (SWAP) ==<br />
Die komplette SWAP- Kommunikation ist registerbasiert und erfolgt mit Nachrichten um diese Register abzufragen, zu setzen und deren Inhalt zu senden. Alle Register lassen sich lesen, manche auch beschreiben.<br />
<br />
Jeder panStamp stellt elf Systemregister (00-0A) [http://code.google.com/p/panstamp/wiki/SWAPregisters] und beliebig viele sketchabängige Userregister (0B-)bereit. Die Beschreibung der jeweils von einem Sketch bereitgestellten Userregister erfolgt in ''Device Description Files'', die in .../FHEM/lib/SWAP zu finden sind. Die Identifikation der Art eines panStamp und die Zuordnung zu einem bestimmten Device Description File erfolgt über den productCode der aus ''Hersteller''- und ''Produkt''-Id gebildet wird.<br />
<br />
In den Systemregistern steht z.&nbsp;B. der productCode, die Deviceadresse und das Übertragungsintervall. Konfigurierbare Register werden im EEPROM gesichert, so dass die Werte auch bei einem Neustart nicht verlorengehen. Beim ersten Starten eines panStamp ist das EEPROM mit FF initialisiert und alle konfigurierbaren Register haben diesen Wert, also z.&nbsp;B. die Adresse FF und das Intervall FFFF (zwischen 18 und 19 Stunden).<br />
<br />
Die Systemregister werden in der Device Detailansicht bei den InternalValues im oberen Bereich angezeigt und die User-Register als reading im unteren Bereich.<br />
<br />
Jeder panStamp durchläuft beim Start eine definierte Einschaltsequenz und überträgt als erstes seinen productCode. Batteriebetriebene panStamps warten anschließend drei Sekunden auf Konfigurationskommandos. Danach werden bestimmte Systemregister und aktuelle Messwerte gesendet.<br />
<br />
== FHEM Integration ==<br />
Die Integration in FHEM erfolgt über eine reihe von Modulen die im folgenden genauer beschrieben werden.<br />
=== panStamp ===<br />
Als Schnittstelle zwischen FHEM und einem panStamp Netzwerk dient entweder ein panStick (USB Stick mit aufgestecktem panStamp) oder ein panStamp Shield mit integriertem panStamp an einem Raspberry PI. Der so angebundene panStamp wird mit einem Modem-Sketch als RF Modem verwenden und über das FHEM Modul panStamp angesprochen. Hierzu ist in FHEM ein entsprechendes Device anzulegen: <pre>define panStick panStamp /dev/ttyUSBx@38400</pre><br />
<br />
Dieses panStamp Device versucht dann als erstes alle panStamps im Netz zu finden und per autocreate anzulegen.<br />
<br />
=== SWAP ===<br />
[[Datei:SWAP_ 0000000100000005-detail.png|mini|hochkant=2.5|Readings]]<br />
Das SWAP Modul ermöglicht die generische Integration beliebiger panStamp Sensoren und Aktoren in FHEM. Mit Hilfe der im jeweiligen Device Description File hinterlegten Beschreibung werden hierzu automatisch userReadings angelegt die neben den reinen Registerwerten in hex auch 'menschenlesbare' readings der Sensorwerte erzeugen. Damit dies funktioniert, muss das Attribut ProductCode korrekt gesetzt sein. Das geschieht normalerweise automatisch beim Anlegen des Device.<br />
<br />
Hier Beispielhaft anhand eines BMP085 Temperatur- und Luftdrucksensors dargestellt:<br />
<br />
:<code>attr temppress userReadings voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, temperature:0C.0-Temperature {hex(ReadingsVal($name,"0C.0-Temperature","0"))*0.1-50}, pressure:0C.1-Pressure {hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01}, pressureNN:0C.1-Pressure {sprintf("%.2f",hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01 + AttrVal("global", "altitude", 0)/8.5)}</code><br />
<br />
[[Datei:SWAP_ 0000000100000005.png|mini|hochkant=2.5|Resultat eines stateFormat]]<br />
Aus diesen readings kann dann mit stateFormat die gewünschte Darstellung für die Raumübersicht erzeugt werden:<br />
<br />
:<code>attr temppress stateFormat {sprintf("%.1f",ReadingsVal($name,"temperature",0))."°C ".sprintf("%.1f",ReadingsVal($name,"pressureNN",0))."mbar"}</code><br />
<br />
<br />
Sobald ein SWAP Device mit dem productCode korrekt angelegt wurde, können die Userregister bzw. alle Register aufgelistet werden: <br />
get <device> regList<br />
get <device> regListALL<br />
<br />
und einzelne Register abgefragt und gesetzt werden:<br />
set <device> regGet <ID><br />
set <device> regSet <ID> <value><br />
Für die Systemregister kann hierzu statt der RegisterID auch der Registername (siehe regListAll) verwendet werden.<br />
<br />
==== Neue panStamps in Betrieb nehmen ====<br />
'''Info: Das SWAP Modul unterstützt autocreate. Bei der Inbetriebnahme ist autocreate zu aktivieren!'''<br />
<br />
Neue panStamps sollten nur Einer nach dem Anderen in Betrieb genommen werden, da sie zuerst mit einer eindeutigen Device-Adresse (ungleich FF und grösser 01) versehen werden müssen. Bei batteriebetriebenen Sensoren sollte auch das Sendeintervall auf einen sinnvollen Wert gesetzt werden:<br />
set <device> regSet 09 <device adresse als 2 stellige hex zahl><br />
set <device> regSet 0A <intervall in sekunden als 4 stellige hex zahl><br />
Für Devices im Power-Down-Modus werden diese Kommandos in eine Warteschlange gestellt und übertragen, sobald das Device seine Initialisierungssequenz durchläuft. Hierzu ist nach Absetzen der Kommandos Reset zu drücken oder die Stromquelle erneut zu verbinden.<br />
<br />
Das SWAP modul versucht, ein Device mit der default Adresse <code>FF</code> automatisch auf die erste freie Adresse im Bereich <code>F0</code>-<code>FE</code> zu ändern.<br />
<br />
Für batteriebetriebene Devices (genauer: Devices die den Power-Down-Modus unterstützen) wird das Default Sendeintervall von <code>FFFF</code> zu <code>0384</code> (900 Sekunden) geändert.<br />
Es gibt mit bestimmten panstamp lib Versionen das Problem das ein wert von FFFF in 0A zum Überlauf führt und dann ununterbrochen gesendet wird. Im fhem Modul wird versucht das abzufangen. Das funktioniert auf manchen langsamen host systemen (z.B. FritzBox) nicht, weil der panstamp so schnell sendet das fhem so mit dem abarbeiten beschäftigt ist das es selber nicht zum senden kommt.<br />
Zur Abhilfe kann im sketch in setup() ganz am Anfang ein<br />
EEPROM.write(EEPROM_TX_INTERVAL, 0x55);<br />
EEPROM.write(EEPROM_TX_INTERVAL+1, 0x55);<br />
eingefügt werden und noch mal flashen. Wenn der Sketch damit ein mal durchgelaufen ist können diese beiden Zeilen wieder entfernen und der panstamp noch mal geflasht.<br />
<br />
Automatisch gesetzte Werte sollten danach manuell auf die jeweilige Installation angepasst werden.<br />
<br />
==== Beispiele ====<br />
===== Bodenfeuchte =====<br />
[[Datei:SWAP_ soilmositure-plot.jpg|mini|hochkant=2.5|Bodenfeuchte]]<br />
<br />
Der panStamp soilmoisture Sketch aus dem examples Verzeichnis ist mit dem Standard SWAP Modul kompatibel. <br />
<br />
Eine für einen Vegetronix sensor angepasste Version kann von [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge] heruntergeladen werden. Das Übertragungsintervall ist wie üblich über das regsiter 0A konfigurierbar. Der Sensor wird and GND, D7 für die Versorgungsspannung und A4 für den Messwert angeschlossen.<br />
<br />
set <MyBodenfeuchte> stateFormat VWC_A%<br />
set <MyBodenfeuchte> userReadings Level0_Voltage {hex(ReadingsVal($name,"0C.0-Moisture_level_0","0"))*(3.3/1024)}, VWC_A:0C.0-Moisture_level_0 {sprintf("%.0f",(11.6552 * (ReadingsVal($name,"Level0_Voltage","0"))**4 + 7.10835 * (ReadingsVal($name,"Level0_Voltage","0"))**2 - 0.569557) / ((ReadingsVal($name,"Level0_Voltage","0"))**2 + 1))}, voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, battery:0B-Voltage {(ReadingsVal($name,"voltage","0")<1?"low":"ok")}<br />
<br />
Mit einem entsprechend erweiterten Sketch lassen sich auch mehrere Sensoren an einem panStamp auslesen.<br />
<br />
=== SWAP_XXXXXXXXXXXXXXXX ===<br />
Besonders bei Aktoren ist oft eine engere FHEM-Integration sinnvoll, um FHEM Konzepte wie on/off/on-for-timer direkt abzubilden und nicht mehr nur auf die Registerebene und regSet und regGet Kommandos beschränkt zu sein.<br />
<br />
Um per autocreate automatisch das passende Modul laden zu können, müssen diese Module nach dem Schema SWAP_XXXXXXXXXXXXXXXX.pm benannt sein wobei XXXXXXXXXXXXXXXX für den jeweiligen productCode steht.<br />
<br />
==== SWAP_0000002200000003 ====<br />
[[Datei:SWAP_0000002200000003.png|mini|rechts|hochkant=2.5|RGB LED Driver Board]]<br />
Ein FHEM Modul für das modifizierte panStamp RGB LED Driver Board. <br />
<br />
Das Board unterstützt RGBW LEDs und lässt sich per Infrarot Fernbedienung, DMX Controller (z.&nbsp;B. als Unterputz Touchpanel) und FHEM bedienen.<br />
<br />
Der Funktionsumfang wird in diesem [http://forum.fhem.de/index.php/topic,12487.msg81923.html#msg81923 Forenthread] vorgestellt. Die Hardware für das Board wird [http://forum.fhem.de/index.php/topic,13890.0.html hier] im FHEM Forum vorgestellt und ein Prototyp ist [http://forum.fhem.de/index.php/topic,12487.msg85777.html#msg85777 hier] zu sehen.<br />
=====Upate 2014-01-11===== <br />
Zur Zeit ist Version 2 des Boards in Vorbereiteung. Die Projektseite zur Hardware findet sich [http://itse.homeip.net/projekte/12/6/ hier]. <br />
<br />
Demnächst wird eine aktualisiert Version des Fhem Moduls und panStamp Sketches eingecheckt. Eine Übersicht über die dann vorhandene Funktionalität:<br />
<br />
was geht:<br />
* bis zu vier led kanäle (je nach kombination von ir und soft pwm)<br />
* ir senden<br />
* ir empfangen<br />
* messen ob die led versorgung an ist<br />
* helligkeit eines an A2 angeschlossenen helligkeits sensors<br />
* konfiguration der dmx basis adresse über das swap register 0x12<br />
* optional soft on auf letzten wert<br />
* alles was auch vorher schon ging: dimmen, faden, ir fernbedienungen anlernen, ...<br />
<br />
wichtig zu wissen:<br />
* wenn ir aktiv ist und kein soft pwm lässt sich der 4. kanal nur ein und aus schalten<br />
* wenn ir aktiv ist muss soft pwm aktiv sein um den 4. kanäle auch zu dimmen<br />
* es wird nur ein zusätzlicher kanal tatsächlich schon unterstützt. der fünfte kommt noch<br />
* bei ir senden sind nur die aufrufe für sony und nec tatsächlich eingebaut. die anderen sind aber einfach zu ergänzen<br />
* beim ir senden sind noch keine Wiederholungen eingebaut. die müssen laut protokoll aber eigentlich sein<br />
<br />
was noch kommt:<br />
* besseres soft pwm<br />
* mehr konfiguration bezüglich default verhalten. ramp zeiten, delays, ...<br />
* hsv farb modell um besser zu faden und vor allem um den weiss anteil automatisch auf die weiss leds zu legen<br />
* die virtuellen channel <br />
* fhem kompatibles ir senden<br />
* sofortiges senden von helligkeit und led spannung bei änderung<br />
* andere ir lib mit sehr viel besserer geräte unterstützung<br />
<br />
wie gehabt muss alles über config.h konfiguriert werden.<br />
<br />
<br />
===== weitrere Screenshots =====<br />
<gallery><br />
File:SWAP_0000002200000003-internal.png|InternalValues<br />
File:SWAP_0000002200000003-readings.png|Readings<br />
File:SWAP_0000002200000003-attributes.png|Attributes<br />
</gallery><br />
<br />
== Arduino Sketches ==<br />
Zum Flashen der Panstamps wird die Arduino IDE benötigt. Eine Installationsanleitung ist unter folgendem Link zu finden:<br />
:https://code.google.com/p/panstamp/wiki/firststeps<br />
<br />
Für den RGB-Driver sketch sind je nach gewünschtem Funktionsumfang noch folgende libs zu installieren:<br />
<br />
* IR lib - https://github.com/shirriff/Arduino-IRremote<br />
* DMX lib- http://www.mathertel.de/Arduino/DMXSerial.aspx<br />
<br />
Die Librarys sollten entweder mit dem entsprechenden Menüpunkt in die IDE integriert werden oder jeweils nach auspacken des zip files als als kompletten Ordner im Arduino libraries verzeichnis abgelegt werden (siehe [http://www.arduino.cc/en/Hacking/Libraries)]).<br />
<br />
Die aktuelle Version des RGB-Driver Sketches findet sich auf [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge].<br />
<br />
Dieser muss in Arduino\libraries\panstamp\examples\sketches entpackt und die rbgdriver.ino gestartet werden. In der Arduino IDE sollte unter Tools->Board "Arduino Pro or Pro Mini (3.3V, 8MHz) w/ Atmega328" eingestellt sein. Wenn man das boards.txt file von [http://code.google.com/p/panstamp/downloads/detail?name=boards.txt&can=2&q= hier] installiert kann man in der IDE auch direkt PanStamp als Plattform auswählen.<br />
<br />
Welche Features der sketch bietet lässt sich im config.h file durch ein- oder auskommentieren der #define ENABLE_... Zeilen festlegen.<br />
<br />
<br />
'''Besonderheiten bei der Nutzung einiger Funktionen'''<br />
<br />
<br />
<nowiki>- #define ENABLE_DMX</nowiki><br />
<br />
Hierbei ist darauf zu achten, dass in der DMX-Lib in der Datei DMXSerial.h die Zeile<br />
* #define DmxModePin 2 // Arduino pin 2 for controlling the data direction<br />
in <br />
* #define DmxModePin 7 // Arduino pin 7 for controlling the data direction<br />
abgeändert werden muss.<br />
<br />
<!--#define HAS_SENSOR (ermöglicht die Nutzung eines DHT22 Sensors zur Auswerung von Temperatur und Luftfeuchtigkeit)<br />
<br />
Hierzu müssen die IRremote.cpp Datei in der Irremote Library um die Zeile<br />
<br />
void IRrecv::disableIRIn() <br />
{<br />
TIMER_DISABLE_INTR;<br />
}<br />
<br />
sowie die Irremote.h Datei unter Public: um die Zeile <br />
<br />
void disableIRIn();<br />
<br />
erweitert werden.<br />
<br />
Der Daten-Pin des DHT22 Sensors muss hierfür an A2 des Panstamps angeschlossen werden.<br />
<br />
--><br />
<br />
== Weblinks ==<br />
* [http://www.panstamp.com/home panStamp] panStamp Hersteller<br />
* [http://itse.homeip.net/projekte/12/6/ Projektseite] für das RGB-Multi-Board.<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ rgbdriver sketch] auf sourceforge<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ soilmoisture sketch] auf sourceforge<br />
<br />
[[Kategorie:Interfaces]]</div>Fidelhttp://wiki.fhem.de/w/index.php?title=PanStamp&diff=6188PanStamp2014-05-03T14:38:04Z<p>Fidel: /* Arduino Sketches */</p>
<hr />
<div>{{Baustelle}}<br />
{{SEITENTITEL:panStamp}}<br />
<br />
{{Infobox Hardware<br />
|Bild=panStamp.jpg<br />
|Bildbeschreibung=panStamp<br />
|HWProtocol=SWAP<br />
|HWType=Sender, Empfänger, Sensor, [[Interface]]<br />
|HWCategory=<br />
|HWComm=868MHz (433/915MHz)<br />
|HWChannels=<br />
|HWVoltage=3.3V (panStick: 5V USB)<br />
|HWPowerConsumption=<br />
|HWPoweredBy=Battery (panStick: USB)<br />
|HWSize=17.7 x 30.5 mm<br />
|HWDeviceFHEM=[http://fhem.de/commandref.html#panStamp 35_panStamp.pm] [http://fhem.de/commandref.html#SWAP 35_SWAP.pm]<br />
|HWManufacturer=panStamp<br />
}}<br />
<br />
<br />
[http://www.panstamp.com/home PanStamps] sind [[Arduino]] Clones, die ein CC1101 Funkmodul beinhalten. Mit ihnen lassen sich Sensoren und Aktoren drahtlos an FHEM anbinden. Sie lassen sich genau wie Arduinos über die Ardunio IDE oder mit dem ino Kommandozeilen Binary programmieren.<br />
<br />
Der panStamp Software Stack unterstützt einen stromsparenden Power-Down- oder Sleep-Modus für batteriebetriebene Sensoren, aus dem diese dann nur zur eigentlichen Messung und Übertragung "aufwachen".<br />
<br />
Zur Kommunikation in einem panStamp Netzwerk dient das ''Simple Wireless Abstract Protocol'' ([http://code.google.com/p/panstamp/wiki/SWAP SWAP]).<br />
<br />
Um einen panStamp in Betrieb zu nehmen muss er unbedingt mit einer Antenne oder einem stück Draht in der [https://code.google.com/p/panstamp/wiki/antennalengths richtigen Länge] bestückt sein. Ohne Antenne funktioniert die Übertragung nicht. Auch nicht auf kurze Distanzen.<br />
<br />
== Simple Wireless Abstract Protocol (SWAP) ==<br />
Die komplette SWAP- Kommunikation ist registerbasiert und erfolgt mit Nachrichten um diese Register abzufragen, zu setzen und deren Inhalt zu senden. Alle Register lassen sich lesen, manche auch beschreiben.<br />
<br />
Jeder panStamp stellt elf Systemregister (00-0A) [http://code.google.com/p/panstamp/wiki/SWAPregisters] und beliebig viele sketchabängige Userregister (0B-)bereit. Die Beschreibung der jeweils von einem Sketch bereitgestellten Userregister erfolgt in ''Device Description Files'', die in .../FHEM/lib/SWAP zu finden sind. Die Identifikation der Art eines panStamp und die Zuordnung zu einem bestimmten Device Description File erfolgt über den productCode der aus ''Hersteller''- und ''Produkt''-Id gebildet wird.<br />
<br />
In den Systemregistern steht z.&nbsp;B. der productCode, die Deviceadresse und das Übertragungsintervall. Konfigurierbare Register werden im EEPROM gesichert, so dass die Werte auch bei einem Neustart nicht verlorengehen. Beim ersten Starten eines panStamp ist das EEPROM mit FF initialisiert und alle konfigurierbaren Register haben diesen Wert, also z.&nbsp;B. die Adresse FF und das Intervall FFFF (zwischen 18 und 19 Stunden).<br />
<br />
Die Systemregister werden in der Device Detailansicht bei den InternalValues im oberen Bereich angezeigt und die User-Register als reading im unteren Bereich.<br />
<br />
Jeder panStamp durchläuft beim Start eine definierte Einschaltsequenz und überträgt als erstes seinen productCode. Batteriebetriebene panStamps warten anschließend drei Sekunden auf Konfigurationskommandos. Danach werden bestimmte Systemregister und aktuelle Messwerte gesendet.<br />
<br />
== FHEM Integration ==<br />
Die Integration in FHEM erfolgt über eine reihe von Modulen die im folgenden genauer beschrieben werden.<br />
=== panStamp ===<br />
Als Schnittstelle zwischen FHEM und einem panStamp Netzwerk dient entweder ein panStick (USB Stick mit aufgestecktem panStamp) oder ein panStamp Shield mit integriertem panStamp an einem Raspberry PI. Der so angebundene panStamp wird mit einem Modem-Sketch als RF Modem verwenden und über das FHEM Modul panStamp angesprochen. Hierzu ist in FHEM ein entsprechendes Device anzulegen: <pre>define panStick panStamp /dev/ttyUSBx@38400</pre><br />
<br />
Dieses panStamp Device versucht dann als erstes alle panStamps im Netz zu finden und per autocreate anzulegen.<br />
<br />
=== SWAP ===<br />
[[Datei:SWAP_ 0000000100000005-detail.png|mini|hochkant=2.5|Readings]]<br />
Das SWAP Modul ermöglicht die generische Integration beliebiger panStamp Sensoren und Aktoren in FHEM. Mit Hilfe der im jeweiligen Device Description File hinterlegten Beschreibung werden hierzu automatisch userReadings angelegt die neben den reinen Registerwerten in hex auch 'menschenlesbare' readings der Sensorwerte erzeugen. Damit dies funktioniert, muss das Attribut ProductCode korrekt gesetzt sein. Das geschieht normalerweise automatisch beim Anlegen des Device.<br />
<br />
Hier Beispielhaft anhand eines BMP085 Temperatur- und Luftdrucksensors dargestellt:<br />
<br />
:<code>attr temppress userReadings voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, temperature:0C.0-Temperature {hex(ReadingsVal($name,"0C.0-Temperature","0"))*0.1-50}, pressure:0C.1-Pressure {hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01}, pressureNN:0C.1-Pressure {sprintf("%.2f",hex(ReadingsVal($name,"0C.1-Pressure","0"))*0.01 + AttrVal("global", "altitude", 0)/8.5)}</code><br />
<br />
[[Datei:SWAP_ 0000000100000005.png|mini|hochkant=2.5|Resultat eines stateFormat]]<br />
Aus diesen readings kann dann mit stateFormat die gewünschte Darstellung für die Raumübersicht erzeugt werden:<br />
<br />
:<code>attr temppress stateFormat {sprintf("%.1f",ReadingsVal($name,"temperature",0))."°C ".sprintf("%.1f",ReadingsVal($name,"pressureNN",0))."mbar"}</code><br />
<br />
<br />
Sobald ein SWAP Device mit dem productCode korrekt angelegt wurde, können die Userregister bzw. alle Register aufgelistet werden: <br />
get <device> regList<br />
get <device> regListALL<br />
<br />
und einzelne Register abgefragt und gesetzt werden:<br />
set <device> regGet <ID><br />
set <device> regSet <ID> <value><br />
Für die Systemregister kann hierzu statt der RegisterID auch der Registername (siehe regListAll) verwendet werden.<br />
<br />
==== Neue panStamps in Betrieb nehmen ====<br />
'''Info: Das SWAP Modul unterstützt autocreate. Bei der Inbetriebnahme ist autocreate zu aktivieren!'''<br />
<br />
Neue panStamps sollten nur Einer nach dem Anderen in Betrieb genommen werden, da sie zuerst mit einer eindeutigen Device-Adresse (ungleich FF und grösser 01) versehen werden müssen. Bei batteriebetriebenen Sensoren sollte auch das Sendeintervall auf einen sinnvollen Wert gesetzt werden:<br />
set <device> regSet 09 <device adresse als 2 stellige hex zahl><br />
set <device> regSet 0A <intervall in sekunden als 4 stellige hex zahl><br />
Für Devices im Power-Down-Modus werden diese Kommandos in eine Warteschlange gestellt und übertragen, sobald das Device seine Initialisierungssequenz durchläuft. Hierzu ist nach Absetzen der Kommandos Reset zu drücken oder die Stromquelle erneut zu verbinden.<br />
<br />
Das SWAP modul versucht, ein Device mit der default Adresse <code>FF</code> automatisch auf die erste freie Adresse im Bereich <code>F0</code>-<code>FE</code> zu ändern.<br />
<br />
Für batteriebetriebene Devices (genauer: Devices die den Power-Down-Modus unterstützen) wird das Default Sendeintervall von <code>FFFF</code> zu <code>0384</code> (900 Sekunden) geändert.<br />
Es gibt mit bestimmten panstamp lib Versionen das Problem das ein wert von FFFF in 0A zum Überlauf führt und dann ununterbrochen gesendet wird. Im fhem Modul wird versucht das abzufangen. Das funktioniert auf manchen langsamen host systemen (z.B. FritzBox) nicht, weil der panstamp so schnell sendet das fhem so mit dem abarbeiten beschäftigt ist das es selber nicht zum senden kommt.<br />
Zur Abhilfe kann im sketch in setup() ganz am Anfang ein<br />
EEPROM.write(EEPROM_TX_INTERVAL, 0x55);<br />
EEPROM.write(EEPROM_TX_INTERVAL+1, 0x55);<br />
eingefügt werden und noch mal flashen. Wenn der Sketch damit ein mal durchgelaufen ist können diese beiden Zeilen wieder entfernen und der panstamp noch mal geflasht.<br />
<br />
Automatisch gesetzte Werte sollten danach manuell auf die jeweilige Installation angepasst werden.<br />
<br />
==== Beispiele ====<br />
===== Bodenfeuchte =====<br />
[[Datei:SWAP_ soilmositure-plot.jpg|mini|hochkant=2.5|Bodenfeuchte]]<br />
<br />
Der panStamp soilmoisture Sketch aus dem examples Verzeichnis ist mit dem Standard SWAP Modul kompatibel. <br />
<br />
Eine für einen Vegetronix sensor angepasste Version kann von [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge] heruntergeladen werden. Das Übertragungsintervall ist wie üblich über das regsiter 0A konfigurierbar. Der Sensor wird and GND, D7 für die Versorgungsspannung und A4 für den Messwert angeschlossen.<br />
<br />
set <MyBodenfeuchte> stateFormat VWC_A%<br />
set <MyBodenfeuchte> userReadings Level0_Voltage {hex(ReadingsVal($name,"0C.0-Moisture_level_0","0"))*(3.3/1024)}, VWC_A:0C.0-Moisture_level_0 {sprintf("%.0f",(11.6552 * (ReadingsVal($name,"Level0_Voltage","0"))**4 + 7.10835 * (ReadingsVal($name,"Level0_Voltage","0"))**2 - 0.569557) / ((ReadingsVal($name,"Level0_Voltage","0"))**2 + 1))}, voltage:0B-Voltage {hex(ReadingsVal($name,"0B-Voltage","0"))*0.001}, battery:0B-Voltage {(ReadingsVal($name,"voltage","0")<1?"low":"ok")}<br />
<br />
Mit einem entsprechend erweiterten Sketch lassen sich auch mehrere Sensoren an einem panStamp auslesen.<br />
<br />
=== SWAP_XXXXXXXXXXXXXXXX ===<br />
Besonders bei Aktoren ist oft eine engere FHEM-Integration sinnvoll, um FHEM Konzepte wie on/off/on-for-timer direkt abzubilden und nicht mehr nur auf die Registerebene und regSet und regGet Kommandos beschränkt zu sein.<br />
<br />
Um per autocreate automatisch das passende Modul laden zu können, müssen diese Module nach dem Schema SWAP_XXXXXXXXXXXXXXXX.pm benannt sein wobei XXXXXXXXXXXXXXXX für den jeweiligen productCode steht.<br />
<br />
==== SWAP_0000002200000003 ====<br />
[[Datei:SWAP_0000002200000003.png|mini|rechts|hochkant=2.5|RGB LED Driver Board]]<br />
Ein FHEM Modul für das modifizierte panStamp RGB LED Driver Board. <br />
<br />
Das Board unterstützt RGBW LEDs und lässt sich per Infrarot Fernbedienung, DMX Controller (z.&nbsp;B. als Unterputz Touchpanel) und FHEM bedienen.<br />
<br />
Der Funktionsumfang wird in diesem [http://forum.fhem.de/index.php/topic,12487.msg81923.html#msg81923 Forenthread] vorgestellt. Die Hardware für das Board wird [http://forum.fhem.de/index.php/topic,13890.0.html hier] im FHEM Forum vorgestellt und ein Prototyp ist [http://forum.fhem.de/index.php/topic,12487.msg85777.html#msg85777 hier] zu sehen.<br />
=====Upate 2014-01-11===== <br />
Zur Zeit ist Version 2 des Boards in Vorbereiteung. Die Projektseite zur Hardware findet sich [http://itse.homeip.net/projekte/12/6/ hier]. <br />
<br />
Demnächst wird eine aktualisiert Version des Fhem Moduls und panStamp Sketches eingecheckt. Eine Übersicht über die dann vorhandene Funktionalität:<br />
<br />
was geht:<br />
* bis zu vier led kanäle (je nach kombination von ir und soft pwm)<br />
* ir senden<br />
* ir empfangen<br />
* messen ob die led versorgung an ist<br />
* helligkeit eines an A2 angeschlossenen helligkeits sensors<br />
* konfiguration der dmx basis adresse über das swap register 0x12<br />
* optional soft on auf letzten wert<br />
* alles was auch vorher schon ging: dimmen, faden, ir fernbedienungen anlernen, ...<br />
<br />
wichtig zu wissen:<br />
* wenn ir aktiv ist und kein soft pwm lässt sich der 4. kanal nur ein und aus schalten<br />
* wenn ir aktiv ist muss soft pwm aktiv sein um den 4. kanäle auch zu dimmen<br />
* es wird nur ein zusätzlicher kanal tatsächlich schon unterstützt. der fünfte kommt noch<br />
* bei ir senden sind nur die aufrufe für sony und nec tatsächlich eingebaut. die anderen sind aber einfach zu ergänzen<br />
* beim ir senden sind noch keine Wiederholungen eingebaut. die müssen laut protokoll aber eigentlich sein<br />
<br />
was noch kommt:<br />
* besseres soft pwm<br />
* mehr konfiguration bezüglich default verhalten. ramp zeiten, delays, ...<br />
* hsv farb modell um besser zu faden und vor allem um den weiss anteil automatisch auf die weiss leds zu legen<br />
* die virtuellen channel <br />
* fhem kompatibles ir senden<br />
* sofortiges senden von helligkeit und led spannung bei änderung<br />
* andere ir lib mit sehr viel besserer geräte unterstützung<br />
<br />
wie gehabt muss alles über config.h konfiguriert werden.<br />
<br />
<br />
===== weitrere Screenshots =====<br />
<gallery><br />
File:SWAP_0000002200000003-internal.png|InternalValues<br />
File:SWAP_0000002200000003-readings.png|Readings<br />
File:SWAP_0000002200000003-attributes.png|Attributes<br />
</gallery><br />
<br />
== Arduino Sketches ==<br />
Zum Flashen der Panstamps wird die Arduino IDE benötigt. Eine Installationsanleitung ist unter folgendem Link zu finden:<br />
:https://code.google.com/p/panstamp/wiki/firststeps<br />
<br />
Für den RGB-Driver sketch sind je nach gewünschtem Funktionsumfang noch folgende libs zu installieren:<br />
<br />
* IR lib - https://github.com/shirriff/Arduino-IRremote<br />
* DMX lib- http://www.mathertel.de/Arduino/DMXSerial.aspx<br />
<br />
Wenn DMX genutzt werden soll, muss vorher in der DMX-Lib in der Datei DMXSerial.h die Zeile<br />
* #define DmxModePin 2 // Arduino pin 2 for controlling the data direction<br />
in <br />
* #define DmxModePin 7 // Arduino pin 7 for controlling the data direction<br />
abgeändert werden.<br />
<br />
Die Librarys sollten entweder mit dem entsprechenden Menüpunkt in die IDE integriert werden oder jeweils nach auspacken des zip files als als kompletten ordner im Arduino libraries verzeichnis abgelegt werden (siehe [http://www.arduino.cc/en/Hacking/Libraries)]).<br />
<br />
Nun fehlt noch der angepasste rgbdriver-Sketch:<br />
* Version vom 06.2013: http://forum.fhem.de/index.php?action=dlattach;topic=12487.0;attach=3392<br />
* Version vom 10.2013: http://forum.fhem.de/index.php?action=dlattach;topic=12487.0;attach=6701<br />
<br />
Die aktuelle Version des sketches findet sich auf [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ sourceforge].<br />
<br />
Welche features der sketch bietet lässt sich im config.h file durch ein- oder auskommentieren der #define ENABLE_... Zeilen festlegen.<br />
<br />
Dieser muss in Arduino\libraries\panstamp\examples\sketches entpackt und die rbgdriver.ino gestartet werden. In der Arduino IDE sollte unter Tools->Board "Arduino Pro or Pro Mini (3.3V, 8MHz) w/ Atmega328" eingestellt sein. Wenn man das boards.txt file von [http://code.google.com/p/panstamp/downloads/detail?name=boards.txt&can=2&q= hier] installiert kann man in der IDE auch direkt PanStamp als plattform auswählen.<br />
<br />
== Weblinks ==<br />
* [http://www.panstamp.com/home panStamp] panStamp Hersteller<br />
* [http://itse.homeip.net/projekte/12/6/ Projektseite] für das RGB-Multi-Board.<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ rgbdriver sketch] auf sourceforge<br />
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/contrib/arduino/ soilmoisture sketch] auf sourceforge<br />
<br />
[[Kategorie:Interfaces]]</div>Fidel