Opennet API: Unterschied zwischen den Versionen

Aus Opennet
Wechseln zu: Navigation, Suche
(Überblick)
(Hinweis auf http-Abruf von ondataservice-Daten)
 
(4 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 12: Zeile 12:
 
* https://api.opennet-initiative.de/api/v1/link
 
* https://api.opennet-initiative.de/api/v1/link
 
* https://api.opennet-initiative.de/api/v1/interface
 
* https://api.opennet-initiative.de/api/v1/interface
 +
 +
Filtern nach AP-Status, z.B. "online" (alternativ "flapping")
 +
* https://map.opennet-initiative.de/api/v1/accesspoint/?status=online&data_format=geojson&in_bbox=10.314788818359373,53.72027890176105,14.860382080078127,54.29969774594346
  
 
Für JSON-Format  ?format=json anhängen, z.B.:
 
Für JSON-Format  ?format=json anhängen, z.B.:
 
* https://api.opennet-initiative.de/api/v1/accesspoint/192.168.1.11?format=json
 
* https://api.opennet-initiative.de/api/v1/accesspoint/192.168.1.11?format=json
 +
 +
Für GeoJSON  ?format=geojson, z.B. alle Links im GeoJSON Format:
 +
* https://map.opennet-initiative.de/api/v1/link/?data_format=geojson&in_bbox=10.314788818359373,53.72027890176105,14.860382080078127,54.29969774594346
  
 
== Datenquellen ==
 
== Datenquellen ==
 
* Wiki: AP-Liste mit Besitzern und Positionen
 
* Wiki: AP-Liste mit Besitzern und Positionen
 
* [[Ondataservice]]: Hardware, Firmware, Systemzustand, Netzwerkschnittstellen
 
* [[Ondataservice]]: Hardware, Firmware, Systemzustand, Netzwerkschnittstellen
 +
** derselbe Datensatz ist auch via [[Ondataservice#Alternativer_HTTP-Abruf|HTTP-Abruf]] verfügbar (erfordert eine manuelle Anpassung für Firmware bis 0.5.4)
 
* [[OLSR]]: Links, Qualität, "lastseen"-Zeitstempel
 
* [[OLSR]]: Links, Qualität, "lastseen"-Zeitstempel
 
* manuell gepflegte Liste von Regionen für [[Freifunk API]]
 
* manuell gepflegte Liste von Regionen für [[Freifunk API]]
Zeile 32: Zeile 39:
  
 
== Entwicklung ==
 
== Entwicklung ==
* [http://dev.opennet-initiative.de/browser/on_geronimo git-Repository] auschecken: <tt>git clone git@dev.on-i.de:on_geronimo.git</tt>
+
* [http://dev.opennet-initiative.de/browser/on_geronimo git-Repository] auschecken: <tt>git clone https://dev.opennet-initiative.de/git/on_geronimo</tt>
 
* Dienst lokal starten: <tt>python3 manage.py runserver</tt>
 
* Dienst lokal starten: <tt>python3 manage.py runserver</tt>
 
* Daten importieren (manuell):
 
* Daten importieren (manuell):
** python3 manage.py import_olsr
 
 
** python3 manage.py import_wiki
 
** python3 manage.py import_wiki
** python3 manage.py import_ondataservice ONDATASERVICE_DB_DATEI
+
** python3 manage.py import_olsr http://192.168.2.76:2006/
 +
** python3 manage.py import_ondataservice examples/ondataservice.db
 
* API abfragen (z.B. Browser oder curl): http://localhost:8000/api/v1/accesspoint/
 
* API abfragen (z.B. Browser oder curl): http://localhost:8000/api/v1/accesspoint/
 
* Release erstellen: <tt>make release-(major|minor|patch)</tt>
 
* Release erstellen: <tt>make release-(major|minor|patch)</tt>

Aktuelle Version vom 13. April 2019, 12:15 Uhr

Die Opennet API (Geronimo v2) bietet Statusdaten des Mesh-Netzwerks und Meta-Daten der lokalen Communities basierend auf verschiedenen Quellen mittels einer REST-API an. Der Vorgänger dieses Diensts war Geronimo v1.

Inhaltsverzeichnis

[Bearbeiten] Überblick

URLs für einen Node:

Für alle Nodes:

Filtern nach AP-Status, z.B. "online" (alternativ "flapping")

Für JSON-Format  ?format=json anhängen, z.B.:

Für GeoJSON  ?format=geojson, z.B. alle Links im GeoJSON Format:

[Bearbeiten] Datenquellen

  • Wiki: AP-Liste mit Besitzern und Positionen
  • Ondataservice: Hardware, Firmware, Systemzustand, Netzwerkschnittstellen
    • derselbe Datensatz ist auch via HTTP-Abruf verfügbar (erfordert eine manuelle Anpassung für Firmware bis 0.5.4)
  • OLSR: Links, Qualität, "lastseen"-Zeitstempel
  • manuell gepflegte Liste von Regionen für Freifunk API

[Bearbeiten] Funktionsumfang

  • Zusammenfassung verschiedener Datenquelle
  • aktuelle Zustände von Accesspoints und Links ausliefern
  • Metadaten für die Freifunk API ausliefern

[Bearbeiten] Architektur

  • Django-Anwendung liefert Daten via REST-Framework aus (inkl. Unterstützung für Geodaten - z.B. Bounding-Box-Limitierung von Abfragen)
  • Import von Daten aus den verschiedenen Quellen via cron-Jobs

[Bearbeiten] Entwicklung

[Bearbeiten] Installation

  • deb-Paket installieren (zuvor eventuell manuell erstellen - siehe oben)
  • den Anweisungen aus der Datei /usr/share/doc/on-geronimo-api/README.Debian folgen
Meine Werkzeuge
Namensräume

Varianten
Aktionen
Start
Opennet
Kommunikation
Karten
Werkzeuge