SynSynk apps.yaml

[gorstj]

Can anyone share a working apps.yaml template for SunSynk?

The one at https://github.com/springfall2008/batpred/blob/main/templates/sunsynk.yaml seems to bear no relation to my entities using the SunSynk integration https://github.com/kellerza/sunsynk

Any pointers gladly received!

[gcoan]

The apps.yaml template was supplied in #1331

Certainly for that author it was working. I can only suggest you try mapping the entities that the integration provides to what predbat requires as documented in https://springfall2008.github.io/batpred/apps-yaml/

[gorstj]

Thank for the reply.

I think the integration has markedly changed and that there is an easier way to commence the charge and dishcharge that doesn't use all the timers!

Here is where I am so far, but am awaiting my batteries to be added next week.

I will report back with a more streamlined apps.yaml file to the thread you identified if I get a better version!

[gcoan]

Probably better if you post your new apps yaml to this thread as the other one is quite old

And I can merge that in if the other one is outdated compared to the integration

cheers

[gorstj]

I have done some work with the apps.yaml for the SunSynk integration at https://kellerza.github.io/sunsynk/

The one on the PredBat documentation page bears no relation to how the current SunSynk integration presents the entities!

I had to set up a single automation to copy the charge limit to all the timers. (at end) Can I list multiple charge limit entities within the apps.yaml to avoid this?
Is there a way to add multiple PV inputs together within apps.yaml even rather than using a helper to add them?

I have this running in monitor mode and I am semi-confident it will work after some manual testing! Will report back in due course.

Grateful for feedback!

