Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,27 @@ The Integration that communicates with your inverter will be depend on the brand

- You will need at least 24 hours history in HA for this to work correctly, the default is 7 days (but you configure this back 1 day if you need to)

## AppDaemon install
## AppDaemon-Predbat combined install

The simplest way to install Predbat now is with a combined AppDaemon/Predbat add-in. This is a fork of AppDaemon which installs
Predbat automatically.

- Go to settings, Add-ons, Add on store (bottom right), Top right three dots, Repositories and add
'<https://github.com/springfall2008/appdaemon-predbat>' to the list and close.
- Next select AppDaemon with Predbat and Install and then hit 'start'
- If you haven't already change your Editor settings to ensure 'enforce base path' is disabled (settings, Add-ons, File Editor, Configuration)
- Now use your Editor to find '/addon_configs/46f69597_appdaemon-predbat', here there is
- predbat.log - contains the active logfile with any errors
- apps/apps.yaml - you need to edit apps.yaml to remove the template settings and customise
- Once you have edited apps.yaml click 'restart' on the appdaemon-predbat add-on

Once installed you should perform updates directly within Predbat by using the 'select.predbat_update' selector or by enabling the **switch.predbat_auto_update**

If you use this method you do not need to install AppDaemon or HACS so you can skip directly to Solcast install (below)

## Predbat installation into AppDaemon

### AppDaemon install

- Install the AppDaemon add-on [https://github.com/hassio-addons/addon-appdaemon](https://github.com/hassio-addons/addon-appdaemon)
- You will find the appdaemon.yaml file in addon_configs/a0d7b954_appdaemon ![image](https://github.com/springfall2008/batpred/assets/48591903/bf8bf9cf-75b1-4a8d-a1c5-fbb7b3b17521)
Expand Down Expand Up @@ -58,12 +78,12 @@ old location and update your logfile location (if you have set it). You should r
- Restart appdaemon
- Check it has started and confirm Predbat is running correctly again.

## HACS install
### HACS install

- Install HACS if you haven't already ([https://hacs.xyz/docs/setup/download](https://hacs.xyz/docs/setup/download))
- Enable AppDaemon in HACS: [https://hacs.xyz/docs/categories/appdaemon_apps/](https://hacs.xyz/docs/categories/appdaemon_apps/)

## Predbat install with HACS
### Predbat install with HACS

[![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)

Expand All @@ -87,6 +107,8 @@ While the above warning might not prevent Predbat from startup you should fix th

## Predbat manual install

A manual install is suitable for those running Docker type systems where HACS does not function correctly and you had to manually install AppDaemon

Note: **Not recommended if you are using HACS**

- Copy apps/predbat/predbat.py to 'config/appdaemon/apps/' directory in home assistant (or wherever you set appdaemon apps_dir to)
Expand Down
25 changes: 14 additions & 11 deletions docs/installation-summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,17 @@ Note there are [step by step installation](video-guides.md#basic-installation) v
Please see the sections below for how to achieve each step. This is just a checklist of things:

1. Make sure GivTCP is installed and running - [GivTCP install](install.md#givtcp-install)
2. Install AppDaemon if you haven't already - [AppDaemon install](install.md#appdaemon-install)
3. Install HACS if you haven't already - [HACS install](install.md#hacs-install)
4. Install Predbat using HACS - [Predbat install](install.md#predbat-install)
5. Install Solcast if you haven't already [Solcast install](install.md#solcast-install)
2. Install Solcast if you haven't already [Solcast install](install.md#solcast-install)
- Also check Solcast is being auto-updated a few times a day and that you see the data in Home Assistant
6. If you use Octopus Energy then install the Octopus Energy plugin (if you haven't already) - [Octopus Energy](install.md#octopus-energy)
3. If you use Octopus Energy then install the Octopus Energy plugin (if you haven't already) - [Octopus Energy](install.md#octopus-energy)
- CAUTION: You need to enable the events for previous, current and next rates for import and export in HA as the plugin leaves them disabled by default (see the above link for details)
8. Go and edit apps.yaml (in config/appdaemon/apps/predbat/config/apps.yaml) to match your system - [apps.yaml settings](config-yml-settings.md)
4. Install Predbat and AppDaemon, either:
- a) Install AppDaemon-Predbat combined install - [AppDaemon-Predbat combined install](install.md#appdaemon-predbat-combined-install)
- b) Complete the separate installation steps
- i) Install AppDaemon if you haven't already - [AppDaemon install](install.md#appdaemon-install)
- ii) Install HACS if you haven't already - [HACS install](install.md#hacs-install)
- iii) Install Predbat using HACS - [Predbat install](install.md#predbat-install)
5. Go and edit apps.yaml (in config/appdaemon/apps/predbat/config/apps.yaml) to match your system - [apps.yaml settings](config-yml-settings.md)
- Inverter settings match the names in GivTCP - should be automatic (but if you have 2 names you will have to edit apps.yml)
- You have set the right number of inverters (**num_inverters**)
- Adjust your **inverter_limit** and **export_limit** as required
Expand All @@ -22,11 +25,11 @@ Please see the sections below for how to achieve each step. This is just a check
- Then check the AppDaemon log file and make sure you have no errors or warnings that are unexpected
- And check **predbat.status** in Home Assistant to check it's now Idle (errors are reported here too)
- Start with **select.predbat_mode** as Monitor but remember to change it later to enable Predbat to control your inverter
9. Add the Predbat entities to your dashboard - [Output data](output-data.md)
10. Follow the configuration guide to tune things for your system - [Configuration guide](configuration-guide.md)
11. Set up the Apex Charts so you can check what Predbat is doing - [Creating the charts](creating-charts.md)
12. Set up the Predbat Plan card for another view on what Predbat is doing - [Create the Predbat Plan card](predbat-plan-card.md)
13. Look at the [FAQ](faq.md) and [Video Guides](video-guides.md) for help
6. Add the Predbat entities to your dashboard - [Output data](output-data.md)
7. Follow the configuration guide to tune things for your system - [Configuration guide](configuration-guide.md)
8. Set up the Apex Charts so you can check what Predbat is doing - [Creating the charts](creating-charts.md)
9. Set up the Predbat Plan card for another view on what Predbat is doing - [Create the Predbat Plan card](predbat-plan-card.md)
10. Look at the [FAQ](faq.md) and [Video Guides](video-guides.md) for help

Overview of the key configuration elements:

Expand Down