Quick Start

Nach der Installation von Controller for HomeKit auf einem Gerät öffnen alle Links, die mit controllerforhomekit:// beginnen, die App.

Du kannst folgende Hauptbildschirme der App direkt öffnen:

controllerforhomekit://v1/cameras
controllerforhomekit://v1/accessories
controllerforhomekit://v1/scenes

Standardmäßig beziehen sich alle Links auf das aktuell ausgewählte Zuhause in Controller. Du kannst jedoch den URL-Parameter 'home' anhängen, um ein bestimmtes Zuhause zu öffnen:

controllerforhomekit://v1/scenes?home=Example%20Home

Du kannst bestimmte Detailansichten öffnen, z. B. eine bestimmte Szene, indem du deren Namen und den Zuhause-Namen im Pfad angibst:

controllerforhomekit://v1/cameras/Example%20Camera?home=Example%20Home

Du kannst eine Ansicht mit einem vorausgewählten Smart Folder öffnen, indem du den URL-Parameter 'folder' verwendest:

controllerforhomekit://v1/scenes?home=Example%20Home&folder=My%20Lights

Für Szenen und Workflows kannst du den Parameter 'action' verwenden, damit die App sie ausführt.

controllerforhomekit://v1/scenes/Example%20Scene?home=Example%20Home&action=execute

Du kannst einen Grundriss über den Pfad 'floorplan' öffnen:

controllerforhomekit://v1/floorplan/Example%20Floor%20Plan?home=Example%20Home

Tipp: Wenn du ein Widget in Controller for HomeKit erstellst, kannst du eine Aktion gedrückt halten, um die verwendete URL in die Zwischenablage zu kopieren.

URL Pattern

Das allgemeine Schema für Links zu Controller sieht so aus:

controllerforhomekit://<api-version>/<view>/<target>?home=<home>&folder=<folder>&action=<action>

API Version

Derzeit ist 'v1' der einzig gültige Wert für api-version.

View

Der View-Parameter gibt an, welche Ansichten du über das Hauptmenü der App und Zonen öffnen kannst. Gültige Werte sind:

cameras, accessories, scenes,
automations, workflows, rooms,
zones, backups, logs,
maintenance, serviceGroups, widgets,
watchScreens, nfcTags, settings

Target

Der Target-Parameter gibt eine bestimmte Detailansicht in einer der Hauptansichten an, z. B. eine bestimmte Szene. Du kannst ein Target für folgende Ansichten setzen:

cameras, accessories, scenes,
automations, workflows, rooms,
zones, widgets

Der Wert für Target ist der Name des Objekts, das du öffnen möchtest. Wenn der Name ein Leerzeichen oder Sonderzeichen enthält, musst du ihn prozentcodieren. Siehe Sonderzeichen.

Wenn du ein Target angibst, musst du immer auch ein Zuhause angeben.

Um den Workflow „Check Windows" im Zuhause „My Home" zu öffnen, muss die URL so aussehen:

controllerforhomekit://v1/workflows/Check%20Windows?home=My%20Home

Home

Der Home-Parameter ist optional, wird aber obligatorisch, wenn ein Target oder Folder angegeben ist. Er legt fest, welches Zuhause Controller auswählt. Wenn kein Zuhause angegeben wird, bleibt das aktuell ausgewählte Zuhause ausgewählt.

Leerzeichen und Sonderzeichen im Zuhause-Namen müssen prozentcodiert werden. Siehe Sonderzeichen.

Folder

Der Folder-Parameter öffnet eine Hauptansicht mit einem ausgewählten Smart Folder. Du kannst einen Folder für folgende Ansichten angeben:

accessories, scenes, automations, logs

Leerzeichen und Sonderzeichen im Folder-Namen müssen prozentcodiert werden. Siehe Sonderzeichen.

Wenn du einen Folder angibst, musst du immer auch ein Zuhause angeben.

Um den Smart Folder „Motion Sensors" im Zuhause „My Home" zu öffnen, muss die URL so aussehen:

controllerforhomekit://v1/accessories?home=My%20Home&folder=Motion%20Sensors

Action

Der Action-Parameter gibt an, welche Aktion die URL in Controller for HomeKit auslösen soll. Wenn keine Action angegeben ist, öffnet die App das URL-Ziel.

Derzeit werden zwei Optionen unterstützt:

open, execute

execute kann nur verwendet werden, wenn der Target-Parameter eine Szene oder ein Workflow ist. Die Szene wird dann angewendet bzw. der Workflow sofort ausgeführt, anstatt die Detailansicht zu öffnen.

Sonderzeichen

URLs dürfen keine Leerzeichen oder Sonderzeichen wie Ausrufezeichen, Fragezeichen oder Kaufmanns-Und enthalten. Wenn dein Target, Folder oder Zuhause ein Sonderzeichen enthält, musst du es prozentcodieren.

Zum Beispiel musst du jedes Leerzeichen durch %20 ersetzen. Wenn du also die Szene 'Late Night' in deinem Zuhause 'My Home' öffnen möchtest, muss die URL so aussehen:

controllerforhomekit://v1/scenes/Late%20Night?home=My%20Home

Mehr über Prozentcodierung und die Codes für verschiedene Zeichen erfährst du hier: https://www.w3schools.com/tags/ref_urlencode.ASP