Skip to content

Commit

Permalink
Update customisation.md (#1113)
Browse files Browse the repository at this point in the history
* Update customisation.md

* [pre-commit.ci lite] apply automatic fixes

* Update configuration-guide.md

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
  • Loading branch information
springfall2008 and pre-commit-ci-lite[bot] authored May 18, 2024
1 parent 75a599c commit 90115a7
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 22 deletions.
17 changes: 5 additions & 12 deletions docs/configuration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,14 @@ Recommended settings - these must be changed in Home Assistant once Predbat is r
|---------|---------------|-------------|
| 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 |

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 |
| switch.predbat_combine_charge_slots | True | As you have just one overnight rate then one slot is fine |
| input_number.predbat_metric_min_improvement | 0 | Charge less if it's cost neutral |
| input_number.predbat_metric_min_improvement_discharge | 0.1 | Discharge only if there is a profit |

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

Expand All @@ -59,18 +58,16 @@ Follow the instructions from the _Cheap Night rate_ above, but also you will als
|---------|---------------|-------------|
| 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 |

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 | ? | Setting to False will allow charging at more expensive day rates when it's worth it to export more |
| input_number.predbat_metric_min_improvement | 0 | Charge less if it's cost neutral |
| input_number.predbat_metric_min_improvement_discharge | 0.1 | Discharge only if there is a profit |
| input_number.predbat_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 |
| input_number.predbat_metric_battery_cycle | 0-2 | Higher numbers mean less charging and discharging but higher costs |
| input_number.predbat_best_soc_min | 0 | Can be set non-zero if you want to force a minimum charge level |

You should set **select.predbat_mode** to 'Control charge & discharge'

Expand All @@ -84,17 +81,15 @@ Recommended settings - these must be changed in Home Assistant once Predbat is r
|---------|---------------|-------------|
| 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 |

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 | ? | Setting to False will allow charging at more expensive day rates when it's worth it to export more |
| input_number.predbat_metric_min_improvement | 0 | Charge less if it's cost neutral |
| input_number.predbat_metric_min_improvement_discharge | 0.1 | Discharge only if there is a profit |
| input_number.predbat_metric_battery_cycle | ? | Higher numbers mean less charging and discharging but higher costs |
| input_number.predbat_metric_battery_cycle | 0-2 | 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'
Expand All @@ -107,7 +102,6 @@ Recommended settings - these must be changed in Home Assistant once Predbat is r
|---------|---------------|-------------|
| 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 | False | Don't combine slots for a better result |

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

Expand All @@ -116,8 +110,7 @@ If you are using expert mode then these options maybe worth reviewing, otherwise
| 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.predbat_metric_min_improvement | 0 | Charge less if it's cost neutral |
| input_number.predbat_metric_min_improvement_discharge | 0.1 | Discharge only if there is a profit |
| input_number.predbat_metric_battery_cycle | ? | Higher numbers mean less charging and discharging but higher costs |
| input_number.predbat_metric_battery_cycle | 0-2 | 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.predbat_calculate_fast_plan | False | The fast plan feature reduces accuracy of planning |

You should set **select.predbat_mode** to 'Control charge & discharge'
15 changes: 5 additions & 10 deletions docs/customisation.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,9 @@ keeping the inverter control in the 5 minute slots. E.g. a value of 10 or 15 min
If you have performance problems leave **switch.predbat_calculate_second_pass** (_expert mode_) turned Off as it's
quite CPU intensive and provides very little improvement for most systems.

If you have performance problems turn **switch.predbat_calculate_fast_plan** (_expert mode_) On to help
reduce your CPU load.
You can can enable **combine_charge_slots** and **combine_discharge_slots** in order to speed up planning.
Note: Combining discharge slots may prevent optimal forced export. Combining charge slots is usually fine for tariffs with
longer periods of fixed rates but can limit the planning ability in some cases.

The number of threads you use can change your performance, you can set **threads** in `apps.yaml` to 0 to disable threading
if you don't have multiple CPUs available or set it to 'auto' (the default) to use one thread per CPU. Its recommended you don't set this to an odd number of threads.
Expand Down Expand Up @@ -243,12 +244,6 @@ The default of 24 hours is the recommended value (to match energy rate cycles).
calculated in 4 hour regions before forming the detailed plan. Is True by default but can be turned off in expert
mode.

**switch.predbat_calculate_fast_plan** (_expert mode_) When True the plan is calculated with a limited number of
windows to make calculations faster. When False (default) all windows are considered but planning will take a little
longer but be more accurate.
The end result is unlikely to change in fast mode as the next 8 windows are always considered in the plan, but the
longer term plan will be less accurate.

**switch.predbat_calculate_discharge_oncharge** (_expert mode_) When True calculated discharge slots will
disable or move charge slots, allowing them to intermix. When False discharge slots will never be placed into charge slots.

Expand Down Expand Up @@ -286,10 +281,10 @@ A value of 0 disables this feature.
**input_number.combine_rate_threshold** (_expert mode_) sets a threshold (in pence) to combine charge or discharge slots together into a single larger average rate slot.
The default is 0p which disables this feature and all rate changes result in a new slot.

**switch.predbat_combine_charge_slots** Controls if charge slots of > 60 minutes can be combined. When disabled they will be split up,
**switch.predbat_combine_charge_slots** Controls if charge slots of > 30 minutes can be combined. When disabled they will be split up,
increasing run times but potentially more accurate for planning. Turn this off if you want to enable ad-hoc import
during long periods of higher rates but you wouldn't charge normally in that period (e.g. pre-charge at day rate before
a saving session). The default is enable (True)
a saving session). The default is disabled (False)

**switch.predbat_combine_discharge_slots** (_expert mode_) Controls if discharge slots of > 30 minute can be combined. When disabled
they will be split up, increasing run times but potentially more accurate for planning. The default is disabled (False)
Expand Down

0 comments on commit 90115a7

Please sign in to comment.