Skip to content

Latest commit

 

History

History
262 lines (150 loc) · 7.54 KB

README.md

File metadata and controls

262 lines (150 loc) · 7.54 KB

NEEO Brain und NEEO Fernbedienung

Version Version

Modul für IP-Symcon ab Version 5

Dokumentation

Inhaltsverzeichnis

  1. Funktionsumfang
  2. Voraussetzungen
  3. Installation
  4. Funktionsreferenz
  5. Konfiguration
  6. Anhang

1. Funktionsumfang

Das Modul stellt eine Schnittstelle für das NEEO Fernbedienungssystem zu IP-Symcon 5 zur Verfügung. Mit dem Modul ist es möglich von einem NEEO Brian aus IP-Symcon zusteuern, auf gesendete Befehle von NEEO kann reagiert werden z.B. mit einem Ereigniss oder einem Skript . Weiterhin ist es auch möglich Geräte aus IP-Symcon auf einem NEEO Brian zu steuern.

Funktionen:

  • NEEO Oberfläche aus dem Webfront aufrufbar
  • Schalten von an NEEO angelernten Geräten
    • Starten und Beenden von Rezepten
    • Ein- / Ausschalten von Geräten
    • Dimmen von Lampen
    • Aufrufen aller Befehle für ein Gerät
  • Binden der Befehle oder Rezepte an Alexa, Google, Homekit
  • Anlegen von Verknüpfungen der NEEO Rezepte für mobile Visualisierung z.B. Apple Watch

2. Voraussetzungen

  • IP-Symcon 5
  • NEEO Brian

3. Installation

a. Laden des Moduls

Die IP-Symcon (min Ver. 5) Konsole öffnen. Im Objektbaum unter Kerninstanzen die Instanz Modules durch einen doppelten Mausklick öffnen.

Modules

In der Modules Instanz rechts oben auf den Button Hinzufügen drücken.

ModulesAdd

In dem sich öffnenden Fenster folgende URL hinzufügen:

https://github.com/Wolbolar/IPSymconNEEO  

und mit OK bestätigen.

Anschließend erscheint ein Eintrag für das Modul in der Liste der Instanz Modules

b. Einrichten der Geräte in NEEO

Mit der NEEO App sind zunächst die Geräte einzurichten, die später aus IP-Symcon angesteuert werden sollen. Geräte aus IP-Symcon werden in einem späteren Schritt in NEEO angelegt. Zunächst werden also alle IR Geräte in NEEO angelegt, die gesteuert werden sollen.

c. Einrichtung in IPS

Zunächst den IO für NEEO anlegen. In IP-Symcon im Objektbaum auf I/O Instanzen mit der rechten Maustatse klicken und Objekt hinzufügen -> Instanz auswählen. NEEOIO

In der NEEO IO Instanz ist die IP Adresse vom NEEO Brain einzutragen, diese kann in der NEEO APP unter About LAN IP / WLAN IP nachgeschaut werden. Optional kann noch ein Skript angeben werden, falls man die Daten von NEEo direkt in einem Skript weiterverarbeiten will.

Ein Skript zum Auswerten der Daten sieht im Grundgerüst so aus

$action = $_IPS['action'];
$device = $_IPS['device'];
$room = $_IPS['room'];
$actionparameter = $_IPS['actionparameter'];
$recipe = $_IPS['recipe'];

if($action == "launch" && $recipe == "LIGHT") // if action is launch and the recipe is LIGHT do something
{
IPS_LogMessage("NEEO Forward Script", "Recipe ". $recipe . " was triggered");
// add device to trigger

}

Übergebene Parameter von NEEO werden ebenfalls in Variablen abgelegt. NEEOIO

So kann man mit Ereignissen z.B. auf einen bestimmten Wert einer Variable reagieren.

NEEO Geräte in IP-Symcon anlegen

Um Geräte aus NEEO als Instanzen in IP-Symcon anzulegen kann ein Konfigurator genutzt werden. In IP-Symcon im Objektbaum auf Konfigurator Instanzen mit der rechten Maustaste klicken und Objekt hinzufügen -> Instanz auswählen.

Sprachsteuerung

Wenn eine Sprachsteuerung genutzt werden soll muss zunächst der entsprechende Dienst in IP-Symcon eingerichtet werden

Alexa

Alexa Einrichtung

Google Home

Google Home Einrichtung

Homekit

Homekit Einrichtung

Wenn der Dienst vorhanden ist kann ein Schalter aktiviert werden. Dann werden für alle vorhandenen NEEO Rezepte automatisch im Sprachdienst ein Schalter angelegt. Der Name sollte dann im entsprechenden Sprachdienst noch überprüft und gegebenfalls angepasst werden.

NEEOConfigurator

Nachdem der Konfigurator angelegt wurde kann ein Gerät über erstellen erzeugt werden.

NEEOConfigurator

In dem Gerät sieht man dann was das Gerät in NEEO selber an Schaltoptionen zur Verfügung stellt.

NEEODevice

Webfront Ansicht

NEEO UI

NEEOWEBUI

Webfront Beispiel Lampe

NEEOWebfront

Apple Watch Ansicht

Apple Watch 1

Apple Watch 2

Home App Ansicht Apple Watch

Apple Watch 3

Apple Watch 4

4. Funktionsreferenz

NEEO:

Senden eines Befehls an eine Gerät

NEEO_SendCommand(int $InstanceID, string $command);

Parameter $InstanceID ObjectID der NEEO Geräte Instanz

Parameter $command Befehl verfügbare Befehle können in der Liste der Geräte Instanz nachgeschlagen werden

Startet ein Rezept

NEEO_StartRecipe(int $InstanceID);

Parameter $InstanceID ObjectID der NEEO Geräte Instanz

Beendet ein Rezept

 NEEO_EndRecipe(int $InstanceID);

Parameter $InstanceID ObjectID der NEEO Geräte Instanz

Schaltet ein Gerät ein

NEEO_PowerOn(int $InstanceID);

Parameter $InstanceID ObjektID der NEEO Geräte Instanz

Schaltet ein Gerät aus

NEEO_PowerOff(int $InstanceID);

Parameter $InstanceID ObjektID der NEEO Geräte Instanz

Schaltet LED des Brain ein

NEEO_LED_On(int $InstanceID);

Parameter $InstanceID ObjektID der NEEO Cranium Instanz

Schaltet LED des Brain aus

NEEO_LED_Off(int $InstanceID);

Parameter $InstanceID ObjektID der NEEO Cranium Instanz

Reboot des NEEO Brain

NEEO_Brain_Reboot(int $InstanceID);

Parameter $InstanceID ObjektID der NEEO Cranium Instanz

5. Konfiguration:

Eigenschaften:

Eigenschaft Typ Standardwert Funktion
Host string IP Adresse des NEEO Brain

6. Anhang

a. Funktionen:

NEEO:

Schaltet ein Gerät ein

NEEORD_PowerOn($InstanceID);

Parameter $InstanceID ObjektID der NEEO IO Instanz

Schaltet ein Gerät aus

NEEORD_PowerOff($InstanceID);

Parameter $InstanceID ObjektID der NEEO IO Instanz