Posts tagged ‘REST’

Hue Programmierung via REST – Teil 4

This entry is part 4 of 4 in the series Hue Programmierung

In diesem Beispiel möchte ich zeigen, wie man mit nur wenigen Zeilen Python-Code „Disco-Lichter“ erzeugt.

Für die Erzeugung der zufälligen Farben (wie auch für die Umwandlung von RGB nach xy) nutze ich ein Projekt von github, https://github.com/benknight/hue-python-rgb-converter, das über eine converter.get_random_xy_color() Funktion verfügt.

Den github-Code lege ich in ein Unterverzeichnis und importiere ihn. Nach der Instanzierung ruf ich in einer
Schleife die erwähnte get_random_xy_color() Funktion auf, die den x und y Wert zurückliefert. Diese beiden Werte werden dann in den REST-String verwandelt und im Abstand von 0.1 Sekunden an die Lampe geschickt.

# -*- coding: utf-8 -*-
"""
@author: Uwe
"""
 
import requests
import time
from rgb_xy import Converter
 
converter = Converter()
light = 'http://192.168.0.123/api/yxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxt/lights/9/state'
 
for i in range(100):
    x, y = converter.get_random_xy_color()
    xy_string = '{"xy":[' +  str(x)+','+ str(y) + '],"transitiontime":0}'
    r = requests.put(light, xy_string)
    time.sleep(0.1)

Uwe

Uwe Ziegenhagen mag LaTeX und Python, auch gern in Kombination. Hat Dir dieser Beitrag geholfen und möchtest Du Dich dafür bedanken? Dann unterstütze doch vielleicht die Dingfabrik Köln e.V. mit einem kleinen Beitrag. Details zur Bezahlung findest Du unter Spenden für die Dingfabrik.

More Posts - Website

Hue Programmierung via REST – Teil 3

This entry is part 1 of 4 in the series Hue Programmierung

In diesem Teil schauen wir uns die möglichen Aufrufparameter für die URL etwas näher an.

