From e8cbe07067a824f83c8a5f8e232e701531c0819b Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Thu, 11 Oct 2018 21:43:02 +0200 Subject: [PATCH] Update Mochad light and switch component configuration variable (#6680) * Update Mochad light and switch component configuration variable Update style of Mochad light and switch component documentation to follow new configuration variables description. Related to #6385. * :ambulance: Bugfix * :rewind: Undo last change * :ambulance: Fix * :ambulance: Fix round 2 --- source/_components/light.mochad.markdown | 28 +++++++++++++++++------ source/_components/switch.mochad.markdown | 24 ++++++++++++------- 2 files changed, 37 insertions(+), 15 deletions(-) diff --git a/source/_components/light.mochad.markdown b/source/_components/light.mochad.markdown index 9721e9d6c98..c175d48ffd1 100644 --- a/source/_components/light.mochad.markdown +++ b/source/_components/light.mochad.markdown @@ -26,10 +26,24 @@ light: - address: a5 ``` -Configuration variables: - -- **address** (*Required*): The X10 address of the light. -- **name** (*Optional*): The name of the light. Default is: x10_light_dev_*address*. -- **comm_type** (*Optional*): pl (powerline) or rf (radio frequency). Default is pl. -- **brightness_levels** (*Optional*): The number of brightness levels the X10 light device supports. This can either be 32, 64, or 256 (note that the max -value sent to the device will be n-1 because it starts at 0) +{% configuration %} +address: + description: The X10 address of the light. + required: true + type: string +name: + description: The name of the light. + required: false + default: x10_light_dev_address + type: string +comm_type: + description: pl (powerline) or rf (radio frequency). + required: false + default: pl + type: string +brightness_levels: + description: The number of brightness levels the X10 light device supports. This can either be 32, 64, or 256 (note that the max value sent to the device will be n-1 because it starts at 0). + required: false + default: 32 + type: integer +{% endconfiguration %} diff --git a/source/_components/switch.mochad.markdown b/source/_components/switch.mochad.markdown index a1d7569ec17..6d9c2bba878 100644 --- a/source/_components/switch.mochad.markdown +++ b/source/_components/switch.mochad.markdown @@ -27,11 +27,19 @@ switch: - address: a5 ``` -Configuration variables: - -- **address** (*Required*): The X10 address of the switch. -- **name** (*Optional*): The name of the switch. Default is: x10_switch_dev_*address*. -- **comm_type** (*Optional*): pl (powerline) or rf (radio frequency). Default is pl. - - - +{% configuration %} +address: + description: The X10 address of the switch. + required: true + type: string +name: + description: The name of the switch. + required: false + default: x10_switch_dev_*address* + type: string +comm_type: + description: pl (powerline) or rf (radio frequency). + required: false + default: pl + type: string +{% endconfiguration %}