diff --git a/README.md b/README.md index d3f2617..dd335cd 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,35 @@ -# ubnt-freifunk-map-api +# Freifunk Meshviewer Unifi Access Points und Richtfunkstrecken import -Use the API of UNMS and Unifi Controller to display Unifi Hardware in Freifunk Map \ No newline at end of file +Dieses tool Importiert Nodes für die Freifunk Map aus den APIs UNMS (Richtfunk) & Unifi (Access Points) + +## Config + +### Unifi Access Points + +In der Datei ucDevices.json können die Access Points gepflegt werden, die auf der Freifunk Map erscheinen sollen. + +Hierzu muss die Datei im json Format erweitert werden. + +Für jedes Gerät muss dieser Block angelegt werden: +```json +{ + "name": "ROUTERNAME", + "mac": "00:00:00:00:00", + "gateway_nexthop": "1234567890", + "gateway": "1234567890", + "linked_to": "18:e8:29:24:17:0a", + "domain": "unifi", + "location": { + "longitude":7.148406208, + "latitude":50.817093402 +}, +``` +Erklärung: +* name: Dient nur zur Wiedererkennung. Auf der Map erscheint der Name aus dem Unifi Controller +* mac: Die MAC Adresse des Access Points. Zu finden im Controller. (Statistik Übersicht in der Geräteansicht) +* gateway_nexthop: Die Node ID (MAC ohne :) des Freifunk Routers an den der AP angeschlossen ist. +* gateway: Im Normalfall die NodeID des Supernodes (zu finden in der MAP) +* linked_to: (Optional) Die MAC Adresse des Routers an dem der AP angeschlossen ist. Normalerweise gateway_nexthop mit Doppelpunkten. Wenn nicht gesetzt wird kein Link auf der Map angezeigt. +* domain: Die Domain in der sich der AP befindet. (TDF, UML, FLU) + +Die Blocks müssen am ende immer ein , haben. Nur der Letzte Block nicht! \ No newline at end of file