[WLANnews] API Eintrag für relaunch von freifunk.net

Andreas Braeu ab at andi95.de
So Sep 15 11:20:37 CEST 2013


Hallo Christoph,

nach deiner langen Email kommen hier nun ein paar Stichpunkte von mir.
Es sind doch ein paar mehr geworden :-)

zum Thema Freifunk:

- freifunk sind doch wir alle, es gibt kein übergeordnetes
freifunk-Gebilde, das sich hinter Mauern versteckt. Meine
"Heimatcommunity" ist z.B. Weimar, auch dort investiere ich viel Zeit.
Dinge wie die API gibts quasi nebenbei für alle.

- da wir freifunk alle als Hobby und ehrenamtlich betreiben, wird es
immer wieder vorkommen, dass Projekte anfangs keine Perfektion
erreichen. Mir ist es aber lieber, etwas Nutzbringendes erstmal
anzuarbeiten, als es gleich sein zu lassen.

zum Thema API:

- so sehr kompliziert kann die API doch nicht sein, wenn ich mir die
Karte ansehe :-)

- JSON haben wir als Datenaustauschformat gewählt, weil es Daten
strukturiert und doch noch lesbar ablegt und sich in vielen Sprachen
sehr angenehm verarbeiten lässt. Wir nutzen außerdem aus, dass man mit
JSON ein Schema definieren kann und Daten gegen dieses Schema validieren
kann. Deswegen sind im Ergebnis auch leere Felder nicht vorhanden und
keine Kommentare darin. Mit dem Schema lässt sich z.B. definieren,
welche Felder der Generator anzeigt, so dass man diesen bei
Feldänderungen nicht immer anpassen muss.

- JSON ist ein Kompromiss zwischen menschenlesbar und
maschinenlesbar :-)

- JSON eignet sich außerdem gut, Daten auf Abruf zu Verfügung zu stellen
oder die Dateien zu modifizieren. Soma hat z.B. ein Stück Software
geschrieben, das die Anzahl der OLSR-Knoten aktualisiert. Auch andere
Communities erzeugen die Datei erst auf Anfrage oder aktualisieren
einzelne Bestandteile regelmäßig (z.B. Hamburg, Chemnitz, ...).
Vielleicht können diese ihre Scripte kurz vorstellen oder zum Projekt
unter http://api.freifunk.net hinzufügen.

- viele Felder sind im übrigen keine Pflichtfelder, in der Sektion
Contact wird eines der Felder benötigt. Ohne Kontaktmöglichkeit macht
ein Eintrag natürlich wenig Sinn. Falls ihr da noch nichts habt, legt
euch doch einfach erstmal eine Emailadresse an, die ihr regelmäßig prüft
oder verschiedene Leute weiterleitet. Die technischen Details enthalten
z.B. keinerlei Pflichtfelder.

- die technischen Details befinden sich sowieso eher noch in der
Entwurfsphase. Wir hatten damals nur verschiedene Tabellen aus dem Wiki
zusammengetragen und in diese Sektion eingefügt. Wie tief wir hier in
technische Details gehen wollen müssen wir gemeinsam diskutieren. Für
mich wäre es beispielsweise nicht notwendig, zwischen verschiedenen
Batman-Varianten zu unterscheiden, 

- zu den Datumsfeldern (z.B. lastchange): mir ist das Problem bewusst,
doch auf die Schnelle hatte ich keine bessere Lösung für ein
standardisiertes Datumsformat gefunden. Falls jemand einen Datepicker
für den Generator beisteuern möchte, dann gern her damit... im Moment
wird das Feld auch noch nirgends ausgewertet, es gibt also aktuell kein
Problem bei Fantasiewerten :-)

- Der Button "Speichern unter" fehlt tatsächlich, wer so etwas mit dem
Generator bauen kann, darf sich gern einbringen. Den Generator habe ich
übrigens hier gefunden: https://github.com/joshfire/jsonform

- Die Dateien sollen natürlich am besten dezentral bei den Communities
abgelegt werden. Für die, di über gar keinen Webspace, Blog oder eigenes
Wiki verfügen haben wir im Freifunk-Wiki die Möglichkeit geschaffen,
Dateien mit der Endung .json hochzuladen.

- welche Fehlermeldungen erhälst du im Generator?

Wenn du in unsere Todos schaust, wirst du sehen, dass da auch schon
einige Dinge "auf Halde" stehen, die gemacht werden müssten, um die API
benutzerfreundlicher zu machen:
https://github.com/freifunk/api.freifunk.net/blob/master/TODO.md

