update README
[pulsecounter.git] / linux / README.md
1 # Host side of the pulse counter infrastructure.
2
3 pulsecounter.c is modelled after BlueZ' gatttool. Because of "strange"
4 design of BlueZ tools, it is not sufficient to use the library that
5 gets installes with it. Complete source installation is necessary.
6
7 So, unpack, configure *and build* BlueZ source (`make install` is not
8 necessary). In the `pulsecounter/linux` directory, run
9 `make BLUEZ=/path/to/top/of/bluez/source`. You will get the
10 `pulsecounter` binary.
11
12 Currently (2015-12-21) supplied database adapter uses MySQL(/MariaDB).
13 Confiruration file (default path `/etc/pulsecounter.db`) contains lines
14 of this format:
15
16     key SPACE* [=:]* SPACE* value
17
18 Lines are analyzed up to the '#' character (comment separator).
19 There is no escaping.
20
21 Keys are:
22
23     host        hostname, NULL if not specified (meaning local database).
24     user        database user name, NULL if not specified
25     password    database password, NULL if not specified
26     database    database name, "watermeter" if not specified.
27
28