Brewfather integration for Home Assistant

A Home Assistant custom Integration for getting Brewfather batch information in Home Assistant for all homebrewers!

The following sensors will be added after setup:

Recipe name

Name of the beer you are fermenting
Current temperature

Temperature the fermentation should have following the recipe
Upcoming temperature

The temperature of the next step in the fermentation profile from the recipe
Upcoming temperature change

The date and time when the upcoming temperature will be activated
Fermenting batches

A list of all batches that are fermenting. This sensor contains the following attributes:
- batchNo
  
  The batch number of the batch
- name
  
  The name of the recipe
- fermentingStart
  
  The date and time when the fermentation started
- fermentingEnd
  
  The date and time when the fermentation should be finished
- fermentingLeft
  
  The number of days left until the fermentation is finished
- target_temperature
  
  The temperature the fermentation should have following the recipe
- current_temperature
  
  The current temperature of the fermentation based on readings entered into the app or through a connected device

Installation:

Copy the custom_components/brewfather folder and all of its contents into your Home Assistant's custom_components folder. This folder is usually inside your /config folder. If you are running Hass.io, use SAMBA to copy the folder over. If you are running Home Assistant Supervised, the custom_components folder might be located at /usr/share/hassio/homeassistant. You may need to create the custom_components folder and then copy the brewfather folder and all of its contents into it

Alternatively, you can install brewfather through HACS by adding this repository.

Single Batch Support

The integration produces a sensor for recipe name, current temperature, upcoming temperature and upcoming temperature change date for the most recently started batch. This can be displayed in home assistant by creating a new dashboard and copying the contents of the dashboard/dashboard-single-batch.png file into it.

Multiple Batch Support

Multiple batch support is available through the use of custom templates and a custom dashboard. All the data for all currently fermenting batches is stored in the fermenting_batches sensor. The fermenting_batches sensor as a data attribute that contains a list of all fermenting batches. The data attribute is a list of dictionaries. You can follow the below steps to add the custom templates and dashboard to display all fermenting batch information in your Home Assistant.

Copy the custom_templates folder and all of its contents into your Home Assistant's custom_templates folder, this should be in the config directory next to custom_components. If the custom_templates folder does not exist, create it.

Copy the contents of the template_sensors/template_sensors.yaml file and paste it on to the end of the config/configuration.yaml file. If you already have a template and sensor section, just copy the contents of the template_sensors.yaml file excluding the first 2 lines and paste it into your existing template / sensor section.

A dashboard/dashboard-multi-batch.png file has been included in this repository. To use it, create a new dashboard amd copy the contents of the dashboard-multi-batch.png file into it. The dashboard shows up to 4 batches, if you have more than 4 batches you will need to add more cards to the dashboard and template_sensors.yaml.

Dashboard

dashboard-multi-batch.png)

Setup

After installation is completed you must create a new integration in Home Assistant by clicking on the "ADD INTEGRATION" button and search for "Brewfather". A dialog will popup containing the following fields:

Connection name

A unique name for your Brewfather connection that will be used in Home Assistant
User ID

User ID used for API-access. You can get this in the Brewfather app under Settings -> Api -> Generate API-Key.
API-Key

API-Key with the correct scopes. This is also located in Settings -> Api -> Generate API-Key. For more info on how to create a correct key see the section "Creating a Brewfather API-key" below.

Creating a Brewfather API-Key

To create a Brewfather API-key follow the documentation on Brewfather - docs. Make sure to give the API-key at least the "Read Batches" scope.

Getting batch information

Setup a markdown card with the following content to get the batch information in Home Assistant:

type: markdown
content: |-
  # Batch status
  ---
  {% for batch in state_attr('sensor.fermenting_batches', 'data') %}
    ## Batch \#{{ batch.batchNo }}, recipe: {{ batch.name }}
    **Start Date**: {{ batch.fermentingStart.strftime('%a, %d %b %Y') }}
    **End Date:** {{ batch.fermentingEnd.strftime('%a, %d %b %Y') }}
    **Days Left:** {{ batch.fermentingLeft | round(1) }}
    **Temperature:** {% if batch.current_temperature is not none %}
    {% if batch.current_temperature == batch.target_temperature %}
    <ha-alert alert-type="success">
    {%else%}
    <ha-alert alert-type="error">
    {% endif %}Current: {{ batch.current_temperature }}°C / Target: {{ batch.target_temperature }}°C
    {%else%}<ha-alert alert-type="warning">Unknown / Target: {{ batch.target_temperature }}°C
    {% endif %}</ha-alert>

  {% endfor %}

Developing

Partial support for testing API response parsing is available in test_connection.py. You will need your User ID and API Key to run the tests. These should be set as the environment variables USER_ID and API_KEY

The following commands can be used to run the tests:

export USER_ID=your_user_id
export API_KEY=your_api_key
pytest

MvdDonk / brewfather

readme