diff --git a/ebusd/DOCS.md b/ebusd/DOCS.md index 2d1bc8a..3326821 100644 --- a/ebusd/DOCS.md +++ b/ebusd/DOCS.md @@ -8,7 +8,7 @@ Deep dive into the [ebusd Wiki](https://github.com/john30/ebusd/wiki). The steps **Build and Install are handled by this addon**. You'll need to **configure the options in this addon to run** ebusd. 1. Connect a [hardware interface](https://github.com/john30/ebusd/wiki/6.-Hardware) to your device runing Home Assistant OS. USB and network devices are supported. -2. Define either a USB or network device. Seperate configuration entries are available via the UI or can be configured manually using ```device: /dev/ttyAMA0``` or ```network_device: enh:192.158.0.7:9999``` +2. Define either a USB or network device. Seperate [configuration entries](https://github.com/john30/ebusd/wiki/2.-Run#device-options) are available via the UI or can be configured manually using `device: /dev/ttyAMA0` or `network_device: ens:192.158.0.7:9999` 3. MQTT will be configured automatically to use the Home Assitant MQTT Broker. This can be overridden in the config options if you would prefer to use an external MQTT server. TCP and HTTP client acces is also available. 4. Start the Add-on and check the output logs Bildschirmfoto 2021-10-07 um 21 54 10 @@ -26,16 +26,16 @@ For more info please see the eBUSd docs: **Top tips:** -- If you send an MQTT get message with payload "?1" eBUSd will automatically poll that reading every 30 seconds and publish via MQTT. For example: ```mosquitto_pub -t ebusd/bai/FlowTemp/get -m ?1``` +- If you send an MQTT get message with payload "?1" eBUSd will automatically poll that reading every 30 seconds and publish via MQTT. For example: `mosquitto_pub -t ebusd/bai/FlowTemp/get -m ?1` - Git clone the ebusd-configuration files to your /config folder and edit the config files for your heating system. Add a number 1-9 (1 high priority, 9 low prioirty) after the r at the start of each line and eBUSd will poll that reading automatically. - Once your heating system has been detected change the device name from "ebusd bai" to the name of your boiler e.g. "ecoTEC pro" -- If some polled readings do not show up in Home Assistant it might be because mqtt-hassio.cfg is configured to filter them out. Try setting to mqttvar to ```"filter-name="``` and this will remove any filters so you can debug the issue. +- If some polled readings do not show up in Home Assistant it might be because mqtt-hassio.cfg is configured to filter them out. Try setting to mqttvar to `"filter-name="` and this will remove any filters so you can debug the issue. ## Custom CSV or MQTT cfg files: -To use custom config files you can use the configpath option. You can create a local copy of https://github.com/john30/ebusd-configuration in your "/config" folder and change configpath to e.g. "/config/ebusd-configuration/latest/en". Custom CSV files must be in the /config folder. +To use custom config files, you can use the `configpath` option. You can create a local copy of https://github.com/john30/ebusd-configuration in your "/config" folder and change `configpath`, to e.g. "/config/ebusd-configuration/latest/en". Custom CSV files must be in the /config folder. -Similarly for MQTT create config file in "/config" folder and link it using the --mqttint=/config/YOUR_FILE_PATH option +Similarly for MQTT, create a config file in "/config" folder and link it using the `--mqttint=/config/YOUR_FILE_PATH` option ## HTTP and TCP client Access @@ -44,8 +44,9 @@ After TCP clients activation you can connect from any system with installed [ebu The following example will force a reading of all messages from loaded csv config files and can be included via crontab for regular message updates: -```ebusctl -s X.X.X.X f -l "*" -a|awk '{print $2}' | xargs -L1 -t ebusctl -s X.X.X.X r``` -Where ```X.X.X.X``` is the address of the ebusd add-on. +`ebusctl -s X.X.X.X f -l "*" -a|awk '{print $2}' | xargs -L1 -t ebusctl -s X.X.X.X r` + +Where `X.X.X.X` is the address of the ebusd add-on. ## Running ebusd and ebusctl directly @@ -65,12 +66,12 @@ and you are inside the docker container, where you can easily run `ebusctl` or ` You can add any command line options using the custom command line options field. Check the eBUSd wiki for all available options - https://github.com/john30/ebusd/wiki/2.-Run -For example ``` --initsend --dumpconfig``` +For example, `--initsend --dumpconfig` ## Network eBUS adapter support -This release now fully supports wireless/network [eBUS adapters](https://adapter.ebusd.eu/index.en.html). The configuration options has changed from custom_device to network_device. +This release now fully supports wireless/network [eBUS adapters](https://adapter.ebusd.eu/index.en.html). The configuration options have changed from custom_device to network_device. -For example ```network_device: enh:Y.Y.Y.Y:9999``` -Where ```Y.Y.Y.Y``` is the address of the eBUS asapter. +For example, `network_device: ens:Y.Y.Y.Y:9999` +Where `Y.Y.Y.Y` is the address of the eBUS adapter.