# ------------------------------------------------------------------
# This is an example configuration, please modify it
# ------------------------------------------------------------------
---
pred_bat:
  module: predbat
  class: PredBat

  # Remove if you don't use Ohme ******
  ohme_login: !secret ohme_login
  ohme_password: !secret ohme_password
  ohme_automatic_octopus_intelligent: true

  # Sets the prefix for all created entities in HA - only change if you want to run more than once instance
  prefix: predbat

  # Sets the name prefix for your inverter entities ******
  inverter_name: "ss"

  # Timezone to work in
  timezone: Europe/London

  # If you are using Predbat outside of HA then set the HA URL and Key (long lived access token here)
  #ha_url: 'http://homeassistant.local:8123'
  #ha_key: 'xxx'

  # Currency, symbol for main currency second symbol for 1/100s e.g. $ c or £ p or e c
  currency_symbols:
    - '£'
    - 'p'

  # Number of threads to use in plan calculation
  # Can be auto for automatic, 0 for off or values 1-N for a fixed number
  threads: auto

  # Sets the maximum period of zero load before the gap is filled, default 30 minutes
  # To disable set it to 1440
  load_filter_threshold: 30

  # Sensors, more than one can be specified and they will be summed up automatically
  #
  # For two inverters the load today would normally be the master load sensor only (to cover the entire house)
  # If you have three phase and one inverter per phase then you would need three load sensors
  # For pv_today if you have multiple solar inverter inputs then you should include one entry for each inverter
  #
  load_today:
    - sensor.{inverter_name}_day_load_energy
  import_today:
    - sensor.smart_meter_electricity_import_today # electric_import_daily_kWh 
  export_today:
    - sensor.smart_meter_electricity_total_export_daily # electric_export_daily_kWh
  pv_today:
    - sensor.{interver_name}_day_pv_energy

  pv_power:
  - sensor.total_pv_power # ***** you need to create a sensor that adds together all your PV power inputs (if multiple)
  load_power:
  - sensor.{inverter_name}_load_power
  grid_power:
  - sensor.{inverter_name}_grid_ct_power 
  grid_power_invert:
  - true
  battery_power:
    - sensor.{inverter_name}_battery_power #in watts

  # Load forecast can be used to add to the historical load data (heat-pump)
  # To link to Predheat
  # Data must be in the format of 'last_updated' timestamp and 'energy' for incrementing kWh
  #load_forecast:
  #  - predheat.heat_energy$external
  #
  # Controls/status - must by 1 per inverter
  #
  num_inverters: 1
  inverter_type: SK

  # **** Start of Outputs to Sunsynk Inverter ****
  # Ensure the following switches are on 'Grid charge enabled'  'Solar Export' 'Use Timer'

  charge_start_service:
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog1_charge"
      option: "Allow Grid & Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog2_charge"
      option: "Allow Grid & Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog3_charge"
      option: "Allow Grid & Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog4_charge"
      option: "Allow Grid & Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog5_charge"
      option: "Allow Grid & Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog6_charge"
      option: "Allow Grid & Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_load_limit" # Inverter work mode
      option: "Zero Export"
  charge_stop_service:
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog1_charge"
      option: "Allow Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog2_charge"
      option: "Allow Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog3_charge"
      option: "Allow Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog4_charge"
      option: "Allow Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog5_charge"
      option: "Allow Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog6_charge"
      option: "Allow Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_load_limit" # Inverter work mode
      option: "Zero Export"
  discharge_start_service:
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog1_charge"
      option: "No Grid or Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog2_charge"
      option: "No Grid or Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog3_charge"
      option: "No Grid or Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog4_charge"
      option: "No Grid or Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog5_charge"
      option: "No Grid or Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_prog6_charge"
      option: "No Grid or Gen"
    - service: select.select_option
      entity_id: "select.{inverter_name}_load_limit"  # Inverter work mode
      option: "Allow Export"

  timed_charge_current:
    - number.{inverter_name}_battery_max_charge_current # Inverter battery max charge setting in A

  timed_discharge_current:
    - number.{inverter_name}_battery_max_discharge_current # Inverter battery max discharge setting in A

  soc_percent:
    - sensor.{inverter_name}_battery_soc

  battery_voltage:
    - 51.2 #nominal voltage of your battery. Could also map to sensor.{inverter_name}_battery_voltage ****


  battery_rate_max:
    - 5000   # Set to the maximum rate your inverter can charge your battery at (in Watts) ****

  soc_max:
  - 10 #total capcity of your battery/batteries in kw/h ****

  battery_min_soc:
    - 12 # set in #   ****

  reserve:
    - 15 # set in #  *****

  charge_limit:
    - number.{inverter_name}_prog1_capacity # Inverter SoC time slot1 **needs HA automation to copy to all other timers**

  # **** End of Outputs to Sunsynk Inverter ****


  # Run balance inverters every N seconds (0=disabled) - only for multi-inverter
  balance_inverters_seconds: 0
  #

  inverter_limit:
    - 8000 # change to inverter size in W

  # Export limit is a software limit set on your inverter that prevents exporting above a given level
  # When enabled Predbat will model this limit
  #export_limit:
  # - 3600
  # - 3600

  # Some inverters don't turn off when the rate is set to 0, still charge or discharge at around 200w
  # The value can be set here in watts to model this (doesn't change operation)
  #inverter_battery_rate_min:
  #  - 200

  # Workaround to limit the maximum reserve setting, some inverters won't allow 100% to be set
  # Comment out if your inverter allows 100%
  #  inverter_reserve_max : 98

  # Some batteries tail off their charge rate at high soc%
  # enter the charging curve here as a % of the max charge rate for each soc percentage.
  # the default is 1.0 (full power)
  # The example below is from GE 9.5kwh battery with latest firmware and gen1 inverter
  #
  # Predbat can compute this curve automatically if you have enough data, restart the app and look in the logfile for the data
  # once set here Predbat will no longer re-compute the curve.
  # Can also be set to 'auto' to just use the calculation curve, not recommended if you are using low power charging mode.
  #battery_charge_power_curve:
  #  91 : 0.91
  #  92 : 0.81
  #  93 : 0.71
  #  94 : 0.62
  #  95 : 0.52
  #  96 : 0.43
  #  97 : 0.33
  #  98 : 0.24
  #  99 : 0.24
  #  100 : 0.24
  #battery_discharge_power_curve:
  #  4 : 1.0

  # Inverter clock skew in minutes, e.g. 1 means it's 1 minute fast and -1 is 1 minute slow
  # Separate start and end options are applied to the start and end time windows, mostly as you want to start late (not early) and finish early (not late)
  # Separate discharge skew for discharge windows only
  inverter_clock_skew_start: 0
  inverter_clock_skew_end: 0
  inverter_clock_skew_discharge_start: 0
  inverter_clock_skew_discharge_end: 0

  # Clock skew adjusts the Appdaemon time
  # This is the time that Predbat takes actions like starting discharge/charging
  # Only use this for workarounds if your inverter time is correct but Predbat is somehow wrong (AppDaemon issue)
  # 1 means add 1 minute to AppDaemon time, -1 takes it away
  clock_skew: 0

  # Solcast cloud interface, set this or the local interface below
  #solcast_host: 'https://api.solcast.com.au/'
  #solcast_api_key: 'xxxx'
  #solcast_poll_hours: 8

  # Set these to match solcast sensor names if not using the cloud interface
  # The regular expression (re:) makes the solcast bit optional
  # If these don't match find your own names in Home Assistant
  pv_forecast_today: re:(sensor.(solcast_|)(pv_forecast_|)forecast_today)
  pv_forecast_tomorrow: re:(sensor.(solcast_|)(pv_forecast_|)forecast_tomorrow)
  pv_forecast_d3: re:(sensor.(solcast_|)(pv_forecast_|)forecast_(day_3|d3))
  pv_forecast_d4: re:(sensor.(solcast_|)(pv_forecast_|)forecast_(day_4|d4))

  # car_charging_energy defines an incrementing sensor which measures the charge added to your car
  # is used for car_charging_hold feature to filter out car charging from the previous load data
  # Automatically set to detect Wallbox and Zappi, if it doesn't match manually enter your sensor name
  # Also adjust car_charging_energy_scale if it's not in kwH to fix the units
