yanic/README.md

# Respond Collector

[![Build Status](https://travis-ci.org/FreifunkBremen/respond-collector.svg?branch=master)](https://travis-ci.org/FreifunkBremen/respond-collector)
[![Coverage Status](https://coveralls.io/repos/github/FreifunkBremen/respond-collector/badge.svg?branch=master)](https://coveralls.io/github/FreifunkBremen/respond-collector?branch=master)

`respond-collector` is a respondd client that fetches, stores and publishes information about a Freifunk network. The goals:
* Generating JSON for [MeshViewer](https://github.com/ffnord/meshviewer) (Works with branch [JSONv2](https://github.com/FreifunkBremen/meshviewer/tree/JSONv2))
* Storing statistics in [InfluxDB](https://influxdata.com/) to be analyzed by [Grafana](http://grafana.org/)
* Provide information via JSON-APIs

## Usage
```
Usage of ./respond-collector:
  -config path/to/config.toml
```

## Development
### respond
It sends the `gluon-neighbour-info` request and collects the answers.

It will send UDP packets with multicast group `ff02:0:0:0:0:0:2:1001` and port `1001`.

### nodes.Nodes
It caches the information of the nodes and will save them periodical to a JSON file.
The current nodes are saved default under `nodes.json`.

## Related projects

Collecting data from respondd:
* [Node informant](https://github.com/ffdo/node-informant) written in Go
* [HopGlass Server](https://github.com/plumpudding/hopglass-server) written in Node.js

Respondd for servers:
* [respondd branch of ffnord-alfred-announce](https://github.com/ffnord/ffnord-alfred-announce/tree/respondd) from FreiFunkNord
* [respondd](https://github.com/Sunz3r/ext-respondd) from Sunz3r
Update README 2016-03-12 15:40:43 +00:00			`# Respond Collector`
add README 2016-02-26 08:28:31 +00:00
Add Travis CI 2016-03-20 11:34:58 +00:00			`[![Build Status](https://travis-ci.org/FreifunkBremen/respond-collector.svg?branch=master)](https://travis-ci.org/FreifunkBremen/respond-collector)`
Add Coveralls 2016-03-20 11:54:40 +00:00			`[![Coverage Status](https://coveralls.io/repos/github/FreifunkBremen/respond-collector/badge.svg?branch=master)](https://coveralls.io/github/FreifunkBremen/respond-collector?branch=master)`
Add Travis CI 2016-03-20 11:34:58 +00:00
Update README.md Typos 2016-12-22 19:58:19 +00:00			`respond-collector` is a respondd client that fetches, stores and publishes information about a Freifunk network. The goals:
Update README 2016-03-14 10:02:10 +00:00			`* Generating JSON for [MeshViewer](https://github.com/ffnord/meshviewer) (Works with branch [JSONv2](https://github.com/FreifunkBremen/meshviewer/tree/JSONv2))`
Update README 2016-03-12 15:40:43 +00:00			`* Storing statistics in [InfluxDB](https://influxdata.com/) to be analyzed by [Grafana](http://grafana.org/)`
Update README 2016-11-20 17:30:10 +00:00			`* Provide information via JSON-APIs`
add README 2016-02-26 08:28:31 +00:00
			`## Usage`
			```
Rename package to respond-collector 2016-03-15 22:26:30 +00:00			`Usage of ./respond-collector:`
Make configuration more intuitive and consistent 2017-01-29 17:30:08 +00:00			`-config path/to/config.toml`
add README 2016-02-26 08:28:31 +00:00			```
Update README 2016-03-12 15:40:43 +00:00
add README 2016-02-26 08:28:31 +00:00			`## Development`
			`### respond`
Update README.md Typos 2016-12-22 19:58:19 +00:00			It sends the `gluon-neighbour-info` request and collects the answers.
add README 2016-02-26 08:28:31 +00:00
Update README.md Typos 2016-12-22 19:58:19 +00:00			It will send UDP packets with multicast group `ff02:0:0:0:0:0:2:1001` and port `1001`.
add README 2016-02-26 08:28:31 +00:00
Update README 2016-11-20 17:30:10 +00:00			`### nodes.Nodes`
Update README.md Typos 2016-12-22 19:58:19 +00:00			`It caches the information of the nodes and will save them periodical to a JSON file.`
add README 2016-02-26 08:28:31 +00:00			The current nodes are saved default under `nodes.json`.

Add related projects 2016-03-21 17:58:49 +00:00			`## Related projects`

			`Collecting data from respondd:`
			`* [Node informant](https://github.com/ffdo/node-informant) written in Go`
			`* [HopGlass Server](https://github.com/plumpudding/hopglass-server) written in Node.js`

			`Respondd for servers:`
			`* [respondd branch of ffnord-alfred-announce](https://github.com/ffnord/ffnord-alfred-announce/tree/respondd) from FreiFunkNord`
			`* [respondd](https://github.com/Sunz3r/ext-respondd) from Sunz3r`