Für die Zukunft wünsche ich mir konstruktivere Vorschläge, bei Problemen
bitte ich um Issues in Github. Besser ist es auch, pro Problem/Anliegen
eine Email oder einen Issue zu schreiben, das macht es einfacher zu
sortieren und die Probleme können konkreter angegangen werden :-) Zum
Wireless Summit Anfang Oktober bin ich in Berlin, um die API und die
ersten Anwendungen vorzustellen, da können wir sehr gern über die
Weiterentwicklung der API diskutieren.

Liebe Grüße

Andi


Am Freitag, den 13.09.2013, 17:05 +0200 schrieb Christoph Franzen:
> Am Fri, 13 Sep 2013 09:27:39 +0200 schrieb Andreas Bräu <ab at andi95.de>:
> 
> Hallo,
> 
> vorweg, das hier ist nicht als Gemotze über die Leute zu verstehen, die
> sich die Freifuk-API ausgedacht und gemacht haben, sondern beschreibt,
> wie die Sache hier bei mir ankommt.
> 
> Für Aachen habe ich das Ausfüllen mal versucht und bin prompt an den
> Details gescheitert.
> 
> > Wie ihr seht, ist noch Platz auf der Karte, einige Communities fehlen
> > noch.
> 
> Zumindest bei mir liegt es daran, daß ich keine Ahnung habe, wie das
> eigentlich genau geht und weil das alles dermaßen umständlich und
> freifunküblich miserabel dokumentiert ist:
> 
> > Einträge auf der Karte können über unsere freifunk-API
> > vorgenommen werden, das ist ein dezentraler Ansatz, Informationen
> > über die Communities zu sammeln. Wer sich also angesprochen fühlt,
> > erstellt bitte ein API-file,
> 
> Ja, aber wenn ich das jetzt einfach mal mache, soweit ich
> bereits durchblicke und den Rest später, wenn wir hier in Aachen die
> ganzen fehlenden Informationshäppchen zusammengetragen haben, dann
> „darf“ ich den Generator immer wieder komplett neu von vorne ausfüllen
> (und jedes Mal andere Fehler einbauen) oder die Datei (laut
> https://github.com/freifunk/api.freifunk.net/blob/master/specs/0.1.json
> in so einem gruseligen, „menschenlesefeindlichen“
> Format) mit vi beackern? Da ist das Problem, daß man die Feldnamen
> kennen muß, unausgefüllte Felder sind in der generierten Datei nicht
> drin und auch keine Kommentare.
> 
> Verwirrend ist auch, daß die fertig generierte Datei oben rechts in
> einem Fenster erscheint, beim ersten Mal habe ich gedacht, da müßte
> doch jetzt ein Speichern-Unter-Fenster aufgehen oder sowas.
> 
> > legt es auf einem Webserver ab
> 
> Wir haben keinen eigenen, nur ein Konto für die
> Freifunk-Rheinland-Wordpress-Seite und ein paar von uns haben
> Wiki-Konten für „http://wiki.freifunk-rheinland.net“ und
>http://wiki.freifunk.net“.http://aachen.freifunk.net“ leitet um auf
>http://wiki.freifunk.net/Freifunk_Aachen“,
> letzteres ist unser ältester und damit Haupt-Auftritt im Internet.
> 
> Wie lege ich die Datei so in einem Wiki ab, daß das funktioniert?
> 
> > Informationen zur API gibt's unter
> > http://api.freifunk.net sowie unter blog.freifunk.net, da ist ein
> > längerer Beitrag enthalten. Ein API-file kann man bequem mit dem
> > Generator erzeugen, der unter http://ja.ishalt.so/ffapi zu finden ist.
> 
> Da steht nichts zu den Einzelheiten, man kommt nicht besonders weit,
> ohne gleich den Quelltext zu verstehen, siehe unten.
> 
> > Bei Fragen zur API könnt ihr mir gern schreiben.
> 
> Wie trägt man „Feeds“ so ein. daß die später auch richtig verarbeitet
> werden, also beispielsweise die Aachener Wiki-Seiten oder dieses
> Rheinland-Wordpress (sowas zum Aggregieren habe ich da nirgends
> gefunden, aber mit „Web 2.0“ stehe ich eh auf Kriegsfuß, heißt also
> nichts)?
> 
> Was soll da beispielsweise rein:
> --8<--------------------
> Firmware Name
> name of your firmware
> needs to be defined
> --8<--------------------
> ?
> Wir benutzen die Rheinland-Firmware, ich hab' keine Ahnung, wie die
> jetzt offiziell heißt und was in das undefinierte Feld gehört.
> 
> --8<--------------------
> At what (unix) timestamp has your community status lastly changed?
> --8<--------------------
> Was soll in dieses Pflichtfeld, geht nur `date +%s`? Muß man also cooler
> Hacker sein, um den bequemen Generator zu verwenden? Offenbar knallt es,
> wenn man ein Freitext-Datum reinschreibt.
> 
> Jetzt sind da alle Kommentare englisch, wollt Ihr das auch englisch
> ausgefüllt haben und wenn ja, wieso denn; wenn nein, warum ist die Hilfe
> dann nicht deutsch, damit wir es beim Ausfüllen leichter haben und das
> auch Leute mit mäßigen Sprachkenntnissen schaffen? Ich will doch Leute
> aus der Umgebung anlocken, nicht die Neugier irgendeines Engländers oder
> Amis befriedigen.
> 
> In dem Routing-Feld steht nur „BATMAN“, fällt das
> Layer-2-Batman-Advanced auch darunter oder wurde das in der Auswahlliste
> vergessen?
> Da gibt es ja auch haufenweise untereinander inkompatible Versionen, so
> daß diese Angabe allein nicht wirklich weiterhilft.
> 
> „Offizielle“ Mail- und Jabber-Adressen und so weiter haben wir in
> Aachen auch (noch) nicht, also nichts, was nicht an Einzelpersonen
> hängt, die vielleicht irgendwann, womöglich schon in naher Zuḱunft,
> nicht mehr aktuell sind. Ich scheue mich auch spontan, eigene
> Adressen anzugeben, weil ich dann perönlich einer noch unbekannten
> Anzahl von Leuten zwischen 0 (findet eh keiner) und viel zu vielen
> (wird ein voller Erfolg) weiterhelfen muß; läßt man es leer, wird klar
> der Zweck verfehlt, den Zugang für Außenstehende zu erleichtern. Die
> Mailingliste bedarf einer Anmeldung, die zählt also wegen fehlender
> Niederschwelligkeit nicht.
> 
> Wenn ich jetzt ernsthaft versuche, jedes Feld auszufüllen, komme ich
> bestimmt noch auf wesentlich mehr Fragen…
> 
> Alles in allem denke ich, daß die Hürde so noch viel zu hoch ist. Die
> Datei wird entweder jetzt notdürftig und sehr unvollständig ausgefüllt
> und bleibt dann ewig so, so daß das Potential der Freifunk-API
> niemals ausgeschöpft werden wird, oder man schiebt das Ausfüllen wegen
> der ganzen ungelösten Detailfragen bis zum Sankt-Nimmerleins-Tag auf und
> es steht auch hier wieder nur ein Bruchteil der Ortsgruppen drin. Das
> ist wie alles Bisherige meiner Ansicht nach prädestiniert dafür, niemals
> auch nur ansatzweise vollständig (gewesen) zu sein und bereits sehr bald
> wieder zu veralten. Wer später dazukommt, wird wohl lieber einfach
> wieder was neues anfangen, als sich da „durchzubeißen“.
> 
> Freifunk kommt mir insgesamt vor wie ein gigantisches Labyrinth aus zehn
> Meter hohen Mauern, wo an jeder Abzweigung ein Schild mit „RTFM“ hängt.
> Versuche, das zu durchbrechen, wie die Freifunk-API, enden regelmäßig
> damit, daß die Wände ein wenig bunter angemalt und neue Wegweiser
> aufgehängt werden, auf denen dann auch wieder hauptsächlich „RTFM“
> steht. Natürlich gibt es im Labyrinth ein paar „Inseln der Seligen“ mit
> gut organisierten Gemeinschaften, aber wenn man wie ich alleine auf dem
> Land hockt und sich nicht bloß einen Alibi-Router aufs Fensterbrett
> stellen möchte, steht man ziemlich im Regen.
> 
> Wenn ich die Patentlösung hätte, würde ich sie hier vorschlagen,
> anstatt mich nur über das Vorhandene zu beschweren, aber ich denke,
> das hier ist noch weit von einer solchen entfernt.
> 
> Viele Grüße, Christoph
> _______________________________________________
> WLANnews mailing list
> WLANnews at freifunk.net
> Abonnement abbestellen? -> http://lists.freifunk.net/mailman/listinfo/wlannews-freifunk.net
> 
> Weitere Infos zu den freifunk.net Mailinglisten und zur An- und Abmeldung unter http://freifunk.net/mailinglisten

-------------- nächster Teil --------------
Ein Dateianhang mit Binärdaten wurde abgetrennt...
Dateiname   : smime.p7s
Dateityp    : application/x-pkcs7-signature
Dateigröße  : 5494 bytes
Beschreibung: nicht verfügbar
URL         : <http://lists.freifunk.net/pipermail/wlannews-freifunk.net/attachments/20130915/a7921254/attachment-0001.bin>


Mehr Informationen über die Mailingliste WLANnews