#  car_charging_energy: 're:(sensor.myenergi_zappi_[0-9a-z]+_charge_added_session|sensor.wallbox_portal_added_energy)'

  # Defines the number of cars modelled by the system, set to 0 for no car
  num_cars: 1

  # car_charging_planned is set to a sensor which when positive indicates the car will charged in the upcoming low rate slots
  # This should not be needed if you use Intelligent Octopus slots which will take priority if enabled
  # The list of possible values is in car_charging_planned_response
  # Auto matches Zappi and Wallbox, or change it for your own
  # One entry per car
  # car_charging_planned:
  #   - 're:(sensor.wallbox_portal_status_description|sensor.myenergi_zappi_[0-9a-z]+_plug_status)'

  # car_charging_planned_response:
  #   - 'yes'
  #   - 'on'
  #   - 'true'
  #   - 'connected'
  #   - 'ev connected'
  #   - 'charging'
  #   - 'paused'
  #   - 'waiting for car demand'
  #   - 'waiting for ev'
  #   - 'scheduled'
  #   - 'enabled'
  #   - 'latched'
  #   - 'locked'
  #   - 'plugged in'

  # In some cases car planning is difficult (e.g. Ohme with Intelligent doesn't report slots)
  # The car charging now can be set to a sensor to indicate the car is charging and to plan
  # for it to charge during this 30 minute slot
  #car_charging_now:
  #  - off

  # Positive responses for car_charging_now
  # car_charging_now_response:
  #   - 'yes'
  #   - 'on'
  #   - 'true'

  # To make planned car charging more accurate, either using car_charging_planned or the Octopus Energy plugin,
  # specify your battery size in kwh, charge limit % and current car battery soc % sensors/values.
  # If you have Intelligent Octopus the battery size and limit will be extracted from the Octopus Energy plugin directly.
  # Set the car SoC% if you have it to give an accurate forecast of the cars battery levels.
  # One entry per car if you have multiple cars.
  #car_charging_battery_size:
  #  - 75
  #car_charging_limit:
  #  - 're:number.tsunami_charge_limit'
  #car_charging_soc:
  #  - 're:sensor.tsunami_battery'

  # One per car, when true only one car can charge at once, when False multiple cars can charge at once
  #car_charging_exclusive:
  #  - True

  # If you have Octopus Intelligent Go and are not using the Octopus Direct connection method, enable the intelligent slot information to add to pricing
  # Will automatically disable if not found, or comment out to disable fully
  # When enabled it overrides the 'car_charging_planned' feature and predict the car charging based on the intelligent plan (unless Octopus intelligent charging is False)
  # This matches the intelligent slot from the Octopus Energy integration
  octopus_intelligent_slot: 're:(binary_sensor.octopus_energy([0-9a-z_]+|)_intelligent_dispatching)'
  octopus_ready_time: 're:((select|time).octopus_energy_([0-9a-z_]+|)_intelligent_target_time)'
  octopus_charge_limit: 're:(number.octopus_energy([0-9a-z_]+|)_intelligent_charge_target)'

  # Example alternative configuration for Ohme integration release >=v0.6.1
  #octopus_intelligent_slot: 'binary_sensor.ohme_slot_active'
  #octopus_ready_time: 'time.ohme_target_time'
  #octopus_charge_limit: 'number.ohme_target_percent'

  # Set this to False if you use Octopus Intelligent slot for car planning but when on another tariff e.g. Agile
  #octopus_slot_low_rate: False

  # Carbon Intensity data from National grid
  # carbon_postcode: 'SW1 5NA'
  # carbon_automatic: True

  # Octopus saving session points to the saving session Sensor in the Octopus plugin, when enabled saving sessions will be at the assumed
  # Rate is read automatically from the add-in and converted to pence using the conversion rate below (default is 8)
  octopus_saving_session: 're:(binary_sensor.octopus_energy([0-9a-z_]+|)_saving_session(s|))'
  octopus_saving_session_octopoints_per_penny: 8

  # Octopus free session points to the free session Sensor in the Octopus plugin
  # Note: You must enable this event sensor in the Octopus Integration in Home Assistant for it to work
  octopus_free_session: 're:(event.octopus_energy_([0-9a-z_]+|)_octoplus_free_electricity_session_events)'

  # Energy rates
  # Please set one of these three, if multiple are set then Octopus is used first, second rates_import/rates_export and latest basic metric

  # Set import and export entity to point to the Octopus Energy plugin import and export sensors
  # automatically matches your meter number assuming you have only one (no need to edit the below)
  # Will be ignored if you don't have the sensor but will error if you do have one and it's incorrect
  # Note: To get detailed energy rates you need to go in and manually enable the following events in HA
  #       event.octopus_energy_electricity_xxxxxxxx_previous_day_rates
  #       event.octopus_energy_electricity_xxxxxxxx_current_day_rates
  #       event.octopus_energy_electricity_xxxxxxxx_next_day_rates
  # and if you have export enable:
  #       event.octopus_energy_electricity_xxxxxxxx_export_previous_day_rates
  #       event.octopus_energy_electricity_xxxxxxxx_export_current_day_rates
  #       event.octopus_energy_electricity_xxxxxxxx_export_next_day_rates
  # Predbat will automatically find the event. entities from the link below to the sensors
  metric_octopus_import: 're:(sensor.(octopus_energy_|)electricity_[0-9a-z]+_[0-9a-z]+_current_rate)'
  metric_octopus_export: 're:(sensor.(octopus_energy_|)electricity_[0-9a-z]+_[0-9a-z]+_export_current_rate)'

  # Standing charge in pounds, can be set to a sensor or manually entered (e.g. 0.50 is 50p)
  # The default below will pick up the standing charge from the Octopus Plugin
  # The standing charge only impacts the cost graphs and doesn't change the way Predbat plans
  # If you don't want to show the standing charge then just delete this line or set to zero
  metric_standing_charge: 're:(sensor.(octopus_energy_|)electricity_[0-9a-z]+_[0-9a-z]+_current_standing_charge)'

  # Or set your actual rates across time for import and export
  # If start/end is missing it's assumed to be a fixed rate
  # Gaps are filled with zero rate
  #rates_import:
  #  -  start: "00:30:00"
  #     end: "04:30:00"
  #     rate: 7.5
  #  -  start: "04:30:00"
  #     end: "00:30:00"
  #     rate: 40.0
  #
  #rates_export:
  #  -  rate: 4.2

  # Can be used instead of the plugin to get import rates directly online
  # Overrides metric_octopus_import and rates_import
  # See the 'energy rates' part of the documentation for instructions on how to find the correct URL for your tariff and DNO region
  #
  # rates_import_octopus_url : "https://api.octopus.energy/v1/products/FLUX-IMPORT-23-02-14/electricity-tariffs/E-1R-FLUX-IMPORT-23-02-14-A/standard-unit-rates"
  # rates_import_octopus_url : "https://api.octopus.energy/v1/products/AGILE-24-10-01/electricity-tariffs/E-1R-AGILE-24-10-01-A/standard-unit-rates"

  # Overrides metric_octopus_export and rates_export
  # rates_export_octopus_url: "https://api.octopus.energy/v1/products/FLUX-EXPORT-23-02-14/electricity-tariffs/E-1R-FLUX-EXPORT-23-02-14-A/standard-unit-rates"
  # rates_export_octopus_url: "https://api.octopus.energy/v1/products/AGILE-OUTGOING-19-05-13/electricity-tariffs/E-1R-AGILE-OUTGOING-19-05-13-A/standard-unit-rates/"

  # Import rates can be overridden with rate_import_override
  # Export rates can be overridden with rate_export_override
  # Use the same format as above, but a date can be included if it just applies for a set day (e.g. Octopus power ups)
  # This will override even the Octopus plugin rates if enabled
  #
  #rates_import_override:
  # -  date: '2023-09-10'
  #    start: '14:00:00'
  #    end: '14:30:00'
  #    rate: 112
  #    load_scaling: 0.8

  # Days previous is the number of days back to find historical load data
  # Recommended is 7 to capture day of the week but 1 can also be used
  # if you have more history you could use 7 and 14 (in a list) but the standard data in HA only lasts 10 days
  days_previous:
    - 7
    - 14

  # Days previous weight can be used to control the weighting of the previous load points, the values are multiplied by their
  # weights and then divided through by the total weight. E.g. if you used 1 and 0.5 then the first value would have 2/3rd of the weight and the second 1/3rd
  # Include one value for each days_previous value, each weighting on a separate line.
  # If any days_previous's that are not given a weighting they will assume a default weighting of 1.
  days_previous_weight:
    - 1

  # Number of hours forward to forecast, best left as-is unless you have specific reason
  forecast_hours: 48

  # Specify the devices that notifies are sent to, the default is 'notify' which goes to all
  notify_devices:
    - mobile_app_jg_iphone

  # Battery scaling makes the battery smaller (e.g. 0.9) or bigger than its reported
  # If you have an 80% DoD battery that falsely reports it's kwh then set it to 0.8 to report the real figures
  # One per inverter
  battery_scaling:
    - 1.0

  # Can be used to scale import and export data, used for workarounds
  import_export_scaling: 1.0

  # Export triggers:
  # For each trigger give a name, the minutes of export needed and the energy required in that time
  # Multiple triggers can be set at once so in total you could use too much energy if all run
  # Creates an entity called 'binary_sensor.predbat_export_trigger_<name>' which will be turned On when the condition is valid
  # connect this to your automation to start whatever you want to trigger
  export_triggers:
    - name: 'large'
      minutes: 60
      energy: 1.0
    - name: 'small'
      minutes: 15
      energy: 0.25

  # If you have a sensor that gives the energy consumed by your solar diverter then add it here
  # this will make the predictions more accurate. It should be an incrementing sensor, it can reset at midnight or not
  # It's assumed to be in Kwh but scaling can be applied if need be
  #iboost_energy_today: 'sensor.xxxxx'
  #iboost_energy_scaling: 1.0
  # Gas rates for comparison
  #metric_octopus_gas: 're:(sensor.(octopus_energy_|)gas_[0-9a-z]+_[0-9a-z]+_current_rate)'

  # Nordpool market energy rates
  #futurerate_url: 'https://dataportal-api.nordpoolgroup.com/api/DayAheadPrices?date=DATE&market=N2EX_DayAhead&deliveryArea=UK&currency=GBP'
  #futurerate_adjust_import: False
  #futurerate_adjust_export: False
  #futurerate_peak_start: "16:00:00"
  #futurerate_peak_end: "19:00:00"
  #futurerate_peak_premium_import: 14
  #futurerate_peak_premium_export: 6.5

  # Watch list, a list of sensors to watch for changes and then update the plan if they change
  # This is useful for things like the Octopus Intelligent Slot sensor so that the plan update as soon as you plugin in
  # Only uncomment the items you actually have set up above in apps.yaml, of course you can add your own as well
  # Note those using +[] are lists that are appended to this list, whereas {} items are single items only
  #watch_list:
  #  - '{octopus_intelligent_slot}'
  #  - '{octopus_ready_time}'
  #  - '{octopus_charge_limit}'
  #  - '{octopus_saving_session}'
  #  - '+[car_charging_planned]'
  #  - '+[car_charging_soc]'
  #  - '{car_charging_now}'

