cbpi4-PIDBoil


Namecbpi4-PIDBoil JSON
Version 0.0.9 PyPI version JSON
download
home_pagehttps://github.com/avollkopf/cbpi4-PIDBoil
SummaryCraftBeerPi4 PID Kettle Control Plugin
upload_time2022-12-30 08:12:25
maintainer
docs_urlNone
authorAlexander Vollkopf
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Craftbeerpi4 Kettle Logic Plugin

## PID Logic with boil threshold.

If the target Temperature is above a configurable threshold the PID will be ignored and heater is switched on to the max output value. This is helpful if you use the same kettle for mashing and boiling.

Once the boil threshold temperature is reached, the boil will be done with the max boil output power


### Installation:

You can install it directly via pypi.org:	
- sudo pip3 install cbpi4-PIDBoil 

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-PIDBoil/archive/main.zip


### Parameters

![PIDBoil Settings](https://github.com/avollkopf/cbpi4-PIDBoil/blob/main/cbpi4-PIDBoil-logic.png?raw=true)

- P - proportional value
- I - integral value
- D - derivative value
- SampleTime - 2 or 5 seconds -> how often the logic calculates the power setting
- max output - heater power which is set above boil threshold
- Boil Threshold - Above this temperature the heater will be set to Max Boil Output Power (default: 98°C / 208F)
- Max Boil Output - Power (%) that is used above Boil Threshold Temperature (default: 100%)

### Changelog

- 29.12.22: (0.0.9) Fixed Bug related to Boil Threshold Parameter
- 10.05.22: (0.0.8) Updated README (removed cbpi add)
- 10.05.22: (0.0.7) Removed cbpi dependency
- 01.12.21: (0.0.6) If current kettle power is different from kettle logic. logic will overrule kettle power setting
- 21.11.21: (0.0.5) Adapted to cbpi4 4.0.0.45 to accomodate actor power settings incl. the PWM Actor.
- 13.10.21: (0.0.4) Added Power setting for Boil
- 13.10.21: (0.0.3) Improvement of actor toggling in case of 0% or 100% heating
- 12.10.21: (0.0.2) Bug fixing MashStep Automode Issue
- 19.08.21: (0.0.1) Initial commit



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/avollkopf/cbpi4-PIDBoil",
    "name": "cbpi4-PIDBoil",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Alexander Vollkopf",
    "author_email": "avollkopf@web.de",
    "download_url": "https://files.pythonhosted.org/packages/0e/9c/6c9c10c60fe379d034f75b6d0c5c755b53849b5de5b72209a50b3454ac1f/cbpi4-PIDBoil-0.0.9.tar.gz",
    "platform": null,
    "description": "# Craftbeerpi4 Kettle Logic Plugin\r\n\r\n## PID Logic with boil threshold.\r\n\r\nIf the target Temperature is above a configurable threshold the PID will be ignored and heater is switched on to the max output value. This is helpful if you use the same kettle for mashing and boiling.\r\n\r\nOnce the boil threshold temperature is reached, the boil will be done with the max boil output power\r\n\r\n\r\n### Installation:\r\n\r\nYou can install it directly via pypi.org:\t\r\n- sudo pip3 install cbpi4-PIDBoil \r\n\r\nAlternativeley you can install (or clone) it from the GIT Repo. In case of updates, you will find them here first:\r\n- sudo pip3 install https://github.com/avollkopf/cbpi4-PIDBoil/archive/main.zip\r\n\r\n\r\n### Parameters\r\n\r\n![PIDBoil Settings](https://github.com/avollkopf/cbpi4-PIDBoil/blob/main/cbpi4-PIDBoil-logic.png?raw=true)\r\n\r\n- P - proportional value\r\n- I - integral value\r\n- D - derivative value\r\n- SampleTime - 2 or 5 seconds -> how often the logic calculates the power setting\r\n- max output - heater power which is set above boil threshold\r\n- Boil Threshold - Above this temperature the heater will be set to Max Boil Output Power (default: 98\u00b0C / 208F)\r\n- Max Boil Output - Power (%) that is used above Boil Threshold Temperature (default: 100%)\r\n\r\n### Changelog\r\n\r\n- 29.12.22: (0.0.9) Fixed Bug related to Boil Threshold Parameter\r\n- 10.05.22: (0.0.8) Updated README (removed cbpi add)\r\n- 10.05.22: (0.0.7) Removed cbpi dependency\r\n- 01.12.21: (0.0.6) If current kettle power is different from kettle logic. logic will overrule kettle power setting\r\n- 21.11.21: (0.0.5) Adapted to cbpi4 4.0.0.45 to accomodate actor power settings incl. the PWM Actor.\r\n- 13.10.21: (0.0.4) Added Power setting for Boil\r\n- 13.10.21: (0.0.3) Improvement of actor toggling in case of 0% or 100% heating\r\n- 12.10.21: (0.0.2) Bug fixing MashStep Automode Issue\r\n- 19.08.21: (0.0.1) Initial commit\r\n\r\n\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "CraftBeerPi4 PID Kettle Control Plugin",
    "version": "0.0.9",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "3d3b73dd56f22e3a823997d7673f3ff7",
                "sha256": "8f108a092860e70cfa20520770a5c783126973197105d38e3f396d986fd4d710"
            },
            "downloads": -1,
            "filename": "cbpi4-PIDBoil-0.0.9.tar.gz",
            "has_sig": false,
            "md5_digest": "3d3b73dd56f22e3a823997d7673f3ff7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 195196,
            "upload_time": "2022-12-30T08:12:25",
            "upload_time_iso_8601": "2022-12-30T08:12:25.243534Z",
            "url": "https://files.pythonhosted.org/packages/0e/9c/6c9c10c60fe379d034f75b6d0c5c755b53849b5de5b72209a50b3454ac1f/cbpi4-PIDBoil-0.0.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-30 08:12:25",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "avollkopf",
    "github_project": "cbpi4-PIDBoil",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "cbpi4-pidboil"
}
        
Elapsed time: 0.04144s