Skip to content

Documentation enhancements #596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
springfall2008 merged 2 commits into from
Jan 9, 2024
Merged

Documentation enhancements #596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d20772
Review and update configuration guide
gcoan Jan 8, 2024
6025df9
Review & refine 'what does predbat do'
gcoan Jan 8, 2024
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
4 changes: 4 additions & 0 deletions docs/apps-yaml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,10 @@ then it's recommended that Solcast is only configured for the PV connected to th
Solcast produces 3 forecasted PV estimates, the 'central' (50% or most likely to occur) PV forecast, the '10%' (worst case) PV forecast, and the '90%' (best case) PV forecast.<BR>
By default Predbat will use the central estimate and applies to it the **input_number.pv_metric10_weight** weighting of the 10% (worst case) estimate.

Predbat models cloud coverage by using the difference between the PV and PV10 forecasts to work out a cloud factor,
this modulates the PV output predictions up and down accordingly as if there were passing clouds.
This can have an impact on planning, especially for things like freeze charging which could assume the PV will cover the house load but it might not due to clouds.

- **pv_estimate** in `apps.yaml` can be used to configure Predbat to always use the 10% forecast by setting the configuration item to '10',
or '90' to always use the 90% PV estimate (not recommended!).<BR>
Set to blank or delete / comment out the line to use the default central estimate.
Expand Down
87 changes: 44 additions & 43 deletions docs/configuration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,127 +1,128 @@
# Configuration guide

