This page in English

Hausautomation ​

Leg in deiner Basis einen Hebel um, und die Lampe in deiner echten Küche geht an; leg ihn zurück, und sie geht aus. Das Programm schickt den neuen Zustand der Lampe mit HTTP_PUT an deine Hausautomation. Ihr Token – das Passwort der Hausautomation – steht nicht auf dem Blatt, sondern kommt aus einer Konstantenkarte im Auslöserblock.

Funktionen: HTTP_PUT, HTTP_CONNECTION, TO_JSON aus c0de/strings, SLEEP aus c0de/time und GET_LEVER aus c0de/minecraft

Was du brauchst

Die Mod c0de net in deinem Spiel, eine Hausautomation mit HTTP-API in deinem Heimnetz und ein Token dafür, einen Auslöserblock mit einem Hebel obendrauf und eine Konstantenkarte token vom Typ STRING mit dem Token. Um die Anfrage vorher auszuprobieren: einen zweiten Auslöserblock mit Knopf und einen Laptop. Für die Übungen: für jede weitere Lampe einen weiteren Auslöserblock mit Hebel und eine Variablenkarte lamp vom Typ STRING.

Die Idee ​

Die meisten Hausautomationen – eine Zentrale, eine Bridge, eine smarte Steckdose – lassen sich über HTTP schalten. Jede hat ihre eigene API, aber sie ähneln sich: eine Adresse in deinem Heimnetz, ein Endpunkt für die Lampe, der neue Zustand als JSON und ein Token im Header Authorization. Dieses Rezept nimmt eine ausgedachte Zentrale unter homehub.local, Port 8080, die PUT /api/lamps/kitchen mit {"on":true} versteht. Schlag die Adresse, den Endpunkt, die Daten und die Art des Tokens deines eigenen Systems in seiner Dokumentation nach und ändere das Programm entsprechend.

Zwei Dinge machen das möglich, und sicher:

  • Die Anfrage kommt von deinem Computer. c0de net sendet sie vom Computer des Spielers, der den Hebel umlegt, nicht vom Minecraft-Server. Deshalb erreicht sie dein Heimnetz, wenn du zu Hause spielst – auch auf einem Server weit weg. Ein Freund, der den Hebel umlegt, sendet sie von seinem Computer, und dort gibt es homehub.local nicht. Jeder Spieler kann Anfragen für seinen eigenen Computer abschalten.
  • Das Token steht nicht auf dem Blatt. Jeder, der das Blatt sieht, kann seine Literale lesen. Das Token kommt stattdessen in eine Konstantenkarte, die sich nicht mehr ändern lässt, sobald sie einen Wert hat, in einem Auslöserblock, den nur du ändern kannst.

Das Programm ​

c0de
PROGRAM homelamp
NOOP
INCLUDE c0de/minecraft
INCLUDE c0de/strings
INCLUDE c0de/time
INCLUDE c0de_net/http
NOOP
FUNCTION send
    PARAMETER token STRING
    PARAMETER on BOOLEAN
BEGIN
    VARIABLE hub STRUCT c0de_net/http/HTTP_CONNECTION
    VARIABLE state BOOLEAN TAG(json: "on")
    VARIABLE data STRING
    ASSIGN hub.server "homehub.local" ;
    ASSIGN hub.port 8080 ;
    ASSIGN hub.base_endpoint "/api" ;
    ASSIGN hub.headers["Authorization"] "Bearer " ⊕ token ;
    ASSIGN hub.headers["Content-Type"] "application/json" ;
    ASSIGN hub.timeout 5 ;
    ASSIGN state on ;
    CALL c0de/strings/TO_JSON
        PARAMETER value state ;
        RESULT result data
    CALL c0de_net/http/HTTP_PUT
        PARAMETER connection hub ;
        PARAMETER endpoint "/lamps/kitchen" ;
        PARAMETER data data ;
END FUNCTION
NOOP
FUNCTION switch
    PARAMETER token STRING
BEGIN
    VARIABLE lever STRUCT c0de/minecraft/POSITION
    VARIABLE on BOOLEAN TRUE
    ASSIGN lever.x PID.x ;
    ASSIGN lever.y PID.y + 1 ;
    ASSIGN lever.z PID.z ;
    CALL send
        PARAMETER token token ;
        PARAMETER on TRUE ;
    WHILE on ;
    BEGIN
        CALL c0de/time/SLEEP
            PARAMETER ticks 10 ;
        CALL c0de/minecraft/GET_LEVER
            PARAMETER position lever ;
            RESULT result on
    END WHILE
    CALL send
        PARAMETER token token ;
        PARAMETER on FALSE ;
END FUNCTION

Erst die Anfrage ausprobieren ​

Du siehst nicht, was deine Zentrale bekommt, und ein Fehler in den Daten bewirkt einfach nichts. Schick dieselbe Anfrage deshalb zuerst an das Echo von c0de.at, das mit der Anfrage antwortet, so wie sie angekommen ist:

c0de
PROGRAM lamppreview
NOOP
INCLUDE c0de/strings
INCLUDE c0de_net/http
NOOP
STRUCT received
BEGIN
    method STRING
    path STRING
    headers HASH STRING
    body STRING
END STRUCT
NOOP
FUNCTION preview
    PARAMETER token STRING "test"
    PARAMETER on BOOLEAN TRUE
