Release 5 discussion

[PeterH24x7]

Please post any feedback, questions or issues about Release 5 in this discussion thread.

[PeterH24x7]

New minor version is currently in test - basically minor calculation and logic fixes for more recent sensors.

There's no impact to 3-phase implementation.

#                 - sa_data_by_5min_meter_reset is depracated as not used/required (separate Amber code
#                   has own midnight meter trigger). Uncomment if required.
#                 - sa_data_by_5min_exported_total and sa_data_by_5min_consumed_solar_total added error
#                   and generated negative value testing.
#                 - sa_data_by_5min_load_ev_charger_generated and sa_data_by_5min_load_ev_charger_imported
#                   corrected calculation - minor missing logic.
#                 - sa_data_by_5min_history_time_stamp_count added time_stamp attribute.
#                 - sa_todays_electric_vehicle_generated and sa_todays_electric_vehicle_imported corrected
#                   calculations for ev_energy_last5min attribute.
#                 - sa_todays_generated_consumed_percentage and sa_todays_consumed_generated_percentage
#                   fixed calculation logic where total energy generated at start of the day
#                   could be negative (i.e. the inverter has consumed energy at start-up).

[Roving-Ronin]

@PeterH24x7 given the 3phase still uses:

• sa_data_by_5min_meter_reset
• sa_data_by_5min_exported_total
• sa_data_by_5min_consumed_solar_total
• sa_data_by_5min_history_time_stamp_count
• sa_todays_generated_consumed_percentage
• sa_todays_consumed_generated_percentage

Its' probably still good to test with 3 phase. Can you post a copy of the update?

[PeterH24x7]

@Roving-Ronin - here's the latest/last updated code - lots of little changes, extra error checking, default value definition and generally tidy-up to improve readability. There should no longer be any warnings/errors for any out of the ordinary execution (e.g. failed GET). There should be no breaking changes.

You will note I've put in markers where I believe the 3-phase version should be edited - let me know if these are correct please.

Thank you for your support. Rgds, Peter.

UPDATED WITH LATEST CHANGES/FIXES ON 12-Jul-23 - LAST ROUND OF TESTING BEFORE REL 6 (I HOPE).

# -----------------------------------------------------------------------------
#
# SOLAR ANALYTICS - RELEASE 6 DRAFT FOR TESTING - integration for Home Assistant Energy Monitoring
# 
# Developed by Peter Hormann and with thanks to Glen S and Roving-Ronin for their contributions.
#
# Created: 7-Jan-2022
#
# Last updated: 15-Apr-2023 as Release 5 - see update notes below.
#
# Updates: 
#     16-Jan-2022 - INITIAL RELEASE 1
#                 - Added power reporting (last 5 minute average).
#     16-Jul-2022 - RELEASE 2
#                 - Enabled more accurate and more frequent 1 minute power reporting
#                 - Added 5 minute energy updates for all channels
#                 - Moved sa_site_id to secrets.yaml.
#     20-Aug-2022 - RELEASE 3
#                 - Added some error checking to deal with daily energy total errors when the 
#                   data get is 'unavailable' or 'unknown'
#                 - Removed "force_update: true" - where the data get may be 'unavailable'
#                 - Removed "state_class: measurement" and "device_class: energy" for rest platform 
#                   sensors (not applicable)
#     10-Feb-2023 - RELEASE 4
#                 - Added "unique_id" to each sensor entity (including existing) to enable HA 
#                   Lovelace based settings changes.
#                 - Added new "Total Energy Generated Expected" sensor to provide daily cumulative 
#                   expected energy (as per the Solar Analytics portal).
#                 - Added kW sensors as conversions of their respective W counterpart (note: not 
#                   required for energy entities as of HA 2023.2).
#                 - Where HA EM is used for cost calculations added "Todays Energy Total Net Cost" 
#                   (import cost minus feed-in revenue).
#                 - For those on variable energy rates (e.g. Amber) created new sensors "Todays Energy 
#                   Import Rate" and "Todays Energy Export Rate".
#     10-Apr-2023 - RELEASE 5
#                 - Added "unique_id" to each REST sensor.
#                 - Implemented token authentication with timer based refresh using username/password.
#                 - Updated REST sensors to use token authentication.
#                 - Changed sa_live_site_data to 60s scan_interval (avoid repeated update at 30s 
#                   interval where data actually only changes every minute - some users may consider 
#                   changing back to 30s to reduce the delay to update).
#                 - Added time_stamp attribute to sa_todays_energy_total_net_cost, 
#                   sa_todays_energy_import_rate and sa_todays_energy_export_rate.
#                 - Added 3x new sensors sa_todays_energy_consumed_solar (Wh), 
#                   sa_todays_generated_consumed_percentage (%) and 
#                   sa_todays_consumed_generated_percentage (%).
#                 - Added automation sa_refresh_all_rest_gets to manually force refesh of all REST 
#                   data gets.
#                 - Added sa_todays_electric_vehicle_generated and sa_todays_electric_vehicle_imported as
#                   breakdown of the daily EV charging energy into generated and imported sourced energy.
#                   Does not include EV charger standby energy and the sum of these sensors may differ
#                   slightly from sa_todays_electric_vehicle_total. Attributes include last 5 minute
#                   energy and % of total.
#                 - Modified all REST gets from template platform rest to RESTful sensors. Required to 
#                   solve overflowing attributes.data for sa_data_by_5min. Also resolves many of the
#                   sensor unit issues (ie. Wh/kWh and W/kW).
#                 - Added Energy history sensor for graphing each SA channel (e.g. in Apex Charts).
#                   Note: results are 5 minute average power (kW), with area under the graph being the energy
#                   usage within that time interval. The time duration is limited to 28x 5 minute intervals
#                   (= 2h20m) as this fits within the 255 character max allowed by the state of a sensor.
#                   Rounding to a reduced number of decimal places (e.g. 1 instead of 2) could increase
#                   the number of intervals if that's desireable, but at a lower resolution.
#       12-Jul-23 - RELEASE 6 MINOR FIXES
#                 - sa_data_by_5min_meter_reset is depracated as not used/required (separate Amber code
#                   has own midnight meter trigger). Uncomment if still required.
#                 - sa_data_by_5min_exported_total and sa_data_by_5min_consumed_solar_total added error
#                   and generated negative value testing.
#                 - sa_data_by_5min_load_ev_charger_generated and sa_data_by_5min_load_ev_charger_imported
#                   corrected calculation - minor missing logic.
#                 - sa_data_by_5min_history_time_stamp_count added time_stamp attribute.
#                 - sa_todays_electric_vehicle_generated and sa_todays_electric_vehicle_imported corrected
#                   calculations for ev_energy_last5min attribute.
#                 - sa_todays_generated_consumed_percentage and sa_todays_consumed_generated_percentage
#                   fixed calculation logic where total energy generated at start of the day
#                   could be negative (i.e. the inverter has consumed energy at start-up).
#                 - general improved error checking using is_number (instead of is defined) and providing
#                   float(0.0) and int(0) default values.
#
# This code is provided as-is and without any warrantee or guarantees. 
# Further public contributions and enhancements are welcomed.
# 
# INSTALLATION - NEW: 
#   1. Copy this yaml file to the HA config directory.
#   2. Include this file name as a package in the HA configuration.yaml. 
#      For example -
#        packages:
#          pack_1: !include solar_analytics.yaml
#   3. Define sa_username, sa_password and sa_site_id (e.g. 36304) in the secrets.yaml file (see
#      example on github).
#   4. Using HA Developer Tools check the configuration and restart.  From States, review the 
#      attributes for sa_data_by_5min to identify the device specific channel names and 
#      update/delete the sa_todays_... xyz sensors to suit.
#   5. Add the new energy sensors from 4. above to the HA Energy Manager as "Monitor 
#      Individual Devices". Go to HA Settings and then search for “Energy Configuration” 
#      to make the changes.
#   6. Also in HA Energy Configuration, enter the details for
#      > Grid consumption - as sa_todays_energy_imported
#      > Return to grid - as sa_todays_energy_exported
#      > Solar production - as sa_todays_energy_generated_total
#   7. If all working is correctly, the Energy dashboard should start populating data within 
#      a couple of hours.
#   8. If HA EM "Grid Consumption" and "Return to grid" are configured with energy pricing 
#      details, then the sa_todays_energy_imported_cost and sa_todays_energy_imported_cost sensors 
#      should be auto-created by the Energy Manager. These sensors can be found as hidden Entities 
#      (which can't be changed or deleted). If all good, then the sa_todays_energy_import_rate 
#      (daily av. $/kWh), sa_todays_energy_export_rate (daily av. $/kWh) and
#      sa_todays_energy_total_net_cost ($) should work without further config. If no pricing 
#      is set, then delete these 3x sensors from the configuration.
#   9. Enjoy!
#
# UPGRADING - FROM A PREVIOUS VERSION:
#   This upgrade should not break the sensors created in a previous versions. It's recommended that the 
#   previous version solar_analytics.yaml should be deleted, HA restarted, the new solar_analytics.yaml
#   copied to the <config> folder and then HA restarted again. The sensors should start repopulating
#   within their refresh timecycles. If any duplicate sensors happen to be created, go to HA Settings ->
#   Devices & Services -> Entities and delete any "sa_..." prefixed sensors showing as unavailable or
#   disabled, then restart once more and the correctly named sensor and its data should be restored
#   to normal. Alternatively go to 'Developer Tools -> Services' and select 'Recorder: Purge Entities' 
#   and then 'Choose entity' and select all the "sa_..." entities needing to purge immediately.
#
# If you find my work useful, please buy me a coffee ... thank you!
#   https://www.buymeacoffee.com/peter24x7
#
# Reference for more information and updates:
#   https://github.com/PeterH24x7/-Solar-Analytics-integration-for-Home-Assistant-Energy-monitoring
#
# -----------------------------------------------------------------------------


# -----------------------------------------------------------------------------
#  
# Define the Solar Analytics site_id value is required in URLs used in gets below - e.g. 36304. 
#   See the Solar Analytics user portal to find your site id or see the collected sa_site_list 
#   attributes as defined below.
#
input_text:
    sa_site_id:
      initial: !secret sa_site_id

timer:
  sa_token_expiry_timer:
    duration: 0
    icon: mdi:clock-check
    restore: true

automation:
  - id: 'sa_token_expiry_update'
    alias: SA Token Expiry update
    description: ''
    trigger:
    - platform: state
      entity_id:
      - sensor.sa_auth_token
      for:
        hours: 0
        minutes: 0
        seconds: 5
    condition: []
    action:
    - service: timer.start
      data:
        duration: '{{- states(''sensor.sa_auth_token'') | int -}}'
      target:
        entity_id: timer.sa_token_expiry_timer
    mode: single
  - id: 'sa_token_refresh_on_timer_expiry'
    alias: SA Token refresh on Timer expiry
    description: ''
    trigger:
    - platform: state
      entity_id:
      - timer.sa_token_expiry_timer
      to: idle
      for:
        hours: 0
        minutes: 0
        seconds: 5
    condition: []
    action:
    - service: homeassistant.update_entity
      data: {}
      target:
        entity_id: sensor.sa_auth_token
    mode: single

  - id: 'sa_refresh_all_rest_gets'
    alias: SA Refresh all REST data gets
    description: "Automation that can be manually run to refresh all REST data gets."
    trigger: []
    condition: []
    action:
      - service: homeassistant.update_entity
        data: {}
        target:
          entity_id:
            - sensor.sa_data_by_5min_extract
    mode: single



# -----------------------------------------------------------------------------
#
# Solar Analytics - rest get of latest token using username and password credentials.
#   - Auto updates every 2 hours, else on sa_token_expiry_timer via automation.
#
rest:
  - resource: "https://portal.solaranalytics.com.au/api/v3/token"
    authentication: basic
    username: !secret sa_username
    password: !secret sa_password
    scan_interval: 7200
    sensor:
      - name: sa_auth_token
        unique_id: sa_auth_token
        value_template: "{{- value_json['duration'] -}}"
        json_attributes:
          - "token"
          - "expires"

# -----------------------------------------------------------------------------
#  
# Solar Analytics - get the site details associated with the given user account login.
# Updated every 24 hours.
#
# Note: assumes only a single device per account, there could be a second device (e.g. replaced 
# device due to fault/upgrade) at $.data.[1]
#
  - resource: "https://portal.solaranalytics.com.au/api/v3/site_list?hardware=true&capacity=true&subscription=true"
    headers: 
      Authorization: >
        {{- 'Bearer ' ~ state_attr('sensor.sa_auth_token','token') -}}
    scan_interval: 62400
    sensor:
      - name: sa_site_list
        unique_id: sa_site_list
        value_template: "{{ now() }}"
        json_attributes_path: "$.data.[0]"
        json_attributes:
          - "e_status"
          - "fault_class"
          - "fault_id*"
          - "has_pv"
          - "mer_status"
          - "overall_status"
          - "retailer_user"
          - "s_cli_site_name"
          - "site_id"
          - "site_inactive"
          - "capacity"
          - "devices"
          - "sub_type"
    
# -----------------------------------------------------------------------------
#
# Solar Analytics - get the site status for the specified site_id.
# Updated every hour.
#
  - resource_template: https://portal.solaranalytics.com.au/api/v3/site_status/{{- states('input_text.sa_site_id') -}}
    headers: 
      Authorization: >
        {{- 'Bearer ' ~ state_attr('sensor.sa_auth_token','token') -}}
    scan_interval: 3600
    sensor:
      - name: sa_status
        unique_id: sa_status
        value_template: "{{ value_json['data']['mer_status'] }}"
        json_attributes_path: "$.data"
        json_attributes:
          - "dashboard_status"
          - "event_id"
          - "event_list"
          - "fault_status"
          - "mer_percentage"
          - "mer_status"
          - "mer_text"


