From a238c0295b7042ff3f8ff80cda14af49a6d05956 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Thu, 23 Nov 2017 08:29:18 +0100 Subject: [PATCH] Update variable description style (#4043) * Update variable description style * :pencil2: Tiny grammar fix * :pencil2: Tiny grammar fix --- source/_components/light.mystrom.markdown | 20 +++++++++++++++----- source/_components/switch.mystrom.markdown | 15 +++++++++++---- 2 files changed, 26 insertions(+), 9 deletions(-) diff --git a/source/_components/light.mystrom.markdown b/source/_components/light.mystrom.markdown index ea1334c3f97..f9ceacdb226 100644 --- a/source/_components/light.mystrom.markdown +++ b/source/_components/light.mystrom.markdown @@ -26,11 +26,21 @@ light: mac: MAC_ADDRESS ``` -Configuration variables: - -- **host** (*Required*): The IP address of your myStrom WiFi Bulb, eg. `192.168.1.32`. -- **mac** (*Required*): The MAC address of your myStrom WiFi Bulb, eg. `5AAC8CA542F3`. -- **name** (*Optional*): The name to use when displaying this light. +{% configuration %} +host: + description: "The IP address of your myStrom WiFi Bulb, e.g., `192.168.1.32`." + required: true + type: string +mac: + description: "The MAC address of your myStrom WiFi Bulb, e.g., `5AAC8CA542F3`." + required: true + type: string +name: + description: The name to use when displaying this bulb. + required: false + type: string + default: myStrom Bulb +{% endconfiguration %} Check if you are able to access the light located at `IP_ADRRESS`. The details about your light is provided as a JSON response. diff --git a/source/_components/switch.mystrom.markdown b/source/_components/switch.mystrom.markdown index a9a4e3d7b0c..7c81252bfc9 100644 --- a/source/_components/switch.mystrom.markdown +++ b/source/_components/switch.mystrom.markdown @@ -25,10 +25,17 @@ switch: host: IP_ADRRESS ``` -Configuration variables: - -- **host** (*Required*): The IP address of your myStrom switch, eg. `http://192.168.1.32`. -- **name** (*Optional*): The name to use when displaying this switch. +{% configuration %} +host: + description: "The IP address of your myStrom switch, e.g., `http://192.168.1.32`." + required: true + type: string +name: + description: The name to use when displaying this switch. + required: false + type: string + default: myStrom Switch +{% endconfiguration %} Check if you are able to access the device located at `http://IP_ADRRESS`. The details about your switch is provided as a JSON response.