UniFi Toolbox

Die UniFi Toolbox ist eine Sammlung von Modulen, welche verschiedene Aktionen in Verbindung mit einem UniFi Netzwerk Controller unterstützen.

Inhaltsverzeichnis

1. Voraussetzungen
2. Installation
3. Komponenten des Moduls
4. Wird Hilfe benötigt oder hast du Vorschläge/Ideen?
5. Mitarbeit

1. Voraussetzungen

• Symcon 5.5 oder höher
• UniFi DreamMachine / UniFi Controller
• lokaler User (nicht Owner mit Mailadresse!)

2. Installation

Variante 1 (empfohlen): Modulverwaltung (Module Control)

Über das in der IP Symcon Console (unter Core Instances/Kerninstanzen) enthaltene Modulverwaltung (Module Control) die URL https://github.com/elueckel/Unifi-Toolbox manuell hinzufügen.

Anschließend steht das Modul zur Verfügung und eine Unifi-Toolbox Modul Instanz kann hinzugefügt werden.

Anmerkung: Per Klick auf das Zahnradsymbol kann in der Modulverwaltung ganz einfach für Tests zwischen "main" (stabile und getestete Versionen) und "beta" (enthält neuste Funktionen, welche teils getest und ggf. fehlerbehaftet sind) hin- und hergewechselt werden.

Variante 2: Module Store

Über den in der IP Symcon Console integrierten Module Store das 'Unifi-Toolbox'-Modul installieren.

Anschließend steht das Modul zur Verfügung und eine Unifi-Toolbox Modul Instanz kann hinzugefügt werden.

3. Komponenten des Moduls

Folgende Module beinhaltet das UniFi Toolbox Repository:

• UniFi Presence Manager (Dokumentation)
  Mit dem Presence oder Anwesenheitsmanager ist es möglich Geräte die mit dem Netzwerk verbunden sind zu überwachen, z.B. um die Anwesenheit zu bestimmen.

• UniFi Internet Controller (Dokumentation)
  Der Internet Controller ermöglich die Erfassung von Informationen zur Internetverbindung, wenn eine USG oder DreamMachine eingesetzt wird.

• UniFi Endpoint Blocker (Dokumentation)
  Mit dem Endpoint Blocker können Geräte anhand ihrer MAC Adresse vom Zugang auf das Netzwerk geblockt werden, z.B. um die Nutzung von Geräten im Kinderzimmer nach 20 Uhr zu sperren und am Morgen wieder zu aktivieren.

• UniFi Device Monitor (Dokumentation)
  Mit dem Device Monitor können Geräte von UniFi überwacht werden - es stehen bei Firewalls (UDM/USG) Daten zur Internetverbindung zur Verfügung, bei generischen Geräten Daten zum Status und Hardware.

• UniFi Endpoint Monitor (Dokumentation)
  Mit dem Multi Endpoint Monitor können mit den UniFi Netzwerk verbunde mehrere Geräte überwacht werden. Hierbei wird zwischen Kabel und WLAN Verbindungen unterschieden, da im WLAN weit mehr Daten zur Verfügung stehen.

• UniFi Multi Endpoint Monitor (Dokumentation)
  Mit dem Endpoint Monitor können mit den UniFi Netzwerk verbunde einzelne Geräte überwacht werden. Hierbei wird zwischen Kabel und WLAN Verbindungen unterschieden, da im WLAN weit mehr Daten zur Verfügung stehen.

• UniFi PoE Control (Dokumentation)
  Mit dem PoE Control Modul können einzelne PoE Ports neu gestrtet werden, um z.B. einen Teset bei einer Webcam oder ähnlichem durchzuführen.

Für detaillierte Informationen zu den Modulen, wie z.B. zur Version bitte die Hilfeseiten der Module besuchen.

Dieses Modul ist für die nicht kommerzielle Nutzung kostenlos - bei kommerzieller Nutzung bitte den Author kontaktieren.

4. Wird Hilfe benötigt oder hast du Vorschläge/Ideen?

Wir sind gerne bereit dir zu helfen. Hast du Fragen oder Probleme, erstelle einfach eine Frage in GitHub-Discussions.

Es sind auch alle Vorschläge für Erweiterungen und Verbesserungen willkommen, welche ebenfalls in GitHub-Discussions diskutiert werden können.

Sofern ein Fehler/Problem gefunden wurde, kann direkt ein Fehlerticket unter GitHub-Issues erstellt werden.

5. Mitarbeit

Es ist noch einiges an Arbeit zu tun, daher ist jede Unterstützung willkommen!

Wenn du gerne mitarbeiten möchtest und deinen eigenen Beitrag leisten möchtest, hast du folgende Möglichkeiten:

• ein Ticket öffnen und dort deine Code-Änderung erläutern
• deine Code-Änderung direkt zum Review einchecken und einen Pull-Request erstellen

Der Einstieg zum Aufsetzen von Visual Studio Code ist hier beschrieben und gerne wird dir auch dort geholfen, sofern du weitere Startschwierigkeiten haben solltest.