eBUS Adapter micro-ebusd

micro-ebusd

Recent eBUS Adapters based on ESP32-C series allow use of an integrated micro-ebusd running inside of the adapter directly. Thus an extra ebusd instance running on a Linux host is no longer necessary.

This is an overview of the components and their connections:

This micro-ebusd is optimized heavily for the ESP32 RISCV platform and subject to a token to be obtained individually, see below.

Features

The main features of micro-ebusd are:

• compatible with these devices:
  • eBUS Adapter Shield C6,
  • eBUS Adapter Stick C6, and
  • eBUS Adapter Shield v5
• handle arbitration directly in hardware
• actively send messages to and receive answers from eBUS
• passively listen to messages on eBUS
• regularly poll configured messages
• cache latest messages (partially)
• scan for bus participants and automatically pick matching message definitions.
• use message definitions from ebusd-configuration (as of the time of the firmware release, either built-in or put on this webservice for dynamic loading as needed)
• decode eBUS messages to JSON and vice versa (via the compiled-in message definitions)
• automatically check for updates
• send arbitrary messages from hex input
• log messages and problems (optionally also to syslog)
• listen for command line client request on the REPL
• display identified messages directly in the adapter webpage and configure polling individually
• format messages and data in JSON on HTTP port
• publish received data as JSON to MQTT topics and vice versa
• announce message definitions for integration with Home Assistant using MQTT Discovery (if authorized by the token), either all or individually adjusted via the adapter webpage
• limit access to messages by picking the desired level (user/service/installer/admin)

Token

In order to use micro-ebusd on your adapter, you need to purchase a token.

Such a token enables using enhanced features of micro-ebusd on a particular adapter forever with the released firmware version at the time of the purchase (and optionally with updated versions depending on the kind of token).

For using newer firmware versions released after token expiry, a prolongation is needed (token renewal).

Every adapter is entitled for a one-time free 30-day trial token in order to test it before purchase.

Currently the following token options are available:

• You need to agree to the Terms and EULA before available options are shown:
  I have read and understood the Terms and EULA and agree to them.
• 
  

In order to purchase one of these options for your adapter, ensure a recent version of the firmware is running on it, open the adapter webpage, go to the Config / eBUS section, and click on the token check icon of the micro-ebusd option.

During purchase as well as for temporary trial tokens, the device needs to have internet access in order to check the transaction or token.

Unless the dynamic loading of message definitions is already completed, the device will also need to have internet access.

Note: my recommendation is to make use of the free 30-day trial token before switching to a real token in order to get familiar with micro-ebusd and checkout the features.

Messages

The messages identified for the system can be viewed directly in the adapter webpage in the “Messages” tab. This also allows adjusting polling for read messages individually as well as for enabling HA discovery (if authorized by token).

Furthermore, read messages can be retrieved directly from that tab, passive messages (like broadcast) can be inspected (if cached), and also write messages can be sent from editable fields.

The messages seen on the eBUS or read directly via the list are sent to MQTT, see MQTT topics for details.