From a9e5c695c968b6da96b5736d549ce641f1704dd2 Mon Sep 17 00:00:00 2001 From: john30 Date: Thu, 12 Mar 2015 23:43:03 +0100 Subject: [PATCH] switched to markdown --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..64a9df10 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +ebusd - eBUS daemon +=================== + +ebusd is a daemon for handling communication with eBUS devices connected to a +2-wire bus system ("energy bus" used by numerous heating systems). + + +Features +-------- + +The main features of the daemon are: + + * actively send messages to and receive answers from the eBUS + * passively listen to messages sent on the eBUS + * regularly poll for messages + * scan for bus participants + * cache all data + * log messages and problems to a log file + * dump sent/received bytes to the log file + * dump received bytes to binary files for later playback/analysis + * listen for client connections on a dedicated TCP port + + +Installation +------------ + +Building ebusd from the source requires the following packages: + * autoconf (>=2.65) + * g++ + * make + +To start the build process, run these commands: +./autogen.sh +make install + + +Documentation +------------- + +Usage instructions and further information can be found here: +https://github.com/john30/ebusd/wiki + + +Contact +------- +For bugs and missing features use github issue system. + +The author can be contacted at ebusd@johnm.de .