PV SolaX inverter cloud sensors via API

Share your Projects!
65

can you help me with the below?

sensor that you can use in the energy dashboard:

this is the code

‘’‘’‘’## X3 ##

  • platform: rest
    resource: https://www.solaxcloud.com:9443/proxy/api/getRealtimeInfo.do?tokenId=XXXXXXX&sn=XXXXXXX
    name: “Solax X3”
    json_attributes_path: “$.result”
    json_attributes:
    • yieldtoday
    • yieldtotal
    • acpower
    • uploadTime
    • inverterStatus
    • sn
      value_template: ‘1’ # dummy value, not used; avoids the “State max length is 255 characters” error
  • platform: template
    sensors:
    solax_x3_today:
    friendly_name: “Solax X3 today”
    value_template: “{{ state_attr(‘sensor.solax_x3’, ‘yieldtoday’) }}”
    unit_of_measurement: “KWh”
    device_class: energy
    solax_x3_total:
    friendly_name: “Solax X3 total”
    value_template: “{{ state_attr(‘sensor.solax_x3’, ‘yieldtotal’) }}”
    unit_of_measurement: “KWh”
    device_class: energy
    solax_x3_now:
    friendly_name: “Solax X3 now”
    value_template: “{{ state_attr(‘sensor.solax_x3’, ‘acpower’) }}”
    unit_of_measurement: “W”
    device_class: energy
    solax_x3_upload_time:
    friendly_name: “Solax X3 upload time”
    value_template: “{{ state_attr(‘sensor.solax_x3’, ‘uploadTime’) }}”
    solax_x3_status:
    friendly_name: “Solax X3 status”
    value_template: >
    {% if state_attr(‘sensor.solax_x3’, ‘inverterStatus’) == ‘100’ %}Wait
    {% elif state_attr(‘sensor.solax_x3’, ‘inverterStatus’) == ‘101’ %}Check
    {% elif state_attr(‘sensor.solax_x3’, ‘inverterStatus’) == ‘102’ %}Normal
    {% elif state_attr(‘sensor.solax_x3’, ‘inverterStatus’) == ‘103’ %}Fault
    {% elif state_attr(‘sensor.solax_x3’, ‘inverterStatus’) == ‘104’ %}Permanent Fault
    {% elif state_attr(‘sensor.solax_x3’, ‘inverterStatus’) == ‘105’ %}Update
    {% elif state_attr(‘sensor.solax_x3’, ‘inverterStatus’) == ‘106’ %}EPS Check
    {% elif state_attr(‘sensor.solax_x3’, ‘inverterStatus’) == ‘107’ %}EPS
    {% elif state_attr(‘sensor.solax_x3’, ‘inverterStatus’) == ‘108’ %}Self-test
    {% elif state_attr(‘sensor.solax_x3’, ‘inverterStatus’) == ‘109’ %}Idle
    {% elif state_attr(‘sensor.solax_x3’, ‘inverterStatus’) == ‘110’ %}Standby
    {% elif state_attr(‘sensor.solax_x3’, ‘inverterStatus’) == ‘111’ %}Pv Wake Up Bat
    {% elif state_attr(‘sensor.solax_x3’, ‘inverterStatus’) == ‘112’ %}Gen Check
    {% elif state_attr(‘sensor.solax_x3’, ‘inverterStatus’) == ‘113’ %}Gen Run
    {% else %}I dont know{% endif %}
    solax_x3_sn:
    friendly_name: “Solax X3 sn”
    value_template: “{{ state_attr(‘sensor.solax_x3’, ‘sn’) }}”
    template:
    • sensor:
    • name: test_energy
      state: “{{ states(‘sensor.solax_total’) }}”
      unit_of_measurement: ‘kWh’
      state_class: measurement
      device_class: energy
      attributes:
      last_reset: ‘1970-01-01T00:00:00+00:00’
      ‘’‘’‘’‘’

This is the message that we get in the configuration test:

The system cannot restart because the configuration is not valid: Invalid config for [sensor.template]: expected dictionary for dictionary value @ data[‘sensors’][‘template’]. Got [OrderedDict([(‘sensor’, None)]), OrderedDict([(‘name’, ‘test_energy’), (‘state’, “{{ states(‘sensor.solax_total’) }}”), (‘unit_of_measurement’, ‘kWh’), (‘state_class’, ‘measurement’), (‘device_class’, ‘energy’), (‘attributes’, OrderedDict([(‘last_reset’, ‘1970-01-01T00:00:00+00:00’)]))])]. (See ?, line ?).

.
Do you have a idea what we do wrong?

66

