/CocktailBerry-Addons

Repository for all official CocktailBerry addons

Primary LanguagePythonMIT LicenseMIT

CocktailBerry

GitHub release (latest by date) GitHub Release Date Python Version GitHub GitHub issues Documentation Status Quality Gate Status GitHub Repo stars

Support CocktailBerry

CocktailBerry-Addons

Repository for all official CocktailBerry addons. For a detailed user guide, have a look into the official documentation. This is the official providing point for the app addon ressources, automatically listed and managed over the GUI. If you are interested in creating an addon for CocktailBerry, have a look into the user guide, fork this repo, and commit a PR.

Addon Overview

Here is a list of currently available addons.

🥛 Start Glass Volume

A simple addon, which adds the option to define the default glass volume, set at machine start. This setting will replace the default 200 ml with the selected value. In addition, you can enable that this value is set after each cocktail, to ensure that this volume is always the default, when a user chooses a recipe. Just install it over the GUI and enjoy the additional setting.

📝 Recipe Presets

Use this addon to get access to an additional GUI for the management of different active presets of your cocktail recipes. You can create and edit presets, as well as activate them. Within a preset, you can define the recipes, which should be available for the maker. The preset will then set your selection to enabled and all other recipes to disabled. Note that this does not change the default CocktailBerry behavior, but only alter the list used for available recipe calculation. Quickly switch between different presets and enjoy the flexibility of CocktailBerry. You can access the GUI as soon as you installed the addon over the addon GUI.

❔❕ Glass Detection

This addon adds the option to detect the glass and only start the recipe, if a glass is placed. It need's some sort of detection hardware, which emits a signal (low or high works) if a glass is detected. This can be a IR sensor, a switch or whatever you like, as long as it emits the signal on detection and the inverse on no detection. The signal needs to be send at one given GPIO pin, which can be configured over the GUI.

Development

To get started go to the documentation for the CocktailBerry addons. You will most likely develop your addon according to this guideline within your local CocktailBerry. If you are satisfied, fork this project, create a branch and place your addon into this repo addons folder. If your addon needs extensive documentation, you can also create an own folder within the addons folder with the python file, as well as a readme file. Otherwise, the documentation or description can be put into this readme file under the overview section. To get your addon discovered and installable by CocktailBerry, place the according information into the addon_data.json file. Each addon is a element in the list, containing name, description and the (raw) file url. You can stick to the existing entries, as an example. Please make the name entry similar to the ADDON_NAME defined in your addon file. If you prefer using your own repository for the addon, you will only need to enter the data into addon_data.json, but refer the url to your project location.

After that, you can create a pull request and let your addon get verified. Verified addons are beneficial for the user because the will be shown over the GUI and can be installed with one click over it. Please remember, if you addon needs additional packages not included within CocktailBerry, either provide installation instruction or implement this logic into the addon setup.