esp8266-arduino-ebus

Warning: Do not power your adapter from a power supply on eBus terminals - you will burn the transmit circuit (receive may still work)!

Quickstart

connect adapter to ebus
you should see at least one LED on the adapter shining (HW v3.0+) - if not, switch eBus wires
LED D1 blinking indicates activity on the bus. The adapter comes pre-adjusted but if D1 is still on or off, you need to re-adjust it:
- by a configuration in web interface for v6.0 and newer:
  - open http://esp-ebus.local/param to adjust PWM value
  - the default value is 130, max is 255, min is 1
  - when D1 is still on, you need to lower the value
  - when D1 is still off, you need to raise the value
- using trimer RV1 for v5.x and older:
  - Note: the following directions are reversed (clockwise/counterclockwise) for adapters purchased via elecrow)
  - turn the trimmer counterclockwise until you find the position between D1 blinking and still on
  - turn the trimmer clockwise until you find the position between D1 blinking and still off
  - count the turns between these positions and set the trimmer in the middle position with D1 blinking
  - if you have adjusted the trimmer, disconnect and connect the adapter to bus again
search for WiFi networks, you should see network with name "esp-eBus"
connect to the network - a configuration page should open automatically, default password is: ebusebus
configure your WiFi network settings (SSID, password)
after reboot, you should be able to run ping esp-ebus.local successfully from a computer in your network (if your network is correctly configured for mDNS)
to verify there are bytes being received by the adapter, you can connect to esp-ebus.local port 3334 using telnet - you should see unreadable binary data
you can use ebusd to decode bus messages, see ports section for device option configuration
the adapter listens on following TCP ports (latest SW):
- 3333 - raw - on this port you can both read and write to the eBus - ebusd config: -d esp-ebus.local:3333
- 3334 - listen only port - everything sent to this port will be discarded and not sent to bus
- 3335 - enhanced protocol - ebusd config: -d enh:esp-ebus.local:3335
- 5555 - status server - you can telnet to this port (or http://esp-ebus.local:5555) to see some basic status info

Hardware revisions

This section lists adapter hardware revisions together with specifics for each one. Each revision lists only change from the previous one.

v1.0

MCU: ESP8266
step-down: MP2307
SMD trimmer

v2.0

firmware file: firmware-HW_v3.x.bin
step-down: XL7015
RESET_PIN: MCU GPIO5
replaced SMD to multiturn timmer
added TX-disable - GPIO2 - function not working

v3.0

firmware file: firmware-HW_v3.x.bin
step-down: ME3116
RESET_PIN: MCU GPIO5
fixed TX-disable - GPIO2 - blue LED on module shines when TX enabled
added programming header
added LEDS for TX, RX, Power
added tp2 - you can apply 24V external power supply between tp2 (+) and BUS GND (-). If you remove D4, you can use an adapter with voltage 5-24V

v4.0

firmware file: firmware-HW_v4.x.bin
RESET_PIN: TX-DISABLE (GPIO5)
moved TX-DISABLE to GPIO5
LEDs position changed
added tp3, jp1 - you can apply 24V external power supply between tp2 (+) and tp3 (-). If you cut jp1, you can use any adapter with voltage 5-24V

v4.1

firmware file: firmware-HW_v4.x.bin
RESET_PIN: TX-DISABLE (GPIO5)
added debug pin to programming header

v5.0

firmware file: firmware-HW_v5.x.bin
MCU changed to ESP32-C3
RESET_PIN: TO-EBUS (GPIO20)
removed TX-DISABLE - MCU doesn't transmit any messages during startup on UART pins
added USB-C connector for power and/or programming
- USB power works only with USB-A - USB-C cables (bug)
added VCC selector jumper - you can choose from:
- power from EBUS: jumper in position VCC-VBUS
- power from 5V USB-C connector: jumper in position VCC-VUSB
- power from any adapter 5-24V: remove jumper and connect adapter to VCC and GND pins
SOD-123 diodes
added LED D8 for MCU status

v5.1

firmware file: firmware-HW_v5.x.bin
RESET_PIN: TO-EBUS (GPIO20)
fixed reference voltage resistor value

v5.2

firmware file: firmware-HW_v5.x.bin
RESET_PIN: TO-EBUS (GPIO20)
USB power works with USB-C - USB-C cables
replaced VCC selector jumper with 2.0mm pitch:
- power from EBUS: jumper in position VCC-VBUS
- power from 5V USB-C connector: jumper removed
- power from any adapter 5-24V: remove jumper and connect adapter to VCC and GND pins

v6.0

firmware file: firmware-HW_v5.x.bin
RESET_PIN: TO-EBUS (GPIO20)
trimmer is replaced by PWM setting in web interface

v6.1 and newer

firmware file: firmware-HW_v5.x.bin
RESET_PIN: TO-EBUS (GPIO20)
added missing via in v6.0

Troubleshooting

The adapter seems dead, no LED shines or blinks.

The ebus wires are reversed, try switching the wires. Don't worry, it has a protection against reversing.

The ebus logs shows `[bus error] device status: unexpected enhanced byte 2`

Please read quickstart section to find correct device configuration options

I often see messages like: `ERR: arbitration lost`, `signal lost`, `signal acquired`

It's possible that the adapter has a poor WiFi reception so it has to resend messages and the latency increases. Try to improve the signal by moving the adapter closer to the WiFi AP. You can also try to increase the ebusd latency parameter to e.g. --latency=200000.

The adapter is loosing connectivity, breaking other ebus components communication, D7 is blinking, WiFi is disappearing after connecting, devices on the bus show error status or other intermittent failures.

It's possible that ebus doesn't have enough power to supply the adapter together with all other connected devices. From version v3.0 there are options for supplying external power, see the hardware revisions section for details.

Nothing helps. I need support.

Run ebusd with --lograwdata=data --latency=2000 --log=all:debug options. Then save the log, open an issue here, describe the problem and attach the log. I'll try to help you.

Config reset

check which RESET_PIN is used in your adapter (see hardware revisions)
- note: RESET_PIN has been changing in different software versions. The defined value refers to latest software revision. If the value doesn't work, you may try also pin ESP-RX/FROM-EBUS
disconnect device from bus
connect RESET_PIN and GND pins using a wire
connect device to bus
wait 5 seconds
disconnect the wire

Upgrading

There are following options:

over the network (OTA)
- using web interface
  - easiest
- using platform.io
  - heavier option - it will compile the firmware from source code and upload using internall tooling
- using espota.py
  - lightweight - just needs OTA script and precompiled firmware file
physically using a USB-TTL adaptor or device USB port (HW v5.0+)

web interface

open web interface of the device by IP or on: http://esp-ebus.local
find the update link
upload correct firmware file (see hardware revisions) - use version WITHOUT fullflash keyword
click Update button
wait for restart, reconnect to adapter and configure WiFi if not connected automatically
in case you cannot open web interface, reset device to access it

platform.io

clone this repository using git
pip3 install platformio
check for correct firmware file (see hardware revisions)
inside the project folder run:
- for firmware-HW_v3.x.bin: pio run -e esp12e-v3.0-ota -t upload
- for firmware-HW_v4.x.bin: pio run -e esp12e-ota -t upload
- for firmware-HW_v5.x.bin: pio run -e esp32-c3-ota -t upload

espota.py

you need python installed in your computer
download espota.py script
- for Windows, you can download espota.exe from esp32-xx.zip - it is located in tools folder
download firmware according to your hardware version from https://github.com/danielkucera/esp8266-arduino-ebus/releases
use port number:
- 8266 - for esp8266 (HW up to v4.1)
- 3232 - for esp32-c3 (HW from v5.0 up)
to upgrade, run:

$ python3 espota.py -i esp-ebus.local -f <FIRMWARE_FILE_NAME> -p <PORT_NUMBER> -r -d
16:33:23 [DEBUG]: Options: {'esp_ip': 'esp-ebus.local', 'host_ip': '0.0.0.0', 'esp_port': 8266, 'host_port': 47056, 'auth': '', 'image': 'firmware.bin', 'spiffs': False, 'debug': True, 'progress': True}
16:33:23 [INFO]: Starting on 0.0.0.0:47056
16:33:23 [INFO]: Upload size: 380320
16:33:23 [INFO]: Sending invitation to: esp-ebus.local
16:33:23 [INFO]: Waiting for device...
Uploading: [============================================================] 100% Done...

16:33:30 [INFO]: Waiting for result...
16:33:31 [INFO]: Result: OK

upgrading over USB (HW v5.0+)

this version has built-in USB serial interface
download firmware-fullflash-* firmware from https://github.com/danielkucera/esp8266-arduino-ebus/releases
connect PROG and GND
connect adapter to a PC using USB-A - USB-C cable
you should see a new serial port
flash the firmware to address 0x0 using either one of tools:
- Web based: https://adafruit.github.io/Adafruit_WebSerial_ESPTool/
- Windows: using Flash Download Tools from https://www.espressif.com/en/support/download/other-tools
- Linux esptool.py: esptool.py write_flash 0x0 firmware-fullflash-*

upgrading over USB-TTL adaptor (before HW v5.0)

You will need an USB-TTL adaptor (dongle) which suports 3V3 voltage levels and has 3V3 voltage output pin

download firmware bin file from https://github.com/danielkucera/esp8266-arduino-ebus/releases
download NodeMCU PyFlasher from https://github.com/marcelstoer/nodemcu-pyflasher/releases
using a wire connect pins PROG and TP3
connect your adaptor in a following way (dongle - module):
- 3V3 <-> 3V3
- TX <-> ESP-RX
- RX <-> ESP-TX
- GND <-> GND
now connect the dongle to your PC - you should see two red LEDs on, blue should flash briefly and stay off (v4.0+)
open NodeMCU PyFlasher and select your firmware file and serial port
click Flash NodeMCU and watch the progress in Console
if that doesn't work, connect also TP1 to 3V3 and try again (see Issue #27)

MQTT support

By setting the MQTT server IP address / hostname, MQTT support is activated. At the configuration web page you can set

server IP address or hostname
user name
password

Warning: The current implementation does not support TLS encryption. The MQTT server should therefore be run in a secure environment!

MQTT interface

The device's MQTT root topic begins with ebus/,
followed by the last 6 characters of its MAC address as a unique device ID
and a trailing slash.
Example root topic: ebus/8406ac/.

Basic device data, settings and various counters are published regularly.

The following topics are available on every device.

topic	description
settings	settings of the ebus adapter
firmware	details of the installed firmware
state	various status/counter information
state/wifi	wifi related information
state/arbitration	arbitration over common interface (e.g. ebusd)

communication
request	JSON encoded request
response	JSON encoded response / error message

MQTT interface with firmware EBUS_INTERNAL=1

A firmware with EBUS_INTERNAL=1 adds a scheduler and a command buffer to the device.

The following topics are available.

topic	description
commands	installed commands
values	received values of installed commands
state/internal/messages	processed messages
state/internal/errors	errors of finite state machine
state/internal/resets	resets of finite state machine
state/internal/requests	bus requests (arbitration)

Details of MQTT commands

The MQTT command interface is divided into two topics for bidirectional communication.

Commands can be sent to the request topic.
After processing, a response is sent to the response topic.
Only JSON-encoded messages are processed.
To distinguish between commands, each message contains a unique ID.

Available MQTT commands.

command	description	EBUS_INTERNAL=1
restart	Restarting of the device
insert	Inserting (Installing) of new commands	x
remove	Removing installed commands	x
publish	Publishing installed commands	x
load	Loading (Installing) saved commands	x
save	Saving the currently installed commands	x
wipe	Wiping of the saved commands	x
send	Sending ebus commands once	x
forward	Activate/deactivate data forwarding (including filtering)	x

Examples

The provided examples were created using Mosquitto in a Linux shell. The server IP address or hostname and unique device ID must be adjusted to your environment.

server IP address or hostname = server
unique device ID = 8406ac
request topic = ebus/8406ac/request
response topic = ebus/8406ac/response

Restarting of the device

payload:
{
  "id": "restart",
  "value": true
}

mosquitto_pub -h server -t 'ebus/8406ac/request' -m '{"id":"restart","value":true}'

Inserting (Installing) of new commands

payload:
{
  "id": "insert",
  "commands": [
    {
      "key": "01",                       // unique key of command
      "command": "fe070009",             // ebus command as vector of "ZZPBSBNNDBx"
      "unit": "°C",                      // unit of the interested part
      "active": false,                   // active sending of command
      "interval": 0,                     // minimum interval between two commands in seconds
      "master": true,                    // value of interest is in master or slave part
      "position": 1,                     // starting position in the interested part
      "datatype": "DATA2B",              // ebus datatype
      "divider": 1,                      // divider for value conversion
      "digits": 2,                       // deciaml digits of value
      "topic": "outdoor_temperature",    // mqtt topic below "values/"
      "ha": true,                        // home assistant support for auto discovery
      "ha_class": "temperature"          // home assistant device_class
    },
    {
    ...
    }
  ]
}

ebus datatypes: 
- numeric: BCD, UINT8, INT8, DATA1B, DATA1C, UINT16, INT16, DATA2B, DATA2C, UINT32, INT32, FLOAT (values as 1/1000)
- character: CHAR1, CHAR2, CHAR3, CHAR4, CHAR5, CHAR6, CHAR7, CHAR8

mosquitto_pub -h server -t 'ebus/8406ac/request' -m '{"id":"insert","commands":[{"key":"01","command":"fe070009","unit":"°C","active":false,"interval":0,"master":true,"position":1,"datatype":"DATA2B","divider":1,"digits":2,"topic":"outdoor/temperature","ha":true,"ha_class":"temperature"}]}'

Removing installed commands

payload:
{
  "id": "remove",
  "keys": [
    "UNIQUE_KEY",
    ...
  ]
}

mosquitto_pub -h server -t 'ebus/8406ac/request' -m '{"id":"remove","keys":["01"]}'

Publishing installed commands

payload:
{
  "id": "publish",
  "value": true
}

mosquitto_pub -h server -t 'ebus/8406ac/request' -m '{"id":"publish","value":true}'

Loading (Installing) saved commands

payload:
{
  "id": "load",
  "value": true
}

mosquitto_pub -h server -t 'ebus/8406ac/request' -m '{"id":"load","value":true}'

Saving the currently installed commands

payload:
{
  "id": "save",
  "value": true
}

mosquitto_pub -h server -t 'ebus/8406ac/request' -m '{"id":"save","value":true}'

Wiping of the saved commands

payload:
{
  "id": "wipe",
  "value": true
}

mosquitto_pub -h server -t 'ebus/8406ac/request' -m '{"id":"wipe","value":true}'

Sending ebus commands once

payload:
{
  "id": "send",
  "commands": [
    "ZZPBSBNNDBx",
    ...
  ]
}

mosquitto_pub -h server -t 'ebus/8406ac/request' -m '{"id":"send","commands":["05070400","15070400"]}'

Activate/deactivate data forwarding (including filtering)

payload:
{
  "id": "forward",
  "value": true,
  "filters": [
    "DB(x)",
    ...
  ]
}

mosquitto_pub -h server -t 'ebus/8406ac/request' -m '{"id":"forward","value":true,"filters":["0700","fe"]}'

mosquitto_pub -h server -t 'ebus/8406ac/request' -m '{"id":"forward","value":false}'

Home Assistant Support

Home Assistant support can be globally activated on the configuration web page.

Once Home Assistant support is activated there will be the followed MQTT topics created under homeassistant.
A running Home Assistant instance should create a new entity in Home Assistant if MQTT autodiscovery is enabled.

MQTT Device - Diagnostic - Uptime of device (DD HH:MM:SS)

topic: homeassistant/sensor/ebus8406ac/uptime/config
payload:
{
  "name": "Uptime",
  "entity_category": "diagnostic",
  "unique_id": "ebus8406ac_uptime",
  "state_topic": "ebus/8406ac/state/uptime",
  "value_template": "{{timedelta(seconds=((value|float)/1000)|int)}}",
  "device": {
    "identifiers": "ebus8406ac",
    "name": "esp-ebus",
    "manufacturer": "",
    "model": "",
    "model_id": "",
    "serial_number": "8406ac",
    "hw_version": "",
    "sw_version": "",
    "configuration_url": "http://esp-ebus.local"
  }
}

MQTT Device - Configuration - Restart button

topic: homeassistant/button/ebus8406ac/restart/config
payload:
{
  "name": "Restart",
  "device_class": "restart",
  "entity_category": "config",
  "unique_id": "ebus8406ac_restart",
  "availability_topic": "ebus/8406ac/state/available",
  "command_topic": "ebus/8406ac/request",
  "payload_press": "{\"id\":\"restart\",\"value\":true}",
  "qos": 0,
  "retain": false,
  "device": {
    "identifiers": "ebus8406ac"
  }
}

MQTT Device - Sensors

When a command is loaded with ha (true), an MQTT topic is automatically created under homeassistant.
A running Home Assistant instance should create a new entity in Home Assistant if MQTT autodiscovery is enabled.
According to the above data it should look like the following example.

topic: homeassistant/sensor/ebus8406ac/outdoor_temperature/config
payload:
{
  "name": "outdoor temperature",
  "device_class": "temperature",
  "state_topic": "ebus/8406ac/values/outdoor_temperature",
  "unit_of_measurement": "°C",
  "unique_id": "ebus8406ac_01",
  "value_template": "{{value_json.value}}",
  "device": {
    "identifiers": "ebus8406ac"
  }
}

Name		Name	Last commit message	Last commit date
Latest commit History 273 Commits
.github/workflows		.github/workflows
include		include
lib		lib
src		src
test		test
.gitignore		.gitignore
.travis.yml		.travis.yml
README.md		README.md
auto_firmware_version.py		auto_firmware_version.py
fullflash.sh		fullflash.sh
platformio.ini		platformio.ini
upload-ota.sh		upload-ota.sh
upload-serial.sh		upload-serial.sh

danielkucera/esp-arduino-ebus

Folders and files

Latest commit

History

Repository files navigation

esp8266-arduino-ebus

Quickstart

Hardware revisions

v1.0

v2.0

v3.0

v4.0

v4.1

v5.0

v5.1

v5.2

v6.0

v6.1 and newer

Troubleshooting

The adapter seems dead, no LED shines or blinks.

The ebus logs shows [bus error] device status: unexpected enhanced byte 2

I often see messages like: ERR: arbitration lost, signal lost, signal acquired

The adapter is loosing connectivity, breaking other ebus components communication, D7 is blinking, WiFi is disappearing after connecting, devices on the bus show error status or other intermittent failures.

Nothing helps. I need support.

Config reset

Upgrading

web interface

platform.io

espota.py

upgrading over USB (HW v5.0+)

upgrading over USB-TTL adaptor (before HW v5.0)

MQTT support

MQTT interface

MQTT interface with firmware EBUS_INTERNAL=1

Details of MQTT commands

Examples

Home Assistant Support

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases 15

Packages 0

Uh oh!

Contributors 7

Uh oh!

Languages

The ebus logs shows `[bus error] device status: unexpected enhanced byte 2`

I often see messages like: `ERR: arbitration lost`, `signal lost`, `signal acquired`

Packages