Automation to sync SoC across all the timers

alias: Sync Sunsynk Program Capacities
description: Hardcoded trigger with dynamic actions
triggers:
  - trigger: state
    entity_id: number.ss_prog1_capacity # change ss to the name of your inverter
actions:
  - action: number.set_value
    target:
      entity_id: |
        {{ states.number 
           | selectattr('entity_id', 'search', '^number\.' ~ inverter_name ~ '_prog[2-6]_capacity$')
           | map(attribute='entity_id') | list }}
    data:
      value: "{{ trigger.to_state.state | float }}"
mode: single
variables:
  inverter_name: ss # enter the name of your inverter here e.g. ss or sunsynk

[gcoan]

had to set up a single automation to copy the charge limit to all the timers. (at end) Can I list multiple charge limit entities within the apps.yaml to avoid this?

Not really

If you list multiple charge entities then predbat will assume that they are for multiple inverters and only use the first for inverter 1. An automation is the right approach

Is there a way to add multiple PV inputs together within apps.yaml even rather than using a helper to add them?

As this is an input you can just list all the entities and predbat will sum them up

When you've got it all worked out please do raise a PR to update the documentation and template

[gorstj]

Thanks for the input.

Will test it out and try and streamline.

I think it works better if all the timers are set for a start time of 00:00 and then only timer6 needs to be altered simplifying setup (SunSynk is not that user friendly!)

[gcoan]

That's similar to other inverters.

On mine I only use slot 1 and all the others are set to 00:00 charge start and end times

[jgogoes]

Great work, tanks for sharing.

I notice you're not specifying:
charge_rate
discharge_rate

Is this set elsewhere or do you find it's not needed? I am getting the below error on Sunsynk and can't work it out!

Warn: Cannot find battery discharge curve (no full rate discharge curve found for battery to empty), one of the required settings for soc_percent, discharge_rate, battery_power and predbat.status do not have history, check apps.yaml

[frazzyfin]

Hi @gorstj, thanks for posting your apps.yaml and the timer-sync automation, really useful.

Did you get it working any better since your last post? Specifically: is it running in active control now (not just monitor mode), and have you made any further refinements to the apps.yaml?