[Modul] Unfolded Circle Remote 3 – Integration Driver & Dock Support

[Modul] Unfolded Circle Remote 3 – Integration Driver für IP-Symcon

Hallo zusammen,

nach einiger Entwicklungszeit möchte ich hier eine Beta-Version meines Integrationsmoduls für die Unfolded Circle Remote 3 vorstellen.

Ziel des Moduls ist eine saubere und bidirektionale Integration der Remote 3 in IP-Symcon – ohne Cloud-Abhängigkeit und vollständig über die offizielle Core-API des Herstellers Unfolded Circle.


:rocket: Funktionsumfang (aktuell Betatest)

Remote 3 Core Manager (Remote 3)

  • WebSocket Verbindung zur Remote 3 um Events der Remote 3 auszuwerten

  • Onlinestatus

  • Batterielevel

  • Makros ausführen

  • aktives Makro

  • Systeminfos der Remote 3

Integration Driver (Remote 3)

  • WebSocket Server für die Remote 3

  • bidirektionale Kommunikation

  • automatische Geräteerkennung

  • Unterstützung für:

    • Button

    • Switch

    • Light

    • Climate

    • Media Player

    • Cover (Rollladen)

    • Sensor

  • Entity-State Synchronisierung

  • Setup-Workflow für die Remote

  • API-Version Handling

  • IPSModuleStrict kompatibel

Dock 3 Manager (UCD3)

  • WebSocket Kommunikation mit dem Dock

  • sysinfo Abfrage

  • Status- und Hardwareinformationen

  • automatische Variablenanlage


:building_construction: Architektur

Symcon kontrolliert Remote 3
⇅ WebSocket
Remote 3 Core Manager

Remote 3 Instanz (Anzeige Status)

Remote 3 kontrolliert Symcon Geräte
⇅ ServerSocket
Remote 3 Integration Driver

IP-Symcon Geräte / Module

Dock:
Dock 3
⇅ WebSocket Client
Dock Manager (Splitter)

Dock Instanzen


:gear: Voraussetzungen

  • IP-Symcon 8.2+

  • PHP 8.x

  • IPSModuleStrict, daher aktuelle Symcon Version

  • Remote 3 Firmware ≥ 2.8.3


:test_tube: Status

Das Modul befindet sich aktuell im Beta-Test.

Installation über den Modul Store und dort suchen nach

Unfolded Circle Remote 3

Eine Dokumentation wird noch erstellt. Das Einbinden von Symcon in die Remote 3 mit Absicherung eines Tokens muss noch ergänzt werden. Das Modul ist noch nicht als Stable Im Modul Store verfügbar und muss daher gezielt über den Namen gesucht werden.

Die Grundfunktionen sind implementiert und getestet, jedoch sind weitere Optimierungen und Feedback aus der Praxis ausdrücklich erwünscht. Insbesondere das automatische einlesen von Gerätetypen wäre etwas für die Zukunft.


:package: Repository

GitHub: IPSymonUnfoldedCircleRemote3


:pushpin: Mögliche Erweiterungen

  • bessere Media Player Metadaten

  • Cover Art Unterstützung

  • erweitertes Mapping

  • optimiertes Setup

  • UI/IPSView Templates


:man_raising_hand: Feedback

Ich freue mich über:

  • Testberichte

  • Verbesserungsvorschläge

  • API-Diskussionen der Remote 3

  • Performance-Hinweise

  • Beteiligung an der Weiterentwicklung des Moduls

Da es aktuell keine offizielle Symcon-Integration für die Remote 3 gibt, würde ich mich freuen, wenn dieses Modul als stabile Lösung für die Community wachsen kann und sich vielleicht der ein oder andere Nutzer der Remote 3 an einer Weiterentwicklung beteiligt.

2 „Gefällt mir“