BEGIN
    VARIABLE hub STRUCT c0de_net/http/HTTP_CONNECTION
    VARIABLE state BOOLEAN TAG(json: "on")
    VARIABLE data STRING
    VARIABLE answer STRING
    VARIABLE echo STRUCT received
    ASSIGN hub.use_ssl TRUE ;
    ASSIGN hub.server "c0de.at" ;
    ASSIGN hub.base_endpoint "/api/tutorial/echo" ;
    ASSIGN hub.headers["Authorization"] "Bearer " ⊕ token ;
    ASSIGN hub.headers["Content-Type"] "application/json" ;
    ASSIGN hub.timeout 5 ;
    ASSIGN state on ;
    CALL c0de/strings/TO_JSON
        PARAMETER value state ;
        RESULT result data
    CALL c0de_net/http/HTTP_PUT
        PARAMETER connection hub ;
        PARAMETER endpoint "/lamps/kitchen" ;
        PARAMETER data data ;
        RESULT result answer
    CALL c0de/strings/FROM_JSON
        PARAMETER source answer ;
        PARAMETER destination echo ;
    CALL CLS
    CALL PRINT
        PARAMETER value echo.method ⊕ " " ⊕ echo.path ;
    CALL PRINT
        PARAMETER value "Authorization: " ⊕ echo.headers["authorization"] ;
    CALL PRINT
        PARAMETER value "Content-Type: " ⊕ echo.headers["content-type"] ;
    CALL PRINT
        PARAMETER value echo.body ;
END FUNCTION

Binde den Laptop an lamppreview / preview und starte es mit einem Auslöserblock. Er zeigt:

PUT /api/tutorial/echo/lamps/kitchen
Authorization: Bearer test
Content-Type: application/json
{"on":true}

Nimm hier das Token test, nicht dein echtes: Das Echo zeigt alles, was es bekommt. Mit einer Variablenkarte on auf FALSE ist die letzte Zeile {"on":false}.

Aufbauen und starten ​

  1. Ändere die Adresse, den Port, den Endpunkt und die Daten von send auf die deiner Hausautomation.
  2. Stelle den Auslöserblock auf homelamp / switch und setz den Hebel obendrauf.
  3. Stelle eine Konstantenkarte her: Name token, Typ STRING, dein Token als Wert. Leg sie in das Eingabeinventar des Auslöserblocks. Stelle seinen Knopf Starten durch auf Nur mich.
  4. Leg den Hebel um: Die Lampe zu Hause geht an. Leg ihn zurück: Nach einer halben Sekunde geht die Lampe aus.
The trigger block with the lever on top, switched on, and the PID block of the running process on the sheet

So funktioniert es ​

  • Der Hebel startet es. Den Hebel einzuschalten, gibt dem Auslöserblock einen Redstone-Impuls, und der Block weiß, wer ihn umgelegt hat. Ausschalten startet nichts, also bleibt der Prozess am Leben, solange die Lampe an ist: Er fragt den Hebel alle 10 Ticks mit GET_LEVER ab und sendet „aus“, wenn der Hebel aus ist. Solange ist sein Blatt gesperrt.
  • Wo der Hebel ist. PID.x, PID.y und PID.z sind die Position des Auslöserblocks, also ist der Hebel obendrauf bei PID.y + 1.
  • Die Daten. VARIABLE state BOOLEAN TAG(json: "on") setzt den Wert an den Schlüssel on, also schreibt TO_JSON {"on":true} oder {"on":false}.
  • Die Verbindung. use_ssl bleibt FALSE, weil die meisten Zentralen im Heimnetz einfaches http sprechen; port 8080 und base_endpoint /api ergänzen die Adresse zu http://homehub.local:8080/api/lamps/kitchen. Das Token kommt als Bearer <token> in den Header Authorization, der user und password ersetzt.
  • Das Token ist ein Parameter. switch bekommt es aus der Konstantenkarte und gibt es an send weiter. Nichts Geheimes steht auf dem Blatt.
  • Wenn es fehlschlägt. Ist die Zentrale nicht erreichbar, löst HTTP_PUT REQUEST_FAILED aus, und der Prozess stürzt ab; der Auslöserblock zeigt den Fehler. Die Anfrage „aus“ sendet der Spieler, der die Lampe eingeschaltet hat, also muss er noch online sein.

Probier es selbst ​

  1. Schalte mehrere Lampen mit demselben Programm.
Lösung

Gib switch und send einen Parameter lamp STRING mit dem Standardwert "kitchen" und nimm den Endpunkt "/lamps/" ⊕ lamp. Jede Lampe bekommt ihren eigenen Auslöserblock mit Hebel und einer Variablenkarte lamp, etwa garden; die Konstantenkarte token ist für alle dieselbe.

  1. Ein Freund legt deinen Hebel um, während du online bist. Was passiert?
Lösung

Mit Nur mich am Knopf Starten durch: nichts, der Auslöserblock startet nicht. Mit Spieler startet der Prozess und sendet die Anfrage vom Computer deines Freundes. Wenn er nicht in deinem Heimnetz ist, kennt sein Computer homehub.local nicht, und der Prozess stürzt mit REQUEST_FAILED (1003) ab. Deine Lampe und dein Token bleiben sicher.

Mehr dazu ​