From 9084527c325ce34397d6a6ef0d7faf573053d2d5 Mon Sep 17 00:00:00 2001 From: Maikel Punie Date: Mon, 9 Sep 2019 20:20:39 +0200 Subject: [PATCH] Solaredge documentation for #26282 (#10256) * Velbus quality scale * Revert "Velbus quality scale" This reverts commit f972eb9e21d332737002364b91bc8ce8ce26329c. * Update solaredge documentation for config entries support * :pencil2: Tweak * :pencil2: Tweaks * Update to latest code * Remove note * :fire: Removed minimal full configuration example --- source/_components/solaredge.markdown | 82 +++------------------------ 1 file changed, 8 insertions(+), 74 deletions(-) diff --git a/source/_components/solaredge.markdown b/source/_components/solaredge.markdown index 938b73c4ce9..a0a4e0fe3b0 100644 --- a/source/_components/solaredge.markdown +++ b/source/_components/solaredge.markdown @@ -20,15 +20,17 @@ The SolarEdge Monitoring API has a daily rate limit of 300 requests. In order to ## Configuration -To use the SolarEdge sensors in your installation, add the following to your configuration.yaml file: +There are 2 options in configuring the SolarEdge integration: + +- Via the Home Assistant user interface where it will let you enter the port string to connect to the Velbus bus. +- Via the Home Assistant `configuration.yaml` file. {% raw %} ```yaml # Example configuration.yaml entry -sensor: - - platform: solaredge - api_key: API_KEY - site_id: SITE_ID +solaredge: + api_key: API_KEY + site_id: SITE_ID ``` {% endraw %} @@ -46,77 +48,9 @@ name: 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: - lifetime_energy: - description: Lifetime energy generated at your SolarEdge Site in Wh - energy_this_year: - description: Energy generated this year at your SolarEdge Site in Wh - energy_this_month: - description: Energy generated this month at your SolarEdge Site in Wh - energy_today: - description: Energy generated today at your SolarEdge Site in Wh - current_power: - description: Current generated power in W - site_details: - description: Site details such as name, location, status, etc. - meters: - description: Site equipment details of connected meters. The sensor value shows the number of meters. Each meter is available as an attribute - sensors: - description: Site equipment details of connected sensors. The sensor value shows the number of sensors. Each sensor is available as an attribute - gateways: - description: Site equipment details of connected gateways. The sensor value shows the number of gateways. Each gateway is available as an attribute - batteries: - description: Site equipment details of connected batteries. The sensor value shows the number of batteries. Each battery is available as an attribute - inverters: - description: Site equiment details of connected inverters. The sensor values shows the number of inverters. Each inverter is available as an attribute - power_consumption: - description: Show the current power consumption of your SolarEdge Site (additional hardware required) - solar_power: - description: Show the current power production of your SolarEdge Site (additional hardware required) - grid_power: - description: Show the current power flow from/to the power grid. State will be either positive of negative indicating importing or exporting electricity (additional hardware required) - storage_power: - description: Show the current power flow from/to your site storage. State will be either positive of negative indicating discharging or charging (additional hardware required) - {% endconfiguration %} -If no **monitored_conditions** are specified, only **current_power** will be enabled. - -### 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 - - energy_today - - energy_this_month - - energy_this_year - - lifetime_energy - - site_details - - meters - - sensors - - gateways - - batteries - - inverters - - power_consumption - - solar_power - - grid_power - - storage_power -``` -{% endraw %} +## Full configuration example 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/).