diff --git a/source/_components/sensor.solaredge.markdown b/source/_components/sensor.solaredge.markdown new file mode 100644 index 00000000000..eb06e02f896 --- /dev/null +++ b/source/_components/sensor.solaredge.markdown @@ -0,0 +1,105 @@ +--- +layout: page +title: "SolarEdge Sensor" +description: "Instructions on how to integrate SolarEdge sensor within Home Assistant." +date: 2018-12-04 14:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: solaredge.png +ha_category: Sensor +ha_release: 0.85 +ha_iot_class: "Cloud Polling" +--- + +The `solaredge` platform uses the [SolarEdge Monitoring API](https://www.solaredge.com/sites/default/files/se_monitoring_api.pdf) to allow you to get details from your SolarEdge solar power setup and integrate these in your Home Assistant installation. + +
+The SolarEdge Monitoring API has a daily rate limit of 300 requests. In order to stay under this limit, and alow for some additional requests, the `solaredge` platform will update the site overview every 5 minutes. +
+ +## {% linkable_title Configuration %} + +To use the SolarEdge sensors in your installation, add the following to your configuration.yaml file: + +{% raw %} +```yaml +# Example configuration.yaml entry +sensor: + - platform: solaredge + api_key: API_KEY + site_id: SITE_ID + monitored_conditions: + - current_power + - last_day_data +``` +{% endraw %} + +{% configuration %} +api_key: + description: Your SolarEdge Site API key. + required: true + type: string +site_id: + description: The id of your SolarEdge Site. + required: true + type: string +name: + description: Let you overwrite the name of the device in the frontend. + required: false + default: SolarEdge + type: string +monitored_conditions: + description: SolarEdge Site information to be monitored. The following conditions can be monitored. + required: false + type: list + default: current_power + keys: + life_time_data: + description: Lifetime energy generated at your SolarEdge Site in Wh + last_year_data: + description: Energy generated this year at your SolarEdge Site in Wh + last_month_data: + description: Energy generated this month at your SolarEdge Site in Wh + last_day_data: + description: Energy generated today at your SolarEdge Site in Wh + current_power: + description: Current generated power in W +{% endconfiguration %} + +If no **monitored_conditions** are specified, only **current_power** will be enabled. + +### {% linkable_title Full configuration sample %} + +A full configuration entry would look like the sample below. + +{% raw %} +```yaml +# Example configuration.yaml entry +sensor: + - platform: solaredge + api_key: API_KEY + site_id: SITE_ID + name: SolarEdge + monitored_conditions: + - current_power + - last_day_data + - last_month_data + - last_year_data + - life_time_data +``` +{% endraw %} + +In case you would like to convert the values for example to kWh instead of the default Wh, you can use the [template platform](/components/sensor.template/). + +{% raw %} +```yaml +# Example configuration.yaml entry for template platform +sensors: + platform: template + sensors: + solaredge_last_year_data_template: + value_template: '{{(states.sensor.solaredge_last_year_data.state | float / 1000) | round(2)}}' +``` +{% endraw %} diff --git a/source/images/supported_brands/solaredge.png b/source/images/supported_brands/solaredge.png new file mode 100644 index 00000000000..ba4584ccf0e Binary files /dev/null and b/source/images/supported_brands/solaredge.png differ