Broadlink

Beschreibung

Die chinesische Firma BroadLink stellt (neben einem Luft-Multisensor A1, einer Funksteckdose SP3, einem Einbau-Funk-Wandschalter TC2 und einem Alarm-Kit S1C) auch WiFi zu 38KHz-IR bzw. WiFi zu 38KHz-IR und 433/315 MHz-RF Gateways her.

Die Gateways werden mit Hilfe einer Android- oder iOS-App e-control an das Haus-WLAN angelernt.

Danach stellen sie die Möglichkeit bereit,

• Infrarot- (und ggf. RF-) Codes bzw. Code-Sequenzen zu erfassen und via WLAN als Parameter zu übermitteln und
• (gelernte) Codes an kompatible IR- bzw. RF-Empfänger zu versenden.

Die dazugehörige openAPI ist nicht öffentlich und unterliegt einer BroadLink NDA.

Zur praktischen Verwendung gibt es mehrere Schnittstellen:

1. die offizielle App e-control (Android >= 4.0, iOS >= 7.0), mit der Codes angelernt, in der App gespeichert und im lokalen WLAN über die RM versendet werden können,
2. die RM Bridge für Android-Geräte, die eine HTTP REST web API auf dem Androidgerät als Webservice bereitstellt,
3. die Python-Bibliothek python-broadlink von Matthew Garrett (mjg59) für Server, auf denen Python lauffähig ist. Diese kann dann direkt per (Shell-)Skript aufgerufen werden aber auch noch schön gekapselt werden:
4. Webservice für Python fähige Server. In dieser Form sind dann gelernte Sendebefehle elegant als HTTPMOD Objekte in FHEM integrierbar.

BroadLink RM mini

Broadlink
BroadLink RM mini 3
Allgemein
Protokoll	Infrarot
Typ	Gateway
Kategorie	Infrarot
Technische Details
Kommunikation	Infrarot 38 KHz Wifi 2.4GHz b/g/n
Kanäle	1
Betriebsspannung	5V
Leistungsaufnahme	max. 2,5W (max. 0,5A) standby ca. 0.85W
Versorgung	Micro USB
Abmessungen	5.5 x 5.5 x 6.45 cm
Sonstiges
Modulname
Hersteller	BroadLink

Der BroadLink RM mini 3 ist ein WLAN zu Infrarot Gateway (ohne RF, vgl. RM Pro). Im deutschen Versandhandel ca. 25 Euro, aus China direkt nochmal günstiger. Im Vergleich zum RM Pro ist die Sendeleistung deutlich schwächer, da nur ein IR-Transmitter verbaut ist.

BroadLink RM Pro

Broadlink
BroadLink RM Pro
Allgemein
Protokoll	Infrarot, RF
Typ	Gateway
Kategorie	Infrarot, RF
Technische Details
Kommunikation	Infrarot 38 KHz RF 433/315 MHz Wifi 2.4GHz b/g/n
Kanäle	2
Betriebsspannung	5V
Leistungsaufnahme	max. 5W (max. 1A) ca. 1W standby
Versorgung	Micro USB
Abmessungen	11 x 3,5 x 11,5 cm
Sonstiges
Modulname
Hersteller	BroadLink

Der BroadLink RM Pro/RM3 (ID 10 026) ist ein WLAN zu Infrarot- und 433/315-MHz-Gateway. Im deutschen Versandhandel ca. 40 Euro, aus China direkt nochmal günstiger. Damit ist der BroadLink RM Pro eine preiswerte Alternative zu anderen Produkten, die oft nur Infrarot können.

Der RM Pro verfügt im Vergleich zum RM mini über eine größere Reichweite, da 6+1 (Kreis und Mitte) IR-Transmitter verbaut sind.

(In der Version RM3 soll der unterstützte RF-Bereich inoffiziell sogar 142...1050 MHz betragen.)

Der RM Pro enthält auch einen Temperatursensor, der mindestens über die App ausgelesen und für Aktions-Regeln verwendet werden kann.

Es gab/gibt Vorgängerversionen:

• RM Home/RM1: "rote Version"; nur IR, ohne RF; schwache Sendeleistung
• RM Pro/RM2: "schwarze Version"; ID 10 002; IR und RF 433/315MHz; verstärkte IR-Sendeleistung (7 IR-Transmitter)
• (OEM Version) RM Plus: schwarz, keine Aufkleber, keine Beschriftungen, gerade, nicht abgerundete Oberseite... (soll intern baugleich mit RM Pro/RM3 sein).

Nutzung in FHEM

Da der Hersteller sein API nicht veröffentlicht, gibt es (noch) kein echtes FHEM-Modul.

Skripte