First get the basics set up, ensure you have the inverter controls configured, the historical load data and the solar forecast
in place. Make sure your energy rates are configured correctly for import and export.
First get the basics set up, ensure you have the [inverter controls configured](install.md#inverter-control-integration-install-givtcpsolax-modbus),
you have [configured apps.yaml](apps-yaml.md) to your setup, and the [solar forecast](install.md#solcast-install) is in place.
Make sure your [energy rates](energy-rates.md) are configured correctly for import and export.

If you have an EV try to set up the car charging sensor correctly so the tool can tell what part of your historical load is EV
charging. You might want to also set to the car charging plan so you can predict when your car is plugged in and how much it will charge.
If you have an EV try to set up the [car charging sensor](apps-yaml.md#car-charging-integration) correctly so Predbat can tell what part of your historical load is EV charging.
You might want to also set to the [car charging plan](apps-yaml.md#planned-car-charging) so you can predict when your car is plugged in and how much it will charge.

You should try to tune **inverter_loss**, **battery_loss** and **battery_loss_discharge** to the correct % loss for your system
in order to get more accurate predictions. Around 4% for each is good for a hybrid inverter. Also set **inverter_hybrid** to
True or False depending on if you have a Hybrid or AC-Coupled battery.
It is recommended that you [create a dashboard page](output-data.md#displaying-output-data) with all the required entities to control Predbat.

The setting **input_number.metric_battery_cycle** (_expert mode_) can be used to put a cost on using your battery for charging
and discharging. In theory if you think your battery will last say 6000 complete cycles and cost you £4000 and is 9.5kWh then
each cycle is 19kWh and so the cost is £4000 / 19 / 6000 = 3.5p. If you configure this number higher then more expensive plans
will be selected which avoids charging and discharging your battery as much. The default is 2p but can be set to 0 if you want
to turn this off. Note that the cycle cost will not be included in the cost predictions, just taken into account in the planning
stage. _Note: Setting this to a non-zero value will increase your daily cost, but will reduce your home battery usage._
You should try to tune **input_number.inverter_loss**, **input_number.battery_loss** and **input_number.battery_loss_discharge** to the correct % loss for your system
in order to get more accurate predictions. Around 4% for each is good for a hybrid inverter.
Also set **switch.inverter_hybrid** to True or False depending upon if you have a Hybrid or AC-Coupled battery.

Cloud coverage is modelled by using difference between PV and PV10 is used to work out a cloud factor, this modulates the PV
output predictions up and down accordingly as if there were passing clouds. This can have an impact on planning, especially for
things like freeze charging which could assume the PV will cover the house load but it might not due to clouds.
The setting **input_number.metric_battery_cycle** (_expert mode_) can be used to put a 'virtual cost' in pence on using your battery for charging and discharging.<BR>
In theory if you think your battery will last say 6000 complete cycles and cost you £4000 and is 9.5kWh then each cycle is 19kWh and so the cost per cycle is £4000 / 19 / 6000 = 3.5p.
If you configure this number higher then more expensive plans will be selected which avoids charging and discharging your battery as much.
The default is 2p but can be set to 0 if you want to turn this feature off.
Note that the cycle cost will not be included in the cost predictions that Predbat produces, its just taken into account in the planning stage.<BR>
_NB: Setting this to a non-zero value will increase your daily cost, but will reduce your home battery usage._

- **input_number.forecast_plan_hours** - the number of hours after the next charge slot to include in the plan, default 24 hours
is the suggested amount (to match energy rate cycles)
- **input_number.forecast_plan_hours** - the number of hours after the next charge slot to include in the plan, default 24 hours is the suggested amount (to match energy rate cycles)

- **set_discharge_during_charge** - If turned off disables inverter discharge during charge slots, useful for multi-inverter
- **switch.set_discharge_during_charge** - If turned off disables inverter discharge during charge slots, useful for multi-inverter setups
to avoid cross charging when batteries are out of balance.

Below is a guide to some of the tariff options, in theory most tariffs will work out of the box but still it's worth reviewing your settings.
Below is a guide to some of the electricity tariff options and a set of recommended Predbat settings for each tariff type.
In theory most tariffs will work out of the box but still it's worth reviewing your settings.

## Fixed daily rates

With a fixed daily rate tariff you will just be predicting the battery levels, no charging or discharging is required although it won't hurt if you leave these options enabled.

You should set **select.predbat_mode** to 'Monitor'.

## Cheap night rate with bad export rate (e.g. Octopus Go, Economy 7 etc)

In this scenario you will want to charge overnight based on the next day's solar forecast.
In this scenario you will want to charge overnight based on the next day's solar forecast and don't want Predbat to force discharge your battery.

Recommended settings - these must be changed in Home Assistant once Predbat is running:

| Item | Value | Comment |
|---------|---------------|-------------|
| select.predbat_mode | Control Charge | You want the tool to calculate and control charging |
| select.predbat_mode | Control Charge | You want Predbat to calculate and control charging |
| input_number.predbat_best_soc_keep | 2.0 | Tweak this to control what battery level you want to keep as a backup in case you use more energy |
| switch.predbat_combine_charge_slots | True | Use one big charge slot |
| switch.predbat_combine_charge_slots | True | Use one big charge slot |

If you are using expert mode then these options maybe worth reviewing:

| Item | Value | Comment |
|---------|---------------|-------------|
| input_number.predbat_forecast_plan_hours | 24 | If you set this to 24 then you will have quicker updates, the cycle repeats itself anyhow |
| input_number.predbat_forecast_plan_hours | 24 | If you set this to 24 then you will have quicker updates, the cycle repeats itself anyhow |
| switch.predbat_combine_charge_slots | True | As you have just one overnight rate then one slot is fine |
| input_number.metric_min_improvement | 0 | Charge less if it's cost neutral |
| input_number.metric_min_improvement | 0 | Charge less if it's cost neutral |

You should set **select.predbat_mode** to Control Charge
You should set **select.predbat_mode** to 'Control Charge'

## Cheap night rate, with a good export rate (e.g. Intelligent Octopus with Octopus Outgoing)

Follow the instructions from the _Cheap Night rate_ above, but also you will also want to have automatic discharge occurring when the export rates are profitable.

| Item | Value | Comment |
|---------|---------------|-------------|
| select.predbat_mode | Control Charge & Discharge | You want the tool to calculate and control charging and discharging |
| select.predbat_mode | Control Charge & Discharge | You want Predbat to calculate and control charging and discharging |
| input_number.predbat_best_soc_keep | 2.0 | Tweak this to control what battery level you want to keep as a backup in case you use more energy |
| switch.predbat_combine_charge_slots | True | Use one big charge slot |
| switch.predbat_combine_charge_slots | True | Use one big charge slot |

If you are using expert mode then these options maybe worth reviewing, otherwise ignore this:

| Item | Value | Comment |
|---------|---------------|-------------|
| input_number.predbat_forecast_plan_hours | 24 | If you set this to 24 then you will have quicker updates, the cycle repeats itself anyhow |
| switch.predbat_combine_charge_slots | ? | Going to False will allow charging at more expensive day rates when it's worth it to export mode |
| input_number.predbat_forecast_plan_hours | 24 | If you set this to 24 then you will have quicker updates, the cycle repeats itself anyhow |
| switch.predbat_combine_charge_slots | ? | Setting to False will allow charging at more expensive day rates when it's worth it to export more |
| input_number.metric_min_improvement | 0 | Charge less if it's cost neutral |
| input_number.metric_min_improvement_discharge | 0.1 | Discharge only if there is a profit |
| input_number.metric_battery_cycle | ? | Higher numbers mean less charging and discharging but higher costs |
| input_number.predbat_best_soc_min | ? | Can be set non-zero if you want to force a minimum charge level |

You should set **select.predbat_mode** to Control Charge & Discharge
You should set **select.predbat_mode** to 'Control Charge & Discharge'

## Multiple rates for import and export (e.g. Octopus Flux & Cozy)

Follow the instructions from Cheap Night rate above, but also you will want to have automatic discharge when the export rates are profitable.
Follow the instructions from _Cheap Night_ rate above, but also you will want to have automatic discharge when the export rates are profitable.

Recommended settings - these must be changed in Home Assistant once Predbat is running:

| Item | Value | Comment |
|---------|---------------|-------------|
| select.predbat_mode | Control Charge & Discharge | You want the tool to calculate and control charging and discharging |
| select.predbat_mode | Control Charge & Discharge | You want Predbat to calculate and control charging and discharging |
| input_number.predbat_best_soc_keep | 0.5 | Use the full battery without going empty |
| switch.predbat_combine_charge_slots | True | Use one big charge slot |
| switch.predbat_combine_charge_slots | True | Use one big charge slot |

If you are using expert mode then these options maybe worth reviewing, otherwise ignore this:

| Item | Value | Comment |
|---------|---------------|-------------|
| input_number.predbat_forecast_plan_hours | 24 | If you set this to 24 then you will have quicker updates, the cycle repeats itself anyhow |
| switch.predbat_combine_charge_slots | ? | Going to False will allow charging at more expensive day rates when it's worth it to export mode |
| input_number.metric_min_improvement | 0 | Charge less if it's cost neutral |
| input_number.predbat_forecast_plan_hours | 24 | If you set this to 24 then you will have quicker updates, the cycle repeats itself anyhow |
| switch.predbat_combine_charge_slots | ? | Setting to False will allow charging at more expensive day rates when it's worth it to export more |
| input_number.metric_min_improvement | 0 | Charge less if it's cost neutral |
| input_number.metric_min_improvement_discharge | 0.1 | Discharge only if there is a profit |
| input_number.metric_battery_cycle | ? | Higher numbers mean less charging and discharging but higher costs |
| input_number.predbat_best_soc_min | 0 | Don't use non-zero otherwise all slots will be force charging |

You should set **select.predbat_mode** to Control Charge & Discharge
You should set **select.predbat_mode** to 'Control Charge & Discharge'

## Half hourly variable rates (e.g. Octopus Agile)

Recommended settings - these must be changed in Home Assistant once Predbat is running:

| Item | Value | Comment |
|---------|---------------|-------------|
| select.predbat_mode | Control Charge & Discharge | You want the tool to calculate and control charging and discharging |
| select.predbat_mode | Control Charge & Discharge | You want Predbat to calculate and control charging and discharging |
| input_number.predbat_best_soc_keep | 0.5 | Use the full battery without going empty |
| switch.predbat_combine_charge_slots | True | Use one big charge slot |
| switch.predbat_combine_charge_slots | True | Use one big charge slot |

If you are using expert mode then these options maybe worth reviewing, otherwise ignore this:

| Item | Value | Comment |
|---------|---------------|-------------|
| input_number.predbat_forecast_plan_hours | 24-48 | If you set this to 24 then you will have quicker updates, going to 36/48 for a longer plan |
| input_number.metric_min_improvement | 0 | Charge less if it's cost neutral |
| input_number.predbat_forecast_plan_hours | 24-48 | If you set this to 24 then you will have quicker updates, going to 36/48 for a longer plan |
| input_number.metric_min_improvement | 0 | Charge less if it's cost neutral |
| input_number.metric_min_improvement_discharge | 0.1 | Discharge only if there is a profit |
| input_number.metric_battery_cycle | ? | Higher numbers mean less charging and discharging but higher costs |
| input_number.predbat_best_soc_min | 0 | Don't use non-zero otherwise all slots will be force charging |
| switch.calculate_fast_plan | False | The fast plan feature reduces accuracy of planning |

You should set **select.predbat_mode** to Control Charge & Discharge
You should set **select.predbat_mode** to 'Control Charge & Discharge'
Loading