7.2. Changelog¶

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/) because it was the first relatively standard format to pop up when I googled “changelog formats”.

7.2.1. [Unreleased] - Additional Bugfixes¶

7.2.1.1. Changed¶

Changed BrewPi-Script process manager to log data points via an HTTP API rather than directly querying the database
Add additional cleanup steps to BrewPi-Script process manager
Clarify links to BrewPi Process Spawner logs on help page

7.2.1.2. Fixed¶

Resolved issue that would prevent the “invert” flag from being properly applied to BrewPi-ESP devices running recent firmware

7.2.2. [2023-08-20] - Additional BrewPi-Script Bugfixes¶

7.2.2.1. Changed¶

Changed BrewPi-Script process manager to get list of devices via an HTTP API rather than directly querying the database
Force BrewPi-Script process manager to restart in certain cases where a deadlock is detected

7.2.3. [2023-07-04] - BrewPi-Script Bugfixes¶

7.2.3.1. Changed¶

Changes the message when a BrewPi device cannot be reached
Only allow BrewPi-Script to check for profile updates once every 30 seconds
Prevents two BrewPi devices from being able to have the same cached IP address

7.2.3.2. Fixed¶

Resolves an error that would cause debugging connections to controllers to periodically raise an exception
Resolves an error where a missing schema on a generic push target would not get corrected to http://
Allow GravityLog.device to be None in backups, fixing errors that could prevent backups from being properly generated
BrewPi-Script processes are now launched in a manner that allows StopIteration exceptions to be properly handled

7.2.4. [2023-06-23] - ESP32 Support, TiltBridge Jr & new BrewPi-Script¶

NOTE - This is the first version of Fermentrack that explicitly DOES NOT support “dockerless” installation. Installation is intended to be via the official Fermentrack images on Docker Hub.

7.2.4.1. Added¶

BrewPi-Script instances are now controlled via a custom process manager
Officially added arm64v8 to supported platforms
Added support for new versions of the BrewPi Firmware for certain ESP-based BrewPi Controllers
Added support for extended settings on new BrewPi Firmware for certain ESP-based BrewPi Controllers
Added board types for ESP32, ESP32-C3, and ESP32-S2
Added examples for HTTPS support (Thanks @HuggableShark)
Added UUIDs to most exportable objects to allow for easier import/export
Added “TiltBridge Jr.” (new Tilt bluetooth daemon) support

7.2.4.2. Changed¶

Removed Circus support in favor of managing processes via Supervisord
Removed libzmq requirement
Removed environment tests for Tilt hydrometers (Obviated via Docker)
Switch to use latest LTS version of Django
Update to Python 3.9
Changed most references to ESP8266 to reference ESP32 as appropriate
Rewrote backup & restore functions to no longer rely on Django management code
Changed restoration of legacy backups to explicitly utilize the staging folder
Removed GitHub upgrade workflow from UI

7.2.4.3. Removed¶

Removed Fermentrack-specific Bluetooth daemon - now handled by TiltBridge Jr.

7.2.5. [2022-04-05] - Last Dockerless Version & Backup & Restore¶

NOTE - This is the last version of Fermentrack that will explicitly support “dockerless” installation. All future installations are encouraged to use (and all existing users are encouraged to migrate) to docker-based installations of Fermentrack to ensure compatibility going forward.

7.2.5.1. Added¶

Backup & Restore functionality (Gear Menu > Manage Backups)

7.2.5.2. Changed¶

Removed “upgrade” notice from non-docker installs
Added warning to non-docker installs about a lack of future support

7.2.5.3. Fixed¶

Adjusted elements that were preventing dark mode from being as dark as it could be (Thanks @carjed)

7.2.6. [2021-12-08] - Compatibility Enhancements¶

7.2.6.1. Added¶

i386 (i686) build target for Docker images
Custom color scheme support (dark mode!) (Thanks @calandryll!)

7.2.6.2. Changed¶

Change to prefer caching IPv4 addresses in BrewPiDevice.wifi_host_ip
Removed PyBluez requirement to enable wider platform support

7.2.6.3. Fixed¶

Properly allow blanks for BrewPiDevice.wifi_host_ip

7.2.7. [2021-04-05] - Docker Support¶

7.2.7.1. Added¶