# -----------------------------------------------------------------------------
#
# Solar Analytics - get 5 minute energy data.
# Used to calculate today's cumulative total energy for consumed, generated, imported and exported 
# energy as used by the HA Energy module.
# Updated every 5 minutes.
#
  - resource_template: https://portal.solaranalytics.com.au/api/v2/site_data/{{- states('input_text.sa_site_id') -}}?all=true&gran=minute&trunc=false&power=false&tstart={{- now().strftime("%Y%m%d") -}}&tend={{- now().strftime("%Y%m%d") -}}
    headers: 
      Authorization: >
        {{- 'Bearer ' ~ state_attr('sensor.sa_auth_token','token') -}}
    scan_interval: 300
    sensor:

# Timestamp of the latest energy data.
# 25-JUN-23 - CHANGED - check for t_stamp is_defined, to energy_consumed is_number.
      - name: sa_data_by_5min_time_stamp
        unique_id: sa_data_by_5min_time_stamp
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].energy_consumed|is_number) -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('energy_consumed', 'equalto', None) | list | last -%}
              {{- most_recent_sensor_data.t_stamp -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_time_stamp.state|default("unavailable") -}}
          {%- endif -%}

# Sensor that indicates that the energy sensors have reset (i.e. at midnight each day)
      - name: sa_data_by_5min_meter_reset
        unique_id: sa_data_by_5min_meter_reset
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].energy_consumed|is_number) -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('energy_consumed', 'equalto', None) | list -%}
            {%- if most_recent_sensor_data|count == 1 -%}
              true
            {%- else -%}
              false
            {%- endif -%}
          {%- else -%}
            unavailable
          {%- endif -%}
        json_attributes_path: "$.data[0]"
        json_attributes: "t_stamp"

# The last 5 minutes energy by sensor type per Solar Analytics channel. 
# These sensors may be useful for calculating energy cost where energy costs vary at intervals down 
# to 5 minutes (e.g. Amber Electric). The may also be useful for configuring "Utility Meter" helpers in HA.
      - name: sa_data_by_5min_energy_consumed
        unique_id: sa_data_by_5min_energy_consumed
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].energy_consumed|is_number) -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('energy_consumed', 'equalto', None) | list | last -%}
              {{- most_recent_sensor_data.energy_consumed 
                  if most_recent_sensor_data.energy_consumed|float(0.0) > 0.0
                  else 0.0 
                -}}
          {%- else -%}
            {{- this.state|default(0.0) -}}
          {%- endif -%}
      - name: sa_data_by_5min_energy_generated
        unique_id: sa_data_by_5min_energy_generated
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].energy_generated|is_number) -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('energy_generated', 'equalto', None) | list | last -%}
            {{- most_recent_sensor_data.energy_generated 
                if most_recent_sensor_data.energy_generated|float(0.0) > 0.0
                else 0.0 
              -}}
          {%- else -%}
            {{- this.state|default(0.0) -}}
          {%- endif -%}

#
### DELETE FOR 3-PHASE SOLUTION - START >>>>>>>>>>
#
      - name: sa_data_by_5min_load_air_conditioner
        unique_id: sa_data_by_5min_load_air_conditioner
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].load_air_conditioner|is_number) -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('load_air_conditioner', 'equalto', None) | list | last -%}
            {{- most_recent_sensor_data.load_air_conditioner
                if most_recent_sensor_data.load_air_conditioner|float(0.0) > 0.0
                else 0.0 
              -}}
          {%- else -%}
            {{- this.state|default(0.0) -}}
          {%- endif -%}
      - name: sa_data_by_5min_load_ev_charger
        unique_id: sa_data_by_5min_load_ev_charger
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].load_ev_charger|is_number) -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('load_ev_charger', 'equalto', None) | list | last -%}
            {{- most_recent_sensor_data.load_ev_charger
                if most_recent_sensor_data.load_ev_charger|float(0.0) > 0.0
                else 0.0 
              -}}
          {%- else -%}
            {{- this.state|default(0.0) -}}
          {%- endif -%}
      - name: sa_data_by_5min_load_hot_water
        unique_id: sa_data_by_5min_load_hot_water
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].load_hot_water|is_number) -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('load_hot_water', 'equalto', None) | list | last -%}
            {{- most_recent_sensor_data.load_hot_water
                if most_recent_sensor_data.load_hot_water|float(0.0) > 0.0
                else 0.0 
              -}}
          {%- else -%}
            {{- this.state|default(0.0) -}}
          {%- endif -%}
      - name: sa_data_by_5min_load_stove
        unique_id: sa_data_by_5min_load_stove
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].load_stove|is_number) -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('load_stove', 'equalto', None) | list | last -%}
            {{- most_recent_sensor_data.load_stove 
                if most_recent_sensor_data.load_stove|float(0.0) > 0.0
                else 0.0 
              -}}
          {%- else -%}
            {{- this.state|default(0.0) -}}
          {%- endif -%}
#
### DELETE FOR 3-PHASE SOLUTION - END <<<<<<<<<<
#

# Daily cumulative total "raw" sensors per Solar Analytics channel reset at midnight.
# These sensors are used for feeding "fully configured" template sensors defined further down below.
      - name: sa_data_by_5min_energy_consumed_total
        unique_id: sa_data_by_5min_energy_consumed_total
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].energy_consumed|is_number) -%}
            {{- value_json.data 
                | rejectattr( 'energy_consumed', 'equalto', None ) 
                | selectattr( 'energy_consumed', 'gt', 0.0 ) 
                | sum( attribute='energy_consumed' ) 
                | float(0.0) | round(4) 
              -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_energy_consumed_total.state|default("unavailable") -}}
          {%- endif -%}
      - name: sa_data_by_5min_energy_generated_total
        unique_id: sa_data_by_5min_energy_generated_total
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].energy_generated|is_number) -%}
            {{- value_json.data 
                | rejectattr( 'energy_generated', 'equalto', None ) 
                | selectattr( 'energy_generated', 'gt', 0.0 ) 
                | sum( attribute='energy_generated' ) 
                | float(0.0) | round(4) 
              -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_energy_generated_total.state|default("unavailable") -}}
          {%- endif -%}

#
### DELETE FOR 3-PHASE SOLUTION - START >>>>>>>>>>
#
      - name: sa_data_by_5min_load_air_conditioner_total
        unique_id: sa_data_by_5min_load_air_conditioner_total
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].load_air_conditioner|is_number) -%}
            {{- value_json.data 
                | rejectattr( 'load_air_conditioner', 'equalto', None ) 
                | selectattr( 'load_air_conditioner', 'gt', 0.0 ) 
                | sum( attribute='load_air_conditioner' ) 
                | float(0.0) | round(4) 
              -}}
          {%- else %}
            {{- states.sensor.sa_data_by_5min_load_air_conditioner_total.state|default("unavailable") -}}
          {%- endif -%}
      - name: sa_data_by_5min_load_ev_charger_total
        unique_id: sa_data_by_5min_load_ev_charger_total
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].load_ev_charger|is_number) -%}
            {{- value_json.data 
                | rejectattr( 'load_ev_charger', 'equalto', None ) 
                | selectattr( 'load_ev_charger', 'gt', 0.0 ) 
                | sum( attribute='load_ev_charger' ) 
                | float(0.0) | round(4) 
              -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_load_ev_charger_total.state|default("unavailable") -}}
          {%- endif -%}
      - name: sa_data_by_5min_load_hot_water_total
        unique_id: sa_data_by_5min_load_hot_water_total
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].load_hot_water|is_number) -%}
            {{- value_json.data 
                | rejectattr( 'load_hot_water', 'equalto', None ) 
                | selectattr( 'load_hot_water', 'gt', 0.0 ) 
                | sum( attribute='load_hot_water' ) 
                | float(0.0) | round(4) 
              -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_load_hot_water_total.state|default("unavailable") -}}
          {%- endif -%}

      - name: sa_data_by_5min_load_stove_total
        unique_id: sa_data_by_5min_load_stove_total
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].load_stove|is_number) -%}
            {{- value_json.data 
                | rejectattr( 'load_stove', 'equalto', None ) 
                | selectattr( 'load_stove', 'gt', 0.0 ) 
                | sum( attribute='load_stove' ) 
                | float(0.0) | round(4) 
              -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_load_stove_total.state|default("unavailable") -}}
          {%- endif -%}
#
### DELETE FOR 3-PHASE SOLUTION - END <<<<<<<<<<
#

# Additional daily cumulative total "raw" sensors that reset at midnight. 
# These sensors are derived/calculated from the main Solar Analytics channels.
      - name: sa_data_by_5min_imported_total
        unique_id: sa_data_by_5min_imported_total
        value_template: >
          {%- if (value_json is defined) 
              and (value_json.data[0].energy_consumed|is_number) and (value_json.data[0].energy_generated|is_number) -%}
            {%- set energy = namespace(imported=0.0) -%}
            {%- for sensor_data in value_json.data | rejectattr('energy_consumed', 'equalto', None) -%}
              {%- if (sensor_data.energy_consumed|float) > (sensor_data.energy_generated|float) -%}
                {%- if (sensor_data.energy_generated|float) > 0.0 -%}
                  {%- set energy.imported = (energy.imported|float) 
                      + (sensor_data.energy_consumed|float) - (sensor_data.energy_generated|float) -%}
                {% else %}
                  {%- set energy.imported = (energy.imported|float) + (sensor_data.energy_consumed|float) -%}
                {% endif %}
              {%- endif -%}
            {%- endfor -%}
            {{- energy.imported|float(0.0)|round(4) -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_imported_total.state|default("unavailable") -}} 
          {%- endif -%}

      - name: sa_data_by_5min_exported_total
        unique_id: sa_data_by_5min_exported_total
        value_template: >
          {%- if (value_json is defined) 
              and (value_json.data[0].energy_consumed|is_number) 
              and (value_json.data[0].energy_generated|is_number) 
            -%}
            {%- set energy = namespace( exported = 0.0 ) -%}
            {%- for sensor_data in value_json.data | rejectattr('energy_generated', 'equalto', None) -%}
                {%- if sensor_data.energy_generated|float > sensor_data.energy_consumed|float -%}
                  {%- set energy.exported = energy.exported|float 
                      + sensor_data.energy_generated|float
                      - sensor_data.energy_consumed|float 
                    -%}
                {%- endif -%}
            {%- endfor -%}
            {{- energy.exported|float(0.0)|round(4) -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_exported_total.state|default("unavailable") -}}
          {%- endif -%}


# Additional "raw" sensor associated with the daily total of consumed energy that
# has been generated from local sources (i.e. not imported).
#
# 18-May-23 - CHANGED - fixed potential bug in where generated could be -ve. Added float to comparisons and calculations.
      - name: sa_data_by_5min_consumed_solar_total
        unique_id: sa_data_by_5min_consumed_solar_total
        value_template: >
          {%- if (value_json is defined) 
              and (value_json.data[0].energy_consumed|is_number) 
              and (value_json.data[0].energy_generated|is_number) 
            -%}
            {%- set energy = namespace( solar_consumed = 0.0 ) -%}
            {%- for sensor_data in value_json.data | rejectattr('energy_generated', 'equalto', None) -%}
              {%- if sensor_data.energy_generated|float >= sensor_data.energy_consumed|float -%}
                {%- set energy.solar_consumed = energy.solar_consumed|float 
                    + sensor_data.energy_consumed|float 
                  -%}
              {%- else -%}
                {%- set energy.solar_consumed = energy.solar_consumed|float 
                    + ( sensor_data.energy_generated 
                        if sensor_data.energy_generated|float > 0.0 
                        else 0.0 
                      )|float
                  -%}
              {%- endif -%}
            {%- endfor -%}
            {{- energy.solar_consumed|float(0.0)|round(4) -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_consumed_solar_total.state|default("unavailable") -}}
          {%- endif -%}

#
### DELETE FOR 3-PHASE SOLUTION - START >>>>>>>>>>
#
# Additional "raw" sensors associated with Electric Vehicle charging broken down by generated 
# and imported energy sources.
      - name: sa_data_by_5min_load_ev_charger_generated
        unique_id: sa_data_by_5min_load_ev_charger_generated
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].load_ev_charger|is_number) -%}
            {%- set energy = namespace( ev_generated = 0.0 ) -%}
            {%- for sensor_data in value_json.data | rejectattr('load_ev_charger', 'equalto', None) -%}
              {%- if sensor_data.load_ev_charger | float > 0.0 -%} 
                {%- if (sensor_data.energy_generated | float) 
                    >= (sensor_data.energy_consumed | float) 
                  -%}
                  {%- set energy.ev_generated = (energy.ev_generated | float) 
                      + (sensor_data.load_ev_charger | float) 
                    -%}
                {%- elif (sensor_data.energy_generated | float) 
                    > ((sensor_data.energy_consumed | float) - (sensor_data.load_ev_charger | float)) 
                  -%}
                  {%- set energy.ev_generated = (energy.ev_generated | float) 
                      + (sensor_data.energy_generated | float) 
                      - ((sensor_data.energy_consumed | float) 
                      - (sensor_data.load_ev_charger | float)) 
                    -%}
                {%- endif -%}
              {%- endif -%}
            {%- endfor -%}
            {{- energy.ev_generated|float(0.0)|round(4) 
                if energy.ev_generated|float(0.0) > 0.0 
                else 0.0 
              -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_load_ev_charger_generated.state|default("unavailable") -}}
          {%- endif -%}

      - name: sa_data_by_5min_load_ev_charger_imported
        unique_id: sa_data_by_5min_load_ev_charger_imported
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].load_ev_charger|is_number) -%}
            {%- set energy = namespace( ev_imported = 0.0 ) -%}
            {%- for sensor_data in value_json.data | rejectattr('load_ev_charger', 'equalto', None) -%}
              {%- if sensor_data.load_ev_charger | float > 0.0 -%}
                {%- if (sensor_data.energy_generated | float) 
                    < (sensor_data.energy_consumed | float) 
                  -%}
                  {%- if (sensor_data.energy_generated | float) 
                      <= ((sensor_data.energy_consumed | float) - (sensor_data.load_ev_charger | float)) 
                    -%}
                    {%- set energy.ev_imported = (energy.ev_imported | float) 
                        + (sensor_data.load_ev_charger | float) 
                      -%}
                  {%- else -%}
                      {%- set energy.ev_imported = (energy.ev_imported | float) 
                          + (sensor_data.energy_consumed | float) 
                          - (sensor_data.energy_generated | float) 
                        -%}
                  {%- endif -%}
                {%- endif -%}
              {%- endif -%}
            {%- endfor -%}
            {{- energy.ev_imported|float(0.0)|round(4)
                if energy.ev_imported|float(0.0) > 0.0 
                else 0.0 
              -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_load_ev_charger_imported.state|default("unavailable") -}}
          {%- endif -%}