Bei dem im Folgenden gezeigten Vorgehen werden auf dem FHEM-Server Skripte installiert und nur jeweils bei Bedarf angestoßen. So wird keine permanente Systemlast produziert. Die Reaktionsgeschwindigkeit ist nicht überwältigend, aber praxistauglich. (Ca 2-3 sec).

Webservice

Es gibt auch den Ansatz, auf dem FHEM-Server einen Webservice (pro Gateway) zu installieren und via HTTPMOD Befehle abzusetzen.

Hinweis

Mit diesem Vorgehen unterstützt das BroadLink sowohl IR als auch RF.

Credits

Die Skript-Lösung basiert auf [1]. Von dort sind auch die ersten drei Skripte, die nur eingedeutscht wurden. Wer lieber Englisch benutzt, nimmt sie bitte direkt von dort.

Die Python-API ist von dieser Github-Seite.

Vorgehen

Installation

Zunächst wird der Broadlink mit der App ins eigene Netz eingebunden. Hierzu der Anleitung folgen: Broadlink Manual

1.Plug in your RM-pro / RM-home,your will find that the blue Wi-Fi indicating light is on and flashing fast (5 times per second). If not, please reset your device.

2.Firstly, link your phone to your own Wi-Fi. Secondly,operate your “Broadlink e-control ” on your smart phone. Third, press the “+” on the top right hand and select “add remote control”.

3.Input WI-Fi password to configure and click “configure” on the button.

4.The blue Wi-Fi indicating light is flashing slowly now (once per second). After being wait for about 60 seconds,the configuration is finish. The RM is linked to your smartphone through your own Wi-Fi.The blue Wi-Fi indicating light is off at this moment.

Auf dem FHEM-Rechner (z.B. Raspi) muss python und am besten auch git installiert sein. Ggf. muss auch noch simplejson und pip installiert werden. Da ich mich nicht als user fhem einlogge, sind in dieser Anleitung viele "sudo"s drin.

sudo apt-get install python git pip
sudo pip install simplejson

Verzeichnis erstellen und die Bibliothek installieren

sudo mkdir /opt/BroadLink
sudo chown fhem.dialout /opt/BroadLink
cd /opt/BroadLink
sudo git clone https://github.com/mjg59/python-broadlink.git
cd python-broadlink
sudo python setup.py install
cd ..

In das Verzeichnis dann noch die vier Skripte kopieren.

1. search-bl.sh

#!/usr/bin/python

#Script to locate Broadlink devices on local network by Graeme Brown Dec 23 2016
#These must be set up using the Broadlink app first!

import broadlink
import time

print "************************************************"
print "Using python library created by Matthew Garrett"
print "https://github.com/mjg59/python-broadlink"
print "************************************************"
print "Scanning network for Broadlink devices...."

mydevices = broadlink.discover(timeout=5)
print "Found " + str(len(mydevices )) + " broadlink devices"
time.sleep(1)
print "..............."

for index, item in enumerate(mydevices):

  mydevices[index].auth()

  ipadd = mydevices[index].host
  ipadd = str(ipadd)
  print "Device " + str(index + 1) +" Host address = " + ipadd[1:19]
  macadd = ''.join(format(x, '02x') for x in mydevices[index].mac[::-1])
  macadd = str(macadd)
 
  mymacadd = macadd[:2] + " " + macadd[2:4] + " " + macadd[4:6] + " " + macadd[6:8] + " " + macadd[8:10] + " " + macadd[10:12]
  print "Device " + str(index + 1) +" MAC address = " + mymacadd
  print "..............."

2. learn-bl.sh

#!/usr/bin/python

import broadlink
import time
import sys

device = broadlink.rm(host=("<your RM3 IP address>",80), mac=bytearray.fromhex("<your RM3 mac>"))

print "Connecting to Broadlink device...."
device.auth()
time.sleep(1)
print "Connected...."

codeName = raw_input("Bitte Namen f. den Code eingeben, z.B. tvOff ")
time.sleep(1)
print "Wenn die LED am Broadlink angeht, innerhalb von 5 Sek die FB-Taste druecken "

device.host
device.enter_learning()
time.sleep(5)
ir_packet = device.check_data()
#convert code to hex
myhex = str(ir_packet).encode('hex');

if ir_packet == None:
   print "Kein Code empfangen - Ende"
   sys.exit()
else:

# record learned hex code to file
   f = open(codeName +".txt",'w')
f.write(myhex)
f.close()

print "Hex code gespeichert unter " + codeName + ".txt"

3. send-bl.sh

#!/usr/bin/python

import broadlink
import time
import sys

try:
    fileName = sys.argv[1]
except IndexError:
    fileName = 'null'

if fileName == 'null':
   print "Error - kein Dateiname angegeben"
   sys.exit()
else:

   device = broadlink.rm(host=("<your RM3 IP address>",80), mac=bytearray.fromhex("<your RM3 mac>"))

