Changes

Server Version 4.3.1 has the following changes:

  • Fixed an issues for a fresh install.

  • added asyncio-timeout package to the requirements as ait was missing with a fresh install. Obviously, some dependencies have changes with the change of the required packages in 4.3.0

Server Version 4.3.0 has the following changes:

  • Update of some required packages

RPi.GPIO is replaced with rpi.lgpio to accommodate compatibility with Pi5

  • On Pi 4 and below you need to remove the RPi.GPIO package from your system prior installation of cbpi4 or prior update from 4.2.0 to 4.3.0. Please read the adapted installation instructions carefully prior upgrading!!!

  • It is also required to install/upgrade cbpi4 now with the --system-site-packages parameter with pipx to ensure that all system packages are usable in the virtual environment. This may change later, but is currently required due to dependencies of rpi-lgpio.

Server Version 4.2.0 has the following changes:

cbpi version is available at pypi.org or from the github development branch

Kleiner Brauhelfer import

  • Craftbeerpi4 is now compatible with Kleiner Brauhelfer 2.6 database for recipe import. OlderKBH database versions won't be supported with 4.2.0+

Installation of cbpi won't require sudo and can be installed under other user with working autostart

  • These changes (in particular removal of sudo requirement) are required for compatibility with newer OS versions such as bookworm.

  • An update of older cbpi versions can be still done with the sudo installation as in the past. However, it is recommended to migrate to bookworm os.

  • Migration to bookworm needs to start from scratch with an empty SD card as migration from bullseye to bookworm via dist upgrade is not recommended and most likely not working.

  • For installation under bookworm, you need to use pipx instead of pip. This package must be installed first (see new Server Installation instructions).

  • To run cbpi you need to run the command pipx ensurepath after installation of cbpi. Close the terminal and open it again. Then the cbpi command will be working.

  • Pipx will create a virtual environment for cbpi4 and you need to install all plugins inside this virtual environment (see new Plugin installation instructions). The virtual environment is only required for plugin installation.

  • cbpi onewire | setup | autostart and chromium commands must be carried out in your normal bash and not in the virtual environment. sudo is not required anymore and won't be working.

  • You should also be able to install cbpi under a different user than pi and have it starting with autostart. The file craftbeerpi.service in the config folder is replaced by a flexible craftbeerpi.template file that is adapted to the user you are logged into your terminal session. cbpi setup must be carried out in your home folder as in older versions (typically the folder you are in, when you open a terminal session).

  • Backup your config on your existing system -> Install bookworm aon an empty sd card -> follow the server and plugin installation instructions. Restore your config file. You need to activate onewire, I2C, autostart,... on your new system. Although I have successfully tested bookworm incl. installation and everything on my productive system, KEEP your SD card with the old system, until you have completed your first batch on the new system.

Debugging: added debug-log-level parameter to config.yaml

  • If not in config.yaml, default log level is 30 (warnings)

  • You can add / modify the level in config.yaml and log level will be also adapted to server running in automode

Dashboard: added hidden gridwidth parameter to settings

  • will be used with upcoming UI to change the dashboard grid settings in edit mode on the fly

Bookworm compatibility

  • This cbpi version is compatible with bookworm os if installed with pipx (tested).

  • Bookworm is now using wayland instead of X11 window manager as default. I have some issues with my touchscreen in combination with wayland but also the standard VNC did not work properly. Therefore I switched to X11 which is possible via raspi-config. You will find the option to switch under Advanced Options.

  • Chromium Kiosk mode is working under X11. I have not tested this under wayland window manager.

Server Version 4.1.10 has the following changes:

Individual Data logging can be now done via plugin (provided by prash3r)

  • In case a developer wants to log data to different databases or files, data can be logged via plugin.

  • As an example you can review the influxdb logger

Adding global settings for a plugin requires now a source parameter

!!! Plugins with global settings (e.g. cpbi4-buzzer, cbpi4-system, cbpi4-Pushover, cbpi4-scd30-co2-sensor,.....) need to be updated to the latest versions !!!

  • To get a better overview on the settings page, plugins that add global settings parameters need to use a 'source' parameter.

  • With UI version 0.3.12, the settings page has a drop down menu at the top to select also settings for individual plugins.

  • An example can be seen here

  • This example also shows how to update parameters in case you want to change for example the description. Therefore, you can use also the source key 'hidden' and write the plugin version to the settings.

  • Hidden parameters won't be shown on the settings page.

  • Added function to remove global config parameters.

UI Version Version 0.3.12 has the following changes:

  • Added selection option to settings page for global plugin settings, Option to remove obsolete global settings on system page.

  • Added various tooltips and fixed issue if fermenter recipe contained special characters (-> will be automatically replaced).

  • Option on analytics page to delete all logs

Server Version 4.1.7 has the following changes:

Cryptography update may cause error 'X509_V_FLAG_CB_ISSUER_CHECK' or 'Illegal instruction'

For security reasons the cryptography package had to be updated to 40.0.0. This may cause an issue later when you are using pip. To fix it, please have a look here

In case of the illegal instruction issue (armv6 based 32 bit systems), you can try to adapt the setup.py manually. However, there won't be any further support with older versions of cryptography due to security issues with older versions of this dependency.

INFLUXDB configuration

  • INFLUXDBADDR address must contain the full address incl. http(s) and port

  • INFLUXDBPORT becomes obsolete

    • old: INFLUXDB: localhost | INFLUXDBPORT: 8086 -> new: INFLUXDBADDR: http://localhost:8086

  • INFLUXDBNAME: 1.8 => database name | 2.X or cloud: bucket name

  • INFLUXDBPWD: 1.8 => password if required | 2.X or cloud: token

  • INFLUXDBUSER: 1.8 => user if required | 2.X or cloud: organization

Buzzer Tone via Browser

  • PLAY_BUZZER parameter has been added to global settings

    • Yes will enable buzzer tone via web interface (UI >= 0.3.11 required)

Reduced sensor logging (integrated http, mqtt and onewire sensors)

  • The sensor plugins that come with cbpi have an additional functionality with respect to logging.

  • The user can assign a Kettle OR a Fermenter to the sensor

  • The reduced logging frequency defines the reduced frequency of sensor logging. Readings will be still handled with regular frequency, but logging to CSV or influxdb is reduced. A value of 0 disables logging completely on inactivity.

  • Reduced logging will be only enabled if a Kettle or Fermenter is specified for this sensor and if the Kettle or Fermenter is inactive (not running in auto mode).

  • For the onewire sensor the reduced logging value must be larger than the regular logging/reading frequency.

  • Example: Onewire sensor is reading data every second and you have set your brew kettle as Kettle for this sensor, you have further set reduced logging to 300. the sensor will log a value every second, while you are brewing in auto mode, but sends values to the log only every 300 seconds, when the kettle is inactive. If the reduced logging value is set to 0, the logging will only take place when brewing, but it is completely disabled when the kettle is inactive.

UI Version Version 0.3.11 has the following changes:

Buzzer Tone via Browser

  • Buzzer signal with server >=4.1.7

Grafana Widget requires change in UI property settings for refresh

  • old: 10 | new: 10s or 1m (time unit required)

  • Only data will be updated and not the entire iframe

Changelog

  • To be created

PreviousExample System: MQTTDevice V4 based Fermentation

Last updated