3

Extending CraftBeerPi

Lai1337 edited this page 2019-01-04 13:17:49 +01:00

Table of Contents

• How to develop a new plugin
• Publish Plugin

How to develop a new plugin

All plugins are in the folder /home/pi/craftbeerpi3/modules/plugins. Each folder is an own plugin.

If you like to create a new plugin just create a new folder under /home/pi/craftbeerp3/modules/plugins Inside this folder create an new file called __init__.py. This is the entry point for your code. Inside of this file place your code.

Folder Structure

+-- craftbeerp3 
|   +-- modules
|         +-- plugins
|                +-- YourCustomPlugin <- Just create a new folder 
|                       +-- __init__.py <- Your code goes here
|         +-- ... 
+-- ....

You can extend the following modules.

• Actors
• Sensors
• KettleController (Logics to control the Kettle Temperature)
• FermentationController (Logics to control the Fermentation Temperature)
• Steps

Publish Plugin

1. Upload your __init__.py to your own GitHub repository.
2. Create a README.md in your GitHub repository with a documentation for your plugin
3. To publish your plugin write an email to manuel@craftbeerpi.com containing the following information (Your name, GitHub URL of your Plugin)