:pushpin: Zweiter Post (Reserviert – Changelog)

  • Testing Kanal des Moduls ist zur Zeit nicht mehr verfügbar, es müssen keine Einladungen ausgestellt werden, das Modul ist im Beta Bereich des Moduls Stores zu finden unter
    Unfolded Circle Remote 3
  • Dokumentation zur Ersteinrichtung ergänzt
  • Alle Aktivitäten werden ausgelesen
  • Token wird von der Remote 3 über Header nicht Message angefordert
  • Gerätesuche für Hue, Spotify, PlayStation, Denon AVR, Sonos hinzugefügt
  • IR-Steuerung über Dock 3 aus IP-Symcon implementiert
  • IR-Befehle können jetzt vom Modul an das Dock gesendet werden (z.B. TV, Beamer, Leinwand)
  • Unterstützung für Wiederholungen (Repeat) pro IR-Befehl
  • Auswertung der Dock-Antworten (ir_send) mit verbesserter Debug-Ausgabe
  • Doppelte Antworten werden anhand der req_id gefiltert

:pushpin: Dritter Post (Reserviert – Known Issues)

  • Automatische Geräte Suche ist nur für einzelne Gerätetypen und Hersteller integriert, die meisten Geräte müssen zur Zeit noch von Hand hinzugefügt werden. Dazu das Expansion Panel öffnen und dann auf Hinzufügen klicken
  • Die Remote 3 sendet noch keinen Token zur Sicherheit an Symcon
  • Der Konfigurationssetup auf der Remote 3 zeigt zur Zeit noch nicht Zwischenschritte an um den Token zu übergeben
  • eine ausführliche Dokumentation ist in Arbeit und wird Stück für Stück ergänzt
  • Befehle für das Dock 3 Administration noch teilweise zu vervollständigen, IR senden geht
  • Authentifizierung beim Dock3 noch unklar was für ein Token bzw. funktioniert zur Zeit noch nicht

Klingt gut.

Dann muss ich mich jetzt nur noch dazu durch Ringen mit dem produktiv System aus auf 9.0RC zu wechseln oder eine Test Umgebung auf setzen. :grinning_face:

Sollte ja hoffentlich nicht mehr so lange dauern. Ansonsten Version 8.2 von Symcon geht auch.

9.0RC ist schon raus wenn ich das richtig gesehen habe und die 8.2 ist die Beta der 9.0

[Edit] Wenn man die aktuell Beta installiert bekommt man die 9.0RC

Hallo fonzo erstmal danke fürs Modul und die Mühe bin noch nicht recht zum Testen gekommen aber mal ein Par ersteindrücke

Installieren des Modules ich weis nicht stell ich mich blöd an oder war es einfach kompliziert zum einrichten bzw nicht sehr intuitiv es sind irgendwie sehr viele Instanzen mit sehr vielen Buttons wo man nicht so recht weis was wann wo drücken bzw. erstellen irgendwann ging es aber der Weg dahin war nicht so einfach.

Modul läuft jetzt Werte kommen an aber was mir aufgefallen ist das die Verbindung auf der Fernbedienung im ca 5sec Takt abgebrochen wird und wider neu verbunden wird.

Gruß Stefan

Morgen

das mit der nicht stabilen Verbindung ist bei mir auch so.

Die Einrichtung sollte sich eigentlich darauf reduzieren in der Discovery die Fernbedienung aus zu wählen und auf erstellen zu drücken. Dabei sollte dann die Core Manager Instant und eine Device Instanz erstellt werden wobei die Einstellungen automatisch gesetzt werden.

Ob der Integrations Driver automatisch angelegt wird weiß ich jetzt nicht, ich habe alles ohne Discovery gemacht.

Wenn ich auf Gerät hinzufügen drücke kommt eine Fehlermeldung.

Moin,

ich habe auch mal ein wenig rumgespielt:

  1. Es werden “nur” 10 Aktivitäten eingelesen mit
    ”/activities?page=1&limit=50”
    kann man es einfach auf 50 erweitern. Ich habe 26 und sollte schon eher viel haben. Mit dieser Einstellung werden anscheinend alle Aktivitäten eingelesen aber nur die ersten 17 (oder so) haben Namen.
  2. UCD2/UCD3 benutzen stark unterschiedliche URLs
    UCD2 = ws://192.168.178.205:946
    UCD3 = ws://192.168.178.243/ws
  3. Der Konfigurator verlangt den PIN man kann also immer nur eine Instanz erstellen. Das ist aber nicht so schlimm.

