From 35c172c73ec9c9a05d4558b871fb18ec362b355b Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Fri, 26 Oct 2018 10:21:05 +0200 Subject: [PATCH] Update Sma sensor component configuration (#7099) * Update Sma sensor component configuration * :ambulance: Fix --- source/_components/sensor.sma.markdown | 77 +++++++++++++++++++------- 1 file changed, 56 insertions(+), 21 deletions(-) diff --git a/source/_components/sensor.sma.markdown b/source/_components/sensor.sma.markdown index 6f8fe3c2b5e..dcf04f87963 100644 --- a/source/_components/sensor.sma.markdown +++ b/source/_components/sensor.sma.markdown @@ -13,7 +13,6 @@ ha_iot_class: "Local Polling" ha_release: 0.36 --- - The `sma` sensor will poll a [SMA](http://www.sma-solar.com/) [(US)](http://www.sma-america.com/) solar inverter and present the values as sensors (or attributes of sensors) in Home Assistant. ## {% linkable_title Configuration %} @@ -28,28 +27,63 @@ sensor: password: YOUR_SMA_PASSWORD sensors: current_consumption: [total_consumption] - current_power: - total_yield: + current_power: + total_yield: ``` -Configuration variables: +{% configuration %} +host: + description: The IP address of the SMA WebConnect module. + required: true + type: string +ssl: + description: + required: false + default: false + type: boolean +password: + description: The password of the SMA WebConnect module. + required: true + type: string +group: + description: The user group, which can be either `user` or `installer`. + required: false + default: user + type: string +sensors: + description: A dictionary of sensors that will be added. The value of the dictionary can include sensor names that will be shown as attributes. + required: true + type: list + keys: + current_power: + description: Current power. + current_consumption: + description: Current consumption. + total_power: + description: Total power. + total_consumption: + description: Total consumption. +custom: + description: A dictionary of custom sensor key values and units. + required: false + type: list + keys: + key: + description: The SMA sensor key. + required: true + type: string + unit: + description: Unit. + required: true + type: string + factor: + description: Factor. + required: false + default: 1 + type: float +{% endconfiguration %} -- **host** (*Required*): The IP address of the SMA WebConnect module. -- **password** (*Required*): The password of the SMA WebConnect module. -- **group** (*Optional*): The user group, which can be either `user` (the default) or `installer`. -- **sensors** (*Required*): A dictionary of sensors that will be added. The value of the dictionary can include sensor names that will be shown as attributes. -- **custom** (*Optional*): A dictionary of custom sensor key values and units. - -Sensors configuration: - -The sensors can be any one of the following: - -- current_power -- current_consumption -- total_power -- total_consumption - -You can create composite sensors, where the sub-sensors will be attributes of the main sensor, e.g. +You can create composite sensors, where the sub-sensors will be attributes of the main sensor. E.g., ```yaml sensors: @@ -59,9 +93,10 @@ You can create composite sensors, where the sub-sensors will be attributes of th The SMA WebConnect module supports a wide variety of sensors, and not all these have been mapped to standard sensors. Custom sensors can be defined by using the `custom` section of the configuration. You will need: A sensor name (no spaces), the SMA sensor key and the unit Example: + ```yaml custom: - yesterday_consumption: + yesterday_consumption: key: 6400_00543A01 unit: kWh factor: 1000