Added support for Docker installations
Added environment/container version number to GitHub page
Tilt “version” is now displayed on the Tilt Configuration page (Bluetooth only)
Tilt battery level now shows on the Tilt Configuration page (Bluetooth v3/Tilt Pro only)
“Last Check-in” time now added to Tilt configuration page (Bluetooth only)
Added link to view Huey logs inside the Fermentrack UI
Added link to view Circusd logs inside the Fermentrack UI

7.2.7.2. Changed¶

Removed instances where BrewPi-Script would write to the database
Adjusted feedback loop for Circus to eliminate a potential race condition with transactional databases
Redesigned available firmware list to reduce confusion
Stale gravity check-in points will now not be displayed in the gravity dashboard panels
Added support for latest TiltBridge firmware
Remove unimplemented “TCP Socket” external push option
Added Beer Setting, Fridge Setting, and Controller State to generic external push targets
Upgraded TiltBridge support for v1.0.0 TiltBridges (earlier TiltBridge versions will now require manual configuration)
External push target attempts now log to huey stdout
Added battery to the GenericPushTarget message for pushed iSpindel devices

7.2.7.3. Fixed¶

Fermentrack now works with properly transactional databases (e.g. Postgres)
Resolved issue causing false failures of the connectivity test (Thanks postalbunny!)
Fixed issue preventing renaming of BrewPi controllers
Dashes now allowed in TiltBridge mDNS IDs
Corrected issue where iSpindel data couldn’t be loaded if a data point wasn’t availble in Redis

7.2.8. [2020-12-19] - Tilt Pro¶

7.2.8.1. Added¶

iSpindel temperature readings can now be calibrated for accuracy
Add properly sized app icon for apple devices

7.2.8.2. Changed¶

Added support for the new Tilt Pro
Updated Sentry target
Round iSpindel readings to four decimal places

7.2.8.3. Fixed¶

Updated requirements to support the new pip

7.2.9. [2020-11-07] - Temp Profile Tweaks & Docker Prep¶

7.2.9.1. Added¶

Added optional “notes” field to fermentation profile models
Added error message when attempting to create a point with an invalid temp/ttl in a temp profile
Added support for configurable gravity units (e.g. plato, specific gravity)

7.2.9.2. Changed¶

Changed link to sqlite database to allow for a subdirectory in Docker installs
Fermentation profile points can now be deleted for in-use fermentation profiles
Remove Python 3.7 warning (everyone should have upgraded by now)
If a Grainfather, Brewfather, or generic push target logging URL doesn’t begin with http:// it is now automatically appended

7.2.9.3. Fixed¶

Bug causing errors when enabling beer profile mode
Can now properly push to BrewFather when a fully populated temperature controller isn’t linked
Don’t prompt new installs to run the script to fix old sqlite files

7.2.10. [2020-08-22] - Bugfixes¶

7.2.10.1. Added¶

Added pin definitions for esp32 BrewPi firmware
Added Linux networking capability test to Tilt connectivity test suite

7.2.10.2. Changed¶

Added ability for BrewFather push target to push temps from BrewPi temp sensors

7.2.10.3. Fixed¶

Fixed bug that prevents reloading of cached controller objects
Properly detect/force temperature conversion for iSpindel

7.2.11. [2020-06-05] - Django 3.0 Support¶

7.2.11.1. Added¶

Added button to controller settings page to restart a controller

7.2.11.2. Changed¶

Updated code to be Django 3.0 Compatible
Changed from Django 1.11 to Django 3.0
Toggling display of a graph line on a temp controller’s dashboard now clears the data point displayed in the legend
Refactored brewpi-script to accept device IDs rather than names

7.2.11.3. Fixed¶

Properly catch exception when Redis test cannot connect to server
Gravity and gravity temp colors when graphed on temp controller graphs will now display the correct color in the legend
Links to CSVs from the beer log list now properly generate if the CSV exists
Correct error detection/logging when a temp controller with an attached gravity sensor attempts to log before the gravity sensor logs its first point
Properly check that a temperature setting is provided when setting a Beer or Fridge Constant mode for temp controllers
Temp controller name uniqueness checks are now properly enforced in all add controller workflows

7.2.12. [2020-04-11] - Bugfixes & Tilt Troubleshooting¶

7.2.12.1. Added¶

Added explicit support for LBussy’s BrewPi-Remix I2C Board
Exposed upgrade.log from the help screen
Store the exact last time that a message was received from a Tilt to Redis
Add sentry support to tilt_monitor_aio.py
Added “debug” scripts for bluetooth Tilt connections
Added TiltBridge connection settings to Tilt management page

