Add support for SAJ inverters connected via WiFi (#10819)

* Add support for SAJ inverters connected via WiFi

* Changes after review saj
This commit is contained in:
fredericvl 2019-10-23 22:47:45 +02:00 committed by Franck Nijhof
parent c7cbd29dfc
commit f985d738e8

View File

@ -12,6 +12,9 @@ The `saj` sensor will poll a [SAJ](https://www.saj-electric.com/) solar inverter
This sensor uses the web interface and to use it, you have to be able to connect to the solar inverter from your favorite web browser. This sensor uses the web interface and to use it, you have to be able to connect to the solar inverter from your favorite web browser.
There is a difference between inverters that are connected via an ethernet module and those connected via a WiFi module.
The WiFi module requires a username and password for authentication where the ethernet module does not.
## Configuration ## Configuration
To enable this sensor, add the following lines to your `configuration.yaml` file: To enable this sensor, add the following lines to your `configuration.yaml` file:
@ -25,9 +28,22 @@ sensor:
{% configuration %} {% configuration %}
host: host:
description: The IP address of the SAJ Solar Inverter. description: "The IP address of the SAJ Solar Inverter."
required: true required: true
type: string type: string
type:
description: "Type of connection module: 'ethernet' or 'wifi'"
required: false
default: ethernet
type: string
username:
description: "Username for logging in to SAJ Solar Inverter (only used when type is 'wifi' but can be skipped if the inverter still has the default credentials set: admin/admin)"
required: false
type: string
password:
description: "Password for logging in to SAJ Solar Inverter (only used when type is 'wifi' but can be skipped if the inverter still has the default credentials set: admin/admin)"
required: false
type: string
{% endconfiguration %} {% endconfiguration %}
## Sensors ## Sensors
@ -35,13 +51,24 @@ host:
Sensors available in the library: Sensors available in the library:
| name | Unit | Description | | name | Unit | Description |
|--------------------|------|:-------------------------------------------| |--------------------|------|:-----------------------------------------------------------------------------|
| current_power | W | Current power generated by the inverter. | | current_power | W | Current power generated by the inverter. |
| today_yield | kWh | Power yield for today. | | today_yield | kWh | Power yield for today. |
| today_time | h | Inverter's running time for today. | | today_time | h | Inverter's running time for today. |
| today_max_current | W | Maximum current power for today. | | today_max_current | W | Maximum current power for today. (only for connection via ethernet module) |
| total_yield | kWh | Total kWh generated to date. | | total_yield | kWh | Total kWh generated to date. |
| total_time | h | Total running time of the inverter . | | total_time | h | Total running time of the inverter . |
| total_co2_reduced | kg | Total CO2 in kg reduced. | | total_co2_reduced | kg | Total CO2 in kg reduced. |
| temperature | °C | Temperature of the inverter. | | temperature | °C | Temperature of the inverter. |
| state | N/A | Live state of the inverter. | | state | N/A | Live state of the inverter. |
## Full configuration example for WiFi inverters
```yaml
sensor:
- platform: saj
host: IP_ADDRESS_OF_DEVICE
type: wifi
username: USERNAME
password: PASSWORD
```