elueckel / Unifi-Toolbox

Modul for Symcon integrating UniFi Network devices
2 stars 2 forks source link

Nutzung der Public-Funktionen #29

Closed elueckel closed 2 years ago

elueckel commented 2 years ago

Guten Morgen @Brovning, bei dem Aufruf der Funktionen müssen wir noch die Doku erweitern, da ich noch nicht so richtig weis wie man diese von außen nutzt. Kannst du hierzu bitte mal ein Beispiel senden.

Ich habe mal probiert: $toogle = UniFiDeviceBlocker_block(51689);

Wäre es nicht sinnvoller den Aufruf UniFiDeviceBlocker_Manager(51689, block) oder halt unblock?

Evtl. verstehe ich es auch falsch?

Brovning commented 2 years ago

Hallo @elueckel ,

die Doku habe ich schon ergänzt: https://github.com/elueckel/Unifi-Toolbox/tree/main/UniFi%20Device%20Blocker#5-php-befehlsreferenz

Zuerst die InstanzId des Unifi Device Blocker dynamisch ermitteln (oder statisch setzen): $InstanzID = IPS_GetInstanceListByModuleID("{FC3E71F1-BF95-D45D-0676-BA3D10D02CB8}")[0];

Anschließend die MAC-Adresse ausfindig machen und wie folgt aufrufen: DB_block($InstanzID, $DeviceMacAddress); bzw. DB_unblock($InstanzID, $DeviceMacAddress);

Wäre es nicht sinnvoller den Aufruf UniFiDeviceBlocker_Manager(51689, block) oder halt unblock?

Von einem Aufruf mit String "block" oder "unblock" halte ich wenig. Woher soll denn ein Anwender den Text kennen, ohne die Doku zu studieren. Mit der Autovervollständigung ist es aktuell selbsterklärend: image

Brovning commented 2 years ago

Hierfür ist die Abkürzung relevant, welche du in der module.json unter "prefix" definiert hast. Ich persönlich hätte alle Abkürzungen mit "U" beginnen lassen. Bspw.: "UDB", anstatt "DB"

elueckel commented 2 years ago

Hi, danke für die Infos - machen Sinn. Ich mache aktuell noch mal eine Review ob mir was auffällt.

Das ausgliedern der Funktionen für Token und Daten in ein Bibliothek macht Sinn und schaut auch gut aus. Ich muss noch ein wenig die Zusammenhänge verstehen, aber da muss ich meine Programmierkenntnisse noch ausbauen.

Den Ansatz mit den Funktionen finde ich auch sinnvoll.

Den Wandel zu UDB könnte man machen, ist aber nochmal ein wenig Aufwand mit übersichtlichen Benefits oder übersehe ich hier etwas?

Brovning commented 2 years ago

Den Wandel zu UDB könnte man machen, ist aber nochmal ein wenig Aufwand mit übersichtlichen Benefits oder übersehe ich hier etwas?

Wieso denkst du, dass es viel Aufwand ist? Für DB muss man inkl. Doku an 4 Stellen ändern: image

Bei den anderen Modulen sollten es stets nur 2 Stellen sein, außer es gibt Profile, dann auch dort.

Wenn du möchtest, kann ich das machen. Wäre kein Problem/Aufwand. Wenn ich die Änderung mache, würde ich es auch gleich mit einem Define machen. ;-)

// Modul Prefix
if (!defined('MODUL_PREFIX'))
{
    define("MODUL_PREFIX", "UDB");
}
elueckel commented 2 years ago

Gerne machen, wobei ich dann bei allen Modulen ein U davor packen würde. Dann ist es sauber.

Ich teste gerade noch ob ich den Fehler beinm Wiederverbinden sehen kann der im Forum reported wurde. Wenn dann alles passt, gebe ich heute Abend die 1.3 an das Symcon Team. Ich will das der Master mit dem Leak aus dem Store kommt.

elueckel commented 2 years ago

Kannst du das hier sehen https://github.com/elueckel/Unifi-Toolbox/projects/2?add_cards_query=is%3Aopen ... ist evtl. sinnvoll um Ideen zu sammeln. Evtl. sollten wir dieses Issue hier auch als Blog führen zur Abstimmung?

Brovning commented 2 years ago

Gerne machen, wobei ich dann bei allen Modulen ein U davor packen würde. Dann ist es sauber.

Ist erledigt.

Brovning commented 2 years ago

Evtl. sollten wir dieses Issue hier auch als Blog führen zur Abstimmung?

Für Diskussionen und Abstimmungen, wäre folgende App vermutlich besser geeignet und müsste noch von dir unter Options aktiviert werden: image

Das Wiki könntest du bei der Gelegenheit gleich deaktivieren.

Brovning commented 2 years ago

Kannst du das hier sehen https://github.com/elueckel/Unifi-Toolbox/projects/2?add_cards_query=is%3Aopen ... ist evtl. sinnvoll um Ideen zu sammeln.

Ja, kann ich sehen. Sehr gut! 👍

Brovning commented 2 years ago

Evtl. sollten wir dieses Issue hier auch als Blog führen zur Abstimmung?

Für Diskussionen und Abstimmungen, wäre folgende App vermutlich besser geeignet und müsste noch von dir unter Options aktiviert werden: image

Das Wiki könntest du bei der Gelegenheit gleich deaktivieren.

@elueckel Was hältst du davon? Entfernen wir das Wiki und fügen Discussions hinzu?

elueckel commented 2 years ago

Jo - ist aktiviert.