7.2.12.2. Changed¶

Removed legacy Python 2 code
Reduced gravity sensor temp precision to 0.1 degrees
Locked pybluez, aioblescan, and redis versions to prevent undesired format changes going forward

7.2.12.3. Fixed¶

Fix display of TiltBridge mDNS settings on Tilt settings page

7.2.13. [2020-02-17] - Improved ESP32 Flashing Support¶

7.2.13.1. Added¶

Added support for flashing a bootloader and otadata partition to ESP32 devices

7.2.13.2. Changed¶

SPIFFS partitions can now be flashed to ESP8266 devices

7.2.14. [2020-02-15] - ThingSpeak and Grainfather Support¶

7.2.14.1. Added¶

Added support for pushing data to ThingSpeak (thanks @johndoyle!)
Added support for pushing data to Grainfather (thanks @mp-se!)

7.2.14.2. Changed¶

Gravity sensors attached to BrewPi controllers will now send those controller’s temps to Brewfather
An explicit error message will now be displayed when a user attempts to manually access the ispindel endpoint

7.2.14.3. Fixed¶

Fixed where Fahrenheit readings coming from an iSpindel could be improperly reconverted to Fahrenheit
Lock temperature display on dashboard panels to one decimal place
Allow updates to controller settings when controller name isn’t changing (for real this time)
Fix bug that would default all Tilts to ‘Bluetooth’ even when a TiltBridge was selected
Fixed issue where Tilt readings were not being properly decoded (Thanks NecroBrews!)
Fixed issue where dashboard panels were not being updated (Thanks NecroBrews!)

7.2.15. [2019-12-15] - Brewer’s Friend, Brewfather, and MacOS BLE Support¶

7.2.15.1. Added¶

Added support for pushing gravity sensor data to Brewer’s Friend
Added support for pushing gravity sensor data to Brewfather
Added BLE support for MacOS (thanks corbinstreehouse!)

7.2.15.2. Changed¶

Adding an external push target now triggers data to always be sent within 60 seconds regardless of push frequency

7.2.15.3. Fixed¶

Disable “View Full CSV” button if gravity/beer logs don’t exist
Properly cleanse booleans when changing site settings for Constance
Allow updates to controller settings when controller name isn’t changing
Remove requirement for TiltBridge value in the TiltBridge model definition
Ignore Tilt diagnostic codes that cause erroneous temperature/gravity readings

7.2.16. [2019-10-24] - Miscellaneous Bugfixes¶

7.2.16.1. Fixed¶

Prompt for reconfiguration if pin/address assignment fails on BrewPi Controller
Validate device name uniqueness when adding a new BrewPi Controller
Warn user when empty temperature is submitted alongside Fridge or Beer Constant mode
Return debugging info when a connection to a WiFi BrewPi Controller is refused
Properly handle errors in the first step of the firmware flash process
When logging beer points on a gravity-enabled log, make sure the gravity sensor exists (or stop logging)
Properly handle empty TiltBridge check-ins
Before adding a Tilt that uses a TiltBridge, make sure the TiltBridge exists
Return an error if a TiltBridge doesn’t pass properly formed JSON
Enforce uniqueness of a Beer name/logging device combination when the Beer is created
Cause brewpi-script to terminate if the controller returns invalid control settings
Return empty JSON for annotations if Beer doesn’t exist

7.2.17. [2019-03-31] - TiltBridge Support¶

7.2.17.1. Added¶

Added support for TiltBridge Tilt-to-WiFi devices

7.2.17.2. Changed¶

Removed Hex SHA display on GitHub update
Tweaked backup count for log files to reduce clutter

7.2.17.3. Fixed¶

Fixed hostname lookup in connection debug when running on a nonstandard port
Fixed multipart firmware flashing
Remove Git branch switching prompt during initial setup
Remove links to defunct Tilt logs
Fixed OneWire address display on BrewPi “Assign Pin/Device” page
Fix link to “load beer log” modal on device dashboard when no beer is loaded

7.2.18. [2019-03-17] - Firmware Flash Changes¶

7.2.18.1. Added¶

Added support for flashing multi-part firmware (eg partition tables)

7.2.18.2. Changed¶

Updated firmware_flash models to support additional device families
Changed to version 2 of firmware_flash models

7.2.19. [2019-02-17] - External Push (Remote Logging) Support¶