Can you please repost the code in a proper format? (between …)

type or paste code here
67

I’ve got the API code and tried the URL (at night) but the only thing i’m getting is This sn did not access! is this due to the fact that it´s currently not on or am I doing something wrong?

{
success: false,
exception: "Query success!",
result: "this sn did not access!"
}
68

In the night my inverter goes in a kind of sleep mode and no data is available or transmitted. So nothing is wrong, just an efficient design.

1 Like
69

Thanks for the quick response, I’ll just add it to my configuration than, and see what happens during the day!

70

Hi I’m new to Home Assistant so it might be that I am doing something wrong. I got the script working and the sensors are showing up on my dashboard. But when I try to add them to my engery page it does not display the sensors in the list.

71

No problemo, have a look at this solution: PV SolaX inverter cloud sensors via API - #45 by mpietersen

1 Like
73

Did the 2022.2 update break anybody else’s Energy dashboard? I still get the correct values in my lovelace card and even the template sensor is showing the correct value. But for some reason the energy dashboard doesn’t pick up on the sensor anymore although it’s still configured as a solar input in the energy dashboard settings.

2 Likes
74

I’ve got the same issue you mentioned.

1 Like
75

I can’t imagine we are the only two people facing this issue. Anybody else got some tips maybe on how we could get this working again?

76

Is it also possible to display the output of the individual strings? It is available in Solax Cloud, but I could find it in the documentation.

77

I get an error trying to add solax to the energy solar configuration:

