format connections, align with wiki

This commit is contained in:
John
2021-01-24 10:34:12 +01:00
parent 30d4110102
commit ba8234bb0f
+12 -4
View File
@@ -14,7 +14,13 @@ Features
The main features of the daemon are:
* use USB serial, TCP connected or UDP device, or enhanced ebusd protocol for recent [ebus adapter 3](https://adapter.ebusd.eu/) or [ebusd-esp firmware](https://github.com/john30/ebusd-esp/) (allows arbitration to be done directly by the hardware)
* use one of these device connections:
* USB serial
* TCP
* UDP
* enhanced ebusd protocol allowing arbitration to be done directly by the hardware, e.g. for recent
* [ebus adapter 3](https://adapter.ebusd.eu/), or
* [ebusd-esp firmware](https://github.com/john30/ebusd-esp/)
* actively send messages to and receive answers from the eBUS
* passively listen to messages sent on the eBUS
* regularly poll for messages
@@ -30,6 +36,7 @@ The main features of the daemon are:
* dump received bytes to binary files for later playback/analysis
* listen for command line client connections on a dedicated TCP port
* optionally provide rudimentary HTML interface and allow data retrieval as JSON on HTTP port
* optionally format messages and data in JSON on dedicated HTTP port
* optionally publish received message data to MQTT topics and vice versa (if authorized)
* optional user authentication via ACL file for access to certain messages
@@ -37,8 +44,9 @@ The main features of the daemon are:
Installation
------------
Either pick the [latest release package](https://github.com/john30/ebusd/releases/latest)
suitable for your system, use the Debian repository as [described here](https://github.com/john30/ebusd-debian/blob/master/README.md), or build it yourself.
Either pick the [latest release package](https://github.com/john30/ebusd/releases/latest) suitable for your system,
use the Debian repository as [described here](https://github.com/john30/ebusd-debian/blob/master/README.md),
build it yourself, or use a docker image (see below).
Building ebusd from the source requires the following packages and/or features:
* autoconf (>=2.63) + automake (>=1.11) or cmake
@@ -72,7 +80,7 @@ the latest configuration files** that are reflected by the configuration reposit
Docker image
------------
A Docker image using the config web service for retrieving the latest message configuration files is available on the hub.
A multi-architecture Docker image using the config web service for retrieving the latest message configuration files is available on the hub.
You can use it like this:
> docker pull john30/ebusd
> docker run -it --rm --device=/dev/ttyUSB0 -p 8888 john30/ebusd