An implementation of the BrewPi firmware on the ESP8266, ESP32, and ESP32-S2 with additional, added features
This project ports the BrewPi firmware to the ESP8266, ESP32, and ESP32-S2 controllers. It is compatible with Fermentrack and BrewPi-Remix.
- Selecting your Hardware
- Building a "Solder Free" BrewPi
- Installing the Firmware
- Developing/Contributing
- Hardware Information - PCB files, ordering and BOMs
There are two versions of the ESP32 firmware - one supporting an LCD2004 I2C display and one supporting a TFT. The pinout is slightly different between the two:
- 25 - Heat
- 26 - Cool
- 13 - OneWire Data
- 34 - Door
- 21 - I2C SDA
- 22 - I2C SCL
- 14 - TFT CS
- 27 - TFT DC
- 33 - TFT RST
- 12 - TS CS
- 32 - TFT Backlight
- 5 - Heat
- 7 - Cool
- 9 - OneWire Data
- 11 - Door
- 33 - I2C SDA
- 35 - I2C SCL
Although the ESP8266 was the original board chosen for this project, due to reduced support by the manufacturer its use in new builds is not recommended. For existing builds using the LoLin D1 Mini, the LoLin S2 Mini (utilizing the ESP32-S2) is recommended as a pin compatible replacement.
- D0 - Heat
- D1 - I2C SCL
- D2 - I2C SDA
- D5 - Cool
- D6 - OneWire Data
- D7 - Door (Untested)
- OneWire Temperature Sensors
- SPIFFS configuration saving
- Pin-Based Relays
- WiFi Soft-AP Configuration
- OTA (WiFi) connection to BrewPi
- I2C LCD (20x4) Screen (/w Address Autodetection)
- Tilt Hydrometer (as Temp Sensor) (ESP32 only)
- TPLink Kasa WiFi Switches (ESP32 & ESP32-S2 WiFi only)
- HTTP interface for quick updates
- Rotary Encoder Support
- Door Sensor Support (Note - May work, untested)
- Buzzer Support
- OneWire "actuators"
The primary goal in creating this was to mirror the spirit of the Arduino implementation as closely as possible while adding in support for WiFi. That said, where I've needed to decide between preserving the original code and adapting for use with the ESP8266 I've generally erred towards the latter. This is especially true with the EEPROM code - this implementation completely replaces the EEPROM with SPIFFS.
When possible, I've broken out ESP8266 specific code using preprocessor logic. Although this should in theory allow this code to be compiled against an Arduino target, backwards compatibility is not guaranteed. The primary goal of using preprocessor logic is to document changes from the Arduino codebase - not to maintain it.
Due to the fact that this is an unsupported board, I have had to rewrite a small portion of brewpi-script to support it. I've also merged in (some of the) changes that were proposed to the official repo late last year to support network sockets (and therefore, WiFi). As a result, to use brewpi-esp8266 you will need to also use this modified brewpi-script.
Although this firmware works with brewpi-www, it is highly recommended that users use Fermentrack instead as Fermentrack substantially reduces the work required to get an ESP8266-based controller working. Due to recent changes in Raspbian, ongoing testing & support for this firmware is exclusively performed on Fermentrack and future changes may introduce incompatibility with brewpi-www.
I maintain a separate repo with PCB and 3D-printable case designs for all of my projects. The page specific to BrewPi-ESP can be accessed here.