7.2.19.1. Added¶

Fermentrack can now periodically “push” readings out to an external device/app
Added “new control constants” support for “modern” controllers

7.2.19.2. Fixed¶

Explicitly linked Favicon from template
Fixed BrewPi-Script error when attempting to use feature not available in Python 3.4
Properly catch error in BrewPi-Script when pidfile already exists
Added filesize check for gravity sensor & brewpi-device logfiles
Add support for temperature calibration offsets

7.2.20. [2019-02-17] - External Push (Remote Logging) Support¶

7.2.20.1. Added¶

Fermentrack can now periodically “push” readings out to an external device/app
Added “new control constants” support for “modern” controllers

7.2.20.2. Fixed¶

Explicitly linked Favicon from template
Fixed BrewPi-Script error when attempting to use feature not available in Python 3.4
Properly catch error in BrewPi-Script when pidfile already exists
Added filesize check for gravity sensor & brewpi-device logfiles
Add support for temperature calibration offsets

7.2.21. [2018-10-24] - Tilt Monitor Refactoring¶

7.2.21.1. Changed¶

The Tilt Hydrometer monitor now uses aioblescan instead of beacontools for better reliability
Added support for smaller screen sizes

7.2.21.2. Fixed¶

Tilt Hydrometers will now properly record temperatures measured in Celsius

7.2.22. [2018-08-05] - Gravity Refactoring¶

7.2.22.1. Added¶

DS18b20 sensors can now have temperature offsets added to each reading to correct for calibration errors
ESP8266 controllers can now have their WiFi settings reset via the “manage sensor” web interface
Control constants form now supports both “new” (OEM BrewPi) and “old” (“Legacy” branch) control constants
Tilt hydrometers can now have their specific gravity readings calibrated
“Heat/Cool State” will now be shown on temperature graphs
Fermentrack logo added as favicon

7.2.22.2. Changed¶

The iSpindel endpoint can now be accessed at either /ispindel or /ispindle
Specific gravity will now be shown on graphs with 3 decimal places
Beer log format has been changed to add state information

7.2.22.3. Fixed¶

Removed constant LCD polling for “modern” controllers
Gravity support will now be properly disabled when the correct flag is set at setup
iSpindel devices that do not report all ‘extras’ will no longer throw errors when reporting gravity

7.2.23. [2018-04-27] - “v1.0 release”¶

7.2.23.1. Added¶

Added fermentation controller “Manage Device” page
Upgrades are now logged to upgrade.log
Controller “stdout” and “stderr” logs are now saved/accessible
Support for serial devices
Support for Arduino-based devices
Support for in-app git branch switching
Autodetection of serial devices
Huey (delayed/scheduled task) support (currently unused)
Controllers connected via serial can now have their serial port autodetected using the udev serial number
Beer profiles are now displayed in graph form
Firmware can now be flashed to new Arduino & ESP8266-based controllers from within the app
Preferred timezone can now be selected for use throughout Fermentrack
Beer log management (deletion/downloading)
Added configuration options for graph line colors
Graph lines can be toggled by clicking the icon in the legend
Added support for specific gravity sensors
Added support for Tilt Hydrometers
Added support for iSpindel specific gravity sensors

7.2.23.2. Changed¶

Inversion flag for installed devices is now shown on the “configure pins/sensors” page
Form errors are now displayed on “configure pins/sensors” page
Beer logs are no longer deleted along with the parent device (but they will become inaccessible from within Fermentrack)
GitHub updates are no longer triggered automatically by visiting the update page, and must now be manually triggered by clicking a button
The IP address of a BrewPiDevice is now cached, and can be used if mDNS stops working
At end of a fermentation profile the controller will now be switched to beer constant mode
All data points are now explicitly recorded in UTC
Added icon to graph legend to display line color
Updated to Django v1.11 (Long term support version)
Changed from supporting Python 2 to Python 3

7.2.23.3. Fixed¶

Inversion state no longer improperly defaults
Minimum graph size adjusted to account for smaller displays
Changed on_delete behavior to allow deletion of fermentation controllers
Git update check will now properly wait between checks if up to date
GIT_UPDATE_TYPE of ‘none’ will now properly disable update checks
BrewPi controllers now accept unicode names
“View Room Temp” link on Dashboard now functions
Room temp now included in legend for graphs

7.2.24. [2017-03-17] - “v0.1 release”¶

7.2.24.1. Added¶

First release!