#
### DELETE FOR 3-PHASE SOLUTION - END <<<<<<<<<<
#

# 
# Solar Analytics Energy history sensor for graphing each channel (e.g. in Apex Charts).
# The units are in kW.
# Added 10-Apr-23 - initial version.
#
# Note: results are actually 5 minute average power, with area under the graph being the energy
# usage within that time interval. The time duration is limited to 28x 5 minute intervals
# (= 2h20m) as this fits within the 255 character max allowed by the state of a sensor.
# Rounding to a reduced number of decimal places (e.g. 1 instead of 2) could increase
# the number of intervals if that's desireable, but at a lower resolution.
#
      - name: sa_data_by_5min_history_time_stamp
        unique_id: sa_data_by_5min_history_time_stamp
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].energy_consumed|is_number) -%}
            {%- set ns = namespace( sensor_values = [] ) -%}
            {%- for sensor_data in value_json.data | rejectattr('energy_consumed', 'equalto', None) -%}
              {%- if loop.index > (loop.length - 28 ) -%}
                {%- set ns.sensor_values = ns.sensor_values + [ as_timestamp(sensor_data.t_stamp)|timestamp_custom('%H:%M') ] -%}
              {% endif %}
            {%- endfor -%}
            {{- ns.sensor_values -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_history_time_stamp.state|default("unavailable") -}}
          {%- endif -%}

      - name: sa_data_by_5min_history_energy_consumed
        unique_id: sa_data_by_5min_history_energy_consumed
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].energy_consumed|is_number) -%}
            {%- set ns = namespace( sensor_values = [] ) -%}
            {%- for sensor_data in value_json.data | rejectattr('energy_consumed', 'equalto', None) -%}
              {%- if loop.index > (loop.length - 28 ) -%}
                {%- set ns.sensor_values = ns.sensor_values + [ ((sensor_data.energy_consumed|float) * 12.0 / 1000) | round(2) ] -%}
              {%- endif -%}
            {%- endfor -%}
            {{- ns.sensor_values -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_history_energy_consumed.state|default("unavailable") -}}
          {%- endif -%}

      - name: sa_data_by_5min_history_energy_generated
        unique_id: sa_data_by_5min_history_energy_generated
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].energy_generated|is_number) -%}
            {%- set ns = namespace( sensor_values = [] ) -%}
            {%- for sensor_data in value_json.data | rejectattr('energy_generated', 'equalto', None) -%}
              {%- if loop.index > (loop.length - 28 ) -%}
                {%- set ns.sensor_values = ns.sensor_values + [ ((sensor_data.energy_generated|float) * 12.0 / 1000) | round(2) ] -%}
              {%- endif -%}
            {%- endfor -%}
            {{- ns.sensor_values -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_history_energy_generated.state|default("unavailable") -}}
          {%- endif -%}

#
### DELETE FOR 3-PHASE SOLUTION - START >>>>>>>>>>
#
      - name: sa_data_by_5min_history_load_air_conditioner
        unique_id: sa_data_by_5min_history_load_air_conditioner
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].load_air_conditioner|is_number) -%}
            {%- set ns = namespace( sensor_values = [] ) -%}
            {%- for sensor_data in value_json.data | rejectattr('load_air_conditioner', 'equalto', None) -%}
              {%- if loop.index > (loop.length - 28 ) -%}
                {%- set ns.sensor_values = ns.sensor_values + [ ((sensor_data.load_air_conditioner|float) * 12.0 / 1000) | round(2) ] -%}
              {%- endif -%}
            {%- endfor -%}
            {{- ns.sensor_values -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_history_load_air_conditioner.state|default("unavailable") -}}
          {%- endif -%}

      - name: sa_data_by_5min_history_load_ev_charger
        unique_id: sa_data_by_5min_history_load_ev_charger
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].load_ev_charger|is_number) -%}
            {%- set ns = namespace( sensor_values = [] ) -%}
            {%- for sensor_data in value_json.data | rejectattr('load_ev_charger', 'equalto', None) -%}
              {%- if loop.index > (loop.length - 28 ) -%}
                {%- set ns.sensor_values = ns.sensor_values + [ ((sensor_data.load_ev_charger|float) * 12.0 / 1000) | round(2) ] -%}
              {%- endif -%}
            {%- endfor -%}
            {{- ns.sensor_values -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_history_load_ev_charger.state|default("unavailable") -}}
          {%- endif -%}

      - name: sa_data_by_5min_history_load_hot_water
        unique_id: sa_data_by_5min_history_load_hot_water
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].load_hot_water|is_number) -%}
            {%- set ns = namespace( sensor_values = [] ) -%}
            {%- for sensor_data in value_json.data | rejectattr('load_hot_water', 'equalto', None) -%}
              {%- if loop.index > (loop.length - 28 ) -%}
                {%- set ns.sensor_values = ns.sensor_values + [ ((sensor_data.load_hot_water|float) * 12.0 / 1000) | round(2) ] -%}
              {%- endif -%}
            {%- endfor -%}
            {{- ns.sensor_values -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_history_load_hot_water.state|default("unavailable") -}}
          {%- endif -%}

      - name: sa_data_by_5min_history_load_stove
        unique_id: sa_data_by_5min_history_load_stove
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].load_stove|is_number) -%}
            {%- set ns = namespace( sensor_values = [] ) -%}
            {%- for sensor_data in value_json.data | rejectattr('load_stove', 'equalto', None) -%}
              {%- if loop.index > (loop.length - 28 ) -%}
                {%- set ns.sensor_values = ns.sensor_values + [ ((sensor_data.load_stove|float) * 12.0 / 1000) | round(2) ] -%}
              {%- endif -%}
            {%- endfor -%}
            {{- ns.sensor_values -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_history_load_stove.state|default("unavailable") -}}
          {%- endif -%}
#
### DELETE FOR 3-PHASE SOLUTION - END <<<<<<<<<<
#

# 18-May-23 - CHANGED - added time stamp attribute.
      - name: sa_data_by_5min_history_time_stamp_count
        unique_id: sa_data_by_5min_history_time_stamp_count
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].energy_consumed|is_number) -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('energy_consumed', 'equalto', None) | list -%}
            {{- most_recent_sensor_data|count -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_5min_history_time_stamp_count.state|default("unavailable") -}}
          {%- endif -%}
        json_attributes_path: "$.data[0]"
        json_attributes: "t_stamp"


# -----------------------------------------------------------------------------
#
# Solar Analytics - get live per minute power data - added 9-Jul-22.
# Used to generate most recent power information.
# 
# 4-Mar-23 - changed to 60 seconds (could be 30s to improve power management responsiveness - if required).
#
# Note: this is not a published API 'get', but is used by the SA portal to display minute to minute power for a site.
#
  - resource_template: https://portal.solaranalytics.com.au/api/v3/live_site_data?site_id={{- states('input_text.sa_site_id') -}}&last_six=true
    headers: 
      Authorization: >
        {{ 'Bearer ' ~ state_attr('sensor.sa_auth_token','token') }}
    scan_interval: 60
    sensor:

# Timestamp of the latest power data.
      - name: sa_live_site_data_time_stamp
        unique_id: sa_live_site_data_time_stamp
        value_template: >
          {%- if value_json|is_defined
              and value_json.data[0]|is_defined 
              and value_json.data[0].consumed|is_number -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('consumed', 'equalto', None) | list | last -%}
            {{- as_timestamp(most_recent_sensor_data.t_stamp) | timestamp_custom ('%Y-%m-%d %H:%M:%S') -}}
          {%- else -%}
            {{- states.sensor.sa_live_site_data_time_stamp.state  
                if states.sensor.sa_live_site_data_time_stamp.state is defined 
                else "unavailable" 
              -}}
          {%- endif -%}

# Minutely updated "raw" power sensors as provided by Solar Analytics.
      - name: sa_live_site_data_consumed
        unique_id: sa_live_site_data_consumed
        value_template: >
          {%- if value_json|is_defined
              and value_json.data[0]|is_defined 
              and value_json.data[0].consumed|is_number -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('consumed', 'equalto', None) | list | last -%}
            {{- most_recent_sensor_data.consumed -}}
          {%- else -%}
            {{- states.sensor.sa_live_site_data_consumed.state 
                if states.sensor.sa_live_site_data_consumed.state|is_number 
                else "unavailable" 
              -}}
          {%- endif -%}

      - name: sa_live_site_data_generated
        unique_id: sa_live_site_data_generated
        value_template: >
          {%- if value_json|is_defined
              and value_json.data[0]|is_defined 
              and value_json.data[0].generated|is_number -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('generated', 'equalto', None) | list | last -%}
            {{- most_recent_sensor_data.generated -}}
          {%- else -%}
            {{- states.sensor.sa_live_site_data_generated.state  
                if states.sensor.sa_live_site_data_generated.state|is_number 
                else "unavailable" 
              -}}
          {%- endif -%}

# Additional minutely updated "raw" sensor derived from Solar Analytics sourced data. A positive 
# value is power been drawn from the grid (imported) and a negative value is power being fed into
# the grid (exported).
      - name: sa_live_site_data_imported_exported
        unique_id: sa_live_site_data_imported_exported
        value_template: >
          {%- if value_json|is_defined
              and value_json.data[0]|is_defined 
              and value_json.data[0].consumed|is_number -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('consumed', 'equalto', None) | list | last -%}
            {{- ( most_recent_sensor_data.consumed|float(0.0) 
                  - most_recent_sensor_data.generated|float(0.0) 
                ) | default('unavailable') 
              -}}
          {%- else -%}
            {{- states.sensor.sa_live_site_data_imported_exported.state  
                if states.sensor.sa_live_site_data_imported_exported.state|is_number 
                else "unavailable" 
              -}}
          {%- endif -%}

# -----------------------------------------------------------------------------
#
# Solar Analytics - get hourly cumulative expected energy data for the day.
# Used to report today's total expected generated energy to the most recent hour - a time lagging 
# report of expected, and not a forecast.
# Notes: this is not a published API 'get', but is used by the SA portal. 
# The get also retrieves the daily total for the most recent hour for generated and consumed energy; 
# not required given 5 min updates of the same above. Checked every 30 minutes for changes in the last hour.
#

#
# Total Energy Generated Expected
# Added 24-Jan-23 - initial version.
#
  - resource_template: https://portal.solaranalytics.com.au/api/v2/site_data/{{- states('input_text.sa_site_id') -}}?all=false&gran=day&losses=true&power=false&trunc=false&tstart={{- now().strftime("%Y%m%d") -}}&tend={{- now().strftime("%Y%m%d") -}}
    headers: 
      Authorization: >
        {{ 'Bearer ' ~ state_attr('sensor.sa_auth_token','token') }}
    scan_interval: 1800
    sensor:
      - name: sa_data_by_hour_time_stamp
        unique_id: sa_data_by_hour_time_stamp
        value_template: >-
          {{- as_timestamp(now()) | timestamp_custom ('%Y-%m-%d %H:%M:%S') -}}
# The rest get timestamp is only the current date - rather use the current date-time of the get.
#      {{ as_timestamp(value_json['data'][0].t_stamp) | timestamp_custom ('%Y-%m-%d %H:%M:%S') }}
      - name: sa_data_by_hour_generated_expected
        unique_id: sa_data_by_hour_generated_expected
        value_template: >
          {%- if value_json|is_defined
              and value_json.data[0]|is_defined 
              and value_json.data[0].energy_expected|is_number -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('energy_expected', 'equalto', None) | list | last -%}
            {{- most_recent_sensor_data.energy_expected -}}
          {%- else -%}
            {{- states.sensor.sa_data_by_hour_generated_expected.state  
                if states.sensor.sa_data_by_hour_generated_expected.state|is_number 
                else "unavailable" 
              -}}
          {%- endif -%}

sensor:

  - platform: template
    sensors:

# Solar Analytics status sensors
      sa_dashboard_status:
        friendly_name: "Dashboard Status"
        unique_id: sa_dashboard_status
        value_template: "{{- state_attr('sensor.sa_status', 'dashboard_status') -}}"
      sa_mer_status:
        friendly_name: "System Status"
        unique_id: sa_mer_status
        value_template: "{{- state_attr('sensor.sa_status', 'mer_status') -}}"
      sa_mer_percentage: 
        friendly_name: "PV Performance"
        unique_id: sa_mer_percentage
        value_template: "{{- state_attr('sensor.sa_status', 'mer_percentage') -}}"
        unit_of_measurement: "%"

