diff --git a/source/_components/sensor.efergy.markdown b/source/_components/sensor.efergy.markdown index 3ffd7d36d77..3291644614e 100644 --- a/source/_components/sensor.efergy.markdown +++ b/source/_components/sensor.efergy.markdown @@ -45,16 +45,43 @@ sensor: - type: current_values ``` -Configuration variables: - -- **app_token** (*Required*): The App Token for your account. -- **utc_offset** (*Required*): Some variables (currently only the daily_cost) require that the negative number of minutes your timezone is ahead/behind UTC time. -- **monitored_variables** array (*Required*): Variables to monitor. - - **type** (*Required*): Name of the variable. - - **instant_readings**: Instant energy consumption. - - **budget**: Monthly budget. - - **cost**: The cost for energy consumption (with the tariff that has been set in Efergy) over a given period. - - **amount**: The amount of energy consumed over a given period. - - **current_values**: This returns the current energy usage of each device on your account, as `efergy_\`. If you only have one device in your account, this is effectively the same as instant_readings. - - **period** (*Optional*): Some variables take a period argument. Valid options are "day", "week", "month", and "year". - - **currency** (*Optional*): This is used to display the cost/period as the unit when monitoring the cost. It should correspond to the actual currency used in your dashboard. +{% configuration %} +app_token: + description: The App Token for your account. + required: true + type: string +utc_offset: + description: Some variables (currently only the daily_cost) require that the negative number of minutes your timezone is ahead/behind UTC time. + required: false + default: 0 + type: string +monitored_variables: + description: Variables to monitor. + required: true + type: list + keys: + type: + description: Name of the variable. + required: true + type: list + keys: + instant_readings: + description: Instant energy consumption. + budget: + description: Monthly budget. + cost: + description: The cost for energy consumption (with the tariff that has been set in Efergy) over a given period. + amount: + description: The amount of energy consumed over a given period. + current_values: + description: This returns the current energy usage of each device on your account, as `efergy_\`. If you only have one device in your account, this is effectively the same as instant_readings. + period: + description: Some variables take a period argument. Valid options are "day", "week", "month", and "year". + required: false + default: year + type: string + currency: + description: This is used to display the cost/period as the unit when monitoring the cost. It should correspond to the actual currency used in your dashboard. + required: false + type: string +{% endconfiguration %}