Metadata-Version: 2.1
Name: cbpi4-BM-PID-SmartBoilWithPump
Version: 0.1.6
Summary: CraftBeerPi4 PID Kettle Logic Plugin
Home-page: https://github.com/avollkopf/cbpi4-BM_PID_SmartBoilWithPump
Author: ['Alexander Vollkopf', 'Guy Lev']
Author-email: avollkopf@web.de
License: GPLv3
Description: # CBPi4 Braumeister Smart Boil with Pump KettleLogic
        
        ### This Kettle Logic can be used to run a Speidel Braumeister with CraftbeerPi4. It is based on this cbpi3 Plugin (https://github.com/cgspeck/cbpi-pidsmartboil-withpump)
        
        ## Mash & Boil in single Kettle (e.g. Speidel Braumeister)
        - The Kettle logic is intended to be used in a single Kettle. It is a PID logic. PID parameters can be for instance derived from the PID AutoTune plugin (https://github.com/avollkopf/cbpi4-PIDAutoTune)
        - It runs on PID control until it reaches a specified temperature. Above that temperature it heates w/o PID logic until a specified boil temp is reached.
        - Power to run boil can be specified in the plugin
        - Pump Intervals cen be set to have a pump rest on specified intervals for a specified time (e.g. 60 seconds every 600 seconds which is a default for the Braumeister controller)
        
        
        ### Installation:
        
        You can install it directly via pypi.org:	
        - sudo pip3 install cbpi4-BM-PID-SmartBoilWithPump 
        
        Alternativeley you can install (or clone) it from the GIT Repo. In case of updates, you will find them here first:
        - sudo pip3 install https://github.com/avollkopf/cbpi4-BM_PID_SmartBoilWithPump/archive/main.zip
        
        
        ## Parameters:
        
        ![Settings](https://github.com/avollkopf/cbpi4-BM_PID_SmartBoilWithPump/blob/main/cbpi4-BM_PID_SmartBoilWithPump-logic.png?raw=true)
        
        - Configurable:
        	- P: Proportional - Takes current value into account
        	- I: Integral - Takes past values into account
        	- D: Derivative - Takes future values into account
        	- SampleTime - 2 or 5 seconds -> how often the logic calculates the power setting
        	- Max Pump Temp: Pump is switched off above this temperature and cannot be switched back on
        	- Max Boil Output: Maximum Power during when Boil Temp is reached
        	- Max Boil Temp: When Temp is reached, power is set to Max Boil Output
        	- Max PID Temp: PID is switched off above this temperature
        	- Rest Interval: Time interval in seconds after which Pump is switched off
        	- Rest Time: Pump is switched off for specified time in seconds
        	
        - Fixed in Code:
        	- Max Output: Maximum Power (%) to be used for PID during Ramp up -> 100%
        
        
        Changelog:
        
        - 14.06.22: (0.1.6) Disable pump pause during temperature ramp -> pause will take effect only on active timer
        - 11.05.22: (0.1.5) Updated README (removed cbpi add)
        - 10.05.22: (0.1.4) removed cbpi dependency
        - 30.12.21: (0.1.3) Fixed 0 pump/rest time -> Pump will be sitched on at start and off if temp is above controll limit. But no pump pause is triggered
        - 01.12.21: (0.1.2) Added security feature: current kettle power is monitored continuously and overwritten in case it's different from the logic loop value
        - 21.11.21: Updated setup and Readme 
        - 15.11.21: Adapted to cbpi 4.0.0.45 with actor power settings
        - 01.11.21: Merged Pull request from madhatguy ansd fixed some bugs
        - 15.03.21: Support for cbpi >= 4.0.0.32
        - 31.10.21: Changed logic to coroutines
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