# Solar Analytics todays total energy sensors
      sa_todays_energy_consumed_total:
        friendly_name: "Total Energy Consumed"
        unique_id: sa_todays_energy_consumed_total        
        unit_of_measurement: "Wh"
        value_template: >-
          {{- states.sensor.sa_data_by_5min_energy_consumed_total.state 
              if states.sensor.sa_data_by_5min_energy_consumed_total.state|is_number
              else this.state|default(0.0)
            -}}
        icon_template: mdi:home-lightning-bolt-outline
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

      sa_todays_energy_generated_total:
        friendly_name: "Total Energy Generated"
        unique_id: sa_todays_energy_generated_total
        unit_of_measurement: "Wh"
        value_template: >-
          {{- states.sensor.sa_data_by_5min_energy_generated_total.state 
              if states.sensor.sa_data_by_5min_energy_generated_total.state|is_number
              else this.state|default(0.0)
            -}}
        icon_template: mdi:solar-power
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

#
### DELETE FOR 3-PHASE SOLUTION - START >>>>>>>>>>
#
      sa_todays_air_conditioner_total:
        friendly_name: "Heating Cooling Energy"
        unique_id: sa_todays_air_conditioner_total
        unit_of_measurement: "Wh"
        value_template: >-
          {{- states.sensor.sa_data_by_5min_load_air_conditioner_total.state
              if states.sensor.sa_data_by_5min_load_air_conditioner_total.state|is_number
              else this.state|default(0.0)
            -}}
        icon_template: mdi:hvac
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

      sa_todays_electric_vehicle_total:
        friendly_name: "Electric Vehicle Energy"
        unique_id: sa_todays_electric_vehicle_total
        unit_of_measurement: "Wh"
        value_template: >-
          {{- states.sensor.sa_data_by_5min_load_ev_charger_total.state
              if states.sensor.sa_data_by_5min_load_ev_charger_total.state|is_number
              else this.state|default(0.0)
            -}}
        icon_template: mdi:car-electric
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

      sa_todays_hot_water_total:
        friendly_name: "Hot Water Energy"
        unique_id: sa_todays_hot_water_total
        unit_of_measurement: "Wh"
        value_template: >-
          {{- states.sensor.sa_data_by_5min_load_hot_water_total.state
              if states.sensor.sa_data_by_5min_load_hot_water_total.state|is_number
              else this.state|default(0.0)
            -}}
        icon_template: mdi:shower-head
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

      sa_todays_stove_oven_total:
        friendly_name: "Stove Oven Energy"
        unique_id: sa_todays_stove_oven_total
        unit_of_measurement: "Wh"
        value_template: >-
          {{- states.sensor.sa_data_by_5min_load_stove_total.state
              if states.sensor.sa_data_by_5min_load_stove_total.state|is_number
              else this.state|default(0.0)
            -}}
        icon_template: mdi:stove
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"
#
### DELETE FOR 3-PHASE SOLUTION - END <<<<<<<<<<
#

# Solar Analytics derived total energy sensors
      sa_todays_energy_imported:
        friendly_name: "Total Energy Imported"
        unique_id: sa_todays_energy_imported
        unit_of_measurement: "Wh"
        value_template: >-
          {{- states.sensor.sa_data_by_5min_imported_total.state
              if states.sensor.sa_data_by_5min_imported_total.state|is_number
              else this.state|default(0.0)
            -}}
        icon_template: mdi:transmission-tower-export
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

      sa_todays_energy_exported:
        friendly_name: "Total Energy Exported"
        unique_id: sa_todays_energy_exported
        unit_of_measurement: "Wh"
        value_template: >-
          {{- states.sensor.sa_data_by_5min_exported_total.state
              if states.sensor.sa_data_by_5min_exported_total.state|is_number
              else this.state|default(0.0)
            -}}
        icon_template: mdi:transmission-tower-import
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

#
### DELETE FOR 3-PHASE SOLUTION - START >>>>>>>>>>
#

#
# EV Charging Energy Generated and Imported
# Added 25-Mar-23 - initial version.
#
# Note: sa_todays_electric_vehicle_generated and sa_todays_electric_vehicle_imported only sum the Wh
# consumed while actually charging. Charger standby energy consumption is not included, but will be
# apparent where the sum of the two sensors is slightly less than sa_todays_electric_vehicle_total.
#
# 18-May-23 - CHANGED - corrected calculations
      sa_todays_electric_vehicle_generated:
        friendly_name: "Electric Vehicle Energy Generated"
        unique_id: sa_todays_electric_vehicle_generated
        unit_of_measurement: "Wh"
        value_template: "{{- states.sensor.sa_data_by_5min_load_ev_charger_generated.state -}}"
        icon_template: mdi:car-electric
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"
          ev_energy_last5min: >
            {%- if ( states.sensor.sa_data_by_5min_load_ev_charger.state|is_number ) 
                and ( states.sensor.sa_data_by_5min_energy_consumed.state|is_number ) 
                and ( states.sensor.sa_data_by_5min_energy_generated.state|is_number ) 
              -%}
              {%- if states.sensor.sa_data_by_5min_load_ev_charger.state|float(0.0) > 0.0 -%} 
                {%- if (states.sensor.sa_data_by_5min_energy_generated.state|float(0.0)) 
                    >= (states.sensor.sa_data_by_5min_energy_consumed.state|float(0.0)) 
                  -%}
                  {{- states.sensor.sa_data_by_5min_load_ev_charger.state|float(0.0) -}}
                {%- elif (states.sensor.sa_data_by_5min_energy_generated.state|float(0.0)) 
                    > ( (states.sensor.sa_data_by_5min_energy_consumed.state|float(0.0)) 
                      - (states.sensor.sa_data_by_5min_load_ev_charger.state|float(0.0)) )
                  -%}
                  {%- set ev_generated = (states.sensor.sa_data_by_5min_energy_generated.state|float(0.0))
                      - ( (states.sensor.sa_data_by_5min_energy_consumed.state|float(0.0))
                          - (states.sensor.sa_data_by_5min_load_ev_charger.state|float(0.0)) ) 
                    -%}
                  {{- (ev_generated|float|round(4)) if (ev_generated|float) > 0.0 else 0.0 -}}
                {% else %}
                  0.0
                {%- endif -%}
              {%- else -%}
                0.0
              {%- endif -%}
            {%- else -%}
              {{- state_attr( 'sensor.sa_todays_electric_vehicle_generated', 'ev_energy_last5min' ) 
                  if states.sensor.sa_todays_electric_vehicle_generated.attributes.ev_energy_last5min|is_number
                  else 0.0 
                -}}
            {%- endif -%}
          percentage_of_total: >
            {%- if ( states.sensor.sa_data_by_5min_load_ev_charger_generated.state|is_number ) 
                and ( states.sensor.sa_data_by_5min_load_ev_charger_total.state|is_number ) 
              -%}
              {% if ( states.sensor.sa_data_by_5min_load_ev_charger_total.state|float(0.0) > 0.0 ) -%}
                {{- (( states.sensor.sa_data_by_5min_load_ev_charger_generated.state|float(0.0) ) 
                    / (states.sensor.sa_data_by_5min_load_ev_charger_total.state|float(1.0)) * 100.0 ) | int | default('none') 
                  -}}
              {%- else -%}
                none
              {%- endif -%}
            {%- else -%}
              none
            {%- endif -%}

      sa_todays_electric_vehicle_imported:
        friendly_name: "Electric Vehicle Energy Imported"
        unique_id: sa_todays_electric_vehicle_imported
        unit_of_measurement: "Wh"
        value_template: "{{- states.sensor.sa_data_by_5min_load_ev_charger_imported.state -}}"
        icon_template: mdi:car-electric
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"
          ev_energy_last5min: >
            {%- if ( states.sensor.sa_data_by_5min_load_ev_charger.state|is_number ) 
                and ( states.sensor.sa_data_by_5min_energy_consumed.state|is_number ) 
                and ( states.sensor.sa_data_by_5min_energy_generated.state|is_number ) 
              -%}
              {%- if states.sensor.sa_data_by_5min_load_ev_charger.state|float(0.0) > 0.0 -%} 
                {%- if (states.sensor.sa_data_by_5min_energy_generated.state|float(0.0)) 
                    < (states.sensor.sa_data_by_5min_energy_consumed.state|float(0.0)) 
                  -%}
                  {%- if (states.sensor.sa_data_by_5min_energy_generated.state|float(0.0))
                      <= ( (states.sensor.sa_data_by_5min_energy_consumed.state|float(0.0)) 
                        - (states.sensor.sa_data_by_5min_load_ev_charger.state|float(0.0)) ) 
                    -%}
                    {{- ( states.sensor.sa_data_by_5min_load_ev_charger.state|float(0.0) ) -}}
                  {%- else -%}
                    {{- (states.sensor.sa_data_by_5min_energy_consumed.state|float(0.0)) 
                        - (states.sensor.sa_data_by_5min_energy_generated.state|float(0.0)) 
                      -}}
                  {%- endif -%}
                {%- else -%}
                  0.0
                {%- endif -%}
              {% else %}
                0.0
              {% endif %}
            {%- else -%}
              {{- state_attr( 'sensor.sa_todays_electric_vehicle_imported', 'ev_energy_last5min' ) 
                  if states.sensor.sa_todays_electric_vehicle_imported.attributes.ev_energy_last5min|is_number 
                  else 0.0 
                -}}
            {%- endif -%}
          percentage_of_total: >
            {%- if ( states.sensor.sa_data_by_5min_load_ev_charger_imported.state|is_number ) 
                and ( states.sensor.sa_data_by_5min_load_ev_charger_total.state|is_number ) 
              -%}
              {%- if ( states.sensor.sa_data_by_5min_load_ev_charger_total.state|float(0.0) > 0.0 ) -%}
                {{- (( states.sensor.sa_data_by_5min_load_ev_charger_imported.state|float(0.0) ) 
                    / ( states.sensor.sa_data_by_5min_load_ev_charger_total.state|float(1.0) ) * 100.0) | int | default('none') 
                  -}}
              {%- else -%}
                none
              {%- endif -%}
            {%- else -%}
              none
            {%- endif -%}

# The percentage of Electric Vehicle energy that has come from locally generated sources
# - i.e. not imported.
      sa_todays_electric_vehicle_generated_percentage:
        friendly_name: "Electric Vehicle Energy Generated Percentage"
        unique_id: sa_todays_electric_vehicle_generated_percentage
        unit_of_measurement: "%"
        value_template: >
          {{- state_attr( "sensor.sa_todays_electric_vehicle_generated", "percentage_of_total" ) 
              if states.sensor.sa_todays_electric_vehicle_generated.attributes.percentage_of_total|is_number 
              else "none" 
            -}}
        icon_template: mdi:car-electric
        attribute_templates:
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"
#
### DELETE FOR 3-PHASE SOLUTION - END <<<<<<<<<<
#


# -----------------------------------------------------------------------------
#
# Solar Energy Consumed as kWh, % of generated, and % of of consumed.
# Added 4-Mar-23 - initial version.
#
      sa_todays_energy_consumed_solar:
        friendly_name: "Total Energy Consumed Solar"
        unique_id: sa_todays_energy_consumed_solar
        unit_of_measurement: "Wh"
        value_template: >-
          {{- states.sensor.sa_data_by_5min_consumed_solar_total.state 
              if states.sensor.sa_data_by_5min_consumed_solar_total.state|is_number 
              else "unavailable" 
            -}}
        icon_template: mdi:solar-power
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_live_site_data_time_stamp.state -}}"

      sa_todays_energy_generated_expected_total:
        friendly_name: "Total Energy Generated Expected"
        unique_id: sa_todays_energy_generated_expected_total
        unit_of_measurement: "Wh"
        value_template: >-
          {{- states.sensor.sa_data_by_hour_generated_expected.state 
              if states.sensor.sa_data_by_hour_generated_expected.state|is_number 
              else "unavailable" 
            -}}
        icon_template: mdi:solar-power
        device_class: "energy"
        attribute_templates:
          state_class: total_increasing
          time_stamp: "{{- states.sensor.sa_data_by_hour_time_stamp.state -}}"

#
# 18-May-23 - CHANGED - fixed calculation logic where total energy generated at start of the day
# could be negative (i.e. the inverter has consumed energy at start-up).
#
# Percentage of generated energy that has been consumed.
# Only shows valid sensor when the daily generated solar energy is greater than 100Wh.
      sa_todays_generated_consumed_percentage:
        friendly_name: "Percentage Generated Energy Consumed"
        unique_id: sa_todays_generated_consumed_percentage
        unit_of_measurement: "%"
        value_template: >
          {%- if (states.sensor.sa_data_by_5min_consumed_solar_total.state|is_number) 
              and (states.sensor.sa_data_by_5min_energy_generated_total.state|is_number) 
            -%}
            {%- if (states('sensor.sa_data_by_5min_consumed_solar_total')|float
                  < states('sensor.sa_data_by_5min_energy_generated_total')|float)
                and (states('sensor.sa_data_by_5min_consumed_solar_total')|float > 100.0)                
              -%}
              {{- ( (states('sensor.sa_data_by_5min_consumed_solar_total') | float) 
                    / (states('sensor.sa_data_by_5min_energy_generated_total') | float) * 100.0 ) 
                  | round(1) 
                -}}
            {%- else -%}
              100.0
            {%- endif -%}
          {%- else -%}
            {{- states( 'sensor.sa_todays_generated_consumed_percentage' ) 
                if states.sensor.sa_todays_generated_consumed_percentage.state|is_number 
                else "unavailable" 
              -}}
          {%- endif -%}
        icon_template: mdi:solar-power
        attribute_templates:
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

