ubnt-freifunk-map-api/README.md

Freifunk Meshviewer Unifi Access Points und Richtfunkstrecken import

Dieses tool Importiert Nodes für die Freifunk Map aus den APIs UNMS (Richtfunk) & Unifi (Access Points)

Config

Unifi Access Points (ucDevices.json)

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:

{
    "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, inn, flu)

UNMS Richtfunkstrecken

In der Datei devices.json können die Richtfunkstrecken gepflegt werden, die auf der Freifunk Map erscheinen sollen.

{
  "name": "Rathaus2Bahnhof",
  "mac": "18:E8:29:8E:C6:4D",
  "gateway_nexthop": "18e8292f7de6",
  "gateway": "a28cae6ff604",
  "domain": "rifu",
  "location": {
    "longitude":7.148406208,
    "latitude":50.817093402
  }
}

Erklärung:

• name: Dient nur zur Wiedererkennung. Auf der Map erscheint der Name aus dem UNMS Controller
• mac: Die MAC Adresse des Gerätes. Zu finden im Controller.
• gateway_nexthop: Die Node ID (MAC ohne :) des Freifunk Routers an dem das Gerät angeschlossen ist.
• gateway: Im Normalfall die NodeID des Supernodes (zu finden in der MAP)
• domain: Die Domain in der sich der AP befindet. (tdf, inn, flu)

Config.json

Es gibt 3 Module die Ein/Ausgeschatet werden können:

• UNMS
• Unifi
• Meshviewer

Die Funktion Meshviewer importiert die vorhandenen meshviewer.json und manipuliert dort die Userzahlen. Sobald ein Access Point einen Node aus einer Meshviwer.json als "gateway_nexthop" eingetragen hat, werden die Clients an dem verbundenen Access Point und nicht mehr am Offloader angezeigt.