Plugin installation
Information on how to install Plugins
Plugin installation process
Craftbeerpi4 comes with very basic functionality but has the possibility to use plugins provided by the community. Therefore, it has a huge flexibility as Sensors, Actors Controllers, Recipe creation plugins but also Push Messages and Displays can be added to each users need (The user just needs to write his plugin or needs to find someone who is providing it).
There is currently no possibility to install plugins automatically via the integrated plugin page. All plugins need to be installed via the path described below. The plugin page does only show the installed plugins.
CraftbeerPi4 comes for instance with a Onewire temperature sensor, but some users prefer a PT100/PT1000 sensor. Therefore, a variety of plugins is already available and below is an example on how to install a PT100/PT1000 sensor plugin.
Some plugins have been made available via pypi.org and can be installed directly from there. Other plugins need to be installed directly from GitHub. The cbpi4-pt100X plugin is available on both platforms. Typically, the latest version is available on GitHub and will be released a bit later via pypi.org as package
Installation from pypi.org is quite simple. Just type the following command to install a plugin which is available on pypi.org:
The plugin and it's dependent packages will be installed on your system and cbpi will detect it automatically.
The other way to install the plugin is directly from GitHub:
Also here, the plugin and the dependent packages will be installed automatically.
The command above will install the main branch of the cbpi4-pt100x github repo. The github page for this particular plugin is located at https://github.com/PiBrewing/cbpi4-pt100x and it has for instance two different branches: main and development. If you want to install the development branch, just replace main.zip with development.zip.
The same is true for other plugins you want to install from a repo. You just need to add /archive/BRANCH.zip behind the github http plugin address and substitute BRANCH with the name of the branch you want to install.
Advanced users have the possibility to run the commands within the virtual environment:
Enter the virtual environment:
And install the plugin with:
The other way to install the plugin is directly from GitHub:
Once this is completed, you need to leave the virtual environment with:
Restart cbpi or reboot your server.
To get some detailed information about the plugin configuration and how to connect/install your sensor, you should have always a look at the plugin page on GitHub or pypi.org. I always try to add the most important information in the corresponding README.
For the cbpi4-pt100x plugin, you can find the information here on GitHub or you search for cbpi4-pt100x on the pypi.org site.
Please always remember, that plugins can also add global settings during the installation that need to be set in the settings page. One example is for instance the cbpi4-pushover Plugin which adds the parameters pushover__user and pushover__key to the global settings..
How to update a plugin?
If there is a new version of a plugin you can simply re-install the plugin or run an upgrade. Below is the example for the cbpi-pt100x plugin:
Re-Installation:
Upgrade:
The update/upgrade or re-installation can be also done via pypi.org if the plugin has been published there via the plugin name as shown above.
How to remove a plugin?
If you want to remove a plugin you need to be careful. Before you remove the plugin from the server, you need to ensure that the plugin is not in use in any of your Hardware items and the dashboard as this may cause errors and can prevent the server from starting
To remove the plugin from the cbpi server, just type in case of the cbpi4-pt100x plugin:
How to show the installed/active plugins?
If you want to see the active plugins, you have two possibilities. The first option is from the command line. Just type:
This will show you a list of the installed plugins incl. the version:
The second option is directly from the user interface. Just click on the menu button on the top left and select Plugins. This will show this page which is still in development. However, you can see the active plugins and if the developer has added the corresponding information to his plugin, you can go directly to the corresponding webpage of the Plugin.
You can't install, activate or deactivate plugins on this page. It only shows the plugins you have installed and activated via command line.
Plugin List
The tables below shows the plugins that are currently available by type. At this point of time I cannot guarantee that the list is complete as I can only add the plugins to the list I am aware of.
Sensors
| Name | Description | Link |
|---|---|---|
cbpi4-pt100x | PT100/PT1000 Temp Sensor | |
cbpi4-hx711-loadcell | hx711 based Load cell Sensor | |
cbpi4-Flowmeter | Hall Sensor based Flowmeter Sensor | |
cbpi4-system | System Sensors: Temp, CPU load, Memory | |
cbpi4-scd30-co2-sensor | Temp, Rel. Humidity and CO2 sensor (I2C based) | |
cbpi4-iSpindle | Sensor that collects data from the iSpindle | |
cbpi4-KettleSensor | Collects target emp and power/status for kettle / fermenter | |
cbpi4-dht22-temp-hum-sensor | Sensor for relative humidity and temperature | |
cbpi4_GroupedSensor | Groups up to 8 Sensors for avg, max or min calculation | |
cbpi4-max6675 | Allows usage of max6675 board to connect k-type sensors and measure temps up to 1000°C (e.g. for gas burner control) |
Actors
| Name | Description | Link |
|---|---|---|
cbpi4-GroupedActor | Allows to group Actors | |
cbpi4-GroupedPowerActor | Allows to group Actors and ramp the power linear over the individual actors | |
cpbi4-DependentActor | Contains two Actor types: Dependent Actor allows to switch actors dependent on the state of other actors. Conditional actor allows to switch a target actor based on the status of a an actor group (AND / OR logic included). Helpful for triggering a chiller pump based on the status of solenoid valves | |
cbpi4-GPIODependentActor | Allows to switch actors dependent on the state GPIO Inputs (alpha) | |
cbpi4-pca9685 | PCA9685 I2C PWM Actor Plugin for CraftBeerPi4 | |
cbpi4-http-actor | Generic Craftbeerpi4 HTTP Actor Plugin | |
cbpi4-PCF8574-GPIO | Extend PI's GPIO Actors by 8 via I2C device | |
cbpi4-TriacHatActor | Plugin for using Waveshare's 2CH Triac Hat for controlling actors in CraftBeerPi |
Kettle Controller
| Name | Description | Link |
|---|---|---|
cbpi4-PIDBoil | Kettle controller with PID logic and Boil power parameter | |
cbpi4-PIDHerms | Kettle controller with PID logic, Boil power parameter and HLT temp sensor condition | |
cbpi4-BM__PID__SmartboilWithPump | Kettle controller with PID logic, Boil power parameter and automated Pump control / protection (can be used for instance for Speidel Braumeister) | |
cbpi4-PID_Autotune | Kettle controller that can be used to determine the PID parameters for the PID based Kettle controllers |
Fermenter Controller
| Description | Link | |
|---|---|---|
Example plugin to be created | Hysteresis included in cbpi4 > 4.0.1.0 | |
cbpi4_FermenterHysteresisWithChillerDiff | Fermenter Hysteresis with disabled cooling depending on chiller temp |
Display
| Name | Description | Link |
|---|---|---|
cbpi4-LCDisplay | Allows usage of LCD Display (I2C) | |
cbpi4-LCDisplay | Modded Fork that allows also Display of Fermentation with Fermenter Hysteresis Plugin | |
cbpi4-NEXTIONDisplay | Use Nextion Display on CraftbeerPi4 |
Utilities (Messaging, Custom Recipe Creation / Steps)
| Name | Description | Link |
|---|---|---|
cbpi4-BM_Steps | Example Plugin for custom Mash steps | |
cbpi4_Fermenterstep | Plugin for Additional Fermenter steps | |
cbpi4-RecipeImport | Example Plugin to customize automated recipe creation | |
cbpi4-buzzer | Activates buzzer on cbpi4 messages | |
cbpi4-PushOver | Forwards cbpi4 messages to Pushover push message service | |
cbpi4-TelegramPushNotifications | Telegram Push Notifications for Craftbeerpi 4 | |
cbpi4-alarmClock | Step plugin which starts heating at a specified time |
Last updated
