From f4ea2f070b563b92d4c4d8c89b4abcd6e183ee4f Mon Sep 17 00:00:00 2001 From: Jesse Rizzo <32472573+jesserizzo@users.noreply.github.com> Date: Tue, 17 Sep 2019 14:16:15 -0500 Subject: [PATCH] Enphase envoy Add optional name field (#10378) * Add optional name field * :pencil2: Tweak * :pencil2: Tweak --- source/_components/enphase_envoy.markdown | 33 ++++++++++++++--------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/source/_components/enphase_envoy.markdown b/source/_components/enphase_envoy.markdown index 18d346c8cb8..46d59a6a7aa 100644 --- a/source/_components/enphase_envoy.markdown +++ b/source/_components/enphase_envoy.markdown @@ -12,7 +12,7 @@ redirect_from: A sensor platform for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy-and-combiner) solar energy gateway. Works with older models that only have production metrics (ie. Envoy-C) and newer models that offer both production and consumption metrics (ie. Envoy-S). -### Configuration +## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -22,19 +22,11 @@ sensor: - platform: enphase_envoy ``` -```yaml -# Example configuration.yaml entry, limiting the metrics to production only -sensor: - - platform: enphase_envoy - ip_address: LOCAL_IP_FOR_ENVOY - monitored_conditions: - - production - - daily_production - - seven_days_production - - lifetime_production -``` - {% configuration %} +name: + required: false + type: string + description: An optional name that will be prepended to the sensor type ip_address: description: The local IP address of your Envoy. Leave blank to use the default host name 'envoy', but this may not always be reliable. You should be able to just browse to this IP address. required: false @@ -63,3 +55,18 @@ monitored_conditions: inverters: description: The power in W being produced by each micro-inverter. This will create a separate sensor for each micro-inverter you have installed. These sensors will only update about every 15 minutes, this is a limitation of the Enphase Envoy API. {% endconfiguration %} + +### Full example + +```yaml +# Example configuration.yaml entry, limiting the metrics to production only +sensor: + - platform: enphase_envoy + name: Optional_name + ip_address: LOCAL_IP_FOR_ENVOY + monitored_conditions: + - production + - daily_production + - seven_days_production + - lifetime_production +```