Firmware for ESP8266, ESP8285, and ESP32 allowing eBUS communication for ebusd with lowest possible latency.
For a history of versions and changes made therein, see the change log.
First of all, you need to flash the firmware to the ESP board. Currently, the following boards are supported and require flashing the corresponding binary:
- Wemos D1 mini:
- chip: ESP8266
- flash size: 4MB
- firmware: d1mini
- Wemos D1 mini Lite:
- chip: ESP8285
- flash size: 1MB
- firmware: d1mini_lite_1m
- Wemos D1 mini Pro:
- NodeMcu v1.0:
- chip: ESP8266
- flash size: 4MB
- firmware: nodemcu1
- chip: ESP8266
- flash size: 1MB
- firmware: esp01
- Wemos D32 (aka Lolin32):
- D1 mini 32:
Other boards might work as well, but were not tested.
In order to flash the firmware to the ESP board, you need one of these tools:
Using that tool, simply flash the right binary from the dist folder to the ESP board. Erasing the flash before might be a good idea (if you don't want to keep the settings).
For using the esptool.py either an OS with python installed is needed (e.g. Windows with Python 3.8 installed), or it needs to be made available by e.g. using docker or WSL. With WSL it is a bit tricky to get hold of the USB port of the Windows host but not impossible (e.g. by using usbipd-win).
The image can then be flashed using the flash.sh script which mainly does the following:
- takes one optional argument with the name of the image file to flash (e.g.
./dist/ebusd-v3_d1mini.binwhich is the default as well)
- erases the flash completely (for ESP32: only if you pass one of the
...32_factory.binimages as argument)
- fills or resets the init data areas appropriately
- flashes the image itself
For the esptool flasher, just run it on command line like this
(replacing COM4 with the corresponding port on Windows or the right serial device like /dev/ttyUSB0 under Linux, and
replacing ebus-v3_d1mini.bin with the right filename for your board):
esptool -cp COM4 -bm dio -cd nodemcu -cb 921600 -ce -cf ebus-v3_d1mini.bin
For all ESP32 images, the first flashing of a blank or otherwise differently flashed device has to be done with the image having "_factory" as suffix in the name, e.g. ebus-v3_lolin32_factory.bin. This contains all relevant parts to get the device up and running.
The firmware can be configured with a simple HTML frontend or by using the serial link (using the onboard USB serial converter).
Simply connect with e.g. Putty to the COM port at 115200 Baud (8N1) after connecting the board to your computer, and you will see the following configuration options:
Welcome to eBUS adapter 3, build 20221215 Configured as WIFI access point EBUS without password. For configuration with web browser, connect to this WIFI and open http://192.168.4.1/ Entering configuration mode (4). Chip ID: ********, d1mini@80 Hostname: ebus-****** Configuration (new): 1. WIFI SSID: EBUS 2. WIFI secret: 3. WIFI IP address: DHCP (not started yet) w. WIFI power: normal (17 dBm) W. WIFI phy mode: 802.11 g/b/n = Wi-Fi 4 4. WIFI hostname: ebus-****** 5. eBUS RX+TX PINs: Adapter 3.1 RX+TX high-speed (if enhanced) =GPIO3+1 6. ebusd connection: enhanced on port 9999 7. HTTP TCP port: 80 8. LED PINs: RX:disabled, TX:disabled 9. Initial PINs: D4:H p. Set current PINs: D4:H t. Toggle current output PIN s. Scan & read sensors c. Connect WIFI e. Dump EEPROM content f. Load factory settings F. Factory reset (i.e. erase EEPROM) l. Log lines o. OTA enabled: waiting r. Reboot (without saving) R. Run (without saving) 0. Save and Reboot Enter your choice:
By entering one of the characters at the start of each configuration line and pressing ENTER, you can change the corresponding configuration item or initiate the action behind it.
Once you have entered the desired data and verified their correctness, press "0" for saving the configuration and rebooting the device.
For WIFI connection, you can try the connection (after SSID and secret were set) by using "c" and ENTER.
After flashing, the device acts as an WIFI access point with SSID "EBUS", no password, and IP address "192.168.4.1".
The HTTP TCP port is set to port 80 by default. By entering the IP address of the device in a web browser, a status page like this is shown:
The main configuration settings can be changed similarly to the serial link interface (not all options are available though) by clicking on Configuration:
When configuring for an eBUS adapter 3, the necessary ebuspicloader settings will be shown in the appropriate section. Please make sure to set them accordingly. For older PIC firmware versions, the hardware jumpers are shown as well, but these are obsolete now.
Use "Check & Update" to check your input and if no error message appeared and after you have verified the correctness of the values, simply press "Save & Reboot" to save the changes and reboot the device.
If you're unsure with the settings, you can press "Run (without saving)" to check them before saving.
The red "config mode" pill in the UI changes to a green "running" after reboot and the "new" pill at the "Configuration" tab will be gone.
It is also possible to change PINs directly on the PINs page:
If you want to change the initial PIN settings, just use the last column for that and afterwards go to the Configuration page and press "Save & Reset" to save the changes and reboot the device.
Support for 1-wire temperature sensors is experimental, so handle with care. Once a PIN is configured as sensor PIN, the connected sensors are scanned and sensor data can be retrieved with the "/sensor" URL in JSON format and show up in the HTML frontend.
The onboard LED is used to give some feedback about the current state.
During reset, it usually blinks shortly as some data is sent on the debug output (which usually is connected to the onboard LED).
The LED status after the reset depends on the selected eBUS RX+TX PIN mode.
When in one of these eBUS RX+TX PIN modes, the LED provides the following feedback:
- After reset, it blinks two times slowly to indicate it was (re-)started.
- While establishing the WIFI connection, it dims down from on several times up to 8 seconds.
- When the WIFI connection was successfully established, it is switched off for around 5 seconds. During that time and when no eBUS signal was detected, sending the enter key twice on the serial port makes the firmware go to serial configuration mode.
- When an ebusd instance has connected successfully to the TCP/UDP port and there is a steady eBUS signal, then the LED is turned on permanently either at full brightness (if ebusd regularly sends something to the eBUS) or less brightness (if ebusd does not write to the eBUS).
If anything goes wrong during these steps, the LED will turn off. So everything is fine only if the LED is on permanently at full or less brightness.
When the RX+TX PIN mode is set to mixed software D1 + TX1 D4 mode, the onboard LED will blink when something is sent actively from the board on the eBUS only.
If the HTTP port is configured, you can use the "/pin" URL for changing the value of an output PIN or reading the current status of all PINs in JSON format including the analog input PIN.
The "Log" tab will show the last log entries (up to 64) and is more for debugging.
When configured for one of the eBUS adapter 3 modes, a "PIC" tab appears that allows enabling a pass-through mode to the PIC which can be used to change the settings or update the PIC firmware using ebuspicloader.
In order to update the firmware (after the device was flashed initially as stated above), you can use the HTML frontend or the serial frontend for activating OTA.
Using the HTML frontend, you can also upload a new firmware directly after enabling OTA in the configuration page. This is not possible for all variants though (e.g. when flash size is too small).