# Percentage of consumed energy that has been generated.
      sa_todays_consumed_generated_percentage:
        friendly_name: "Percentage Consumed Energy Generated"
        unique_id: sa_todays_consumed_generated_percentage
        unit_of_measurement: "%"
        value_template: >
          {%- if (states.sensor.sa_data_by_5min_energy_consumed_total.state|is_number) 
              and (states.sensor.sa_data_by_5min_consumed_solar_total.state|is_number) 
            -%}
            {%- if states('sensor.sa_data_by_5min_consumed_solar_total')|float
                  < states('sensor.sa_data_by_5min_energy_consumed_total')|float 
                and (states('sensor.sa_data_by_5min_consumed_solar_total')|float > 100.0)                
              -%}
              {{- ( (states('sensor.sa_data_by_5min_consumed_solar_total') | float) 
                    / (states('sensor.sa_data_by_5min_energy_consumed_total') | float) * 100.0 ) 
                  | round(1) 
                -}}
            {%- else -%}
              0.0
            {%- endif -%}
          {%- else -%}
            {{- states( 'sensor.sa_todays_consumed_generated_percentage' ) 
                if states.sensor.sa_todays_consumed_generated_percentage.state|is_number 
                else "unavailable" 
              -}}
          {%- endif -%}
        icon_template: mdi:solar-power
        attribute_templates:
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"


# ---------------------------------------------------------------------------
# Solar Analytics Energy history sensor for graphing each channel (e.g. in Apex Charts).
# The units are in kW.
# Added 10-Apr-23 - initial version.
#
# Note: results are 5 minute average power, with area under the graph being the energy
# usage within that time interval. The time duration is limited to 28x 5 minute intervals
# (= 2h20m) as this fits within the 255 character max allowed by the state of a sensor.
# Rounding to a reduced number of decimal places (e.g. 1 instead of 2) could increase
# the number of intervals if that's desireable, but at a lower resolution. Lastly,
# the history sensors as states from above are implemented as attributes so they
# can be readily interpreted as lists.
#
      sa_todays_energy_history:
        friendly_name: "Total Energy History"
        unique_id: sa_todays_energy_history        
        value_template: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"
        icon_template: mdi:sun-clock
        attribute_templates:
          times: >
            {%- set ns = namespace( 
                times=[],
                count = states('sensor.sa_data_by_5min_history_time_stamp_count')|int(0) 
                ) 
              -%}
            {%- for i in range(ns.count) -%}
              {%- if i > ns.count - 29 -%}
                {%- set ns.times = ns.times + [
                    as_local( 
                      as_datetime( states('sensor.sa_data_by_5min_time_stamp') )  
                      - timedelta(minutes=(ns.count*5)-((i+1)*5)) 
                      ).strftime("%Y-%m-%d %H:%M:%S")
                    ] 
                  -%}
                {% endif -%}
            {%- endfor -%}
            {{- ns.times -}}
          times_simple: "{{- states.sensor.sa_data_by_5min_history_time_stamp.state -}}"
          energy_consumed: "{{- states.sensor.sa_data_by_5min_history_energy_consumed.state -}}"
          energy_generated: "{{- states.sensor.sa_data_by_5min_history_energy_generated.state -}}"
#
### DELETE FOR 3-PHASE SOLUTION - START >>>>>>>>>>
#
          energy_load_air_conditioner: "{{- states.sensor.sa_data_by_5min_history_load_air_conditioner.state -}}"
          energy_load_ev_charger: "{{- states.sensor.sa_data_by_5min_history_load_ev_charger.state -}}"
          energy_load_hot_water: "{{- states.sensor.sa_data_by_5min_history_load_hot_water.state -}}"
          energy_load_stove: "{{- states.sensor.sa_data_by_5min_history_load_stove.state -}}"
#
### DELETE FOR 3-PHASE SOLUTION - END <<<<<<<<<<
#


# -----------------------------------------------------------------------------
#
# Solar Analytics power sensors
#
# 28-Jun-23 - CHANGED - improved error checking for valid result, if not keep previous result, else default to 0.
      sa_consumption_power:
        friendly_name: "Power Consumption"
        unique_id: sa_consumption_power
        unit_of_measurement: "W"
        value_template: >
          {{- states.sensor.sa_live_site_data_consumed.state
              if states.sensor.sa_live_site_data_consumed.state|is_number
              else states.sensor.sa_consumption_power.state|default(0.0)
            -}}
        icon_template: mdi:home-lightning-bolt-outline
        device_class: "power"
        attribute_templates:
          state_class: "measurement"
          time_stamp: "{{- states.sensor.sa_live_site_data_time_stamp.state -}}"

      sa_generation_power:
        friendly_name: "Power Generation"
        unique_id: sa_generation_power
        unit_of_measurement: "W"
        value_template: >
          {{- states.sensor.sa_live_site_data_generated.state
              if states.sensor.sa_live_site_data_generated.state|is_number
              else states.sensor.sa_generation_power.state|default(0.0)
            -}}
        icon_template: mdi:solar-power
        device_class: "power"
        attribute_templates:
          state_class: measurement
          time_stamp: "{{- states.sensor.sa_live_site_data_time_stamp.state -}}"

      sa_import_export_power:
        friendly_name: "Power Import Export"
        unique_id: sa_import_export_power
        unit_of_measurement: "W"
        value_template: >
          {{- states.sensor.sa_live_site_data_imported_exported.state
              if states.sensor.sa_live_site_data_imported_exported.state|is_number
              else states.sensor.sa_import_export_power.state|default(0.0)
            -}}
        icon_template: mdi:transmission-tower
        device_class: "power"
        attribute_templates:
          state_class: measurement
          time_stamp: "{{- states.sensor.sa_live_site_data_time_stamp.state -}}"


# -----------------------------------------------------------------------------
#
# Home Assistant Energy Management extras
# Added 10-Feb-23 - initial version
#

#
# Todays Energy Total Net Cost
#
# HA EM automatically creates two entities respectively derived from the sa_todays_energy_imported 
# and sa_todays_energy_exported, where:
#   > sa_todays_energy_imported_cost - cost of imported energy
#   > sa_todays_energy_exported_compensation - revenue from exported energy
# This new entity provides the net cost (imported cost minus exported revenue)
#
      sa_todays_energy_total_net_cost:
        friendly_name: "Todays Energy Total Net Cost"
        unique_id: sa_todays_energy_total_net_cost
        unit_of_measurement: "AUD"
        device_class: "monetary"
        icon_template: mdi:cash
        value_template: >
          {{- (states.sensor.sa_todays_energy_imported_cost.state|float(0.0)) 
              - (states.sensor.sa_todays_energy_exported_compensation.state|float(0.0)) 
            -}}
        attribute_templates:
          state_class: total_increasing
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

template:

#
# Todays Energy Import Rate
#
# Useful for those on a variable electricity import/general rate configured in the HA Energy Manager 
# (e.g. peak/off-peak/shoulder, Amber Energy wholesale spot market pricing). The average import 
# rate $/kWh = cumulative exported energy kWh divided by the cumulative imported energy revenue $. 
# Resets to zero at midnight. The sensor sa_todays_energy_imported_cost is created by the 
# HA Energy Manager when appropriate pricing is set-up for energy drawn from the grid.
#
# Defaults to 'none' when the imported total Wh is < 100.
#
  - trigger:
    - platform: state
      entity_id: sensor.sa_todays_energy_imported_cost
    sensor:
      - name: "Todays Energy Import Rate"
        unique_id: sa_todays_energy_import_rate
        unit_of_measurement: "$/kWh"
        device_class: "monetary"
        icon: mdi:cash-plus
        state: >
          {%- if ( states.sensor.sa_data_by_5min_imported_total.state|is_number ) 
              and ( states.sensor.sa_todays_energy_imported_cost.state|is_number ) -%}
            {%- if (states.sensor.sa_data_by_5min_imported_total.state|int) > 100 -%}
              {{- ( (states.sensor.sa_todays_energy_imported_cost.state|float) 
                    / (states.sensor.sa_data_by_5min_imported_total.state|float) 
                    * 1000.0 ) 
                  | round(3) 
                -}}
            {%- else -%}
              none
            {%- endif -%}
          {%- else -%}
            unavailable
          {%- endif -%}
        attributes: 
          state_class: measure
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

#
# Todays Energy Export Rate
#
# Useful for those on a variable electricity feed-in (FIT) rate configured in the HA Energy Manager 
# (e.g. peak/off-peak/shoulder, Amber Energy wholesale spot market pricing). The average export 
# rate $/kWh = cumulative exported energy kWh divided by the cumulative exported energy revenue $. 
# Resets to zero at midnight. The sensor sa_todays_energy_exported_compensation is created by the 
# HA Energy Manager when appropriate pricing is set-up for energy returned to the grid. 
#
# Defaults to 'none' when the exported total Wh is < 100.
#
  - trigger:
    - platform: state
      entity_id: sensor.sa_todays_energy_exported_compensation
    sensor:
      - name: "Todays Energy Export Rate"
        unique_id: sa_todays_energy_export_rate
        unit_of_measurement: "$/kWh"
        device_class: "monetary"
        icon: mdi:cash-plus
        state: >
          {%- if ( states.sensor.sa_data_by_5min_exported_total.state|is_number ) 
              and ( states.sensor.sa_todays_energy_exported_compensation.state|is_number ) -%}
            {%- if (states.sensor.sa_data_by_5min_exported_total.state|int) > 100 -%}
              {{- ( (states.sensor.sa_todays_energy_exported_compensation.state|float) 
                    / (states.sensor.sa_data_by_5min_exported_total.state|float) 
                    * 1000.0 ) 
                  | round(3) 
                -}}
            {%- else -%}
              none
            {%- endif -%}
          {%- else -%}
            unavailable
          {%- endif -%}
        attributes:
          state_class: measure
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

# -----------------------------------------------------------------------------

[Roving-Ronin]

@PeterH24x7 here's a 3p version with non applicable code removed.

# - DRAFT RELEASE 6 CODE - FOR TESTING ----------------------------------------------------------------------------
#
# SOLAR ANALYTICS integration for Home Assistant Energy Monitoring
# 
# Developed by Peter Hormann and with thanks to Glen S and Roving-Ronin for their contributions.
#
# Created: 7-Jan-2022
#
# Last updated: 15-Apr-2023 as Release 5 - see update notes below.
#
# Updates: 
#     16-Jan-2022 - INITIAL RELEASE 1
#                 - Added power reporting (last 5 minute average).
#     16-Jul-2022 - RELEASE 2
#                 - Enabled more accurate and more frequent 1 minute power reporting
#                 - Added 5 minute energy updates for all channels
#                 - Moved sa_site_id to secrets.yaml.
#     20-Aug-2022 - RELEASE 3
#                 - Added some error checking to deal with daily energy total errors when the 
#                   data get is 'unavailable' or 'unknown'
#                 - Removed "force_update: true" - where the data get may be 'unavailable'
#                 - Removed "state_class: measurement" and "device_class: energy" for rest platform 
#                   sensors (not applicable)
#     10-Feb-2023 - RELEASE 4
#                 - Added "unique_id" to each sensor entity (including existing) to enable HA 
#                   Lovelace based settings changes.
#                 - Added new "Total Energy Generated Expected" sensor to provide daily cumulative 
#                   expected energy (as per the Solar Analytics portal).
#                 - Added kW sensors as conversions of their respective W counterpart (note: not 
#                   required for energy entities as of HA 2023.2).
#                 - Where HA EM is used for cost calculations added "Todays Energy Total Net Cost" 
#                   (import cost minus feed-in revenue).
#                 - For those on variable energy rates (e.g. Amber) created new sensors "Todays Energy 
#                   Import Rate" and "Todays Energy Export Rate".
#     10-Apr-2023 - RELEASE 5
#                 - Added "unique_id" to each REST sensor.
#                 - Implemented token authentication with timer based refresh using username/password.
#                 - Updated REST sensors to use token authentication.
#                 - Changed sa_live_site_data to 60s scan_interval (avoid repeated update at 30s 
#                   interval where data actually only changes every minute - some users may consider 
#                   changing back to 30s to reduce the delay to update).
#                 - Added time_stamp attribute to sa_todays_energy_total_net_cost, 
#                   sa_todays_energy_import_rate and sa_todays_energy_export_rate.
#                 - Added 3x new sensors sa_todays_energy_consumed_solar (Wh), 
#                   sa_todays_generated_consumed_percentage (%) and 
#                   sa_todays_consumed_generated_percentage (%).
#                 - Added automation sa_refresh_all_rest_gets to manually force refesh of all REST 
#                   data gets.
#                 - Added sa_todays_electric_vehicle_generated and sa_todays_electric_vehicle_imported as
#                   breakdown of the daily EV charging energy into generated and imported sourced energy.
#                   Does not include EV charger standby energy and the sum of these sensors may differ
#                   slightly from sa_todays_electric_vehicle_total. Attributes include last 5 minute
#                   energy and % of total.
#                 - Modified all REST gets from template platform rest to RESTful sensors. Required to 
#                   solve overflowing attributes.data for sa_data_by_5min. Also resolves many of the
#                   sensor unit issues (ie. Wh/kWh and W/kW).
#                 - Added Energy history sensor for graphing each SA channel (e.g. in Apex Charts).
#                   Note: results are 5 minute average power (kW), with area under the graph being the energy
#                   usage within that time interval. The time duration is limited to 28x 5 minute intervals
#                   (= 2h20m) as this fits within the 255 character max allowed by the state of a sensor.
#                   Rounding to a reduced number of decimal places (e.g. 1 instead of 2) could increase
#                   the number of intervals if that's desireable, but at a lower resolution.
#       18-May-23 - RELEASE 6 MINOR FIXES
#                 - sa_data_by_5min_meter_reset is depracated as not used/required (separate Amber code
#                   has own midnight meter trigger). Uncomment if required.
#                 - sa_data_by_5min_exported_total and sa_data_by_5min_consumed_solar_total added error
#                   and generated negative value testing.
#                 - sa_data_by_5min_load_ev_charger_generated and sa_data_by_5min_load_ev_charger_imported
#                   corrected calculation - minor missing logic.
#                 - sa_data_by_5min_history_time_stamp_count added time_stamp attribute.
#                 - sa_todays_electric_vehicle_generated and sa_todays_electric_vehicle_imported corrected
#                   calculations for ev_energy_last5min attribute.
#                 - sa_todays_generated_consumed_percentage and sa_todays_consumed_generated_percentage
#                   fixed calculation logic where total energy generated at start of the day
#                   could be negative (i.e. the inverter has consumed energy at start-up).
#
# This code is provided as-is and without any warrantee or guarantees. 
# Further public contributions and enhancements are welcomed.
# 
# INSTALLATION - NEW: 
#   1. Copy this yaml file to the HA config directory.
#   2. Include this file name as a package in the HA configuration.yaml. 
#      For example -
#        packages:
#          pack_1: !include solar_analytics.yaml
#   3. Define sa_username, sa_password and sa_site_id (e.g. 36304) in the secrets.yaml file (see
#      example on github).
#   4. Using HA Developer Tools check the configuration and restart.  From States, review the 
#      attributes for sa_data_by_5min to identify the device specific channel names and 
#      update/delete the sa_todays_... xyz sensors to suit.
#   5. Add the new energy sensors from 4. above to the HA Energy Manager as "Monitor 
#      Individual Devices". Go to HA Settings and then search for “Energy Configuration” 
#      to make the changes.
#   6. Also in HA Energy Configuration, enter the details for
#      > Grid consumption - as sa_todays_energy_imported
#      > Return to grid - as sa_todays_energy_exported
#      > Solar production - as sa_todays_energy_generated_total
#   7. If all working is correctly, the Energy dashboard should start populating data within 
#      a couple of hours.
#   8. If HA EM "Grid Consumption" and "Return to grid" are configured with energy pricing 
#      details, then the sa_todays_energy_imported_cost and sa_todays_energy_imported_cost sensors 
#      should be auto-created by the Energy Manager. These sensors can be found as hidden Entities 
#      (which can't be changed or deleted). If all good, then the sa_todays_energy_import_rate 
#      (daily av. $/kWh), sa_todays_energy_export_rate (daily av. $/kWh) and
#      sa_todays_energy_total_net_cost ($) should work without further config. If no pricing 
#      is set, then delete these 3x sensors from the configuration.
#   9. Enjoy!
#
# UPGRADING - FROM A PREVIOUS VERSION:
#   This upgrade should not break the sensors created in a previous versions. It's recommended that the 
#   previous version solar_analytics.yaml should be deleted, HA restarted, the new solar_analytics.yaml
#   copied to the <config> folder and then HA restarted again. The sensors should start repopulating
#   within their refresh timecycles. If any duplicate sensors happen to be created, go to HA Settings ->
#   Devices & Services -> Entities and delete any "sa_..." prefixed sensors showing as unavailable or
#   disabled, then restart once more and the correctly named sensor and its data should be restored
#   to normal. Alternatively go to 'Developer Tools -> Services' and select 'Recorder: Purge Entities' 
#   and then 'Choose entity' and select all the "sa_..." entities needing to purge immediately.
#
# If you find my work useful, please buy me a coffee ... thank you!
#   https://www.buymeacoffee.com/peter24x7
#
# Reference for more information and updates:
#   https://github.com/PeterH24x7/-Solar-Analytics-integration-for-Home-Assistant-Energy-monitoring
#
# -----------------------------------------------------------------------------


