Go to file
Martin Weinelt 9a8d40ea9a update .gitignore 2015-03-24 18:20:28 +01:00
nodedb create nodedb/ directory 2013-11-23 22:11:46 +01:00
.gitignore update .gitignore 2015-03-24 18:20:28 +01:00
GlobalRRD.py Modularize global and node rrd definitions and graphings 2014-02-16 16:54:10 +01:00
LICENSE add LICENSE 2012-06-16 02:50:02 +02:00
NodeRRD.py alfred: restructure code, add nodeinfo, statistics, vis 2015-02-24 13:34:22 +01:00
README.md update README 2015-03-21 01:26:56 +01:00
RRD.py RRD: Fix updating of DS 2014-08-17 21:01:50 +02:00
alfred.py alfred.py: remove superfluous shebang 2015-03-24 18:19:31 +01:00
aliases.json_sample alfred: restructure code, add nodeinfo, statistics, vis 2015-02-24 13:34:22 +01:00
backend.py alfred: restructure code, add nodeinfo, statistics, vis 2015-02-24 13:34:22 +01:00
batman.py alfred: restructure code, add nodeinfo, statistics, vis 2015-02-24 13:34:22 +01:00
graph.py alfred: restructure code, add nodeinfo, statistics, vis 2015-02-24 13:34:22 +01:00
nodes.py make mesh_interfaces optional 2015-03-21 15:17:50 +01:00
rrddb.py alfred: restructure code, add nodeinfo, statistics, vis 2015-02-24 13:34:22 +01:00

README.md

Data for Freifunk Map, Graph and Node List

ffmap-backend gathers information on the batman network by invoking

  • batctl,
  • alfred-json and
  • batadv-vis

as root (via sudo) and has this information placed into a target directory as the file "nodes.json" and also updates the directory "nodes" with graphical representations of uptimes and the number of clients connecting.

Run backend.py --help for a quick overview of all available options.

When executed without root privileges, we suggest to grant sudo permissions within wrappers of those binaries, so no further changes are required in other scripts:

$ cat < $HOME/batctl
#!/bin/sh
exec sudo /usr/sbin/batctl $*
EOCAT

and analogously for batadv-vis. The entry for /etc/sudoers could be whateveruser ALL=(ALL:ALL) NOPASSWD: /usr/sbin/batctl,/usr/sbin/batadv-vis,/usr/sbin/alfred-json

For the script's regular execution add the following to the crontab:

* * * * * /path/to/ffmap-backend/backend.py -d /path/to/output -a /path/to/aliases.json --vpn ae:7f:58:7d:6c:2a --vpn d2:d0:93:63:f7:da

Data format

nodes.json

{ 'nodes': {
    node_id: { 'flags': { flags },
               'firstseen': isoformat,
               'lastseen': isoformat,
               'nodeinfo': {...},         # copied from alfred type 158
               'statistics': {
                  'uptime': double,       # seconds
                  'memory_usage': double, # 0..1
                  'clients': double,
                  'rootfs_usage': double, # 0..1
                  'loadavg': double,
                  'gateway': mac
                }
             },
    ...
  }
  'timestamp': isoformat
}

flags (bool)

  • online
  • gateway