Update SMA sensors list (#17987)

* Remove sensors list

* Updating sensor list

* Missing period char

* Tweak

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
René Klomp 2021-06-27 18:10:40 +02:00 committed by GitHub
parent ad881a4d82
commit 541cb892e9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -7,14 +7,14 @@ ha_iot_class: Local Polling
ha_config_flow: true
ha_release: 0.36
ha_codeowners:
- '@kellerza'
- '@rklomp'
- "@kellerza"
- "@rklomp"
ha_domain: sma
ha_platforms:
- sensor
---
The SMA Solar integration will poll a [SMA](http://www.sma-solar.com/) [(US)](https://www.sma-america.com/) solar inverter and present the values as sensors in Home Assistant.
The SMA Solar integration will poll a [SMA](http://www.sma-solar.com/) [(US)](https://www.sma-america.com/) solar inverter, energy meter or battery inverter and present the values as sensors in Home Assistant.
The integration uses the web interface of the device. Before you start, make sure you are able to connect to the solar inverter from your favorite web browser.
@ -22,55 +22,139 @@ The integration uses the web interface of the device. Before you start, make sur
## Sensors
Sensors available in the library:
The SMA WebConnect module supports a wide variety of sensors, but not all of these have been mapped in the `pysma` library. Currently available sensors can be found below. Feel free to submit additional sensors to be added as standard sensors to the [pysma library](https://github.com/rklomp/pysma/blob/dev/pysma/definitions.py).
### Solar Inverter
| name | Unit | Description |
|--------------|------|:-------------------------------------------|
| status | | Status of the device |
| pv_power_a | W | Current power generated by the solar panels (A side) |
| pv_power_b | W | Current power generated by the solar panels (B side) |
| pv_voltage_a | V | Current voltage generated by the solar panels (A side) |
| pv_voltage_b | V | Current voltage generated by the solar panels (B side) |
| pv_current_a | A | Current amperage generated by the solar panels (A side) |
| pv_current_b | A | Current amperage generated by the solar panels (B side) |
| grid_power | W | Power supplied to the grid by the inverter. grid_power = power_l1 + power_l2 + power_l3 |
| power_l1 | W | Power for phase 1. |
| power_l2 | W | Power for phase 2. |
| power_l3 | W | Power for phase 3. |
| frequency | Hz | Grid frequency. |
| voltage_l1 | V | Voltage for phase 1. |
| voltage_l2 | V | Voltage for phase 2. |
| voltage_l3 | V | Voltage for phase 3. |
| current_l1 | A | Current for phase 1. |
| current_l2 | A | Current for phase 2. |
| current_l3 | A | Current for phase 3. |
| pv_power_a | W | Current power generated by the solar panels (A side). |
| pv_power_b | W | Current power generated by the solar panels (B side). |
| pv_voltage_a | V | Current voltage generated by the solar panels (A side). |
| pv_voltage_b | V | Current voltage generated by the solar panels (B side). |
| pv_current_a | A | Current amperage generated by the solar panels (A side). |
| pv_current_b | A | Current amperage generated by the solar panels (B side). |
| pv_gen_meter | kWh | Total kWh generated to date. |
| total_yield | kWh | Total power yield from a solar installation. |
| frequency | Hz | Grid frequency |
| current_l1 | A | Current for phase 1 |
| current_l2 | A | Current for phase 2 |
| current_l3 | A | Current for phase 3 |
| voltage_l1 | V | Voltage for phase 1 |
| voltage_l2 | V | Voltage for phase 2 |
| voltage_l3 | V | Voltage for phase 3 |
| power_l1 | W | Power for phase 1 |
| power_l2 | W | Power for phase 2 |
| power_l3 | W | Power for phase 3 |
| total_yield | kWh | Total power yield from a solar installation |
| daily_yield | Wh | The solar plant's yield for today |
| grid_power_supplied | W | Power supplied. |
| grid_power_absorbed | W | Power absorbed. |
| grid_total_yield | kWh | Total power from the grid. |
| grid_total_absorbed | kWh | Total power supplied to the grid. |
| current_consumption | W | Power that you are currently drawing, depending on your installation it can be a combination of the inverter and the grid. |
| total_consumption | kWh | Total power consumption. |
| pv_gen_meter | kWh | Total kWh generated to date |
### Custom Sensors
#### Optimizers via Inverter
The SMA WebConnect module supports a wide variety of sensors, but not all of these have been mapped in the `pysma` library. New sensors can be tested by using YAML configuration. The YAML config is deprecated, nevertheless, an example is provided below. You will need a sensor name, the SMA sensor key and the unit. The path attribute is a custom JMESpath to extract the sensor value and typically not required (advanced use only).
| name | Unit | Description |
| optimizer_power_x | W | Power supplied by optimizer X |
| optimizer_current_x | A | Current supplied by optimizer X |
| optimizer_voltage_x | V | Voltage supplied by optimizer X |
| optimizer_temp_x | C | Temperature of optimizer X |
Example:
#### Energy Meter via Inverter
```yaml
sensor:
- platform: sma
host: IP_ADDRESS_OF_DEVICE
ssl: true
verify_ssl: false
password: YOUR_SMA_PASSWORD
custom:
yesterday_consumption:
key: "6400_00543A01"
unit: kWh
factor: 1000
```
| name | Unit | Description |
| metering_power_supplied | W | Power supplied |
| metering_power_absorbed | W | Power absorbed |
| metering_frequency | Hz | Grid frequency |
| metering_total_yield | kWh | Total power from the grid |
| metering_total_absorbed | kWh | Total power supplied to the grid |
| metering_current_l1 | A | Current for phase 1 |
| metering_current_l2 | A | Current for phase 2 |
| metering_current_l3 | A | Current for phase 3 |
| metering_voltage_l1 | V | Voltage for phase 1 |
| metering_voltage_l2 | V | Voltage for phase 2 |
| metering_voltage_l3 | V | Voltage for phase 3 |
| metering_active_power_l1 | W | Active Power for phase 1 |
| metering_active_power_l2 | W | Active Power for phase 2 |
| metering_active_power_l3 | W | Active Power for phase 3 |
| metering_active_power_consumed_l1 | W | Active Power Consumed for phase 1 |
| metering_active_power_consumed_l2 | W | Active Power Consumed for phase 2 |
| metering_active_power_consumed_l3 | W | Active Power Consumed for phase 3 |
Feel free to submit additional sensors to be added as standard sensors to the [pysma library](https://github.com/kellerza/pysma/blob/master/pysma/__init__.py#L100).
### Energy Meter
| name | Unit | Description |
| status | | Status of the device |
| grid_power | W | Power supplied to the grid. grid_power = power_l1 + power_l2 + power_l3 |
| frequency | Hz | Grid frequency. |
| current_l1 | A | Current for phase 1 |
| current_l2 | A | Current for phase 2 |
| current_l3 | A | Current for phase 3 |
| voltage_l1 | V | Voltage for phase 1 |
| voltage_l2 | V | Voltage for phase 2 |
| voltage_l3 | V | Voltage for phase 3 |
| power_l1 | W | Power for phase 1 |
| power_l2 | W | Power for phase 2 |
| power_l3 | W | Power for phase 3 |
### Batery Inverter
| name | Unit | Description |
| operating_status_general | | General operating status |
| inverter_condition | | Inverter Condition |
| inverter_system_init | | Inverter System Init |
| grid_connection_status | | Grid connection status |
| grid_relay_status | | Grid relay status |
| insulation_residual_current | mA | Insulation residual current|
| current_l1 | A | Current for phase 1 |
| current_l2 | A | Current for phase 2 |
| current_l3 | A | Current for phase 3 |
| current_total | A | Total Current. |
| voltage_l1 | V | Voltage for phase 1 |
| voltage_l2 | V | Voltage for phase 2 |
| voltage_l3 | V | Voltage for phase 3 |
| grid_reactive_power | var | Total Reactive Power |
| grid_reactive_power_l1 | var | Reactive Power for phase 1 |
| grid_reactive_power_l2 | var | Reactive Power for phase 2 |
| grid_reactive_power_l3 | var | Reactive Power for phase 3 |
| grid_apparent_power | VA | Total Apparent Power |
| grid_apparent_power_l1 | VA | Apparent Power for phase 1 |
| grid_apparent_power_l2 | VA | Apparent Power for phase 2 |
| grid_apparent_power_l3 | VA | Apparent Power for phase 3 |
| grid_power_factor | | Grid Power factor |
| grid_power_factor_excitation | | Grid Power factor excitation |
| battery_soc_total | % | Total battery state of charge |
| battery_soc_a | % | State of charge battery A |
| battery_soc_b | % | State of charge battery B |
| battery_soc_c | % | State of charge battery C |
| battery_voltage_a | V | Voltage battery A |
| battery_voltage_b | V | Voltage battery B |
| battery_voltage_c | V | Voltage battery C |
| battery_current_a | A | Current battery A |
| battery_current_b | A | Current battery B |
| battery_current_c | A | Current battery C |
| battery_temp_a | C | Temperature battery A |
| battery_temp_b | C | Temperature battery B |
| battery_temp_c | C | Temperature battery C |
| battery_status_operating_mode | | Battery status operating mode |
| battery_capacity_total | % | Total battery capacity |
| battery_capacity_a | % | Capacity battery A |
| battery_capacity_b | % | Capacity battery B |
| battery_capacity_c | % | Capacity battery C |
| battery_charging_voltage_a | V | Charging voltage battery A |
| battery_charging_voltage_b | V | Charging voltage battery B |
| battery_charging_voltage_c | V | Charging voltage battery C |
| battery_power_charge_total | W | Total charging power |
| battery_power_charge_a | W | Charging power battery A |
| battery_power_charge_b | W | Charging power battery B |
| battery_power_charge_c | W | Charging power battery C |
| battery_charge_total | kWh | Total charge |
| battery_charge_a | kWh | Charge battery A |
| battery_charge_b | kWh | Charge battery B |
| battery_charge_c | kWh | Charge battery C |
| battery_power_discharge_total | W | Total discharging power |
| battery_power_discharge_a | W | Disharging power battery A |
| battery_power_discharge_b | W | Disharging power battery B |
| battery_power_discharge_c | W | Disharging power battery C |
| battery_discharge_total | kWh | Total discharge |
| battery_discharge_a | kWh | Discharge battery A |
| battery_discharge_b | kWh | Discharge battery A |
| battery_discharge_c | kWh | Discharge battery A |
| inverter_power_limit | W | Power limit of the Inverter |