#
# Define the Solar Analytics site_id value is required in URLs used in gets below - e.g. 36304. 
#   See the Solar Analytics user portal to find your site id or see the collected sa_site_list 
#   attributes as defined below.
#
input_text:
    sa_site_id:
      initial: !secret sa_site_id

timer:
  sa_token_expiry_timer:
    duration: 0
    icon: mdi:clock-check
    restore: true

automation:
  - id: 'sa_token_expiry_update'
    alias: SA Token Expiry update
    description: ''
    trigger:
    - platform: state
      entity_id:
      - sensor.sa_auth_token
      for:
        hours: 0
        minutes: 0
        seconds: 5
    condition: []
    action:
    - service: timer.start
      data:
        duration: '{{ states(''sensor.sa_auth_token'') | int }}'
      target:
        entity_id: timer.sa_token_expiry_timer
    mode: single
  - id: 'sa_token_refresh_on_timer_expiry'
    alias: SA Token refresh on Timer expiry
    description: ''
    trigger:
    - platform: state
      entity_id:
      - timer.sa_token_expiry_timer
      to: idle
      for:
        hours: 0
        minutes: 0
        seconds: 5
    condition: []
    action:
    - service: homeassistant.update_entity
      data: {}
      target:
        entity_id: sensor.sa_auth_token
    mode: single

  - id: 'sa_refresh_all_rest_gets'
    alias: SA Refresh all REST data gets
    description: "Automation that can be manually run to refresh all REST data gets."
    trigger: []
    condition: []
    action:
      - service: homeassistant.update_entity
        data: {}
        target:
          entity_id:
            - sensor.sa_data_by_5min_extract
    mode: single



# -----------------------------------------------------------------------------
#
# Solar Analytics - rest get of latest token using username and password credentials.
#   - Auto updates every 2 hours, else on sa_token_expiry_timer via automation.
# Added 25-Feb-23 to replace repeated username and password authentication.
#
rest:
  - resource: "https://portal.solaranalytics.com.au/api/v3/token"
    authentication: basic
    username: !secret sa_username
    password: !secret sa_password
    scan_interval: 7200
    sensor:
      - name: sa_auth_token
        unique_id: sa_auth_token
        value_template: "{{ value_json['duration'] }}"
        json_attributes:
          - "token"
          - "expires"

# -----------------------------------------------------------------------------
#  
# Solar Analytics - get the site details associated with the given user account login.
# Updated every 24 hours.
#
# Note: assumes only a single device per account, there could be a second device (e.g. replaced 
# device due to fault/upgrade) at $.data.[1]
#
  - resource: "https://portal.solaranalytics.com.au/api/v3/site_list?hardware=true&capacity=true&subscription=true"
    headers: 
      Authorization: >
        {{ 'Bearer ' ~ state_attr('sensor.sa_auth_token','token') }}
    scan_interval: 62400
    sensor:
      - name: sa_site_list
        unique_id: sa_site_list
        value_template: "{{ now() }}"
        json_attributes_path: "$.data.[0]"
        json_attributes:
          - "e_status"
          - "fault_class"
          - "fault_id*"
          - "has_pv"
          - "mer_status"
          - "overall_status"
          - "retailer_user"
          - "s_cli_site_name"
          - "site_id"
          - "site_inactive"
          - "capacity"
          - "devices"
          - "sub_type"
    
# -----------------------------------------------------------------------------
#
# Solar Analytics - get the site status for the specified site_id.
# Updated every hour.
#
  - resource_template: https://portal.solaranalytics.com.au/api/v3/site_status/{{- states('input_text.sa_site_id') -}}
    headers: 
      Authorization: >
        {{ 'Bearer ' ~ state_attr('sensor.sa_auth_token','token') }}
    scan_interval: 3600
    sensor:
      - name: sa_status
        unique_id: sa_status
        value_template: "{{ value_json['data']['mer_status'] }}"
        json_attributes_path: "$.data"
        json_attributes:
          - "dashboard_status"
          - "event_id"
          - "event_list"
          - "fault_status"
          - "mer_percentage"
          - "mer_status"
          - "mer_text"


# -----------------------------------------------------------------------------
#
# Solar Analytics - get 5 minute energy data.
# Used to calculate today's cumulative total energy for consumed, generated, imported and exported 
# energy as used by the HA Energy module.
# Updated every 5 minutes.
#
# 15-Jul-22 - added trunc=false to include decimal components of 5 minute date (default is true). 
#    Also added air conditioner, EV, hot water and stove-oven energy loads as shown in the attributes of sa_data_by_5min. 
#    These channels should be added/edited/deleted to match the specific device set-up.
#
  - resource_template: https://portal.solaranalytics.com.au/api/v2/site_data/{{- states('input_text.sa_site_id') -}}?all=true&gran=minute&trunc=false&power=false&tstart={{- now().strftime("%Y%m%d") -}}&tend={{- now().strftime("%Y%m%d") -}}
    headers: 
      Authorization: >
        {{ 'Bearer ' ~ state_attr('sensor.sa_auth_token','token') }}
    scan_interval: 300
    sensor:

# Timestamp of the latest energy data.
      - name: sa_data_by_5min_time_stamp
        unique_id: sa_data_by_5min_time_stamp
        value_template: >
          {% if (value_json is defined) and (value_json.data[0].t_stamp is defined) %}
            {% set most_recent_sensor_data = value_json['data'] | rejectattr('energy_consumed', 'equalto', None) | list | last %}
              {{ most_recent_sensor_data.t_stamp }}
          {% else %}
            unavailable
          {% endif %}

# 18-May-23 - DEPRECATED - no longer required.
#
# Sensor that indicates that the energy sensors have reset (i.e. at midnight each day)
#      - name: sa_data_by_5min_meter_reset
#        unique_id: sa_data_by_5min_meter_reset
#        value_template: >
#          {%- if (value_json is defined) %}
#            {% set most_recent_sensor_data = value_json['data'] | rejectattr('energy_consumed', 'equalto', None) | list %}
#            {% if most_recent_sensor_data|count == 1 %}
#              true
#            {% else %}
#              false
#            {% endif %}
#          {% else %}
#            unavailable
#          {% endif %}
#        json_attributes_path: "$.data[0]"
#        json_attributes: "t_stamp"

# The last 5 minutes energy by sensor type per Solar Analytics channel. 
# These sensors may be useful for calculating energy cost where energy costs vary at intervals down 
# to 5 minutes (e.g. Amber Electric). The may also be useful for configuring "Utility Meter" helpers in HA.
      - name: sa_data_by_5min_energy_consumed
        unique_id: sa_data_by_5min_energy_consumed
        value_template: >
          {% if (value_json is defined) and (value_json.data[0].energy_consumed is defined) %}
            {% set most_recent_sensor_data = value_json['data'] | rejectattr('energy_consumed', 'equalto', None) | list | last %}
              {{ most_recent_sensor_data.energy_consumed }}
          {% else %}
            0.0
          {% endif %}
      - name: sa_data_by_5min_energy_generated
        unique_id: sa_data_by_5min_energy_generated
        value_template: >
          {% if (value_json is defined) and (value_json.data[0].energy_generated is defined) %}
            {% set most_recent_sensor_data = value_json['data'] | rejectattr('energy_generated', 'equalto', None) | list | last %}
              {{ most_recent_sensor_data.energy_generated }}
          {% else %}
            0.0
          {% endif %}

# Daily cumulative total "raw" sensors per Solar Analytics channel reset at midnight.
# These sensors are used for feeding "fully configured" template sensors defined further down below.
      - name: sa_data_by_5min_energy_consumed_total
        unique_id: sa_data_by_5min_energy_consumed_total
        value_template: >
          {% if (value_json is defined) and (value_json.data[0].energy_consumed is defined) %}
            {{ ( value_json.data | rejectattr( 'energy_consumed', 'equalto', None ) | sum( attribute='energy_consumed' )) | float | round(4) }}
          {% else %}
            {{ states( 'sensor.sa_data_by_5min_energy_consumed_total' ) 
              if states.sensor.sa_data_by_5min_energy_consumed_total.state is defined else "unavailable" }}
          {% endif %}
      - name: sa_data_by_5min_energy_generated_total
        unique_id: sa_data_by_5min_energy_generated_total
        value_template: >
          {% if (value_json is defined) and (value_json.data[0].energy_generated is defined) %}
            {{ ( value_json.data | rejectattr( 'energy_generated', 'equalto', None ) | sum( attribute='energy_generated' )) | float | round(4) }}
          {% else %}
            {{ states( 'sensor.sa_data_by_5min_energy_generated_total' ) 
              if states.sensor.sa_data_by_5min_energy_generated_total.state is defined else "unavailable" }}
          {% endif %}

# Additional daily cumulative total "raw" sensors that reset at midnight. 
# These sensors are derived/calculated from the main Solar Analytics channels.
      - name: sa_data_by_5min_imported_total
        unique_id: sa_data_by_5min_imported_total
        value_template: >
          {%- if (value_json is defined) 
              and (value_json.data[0].energy_consumed is defined) and (value_json.data[0].energy_generated is defined) -%}
            {%- set energy = namespace(imported=0.0) -%}
            {%- for sensor_data in value_json.data | rejectattr('energy_consumed', 'equalto', None) -%}
              {%- if (sensor_data.energy_consumed|float) > (sensor_data.energy_generated|float) -%}
                {%- if (sensor_data.energy_generated|float) > 0.0 -%}
                  {%- set energy.imported = (energy.imported|float) 
                      + (sensor_data.energy_consumed|float) - (sensor_data.energy_generated|float) -%}
                {% else %}
                  {%- set energy.imported = (energy.imported|float) + (sensor_data.energy_consumed|float) -%}
                {% endif %}
              {%- endif -%}
            {%- endfor -%}
            {{- energy.imported|float|round(4) -}}
          {%- else -%}
            {{- states( 'sensor.sa_data_by_5min_imported_total' ) 
                if states.sensor.sa_data_by_5min_imported_total.state is defined else "unavailable" -}}
          {%- endif -%}

#####
# 18-May-23 - CHANGED SENSORS
#####

# 18-May-23 - CHANGED - fixed potential bug in if statement w/o endif. Added float to comparisons and calculations.
      - name: sa_data_by_5min_exported_total
        unique_id: sa_data_by_5min_exported_total
        value_template: >
          {%- if (value_json is defined) 
              and (value_json.data[0].energy_consumed is defined) and (value_json.data[0].energy_generated is defined) -%}
            {%- set energy = namespace( exported = 0.0 ) -%}
            {%- for sensor_data in value_json.data | rejectattr('energy_generated', 'equalto', None) -%}
                {%- if sensor_data.energy_generated|float > sensor_data.energy_consumed|float -%}
                  {%- set energy.exported = energy.exported|float 
                      + sensor_data.energy_generated|float
                      - sensor_data.energy_consumed|float 
                    -%}
                {%- endif -%}
            {%- endfor -%}
            {{- energy.exported | float | round(4) -}}
          {%- else -%}
            {{- states( 'sensor.sa_data_by_5min_exported_total' ) 
                if states.sensor.sa_data_by_5min_exported_total.state is defined else "unavailable" -}}
          {%- endif -%}