Grundsätzlich gilt (entnommen https://www.developers.meethue.com/things-you-need-know (möglicherweise Registrierung nötig)):

  • Die API ist lokal, ohne VPN Zugang kommt man nicht ohne weiteres ran (Gedanken dazu in einem späteren Beitrag)
  • Ist die Lampe an, dann ist sie an. Man sollte nicht in jedem Befehl ein "on":true mitschicken, nur weil man es kann.
  • Lampen sollte man nicht öfter als 10 Mal pro Sekunde neue Befehle erhalten, Gruppen nur einmal pro Sekunde.
  • Zwischen den Wechseln von Farbe, Helligkeit etc. haben die Lampen standardmäßig eine Transition Time von 400 Millisekunden. Möchte man das nicht, muss "transitiontime":0 gesetzt werden.
  • Die Lampen unterstützen drei Farbmodelle
    • Hue, Saturation und Brightness
    • xy im CIE Farbraum
    • ct the Mired Farbtemperatur

    also kein RGB. Es gibt aber Umwandler in den diversen Sprachen.

  • Wenn eine Lampe widersprüchliche Befehle erhält, dann gilt: xy schlägt ct schlägt hsb.

Im nächsten Teil zeige ich, wie man mit ein paar Zeilen Python „Disco-Lichter“ erzeugt.

Uwe

Uwe Ziegenhagen mag LaTeX und Python, auch gern in Kombination. Hat Dir dieser Beitrag geholfen und möchtest Du Dich dafür bedanken? Dann unterstütze doch vielleicht die Dingfabrik Köln e.V. mit einem kleinen Beitrag. Details zur Bezahlung findest Du unter Spenden für die Dingfabrik.

More Posts - Website

Hue Programmierung via REST – Teil 2

This entry is part 3 of 4 in the series Hue Programmierung

Nachdem wir jetzt den API-Schlüssel erstellt haben, können wir ihn zur Abfrage der Konfiguration nutzen. Dazu geht man auf die /debug/clip.html Seite und trägt unter URL /api/#Schlüssel# ein. Nach dem Drücken des GET Buttons erhält man dann im Command Response Fenster die Ausgabe, die aus JSON-Teilen für Lampen, Gruppen und der Konfiguration besteht. Da ich einige Lampen und Gruppen habe, kommen bei mir etwas über 5000 Zeilen zurück.

Die JSON-Struktur ist hierarchisch aufgebaut, durch leichte Anpassungen der URL kann man auf die einzelnen Teile der Konfiguration zugreifen, so erhält man durch

  • /api/#Schlüssel#/lights den Abschnitt mit den Lampen
  • /api/#Schlüssel#/lights/1 den Abschnitt von Lampe 1
  • /api/#Schlüssel#/groups den Abschnitt mit den Gruppen
  • /api/#Schlüssel#/config die Systemkonfiguration

Lampen steuern

Um jetzt einzelne Eigenschaften wie an/aus, Helligkeit und Farbe zu setzen, müssen wir per „PUT“ (nicht „GET“) entsprechende JSON-Schnipsel absenden. Das folgende Beispiel schaltet Lampe 9 aus:

  • URL:
    /api/#Schlüssel#/lights/9/state
  • Message Body:
    {"on":false}

und das folgende wieder an:

  • URL:
    /api/#Schlüssel#/lights/9/state
  • Message Body:
    {"on":true}

Hier jetzt noch das wichtigste Beispiel, das nicht nur an/aus kontrolliert, sondern auch Farbe und Helligkeit:

  • URL:
    /api/#Schlüssel#/lights/9/state
  • Message Body:
    {"on":true, "sat":254,"bri":254, "hue":30000}

Im nächsten Teil dieser Serie schauen wir uns dann an, wie die einzelnen Komponenten umgewandelt werden müssen, um die gewünschte Farbe und Helligkeit zu erhalten.

Uwe

Uwe Ziegenhagen mag LaTeX und Python, auch gern in Kombination. Hat Dir dieser Beitrag geholfen und möchtest Du Dich dafür bedanken? Dann unterstütze doch vielleicht die Dingfabrik Köln e.V. mit einem kleinen Beitrag. Details zur Bezahlung findest Du unter Spenden für die Dingfabrik.

More Posts - Website

Hue Programmierung via REST – Teil 1

This entry is part 2 of 4 in the series Hue Programmierung

Der folgende Artikel und seine Folgeartikel sind für diejenigen gedacht, die ein Philips Hue System ihr Eigen nennen und ein wenig tiefer in die Programmierung einsteigen möchten. Grundvoraussetzung ist eine aktive Hue Bridge im lokalen Netz und mindestens eine gekoppelte Lampe.

In diesem Artikel erstellen wir einen neuen Api-Schlüssel, den wir für alle weiteren Experimente brauchen. In den Folgeartikeln zeige ich dann, wie man mittels Webinterface, CURL und Python entsprechende Befehle an die Hue Bridge senden kann.

Grundsätzliches

Die IP-Adresse der Hue Bridge bekommen wir über den Router raus, sofern wir sie nicht kennen, Philips selbst zeigt noch andere Wege. Ruft man diese IP-Adresse im Browser auf, so kommt nur die Webseite des Systems zusammen mit den Hinweisen auf die entsprechenden Opensource-Lizenzen, nichts sonderlich spannendes.

Spannender wird es allerdings, wenn man die IP-Adresse mit der URL /debug/clip.html aufruft. Dann nämlich präsentiert sich ein Formular mit mehreren Textfeldern und Buttons, die wir im Laufe der Artikel noch näher kennenlernen werden.

Drückt man den GET-Button, kommt die folgende Meldung zurück:

[
	{
		"error": {
			"type": 1,
			"address": "/",
			"description": "unauthorized user"
		}
	}
]

Der Hue Bridge fehlt also der entsprechende Authentifizierungsschlüssel, ohne den keine Befehle angenommen werden. Um einen solchen Schlüssel zu erstellen, geht man wie folgt vor:

  1. Drücke den Link-Button oben auf der Hue Bridge
  2. Gib in der URL Box /api ein
  3. Gib in der Message Body Box einen Text analog zum folgenden Muster ein

    {"devicetype":"commandline#Uwe"}. Ich habe hier einen Hinweis auf meine Kommandozeile als Namen gewählt, letztlich ist man hier aber recht frei. So nennt sich IFFT bei mir „ifft2“, der Logitech Harmony Hub heißt einfach „Harmony Hub“

Wenn alles geklappt hat, dann antwortet die Bridge mit einer Antwort analog zur folgenden:

[
	{
		"success": {
			"username": "yxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxt"
		}
	}
]

Der zufällige String hinter username, hier unkenntlich gemacht, ist der entsprechende Schlüssel, den wir bei jeder Anfrage an die HUE Bridge mitliefern müssen. Es empfiehlt sich daher, den in einer Textdatei zu parken und keinesfalls zu veröffentlichen.

Uwe

Uwe Ziegenhagen mag LaTeX und Python, auch gern in Kombination. Hat Dir dieser Beitrag geholfen und möchtest Du Dich dafür bedanken? Dann unterstütze doch vielleicht die Dingfabrik Köln e.V. mit einem kleinen Beitrag. Details zur Bezahlung findest Du unter Spenden für die Dingfabrik.

More Posts - Website