Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/feature/multiple-batches'
Browse files Browse the repository at this point in the history
  • Loading branch information
MvdDonk committed Nov 27, 2024
2 parents 5bd7787 + f81f13b commit 8167ef3
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 7 deletions.
3 changes: 1 addition & 2 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# These are supported funding model platforms

custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
- https://buymeacoffee.com/mvddonk
- https://www.paypal.com/donate/?business=4TULNJZAN6P62&no_recurring=0&item_name=Keeping+the+Brewfather+integration+going%21%0Ahttps%3A%2F%2Fgithub.com%2FMvdDonk%2Fbrewfather&currency_code=EUR
buy_me_a_coffee: mvddonk
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Brewfather integration for Home Assistant
A Home Assistant custom Integration for getting Brewfather batch information in Home Assistant for all homebrewers!
### A Home Assistant custom Integration for getting Brewfather batch information in Home Assistant for all homebrewers!
<a href="https://www.buymeacoffee.com/mvddonk"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a beer&emoji=🍺&slug=mvddonk&button_colour=737373&font_colour=ffffff&font_family=Lato&outline_colour=000000&coffee_colour=FFDD00" /></a>
![dashboard-multi-batch.png)](dashboard-multi-batch.png)

# Single Batch Support
Expand Down
23 changes: 19 additions & 4 deletions docs/v1-to-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,26 @@ The addon has been rebuilt from the ground up and I had to rename the sensors wh

\* *Only available after manually enabling in options, see [info](#all-batches-data)*

### <a name="all-batches-data"></a>Brewfather all batches data (in v1 known as "Fermenting batches")

### Removing old sensors
Because of the sensor renames you have to manually remove the old (v1) sensors that are still in your Home Assistant. Go to the <a href="https://my.home-assistant.io/redirect/integration/?domain=brewfather">integration</a> and entities. There you will see some sensors with a red explanation mark.
<a href="images/v2/updates_old-sensor-unavailable-overview.png"><img src="images/v2/updates_old-sensor-unavailable-overview.png" width="300"></a>

Remove those sensors one by one by clicking on them and clicking on the cog in the popup:
<a href="images/v2/updates_old-sensor-unavailable.png"><img src="images/v2/updates_old-sensor-unavailable.png" width="300"></a>

From here you can click the "Delete" button at the bottom left:
<a href="images/v2/updates_old-sensor-remove.png"><img src="images/v2/updates_old-sensor-remove.png" width="300"></a>

# Options
Starting in v2 you can now configure options after setting up the Brewfather integration. Go to the <a href="https://my.home-assistant.io/redirect/integration/?domain=brewfather">integration</a> and click "Configure":
<a href="images/v2/configure_new-options.png"><img src="images/v2/configure_new-options.png" width="300"></a>

## <a name="all-batches-data"></a>Brewfather all batches data (in v1 known as "Fermenting batches")
If you want to have all the Brewfather API data in Home Assistant you can enable "All batches data sensor" in the configure menu.
The data remained the same as in V1 but the name and alias has change, see table above. This sensor has been made optional because of the amount of data it uses and
if you are only fermenting a single batch at the same time you will not need this.

#### Experimental
The usage of "All batches data sensor" is marked experimental because it might be removed in the future (if I have found a better way to support multiple batches).
![Options menu](images/v2/configure_options-popup.png)
### Experimental
The usage of "All batches data sensor" is marked experimental because it might be removed or changed in the future (if I have found a better way to support multiple batches).
<a href="images/v2/configure_options-popup.png"><img src="images/v2/configure_options-popup.png" width="300"></a>

0 comments on commit 8167ef3

Please sign in to comment.