# Additional "raw" sensor associated with the daily total of consumed energy that
# has been generated from local sources (i.e. not imported).
# 18-May-23 - CHANGED - fixed potential bug in where generated could be -ve. Added float to comparisons and calculations.
      - name: sa_data_by_5min_consumed_solar_total
        unique_id: sa_data_by_5min_consumed_solar_total
        value_template: >
          {%- if (value_json is defined) 
              and (value_json.data[0].energy_consumed is defined) and (value_json.data[0].energy_generated is defined) -%}
            {%- set energy = namespace( solar_consumed = 0.0 ) -%}
            {%- for sensor_data in value_json.data | rejectattr('energy_generated', 'equalto', None) -%}
              {%- if sensor_data.energy_generated|float >= sensor_data.energy_consumed|float -%}
                {%- set energy.solar_consumed = energy.solar_consumed|float 
                    + sensor_data.energy_consumed|float 
                  -%}
              {%- else -%}
                {%- set energy.solar_consumed = energy.solar_consumed|float 
                    + ( sensor_data.energy_generated 
                        if sensor_data.energy_generated|float > 0.0 else 0.0 )|float
                  -%}
              {%- endif -%}
            {%- endfor -%}
            {{- energy.solar_consumed | float | round(4) -}}
          {%- else -%}
            {{- states( 'sensor.sa_data_by_5min_consumed_solar_total' ) 
              if states.sensor.sa_data_by_5min_consumed_solar_total.state is defined else "unavailable" -}}
          {%- endif -%}

#### END CHANGED


# 
# Solar Analytics Energy history sensor for graphing each channel (e.g. in Apex Charts).
# The units are in kW.
# Added 10-Apr-23 - initial version.
#
# Note: results are actually 5 minute power, with area under the graph being the energy
# usage within that time interval. The time duration is limited to 28x 5 minute intervals
# (= 2h20m) as this fits within the 255 character max allowed by the state of a sensor.
# Rounding to a reduced number of decimal places (e.g. 1 instead of 2) could increase
# the number of intervals if that's desireable, but at a lower resolution.
#
      - name: sa_data_by_5min_history_time_stamp
        unique_id: sa_data_by_5min_history_time_stamp
        value_template: >
          {%- if (value_json is defined) %}
            {%- set ns = namespace( sensor_values = [] ) -%}
            {%- for sensor_data in value_json.data | rejectattr('energy_consumed', 'equalto', None) -%}
              {% if loop.index > (loop.length - 28 ) %}
                {%- set ns.sensor_values = ns.sensor_values + [ as_timestamp(sensor_data.t_stamp)|timestamp_custom('%H:%M') ] -%}
              {% endif %}
            {%- endfor -%}
            {{- ns.sensor_values -}}
          {%- else -%}
            {{- states( 'sensor.sa_data_by_5min_history_time_stamp' ) 
              if states.sensor.sa_data_by_5min_history_time_stamp.state is defined else "unavailable" -}}
          {%- endif -%}

      - name: sa_data_by_5min_history_energy_consumed
        unique_id: sa_data_by_5min_history_energy_consumed
        value_template: >
          {%- if (value_json is defined) %}
            {%- set ns = namespace( sensor_values = [] ) -%}
            {%- for sensor_data in value_json.data | rejectattr('energy_consumed', 'equalto', None) -%}
              {% if loop.index > (loop.length - 28 ) %}
                {%- set ns.sensor_values = ns.sensor_values + [ ((sensor_data.energy_consumed|float) * 12.0 / 1000) | round(2) ] -%}
              {% endif %}
            {%- endfor -%}
            {{- ns.sensor_values -}}
          {%- else -%}
            {{- states( 'sensor.sa_data_by_5min_history_energy_consumed' ) 
              if states.sensor.sa_data_by_5min_history_energy_consumed.state is defined else "unavailable" -}}
          {%- endif -%}

      - name: sa_data_by_5min_history_energy_generated
        unique_id: sa_data_by_5min_history_energy_generated
        value_template: >
          {%- if (value_json is defined) %}
            {%- set ns = namespace( sensor_values = [] ) -%}
            {%- for sensor_data in value_json.data | rejectattr('energy_generated', 'equalto', None) -%}
              {% if loop.index > (loop.length - 28 ) %}
                {%- set ns.sensor_values = ns.sensor_values + [ ((sensor_data.energy_generated|float) * 12.0 / 1000) | round(2) ] -%}
              {% endif %}
            {%- endfor -%}
            {{- ns.sensor_values -}}
          {%- else -%}
            {{- states( 'sensor.sa_data_by_5min_history_energy_generated' ) 
              if states.sensor.sa_data_by_5min_history_energy_generated.state is defined else "unavailable" -}}
          {%- endif -%}

#
# 18-May-23 - CHANGED - added time stamp
      - name: sa_data_by_5min_history_time_stamp_count
        unique_id: sa_data_by_5min_history_time_stamp_count
        value_template: >
          {%- if (value_json is defined) %}
            {% set most_recent_sensor_data = value_json['data'] | rejectattr('energy_consumed', 'equalto', None) | list %}
            {{ most_recent_sensor_data|count }}
          {%- else -%}
            {{- states( 'sensor.sa_data_by_5min_history_time_stamp_count' ) 
              if states.sensor.sa_data_by_5min_history_time_stamp_count.state is defined else "unavailable" -}}
          {%- endif -%}
        json_attributes_path: "$.data[0]"
        json_attributes: "t_stamp"


# -----------------------------------------------------------------------------
#
# Solar Analytics - get live per minute power data - added 9-Jul-22.
# Used to generate most recent power information.
# 
# 4-Mar-23 - changed to 60 seconds (could be 30s to improve power management responsiveness - if required).
#
# Note: this is not a published API 'get', but is used by the SA portal to display minute to minute power for a site.
#
  - resource_template: https://portal.solaranalytics.com.au/api/v3/live_site_data?site_id={{- states('input_text.sa_site_id') -}}&last_six=true
    headers: 
      Authorization: >
        {{ 'Bearer ' ~ state_attr('sensor.sa_auth_token','token') }}
    scan_interval: 60
    sensor:

# Timestamp of the latest power data.
      - name: sa_live_site_data_time_stamp
        unique_id: sa_live_site_data_time_stamp
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].consumed is defined) -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('consumed', 'equalto', None) | list | last -%}
            {{- as_timestamp(most_recent_sensor_data.t_stamp) | timestamp_custom ('%Y-%m-%d %H:%M:%S') -}}
          {%- else -%}
            unavailable
          {%- endif -%}

# Minutely updated "raw" power sensors as provided by Solar Analytics.
      - name: sa_live_site_data_consumed
        unique_id: sa_live_site_data_consumed
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].consumed is defined) -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('consumed', 'equalto', None) | list | last -%}
            {{- most_recent_sensor_data.consumed -}}
          {%- else -%}
            none
          {%- endif -%}
      - name: sa_live_site_data_generated
        unique_id: sa_live_site_data_generated
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].generated is defined) -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('generated', 'equalto', None) | list | last -%}
            {{- most_recent_sensor_data.generated -}}
          {%- else -%}
            none
          {%- endif -%}

# Additional minutely updated "raw" sensor derived from Solar Analytics sourced data. A positive 
# value is power been drawn from the grid (imported) and a negative value is power being fed into
# the grid (exported).
      - name: sa_live_site_data_imported_exported
        unique_id: sa_live_site_data_imported_exported
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].consumed is defined) -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('consumed', 'equalto', None) | list | last -%}
            {{- ((most_recent_sensor_data.consumed|float) - (most_recent_sensor_data.generated|float)) | default('none') -}}
          {%- else -%}
            none
          {%- endif -%}

# -----------------------------------------------------------------------------
#
# Solar Analytics - get hourly cumulative expected energy data for the day.
# Used to report today's total expected generated energy to the most recent hour - a time lagging 
# report of expected, and not a forecast.
# Notes: this is not a published API 'get', but is used by the SA portal. 
# The get also retrieves the daily total for the most recent hour for generated and consumed energy; 
# not required given 5 min updates of the same above. Checked every 30 minutes for changes in the last hour.
#

#
# Total Energy Generated Expected
# Added 24-Jan-23 - initial version.
#
  - resource_template: https://portal.solaranalytics.com.au/api/v2/site_data/{{ states('input_text.sa_site_id') }}?all=false&gran=day&losses=true&power=false&trunc=false&tstart={{ now().strftime("%Y%m%d") }}&tend={{ now().strftime("%Y%m%d") }}
    headers: 
      Authorization: >
        {{ 'Bearer ' ~ state_attr('sensor.sa_auth_token','token') }}
    scan_interval: 1800
    sensor:
      - name: sa_data_by_hour_time_stamp
        unique_id: sa_data_by_hour_time_stamp
        value_template: >-
          {{ as_timestamp(now()) | timestamp_custom ('%Y-%m-%d %H:%M:%S') }}
# The rest get timestamp is only the current date - rather use the current date-time of the get.
#      {{ as_timestamp(value_json['data'][0].t_stamp) | timestamp_custom ('%Y-%m-%d %H:%M:%S') }}
      - name: sa_data_by_hour_generated_expected
        unique_id: sa_data_by_hour_generated_expected
        value_template: >
          {%- if (value_json is defined) and (value_json.data[0].energy_expected is defined) -%}
            {%- set most_recent_sensor_data = value_json['data'] | rejectattr('energy_expected', 'equalto', None) | list | last -%}
            {{- most_recent_sensor_data.energy_expected -}}
          {%- else -%}
            none
          {%- endif -%}

sensor:

  - platform: template
    sensors:

# Solar Analytics status sensors
      sa_dashboard_status:
        friendly_name: "Dashboard Status"
        unique_id: sa_dashboard_status
        value_template: "{{- state_attr('sensor.sa_status', 'dashboard_status') -}}"
      sa_mer_status:
        friendly_name: "System Status"
        unique_id: sa_mer_status
        value_template: "{{- state_attr('sensor.sa_status', 'mer_status') -}}"
      sa_mer_percentage: 
        friendly_name: "PV Performance"
        unique_id: sa_mer_percentage
        value_template: "{{- state_attr('sensor.sa_status', 'mer_percentage') -}}"
        unit_of_measurement: "%"


# Solar Analytics todays total energy sensors
      sa_todays_energy_consumed_total:
        friendly_name: "Total Energy Consumed"
        unique_id: sa_todays_energy_consumed_total        
        unit_of_measurement: "Wh"
        value_template: "{{- states.sensor.sa_data_by_5min_energy_consumed_total.state -}}"
        icon_template: mdi:home-lightning-bolt-outline
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

      sa_todays_energy_generated_total:
        friendly_name: "Total Energy Generated"
        unique_id: sa_todays_energy_generated_total
        unit_of_measurement: "Wh"
        value_template: "{{- states.sensor.sa_data_by_5min_energy_generated_total.state -}}"
        icon_template: mdi:solar-power
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

# Solar Analytics derived total energy sensors
      sa_todays_energy_imported:
        friendly_name: "Total Energy Imported"
        unique_id: sa_todays_energy_imported
        unit_of_measurement: "Wh"
        value_template: "{{- states.sensor.sa_data_by_5min_imported_total.state -}}"
        icon_template: mdi:transmission-tower-export
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

      sa_todays_energy_exported:
        friendly_name: "Total Energy Exported"
        unique_id: sa_todays_energy_exported
        unit_of_measurement: "Wh"
        value_template: "{{- states.sensor.sa_data_by_5min_exported_total.state -}}"
        icon_template: mdi:transmission-tower-import
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

# -----------------------------------------------------------------------------
#
# Solar Energy Consumed as kWh, % of generated, and % of of consumed.
# Added 4-Mar-23 - initial version.
#
      sa_todays_energy_consumed_solar:
        friendly_name: "Total Energy Consumed Solar"
        unique_id: sa_todays_energy_consumed_solar
        unit_of_measurement: "Wh"
        value_template: "{{- states.sensor.sa_data_by_5min_consumed_solar_total.state -}}"
        icon_template: mdi:solar-power
        device_class: "energy"
        attribute_templates:
          state_class: "total_increasing"
          time_stamp: "{{- states.sensor.sa_live_site_data_time_stamp.state -}}"

      sa_todays_energy_generated_expected_total:
        friendly_name: "Total Energy Generated Expected"
        unique_id: sa_todays_energy_generated_expected_total
        unit_of_measurement: "Wh"
        value_template: "{{- states.sensor.sa_data_by_hour_generated_expected.state -}}"
        icon_template: mdi:solar-power
        device_class: "energy"
        attribute_templates:
          state_class: total_increasing
          time_stamp: "{{- states.sensor.sa_data_by_hour_time_stamp.state -}}"

#
# 18-May-23 - CHANGED - fixed calculation logic where total energy generated at start of the day
# could be negative (i.e. the inverter has consumed energy at start-up).
#