print "Connecting to Broadlink device...."
device.auth()
time.sleep(1)
print "Connected...."
time.sleep(1)
device.host

file = open(fileName, 'r')

myhex = file.read()

device.send_data(myhex.decode('hex'))
print "Code Sent...."

4. sendmore-bl.sh

#!/usr/bin/python

import broadlink
import time
import sys

try:
    fileName = sys.argv[1]
except IndexError:
    fileName = 'null'

if fileName == 'null':
   print "Error - kein Dateiname angegeben"
   sys.exit()
else:
 device = broadlink.rm(host=("<your RM3 IP address>",80), mac=bytearray.fromhex("<your RM3 mac>"))

# print "Connecting to Broadlink device...."
 device.auth()
 time.sleep(1)
# print "Connected...."
 device.host

# Pfad aus Aufruf extrahieren und dann den Befehl selbst vom Stapel nehmen
 Parameter = sys.argv
 # Name des Befehls selbst
 filename1 = Parameter[0]
 # Gesamtlaenge
 FileNameLaenge = len(filename1)
 # in Bestandteile aufteilen
 filearray = filename1.split("/")
 # den letzten identifizieren. Das ist der eigentliche Befehl
 splitNo = len(filename1.split("/"))
 lastElement = filearray[splitNo-1]
 # den vom Aufruf wegschneiden, um den Pfad zu bekommen
 FileNameAbzug = len(lastElement)
 Ende = FileNameLaenge - FileNameAbzug
 Pfad = filename1[0:Ende]
 # Befehl aus der Liste loeschen, damit die Parameter bleiben
 Parameter.pop(0)

 # repeat for each argument
 for argument in Parameter:
    fileName = Pfad + argument +".txt"
    file = open(fileName, 'r')
    myhex = file.read()
    device.send_data(myhex.decode('hex'))
    time.sleep(0.5)
# print "Code Sent...."
sys.exit()

Dann in dem Verzeichnis noch die Dateibesitzer wechseln und die Skripte ausführbar machen:

sudo chown fhem.dialout *.sh
sudo chmod 744 *.sh

Konfiguration

Nun gilt es, die IP und MAC-Adresse des Broadlink herauszufinden. Entweder man schaut im Router nach, benutzt die Android-App FING oder das Script "search-bl.sh". Dazu

sudo ./search-bl.sh

Beispielhaft kommt dann:

************************************************
Using python library created by Matthew Garrett
https://github.com/mjg59/python-broadlink
************************************************
Scanning network for Broadlink devices....
Found 1 broadlink devices
...............
Device 1 Host address = '192.168.1.16', 8
Device 1 MAC address = b4 43 0d aa b3 54
...............

Für später sind die IP Adresse und die MAC Adresse wichtig. Diese müssen im zweiten bis vierten Script eingetragen werden!! Ich benutze da den Editor nano.

sudo nano ./learn-bl.sh
sudo nano ./send-bl.sh
sudo nano ./sendmore-bl.sh

Dabei die doppelten Anführungszeichen stehen lassen und an der passenden Stelle jeweils die IP und an der anderen die MAC-Adresse (mit Leerzeichen anstelle der Doppelpunkte) eintragen. Das erste Script liefert die auch so formatiert. Wenn man sie aber aus dem Router hat oder so, dann eben beachten!

Das zweite Script dient zum Anlernen des Fernbedienungscodes und Abspeichern in jeweils einer txt Datei. Das Script verbindet sich mit dem Broadlink und erwartet einen Namen für den Code. Dann hat man 5 Sec Zeit, um die entsprechende Fernbedienungstaste zu drücken, um den Code anzulernen. Dieser wird dann in eine Datei mit dem Codenamen gespeichert. So kann man alle seine zu verwendenden Codes nacheinander anlernen.

sudo ./learn-bl.sh

zeigt Folgendes an:

Connecting to Broadlink device....
Connected....
Bitte Namen für den Code eingeben, z.B. tvOff test
Wenn die LED am Broadlink angeht, innerhalb von 5 Sek die FB-Taste drücken 
Hex code gespeichert unter test.txt

Betrieb

Mit dem dritten und vierten Script kann man den Code wieder senden. Auch hier wieder die eigene IP Adresse und MAC Adresse des Broadlink von oben eintragen.

Der Aufruf im Terminal ist für das dritte Skript:

sudo /opt/BroadLink/send-bl.sh /opt/BroadLink/test.txt 

Wichtig ist bei diesem Skript, für das Textfile den ganzen Pfad anzugeben, und der in test.txt gelernte Befehl wird gesendet.

Aus FHEM heraus kann dann z.B. auf der Eingabezeile gesendet werden:

 "/opt/BroadLink/send-bl.sh /opt/BroadLink/test.txt"