Ich benommen die Testingversion nicht mehr angezeigt weil ich wohl ein wenig zu viel gespielt haben. Aktuell habe ich über GIT installiert.

Ralf

Ja ich glaube das automatische Suche von kompatiblen Geräten (symcon variabelen) ist noch Work in Progress.

Einfach die Expansions Panels aufklappen und diet manuell die gewünschten variablen hinzu fügen.

Die Konfigurator Instanz hatte ich jetzt noch gar nicht verwendet, aber da dieser Pin ja nur iniziell benötigt wird um den API Key ab zu rufen, solltest du den ja auch jedes Mal ändern können, wenn du eine neue Remote einrichten willst

Da gebe ich Dir recht es fehlt zur Zeit noch eine ausführliche Dokumentation bzw. Schritt für Schritt Einrichtungsbeschreibung. Da bin ich dran und steht auf der TodDo Liste. Wenn ihr während der Einrichtung an den Stellen wo es nicht intuitiv ist einen Screenshot macht und mir diesen zukommen lasst kann in aus den Bildern auch eine nachvollziehbare Anleitung erstellen.

Das ist mir leider auch schon aufgefallen, in der alten Version ohne IPSModuleStrict war das noch nicht so. Kann aber auch sein das sich auf Seiten von Unfolded Circle etwas mit einem Firmware Update geändert hat das noch berücksichtigt werden muss. Aber das ist das Hauptthema die Authentifizierung der Remote 3 mit Token bei Symcon und die stabile Websocket Verbindung die als erstes innerhalb der Beta Phase gelöst werden muss. Wer also da einen entscheidenden Hinweis hat was noch im Code angepasst werden muss, sind alle die das nutzen wollen dankbar.

Das ist zur Zeit noch nicht aktiv, in der Beta Version. Das ist viel Auswand, wer da also eine Idee hat wie man es am besten schafft Geräte in Symcon einwandfrei einem Gerätetyp zuzuordnen, Ideen und Codevorschläage sind willkommen.
Du musst die Instanzen bzw. also in der Tabelle selber mit einem Hinzufügen ergänzen, siehe Bild.

Das setze ich auf die ToDo liste und schaue ich mir an.

Die Testing Version ist nicht mehr verfügbar, diese ist durch den Beta Kanal ersetzt worden. Es sind also keine Einladungen mehr notwendig und das Modul kann von jedem der will aus dem Modul Store geladen und auch aktualisiert werden, Du musst es also nicht manuell hinzu fügen. Du musst nur ganz korrekt
Unfolded Circle Remote 3

im Modul Store eingeben, sonst findet er das nicht, weil es noch keine Stable Version ist.

Moin Max,

ich weiß das und so habe ich es ja auch gemacht. Ich schrieb ja auch “nicht schlimm” man muss es nur wissen.

Ralf

1 „Gefällt mir“

Danke. Die Dock URLs wären auch was für ToDo.

Ralf

Könntest Du mal, als jemand der das Modul neu einrichtet hat, Rückmeldung geben ob jetzt anhand der Dokumentation eher nachvollziehbar ist, wie man das initial einzurichten hat .

Deutsche Dokumentation

Falls etwas fehlen oder unklar sein sollte, an welchen Stellen würdest Du was ergänzen?

hab mir das ganz mal schnell durchgesehen schaut gut aus und sollte für den Anfang mal reichen was mir noch nicht so 100% klar sind sind die einzelnen Buttons in den ganzen Instanzen braucht man die führ die Einrichtung? bzw. muss man die drücken? zb Neuen Token generieren, mit API Key authentifiziere?

Was mir noch aufgefallen ist das auf der einstellungenseite des Remote 3 Device die ganze Seite immer wider mal schnell blinkt

Hab jetzt mal ein Licht eingebunden funktioniert zwar (meistens) aber ab und an wird angezeigt das keine Verbindung vorhanden ist .

Auch bei der Konfiguration der Entität wird die Lampe las nicht verfügbar angezeigt und auch der Verbindungsstatus bricht immer wider mal ab wie am Foto