# Percentage of generated energy that has been consumed.
      sa_todays_generated_consumed_percentage:
        friendly_name: "Percentage Generated Energy Consumed"
        unique_id: sa_todays_generated_consumed_percentage
        unit_of_measurement: "%"
        value_template: >
          {%- if (states.sensor.sa_data_by_5min_consumed_solar_total.state is defined) 
            and (states.sensor.sa_data_by_5min_energy_generated_total.state is defined) -%}
            {%- if states('sensor.sa_data_by_5min_consumed_solar_total')|float
                < states('sensor.sa_data_by_5min_energy_generated_total')|float 
              -%}
              {{- ((states('sensor.sa_data_by_5min_consumed_solar_total') | float) 
                  / (states('sensor.sa_data_by_5min_energy_generated_total') | float) * 100.0) | round(1) -}}
            {%- else -%}
              none
            {%- endif -%}
          {%- else -%}
            {{- states( 'sensor.sa_todays_generated_consumed_percentage' ) 
              if states.sensor.sa_todays_generated_consumed_percentage.state is defined else "unavailable" -}}
          {%- endif -%}
        icon_template: mdi:solar-power
        attribute_templates:
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

# Percentage of consumed energy that has been generated.
      sa_todays_consumed_generated_percentage:
        friendly_name: "Percentage Consumed Energy Generated"
        unique_id: sa_todays_consumed_generated_percentage
        unit_of_measurement: "%"
        value_template: >
          {%- if (states.sensor.sa_data_by_5min_energy_consumed_total.state is defined) 
            and (states.sensor.sa_data_by_5min_consumed_solar_total.state is defined) -%}
            {%- if states('sensor.sa_data_by_5min_consumed_solar_total')|float
                < states('sensor.sa_data_by_5min_energy_consumed_total')|float 
              -%}
              {{- ((states('sensor.sa_data_by_5min_consumed_solar_total') | float) 
                  / (states('sensor.sa_data_by_5min_energy_consumed_total') | float) * 100.0) | round(1) -}}
            {%- else -%}
              none
            {%- endif -%}
          {%- else -%}
            {{- states( 'sensor.sa_todays_consumed_generated_percentage' ) 
              if states.sensor.sa_todays_consumed_generated_percentage.state is defined else "unavailable" -}}
          {%- endif -%}
        icon_template: mdi:solar-power
        attribute_templates:
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

#### END CHANGE


# ---------------------------------------------------------------------------
# Solar Analytics Energy history sensor for graphing each channel (e.g. in Apex Charts).
# The units are in kW.
# Added 10-Apr-23 - initial version.
#
# Note: results are 5 minute average power, with area under the graph being the energy
# usage within that time interval. The time duration is limited to 28x 5 minute intervals
# (= 2h20m) as this fits within the 255 character max allowed by the state of a sensor.
# Rounding to a reduced number of decimal places (e.g. 1 instead of 2) could increase
# the number of intervals if that's desireable, but at a lower resolution. Lastly,
# the history sensors as states from above are implemented as attributes so they
# can be readily interpreted as lists.
#
      sa_todays_energy_history:
        friendly_name: "Total Energy History"
        unique_id: sa_todays_energy_history        
        value_template: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"
        icon_template: mdi:sun-clock
        attribute_templates:
          times: >
            {%- set ns = namespace( 
                times=[],
                count = states('sensor.sa_data_by_5min_history_time_stamp_count')|int
                ) -%}
            {%- for i in range(ns.count) -%}
              {%- if i > ns.count - 29 -%}
                {%- set ns.times = ns.times + [
                  as_local( 
                    as_datetime( states('sensor.sa_data_by_5min_time_stamp') )  
                    - timedelta(minutes=(ns.count*5)-((i+1)*5)) 
                    ).strftime("%Y-%m-%d %H:%M:%S")
                  ] -%}
                {% endif -%}
            {%- endfor -%}
            {{- ns.times -}}
          times_simple: "{{- states.sensor.sa_data_by_5min_history_time_stamp.state -}}"
          energy_consumed: "{{- states.sensor.sa_data_by_5min_history_energy_consumed.state -}}"
          energy_generated: "{{- states.sensor.sa_data_by_5min_history_energy_generated.state -}}"

# -----------------------------------------------------------------------------
#
# Solar Analytics power sensors
#
      sa_consumption_power:
        friendly_name: "Power Consumption"
        unique_id: sa_consumption_power
        unit_of_measurement: "W"
        value_template: "{{- states.sensor.sa_live_site_data_consumed.state -}}"
        icon_template: mdi:home-lightning-bolt-outline
        device_class: "power"
        attribute_templates:
          state_class: "measurement"
          time_stamp: "{{- states.sensor.sa_live_site_data_time_stamp.state -}}"

      sa_generation_power:
        friendly_name: "Power Generation"
        unique_id: sa_generation_power
        unit_of_measurement: "W"
        value_template: "{{- states.sensor.sa_live_site_data_generated.state -}}"
        icon_template: mdi:solar-power
        device_class: "power"
        attribute_templates:
          state_class: measurement
          time_stamp: "{{- states.sensor.sa_live_site_data_time_stamp.state -}}"

      sa_import_export_power:
        friendly_name: "Power Import Export"
        unique_id: sa_import_export_power
        unit_of_measurement: "W"
        value_template: "{{- states.sensor.sa_live_site_data_imported_exported.state -}}"
        icon_template: mdi:transmission-tower
        device_class: "power"
        attribute_templates:
          state_class: measurement
          time_stamp: "{{- states.sensor.sa_live_site_data_time_stamp.state -}}"


# -----------------------------------------------------------------------------
#
# Home Assistant Energy Management extras
# Added 10-Feb-23 - initial version
#

#
# Todays Energy Total Net Cost
#
# HA EM automatically creates two entities respectively derived from the sa_todays_energy_imported 
# and sa_todays_energy_exported, where:
#   > sa_todays_energy_imported_cost - cost of imported energy
#   > sa_todays_energy_exported_compensation - revenue from exported energy
# This new entity provides the net cost (imported cost minus exported revenue)
#
      sa_todays_energy_total_net_cost:
        friendly_name: "Todays Energy Total Net Cost"
        unique_id: sa_todays_energy_total_net_cost
        unit_of_measurement: "AUD"
        device_class: "monetary"
        icon_template: mdi:cash
        value_template: >
          {{- (states.sensor.sa_todays_energy_imported_cost.state|float|default(0.0)) 
              - (states.sensor.sa_todays_energy_exported_compensation.state|float|default(0.0)) -}}
        attribute_templates:
          state_class: total_increasing
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

#
# Todays Energy Import Rate
#
# Useful for those on a variable electricity import/general rate configured in the HA Energy Manager 
# (e.g. peak/off-peak/shoulder, Amber Energy wholesale spot market pricing). The average import 
# rate $/kWh = cumulative exported energy kWh divided by the cumulative imported energy revenue $. 
# Resets to zero at midnight. The sensor sa_todays_energy_imported_cost is created by the 
# HA Energy Manager when appropriate pricing is set-up for energy drawn from the grid.
#
      sa_todays_energy_import_rate:
        friendly_name: "Todays Energy Import Rate"
        unique_id: sa_todays_energy_import_rate
        unit_of_measurement: "$/kWh"
        device_class: "monetary"
        icon_template: mdi:cash-plus
        value_template: >
          {%- if ( states.sensor.sa_data_by_5min_imported_total.state is defined ) 
              and ( states.sensor.sa_todays_energy_imported_cost.state is defined ) -%}
            {%- if (states.sensor.sa_data_by_5min_imported_total.state|int) > 100 -%}
              {{- ((states.sensor.sa_todays_energy_imported_cost.state|float) / 
                (states.sensor.sa_data_by_5min_imported_total.state|float) * 1000.0 ) 
                | round(3) -}}
            {%- else -%}
              none
            {%- endif -%}
          {%- else -%}
            unavailable
          {%- endif -%}
        attribute_templates: 
          state_class: measure
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

#
# Todays Energy Export Rate
#
# Useful for those on a variable electricity feed-in (FIT) rate configured in the HA Energy Manager 
# (e.g. peak/off-peak/shoulder, Amber Energy wholesale spot market pricing). The average export 
# rate $/kWh = cumulative exported energy kWh divided by the cumulative exported energy revenue $. 
# Resets to zero at midnight. # The sensor sa_todays_energy_exported_compensation is created by the 
# HA Energy Manager when appropriate pricing is set-up for energy returned to the grid. 
#
      sa_todays_energy_export_rate:
        friendly_name: "Todays Energy Export Rate"
        unique_id: sa_todays_energy_export_rate
        unit_of_measurement: "$/kWh"
        device_class: "monetary"
        icon_template: mdi:cash-plus
        value_template: >
          {%- if ( states.sensor.sa_data_by_5min_exported_total.state is defined ) 
              and ( states.sensor.sa_todays_energy_exported_compensation.state is defined ) -%}
            {%- if (states.sensor.sa_data_by_5min_exported_total.state | int) > 100 -%}
              {{- ((states.sensor.sa_todays_energy_exported_compensation.state | float) / 
                (states.sensor.sa_data_by_5min_exported_total.state | float) * 1000.0 ) 
                | round(3) -}}
            {%- else -%}
              none
            {%- endif -%}
          {%- else -%}
            unavailable
          {%- endif -%}
        attribute_templates:
          state_class: measure
          time_stamp: "{{- states.sensor.sa_data_by_5min_time_stamp.state -}}"

# -----------------------------------------------------------------------------

[Roving-Ronin]

@PeterH24x7 Hi, where you releasing v6....? Personally I haven't had any issues and have been running 5-6 weeks now.

[PeterH24x7]

Hi @Roving-Ronin - I've made another update to the main body of code above. I think it's the final code ready for release. I would please value your feedback on the 3-phase solution as marked within the code.

[Roving-Ronin]

@PeterH24x7 testing it now. Thanks for highlighting those chunks to delete for 3 phase users ;-)
Only error in logs that has sprung up is:

Logger: homeassistant.components.sensor.recorder
Source: components/sensor/recorder.py:405
Integration: Sensor (documentation, issues)
First occurred: 10:45:10 pm (1 occurrences)
Last logged: 10:45:10 pm

Entity sensor.sa_todays_energy_generated_expected_total from integration template has state class total_increasing, but its state is not strictly increasing. Triggered by state 29.51490044038751 (29520.200222219628) with last_updated set to 2023-07-16T12:41:04.687176+00:00. Please create a bug report at https://github.com/home-assistant/core/issues?q=is%3Aopen+is%3Aissue+label%3A%22integration%3A+template%22

[PeterH24x7]

@Roving-Ronin - yes that's an interesting one which I have seen before. It's like the data from Solar Analytics changes ever so slightly (4th significant figure) and, as a result looks like it's declined; but not materially. Maybe this is appropriate for a generated solar forecast. I'll comment out the attribute "state_class: total_increasing" and the problem should be fixed.

Importantly, were the 3-phase chunk markings correct???

[Roving-Ronin]

@PeterH24x7 Yep thanks, 3p looks good

[PeterH24x7]

Hi @Roving-Ronin - sorry I have been busy with other matters, but have been testing and finalising the new code base. I think that I have eliminated all preventable warnings/errors (including the one in your previous notes).

The release-ready code is now in the main github code tree (links below) and includes a 3-phase version for your interest. There's also an advanced version of the code including additional sensors that are applicable to my set-up (and any user with same), else will this will need customising by someone with more advanced HA YAML skills.

I plan on formalising the release 6 in the next days and will subsequently close off this discussion to start afresh with a new thread.

solar_analytics - regular code base for release 6
https://github.com/PeterH24x7/-Solar-Analytics-integration-for-Home-Assistant-Energy-monitoring/blob/main/solar_analytics.yaml

solar_analytics_3phase - 3 phase code base for release 6
https://github.com/PeterH24x7/-Solar-Analytics-integration-for-Home-Assistant-Energy-monitoring/blob/main/solar_analytics_3phase.yaml

solar_analytics_advanced - advanced code base for release 6
https://github.com/PeterH24x7/-Solar-Analytics-integration-for-Home-Assistant-Energy-monitoring/blob/main/solar_analytics_advanced.yaml

Rgds, Peter

[Roving-Ronin]

@PeterH24x7 installed and testing. Will advise.

[Roving-Ronin]

@PeterH24x7 just checking and one error that is showing is for sa_todays_energy_generated_expected_total with 'The state class of " of this entity is not supported'.

The state class of this entity, is not supported. Statistics cannot be generated until this entity has a supported state class.

[PeterH24x7]

Hi @Roving-Ronin - good pick-up. You will note the state_class is commented out and was set to total_increasing. I did this as I would get a warning where sometimes the sensor would ever so slightly decrease. I've had another look at the state_class options and maybe total is more appropriate (rather commenting it out altogether).

Please let me know if this fixes your problem.

https://developers.home-assistant.io/docs/core/entity/sensor/

      sa_todays_energy_generated_expected_total:
        friendly_name: "Total Energy Generated Expected"
        unique_id: sa_todays_energy_generated_expected_total
        unit_of_measurement: "Wh"
        value_template: >-
          {{- states.sensor.sa_data_by_hour_generated_expected.state 
              if states.sensor.sa_data_by_hour_generated_expected.state|is_number 
              else "unavailable" 
            -}}
        icon_template: mdi:solar-power
        device_class: "energy"
        attribute_templates:
#          state_class: total_increasing
          time_stamp: "{{- states.sensor.sa_data_by_hour_time_stamp.state -}}"

change to

      sa_todays_energy_generated_expected_total:
        friendly_name: "Total Energy Generated Expected"
        unique_id: sa_todays_energy_generated_expected_total
        unit_of_measurement: "Wh"
        value_template: >-
          {{- states.sensor.sa_data_by_hour_generated_expected.state 
              if states.sensor.sa_data_by_hour_generated_expected.state|is_number 
              else "unavailable" 
            -}}
        icon_template: mdi:solar-power
        device_class: "energy"
        attribute_templates:
          state_class: total
          time_stamp: "{{- states.sensor.sa_data_by_hour_time_stamp.state -}}"

[PeterH24x7]

Release 6 (6.2) published.

Last minute change included fix to sa_todays_energy_import_rate and sa_todays_energy_export_rate where the state_class was corrected from "measure" to "measurement".

This discussion will now be closed.