Dabei sind die " " wichtig, da es sich um einen Shell-Befehl handelt.

So kann man das dann auch in at-, notify- oder DOIFs verwenden. Hier mal ein Beispiel:

define atAbendsLichtAn at *19:00:00 "/opt/BroadLink/send-bl.sh /opt/BroadLink/FB1An.txt"

Das 4. Skript "sendmore-bl.sh" ist eine Modifikation des Send-Skripts. Die Unterschiede sind:

1. Es sendet auch mehrere Codes nacheinander, also z. B. auch Zahlenfolgen wie "0202".

2. Es nimmt an, dass die Codes als .txt-Dateien im selben Verzeichnis liegen wie das Skript.

3. Das Skript gibt keine Meldungen aus. Die sind beim Aufruf aus FHEM heraus auch unnötig.

Das Skript extrahiert aus dem Befehlsaufruf den Pfad und ergänzt ihn jeweils bei den Parametern sowie um die Dateierweiterung ".txt". Daher kann der Aufruf dann kürzer sein. Angenommen, es sind die Code-Dateien 1.txt, 2.txt, 3.txt usw. im selben Verzeichnis wie die Skripte vorhanden, lautet der Aufruf im Terminal dann z.B. nur noch:

/opt/BroadLink/sendmore-bl.sh 1 2 3 2

Im "define" lautet das oben genannte Beispiel:

define atAbendsLichtAn at *19:00:00 "/opt/BroadLink/sendmore-bl.sh FB1An"

Feintuning

Im 4. Skript definiert die Zeile (kurz vor Ende)

    time.sleep(0.5)

die Wartezeit zwischen zwei gesendeten "Tasten". Bei vielen Geräten funktioniert das auch, wenn man die Zeile auskommentiert oder löscht. Dann werden die Signale schneller hintereinander gesendet. Man kann hier natürlich auch den Wert 0.5 verändern. Einfach ausprobieren!

Mehrere Bridges betreiben

Um mehrere Bridges nebeneinander zu betreiben, braucht man für jedes Gerät das dritte oder vierte Skript unter eigenem Namen, also z.B. sendmore-bl-WoZi.sh und sendmore-bl-SchlafZi.sh und sendmore-bl-Kueche.sh. In diese müssen die jeweils zugehörenden IP- und MAC-Adressen eingetragen werden. Dann entscheidet man über den Aufruf, welche Bridge den Befehl bekommt. Dabei kann man die gelernten Codes für alle Bridges nutzen und muss sie nicht für jede Bridge neu anlernen.

Bekannte Probleme

Man kann mit dem dritten Skript nur einzelne Tastendrücke senden. Und der Aufruf von mehreren Befehlen nacheinander liegt so weit auseinander, dass das nicht als Folge von Befehlen ankommt, sondern jeweils als Einzelbefehle. Dafür kann man das 4. Skript ausprobieren.

Einige User berichten von diesem Fehler:

 Traceback (most recent call last):
 File "/opt/BroadLink/send-bl.sh", line 34, in <module>
   device.send_data(myhex.decode('hex'))
 File "/usr/local/lib/python2.7/dist-packages/broadlink-0.3-py2.7.egg/broadlink/__init__.py", line 455, in send_data
   self.send_packet(0x6a, packet)
 File "/usr/local/lib/python2.7/dist-packages/broadlink-0.3-py2.7.egg/broadlink/__init__.py", line 250, in send_packet
   response = self.cs.recvfrom(1024)
 socket.timeout: timed out

Abhilfe schafft, in der Datei "/usr/local/lib/python2.7/dist-packages/broadlink-0.3-py2.7.egg/broadlink/__init__.py" Zeile 249 den Timeout von 1 Sekunde auf z.B. 5 Sekunden zu stellen: self.cs.settimeout(5)

Bei der Einrichtung via Smartphone-App gibt den AP-Modus: in diesem wird im Gateway ein WLAN-AP aktiviert, unverschlüsselt, mit dem sich das Smartphone dann verbindet. Über das für Sniffer offene WLAN wird dann SSID und Passwort des lokalen WLAN übermittelt, worauf sich das Gateway versucht dort anzumelden. Die Einrichtung über diesen Weg legt das WLAN Passwort für Sniffer ohne weiteren Aufwand offen. Das Risiko ist auf diese eine Übertragung begrenzt.

Hinweis

Wenn alles funktioniert, kann man aus dem dritten Skript natürlich die Bildschirmausgaben löschen, da es ja in FHEM im Hintergrund aufgerufen wird. Umgekehrt kann man sie auch im 4. Skript wieder "freischalten", indem man die # vor den "print"-Anweisungen löscht.

Gelegentlich auftretende Fehlermeldungen (die nur im Terminal sichtbar sind), tun der Funktion (bei mir) keinen Abbruch.