statistics_not_defined
* sensor.test_energy`

No clue what it means.

78

I followed the instructions with minor modifications. This works for X1-booster and I have the PV yield showing up on the energy dashboard. As I am new to HA it took a bit of digging through posts. My setup described below. Hope this is of help to anyone struggling with the dashboard integration. Thanks to @Doublet and @heldopsokken.

The configuration is split in 3 parts:

  1. configuration.yaml
sensor: !include_dir_merge_list sensor/
template: !include_dir_merge_list template/
  1. solax.yaml
    Grab data via api, “PV now”, “PV today”, “PV total” are in preparation of a second system I am planning to get this year so I can sum up easily.
- platform: rest
  resource: https://www.eu.solaxcloud.com:9443/proxy/api/getRealtimeInfo.do?tokenId=A&sn=B
  name: "Solax Garage"
  json_attributes_path: "$.result"
  json_attributes:
    - yieldtoday
    - yieldtotal
    - acpower
    - uploadTime
    - inverterStatus
  value_template: "1" # dummy value; not used; avoids error
- platform: template
  sensors:
    solax_garage_today:
      friendly_name: "Solax Garage today"
      value_template: "{{ state_attr('sensor.solax_garage', 'yieldtoday') }}"
      unit_of_measurement: "kWh"
    solax_garage_total:
      friendly_name: "Solax Garage total"
      value_template: "{{ state_attr('sensor.solax_garage', 'yieldtotal') }}"
      unit_of_measurement: "kWh"
    solax_garage_now:
      friendly_name: "Solax Garage now"
      value_template: "{{ state_attr('sensor.solax_garage', 'acpower') }}"
      unit_of_measurement: "W"
    solax_garage_upload_time:
      friendly_name: "Solax Garage upload time"
      value_template: "{{ state_attr('sensor.solax_garage', 'uploadTime') }}"
    solax_garage_status:
      friendly_name: "Solax Garage status"
      value_template: >
        {% if state_attr('sensor.solax_garage', 'inverterStatus') == '100' %}Wait
        {% elif state_attr('sensor.solax_garage', 'inverterStatus') == '101' %}Check
        {% elif state_attr('sensor.solax_garage', 'inverterStatus') == '102' %}Normal
        {% elif state_attr('sensor.solax_garage', 'inverterStatus') == '103' %}Fault
        {% elif state_attr('sensor.solax_garage', 'inverterStatus') == '104' %}Permanent Fault
        {% elif state_attr('sensor.solax_garage', 'inverterStatus') == '105' %}Update
        {% elif state_attr('sensor.solax_garage', 'inverterStatus') == '106' %}EPS Check
        {% elif state_attr('sensor.solax_garage', 'inverterStatus') == '107' %}EPS
        {% elif state_attr('sensor.solax_garage', 'inverterStatus') == '108' %}Self-test
        {% elif state_attr('sensor.solax_garage', 'inverterStatus') == '109' %}Idle
        {% elif state_attr('sensor.solax_garage', 'inverterStatus') == '110' %}Standby
        {% elif state_attr('sensor.solax_garage', 'inverterStatus') == '111' %}Pv Wake Up Bat
        {% elif state_attr('sensor.solax_garage', 'inverterStatus') == '112' %}Gen Check
        {% elif state_attr('sensor.solax_garage', 'inverterStatus') == '113' %}Gen Run
        {% else %}I dont know{% endif %}
    solax_now:
      friendly_name: "PV now"
      unit_of_measurement: "W"
      value_template: "{{ (states('sensor.solax_garage_now') | float) }}"
    solax_today:
      friendly_name: "PV today"
      unit_of_measurement: "kWh"
      value_template: "{{ (states('sensor.solax_garage_today') | float) }}"
    solax_total:
      friendly_name: "PV total"
      unit_of_measurement: "kWh"
      value_template: "{{ (states('sensor.solax_garage_total') | float) }}"
  1. pv_sensors.yaml
    For “device_class: energy” the “state_class” needs to be “total_increasing” as described here Energy Dashboard doesn't work - #5 by francisp 
- sensor:
    - name: PV yield (Now)
      state: "{{ states('sensor.solax_now') | float }}"
      unit_of_measurement: "W"
      state_class: total_increasing
      device_class: energy
      attributes:         
        last_reset: '1970-01-01T00:00:00+00:00'
- sensor:
    - name: PV yield (Today)
      state: "{{ states('sensor.solax_today') | float }}"
      unit_of_measurement: "kWh"
      state_class: total_increasing
      device_class: energy
      attributes:         
        last_reset: '1970-01-01T00:00:00+00:00'
- sensor:
    - name: PV yield (Total)
      state: "{{ states('sensor.solax_total') | float }}"
      unit_of_measurement: "kWh"
      state_class: total_increasing
      device_class: energy
      attributes:         
        last_reset: '1970-01-01T00:00:00+00:00'
3 Likes
79

Thanks @schnetf changing the sensor state_class did the trick for me as well!!!

80

Yes you can. I have only one string, so i tested it with the attribute “powerdc1” there are also powerd2/3/4 values, check which one is filled for you.

You need to add “powerdc1” and “powerdc2” to the JSON json_attributes and add add a template sensor for it:

    solax_x1_now_string1:
      friendly_name: "Solax X1 now String1"
      value_template: "{{ state_attr('sensor.solax_x1', 'powerdc1') }}"
      unit_of_measurement: "W"

Keep in mind that is is the “Raw” pv watt and nog excactly what is feeding in to you house. But at least now you can see the data.

81

Hi
OK, got the test link working no problem, had the coffee… than totally lost you.

“Build the Sensors in HA”

ummmm, what? where? how?

I am totally new to this… did you guess. pretend I am really thick… how do I get to “sensors”?

I found it on Sensor - Home Assistant but no idea how I get this on HA? View source on GitHub? that dosent seem to help me either…

dosent seem to be an add on or integration from within the HA GUI?

Sorry for what is probably a very basic and simple question. I am sure when I know I will roll my eyes at myself as I am sure your doing to me now!

Thanks for any help

2 Likes
82

Hi

Ok, Got somewhere.

Great guide, and I wouldn’t have got anywhere without it. I am totally new to to this, but here is some stuff thats not obvious to a totally new person like me.

" Build the sensors in HA"
Translation:-
Add this to the configuration.yaml file on your HA.

To do this add the addon “file Editor”, start it, then click open Web UI. click the folder icon and paste the sensors stuff above.

with one exception…
in the configuration stuff above it says sensors: this should be Sensor:

“just add the new sensors:”
Translation
in HA, click overview in side bar, bottom right click add card, click by entity, search for solax and click the items you have just added.

Thanks again for the guide and sorry if my new-ness is just obvious stuff. but if i got stuck there, maybe others did too.

Thanks

3 Likes
83

I changed the state_class: total_increasing but for some reason it now shows a negative value.

template:
  - sensor:
    - name: test_energy
      state: "{{ states('sensor.solax_total')}}"
      unit_of_measurement: "kWh"
      state_class: total_increasing
      device_class: energy
      attributes:         
          last_reset: '1970-01-01T00:00:00+00:00'

Schermafbeelding 2022-03-21 om 20.31.14
Schermafbeelding 2022-03-21 om 20.31.141716×932 37.7 KB

84

Hi,

First of all, great topic and info. It works for me, but the energy dashboard show different values than the entity. I think this has something to do with the energy production dips. Does anyone know how to get the entity and the energy dashboard in-sync?

Energy dashboard:

Energy dashboard
Energy dashboard1233×228 5.08 KB

Energy enity:

Solax drop
Solax drop1576×728 27.7 KB

85

that can take 2-4 hours