From 968403251a64b70949f32ccfb6525ec95b4a1988 Mon Sep 17 00:00:00 2001 From: Travis Carr Date: Fri, 12 Oct 2018 11:08:42 -0700 Subject: [PATCH] Update history_graph and netatmo config specifications. (#6707) * Clean up configuration options for history_graph * Update netatmo config formatting * Remove title * Minor fixes --- source/_components/history_graph.markdown | 29 ++++++++++++++++------- source/_components/netatmo.markdown | 28 ++++++++++++++++++---- 2 files changed, 44 insertions(+), 13 deletions(-) diff --git a/source/_components/history_graph.markdown b/source/_components/history_graph.markdown index 5059d1ba1cb..a929385fa18 100644 --- a/source/_components/history_graph.markdown +++ b/source/_components/history_graph.markdown @@ -30,14 +30,27 @@ history_graph: ``` -### {% linkable_title Configuration variables %} - -| Attribute | Optional | Default | Description | -|---------------------------|----------|-------------------------------------------------------| -| `entities` | no | | List of entities whose history to show as a graph. | -| `name` | yes | ID | Name to display. | -| `hours_to_show` | yes | 24 | Number of hours to show. | -| `refresh` | yes | 0 | Number of seconds between graph refreshes. 0 for no refreshes. | +{% configuration %} +entities: + description: List of entities whose history to show as a graph. + required: true + type: string +name: + description: Name to display. + required: false + default: ID + type: string +hours_to_show: + description: Number of hours to show in the graph. + required: false + default: 24 + type: integer +refresh: + description: Number of seconds between graph refreshes. 0 to disable refreshing. + required: false + default: 0 + type: integer +{% endconfiguration %} ### {% linkable_title Full Example %} diff --git a/source/_components/netatmo.markdown b/source/_components/netatmo.markdown index 0efe4ac968c..8735db3992c 100644 --- a/source/_components/netatmo.markdown +++ b/source/_components/netatmo.markdown @@ -29,11 +29,29 @@ netatmo: Configuration variables: -- **api_key** (*Required*): The `client id` form your Netatmo app. -- **secret_key** (*Required*): The `client secret` form your Netatmo app. -- **username** (*Required*): Username for the Netatmo account. -- **password** (*Required*): Password for the Netatmo account. -- **discovery** (*Optional)*: Whether to discover Netatmo devices. Set it to False, if you want to choose which Netatmo device you want to add (default True). +{% configuration %} +api_key: + description: The `client id` from your Netatmo app. + required: true + type: string +secret_key: + description: The `client secret` from your Netatmo app. + required: true + type: integer +username: + description: Username for the Netatmo account. + required: true + type: string +password: + description: Password for the Netatmo account. + required: true + type: string +discovery: + description: Whether to discover Netatmo devices. Set it to False, if you want to choose which Netatmo device you want to add. + required: false + type: string + default: true +{% endconfiguration %} ### {% linkable_title Get API and Secret Key %}