From c8e634a819980565fe19394870b445a8981967d5 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sun, 28 Oct 2018 18:06:43 +0100 Subject: [PATCH] Update Kwb sensor component configuration (#7127) --- source/_components/sensor.kwb.markdown | 45 +++++++++++++++++--------- 1 file changed, 29 insertions(+), 16 deletions(-) diff --git a/source/_components/sensor.kwb.markdown b/source/_components/sensor.kwb.markdown index e47d36488f0..e8d5493674c 100644 --- a/source/_components/sensor.kwb.markdown +++ b/source/_components/sensor.kwb.markdown @@ -42,20 +42,33 @@ Telnet terminal server with a serial-ethernet converter: raw: False ``` -Configuration variables: +Take a good look at which configuration variables are for `TCP` use or for `serial` use. -*Required if used with a serial-ethernet converter* - -- **host**: The IP-address of the serial server -- **port**: The TCP-port of the serial server -- **type**: tcp - -*Required if used directly with a serial port* - -- **device**: The serial device of the machine -- **type**: serial - -*Optional for both cases* - -- **name**: The name of the device used in the frontend -- **raw**: Should the raw serial output be shown as a sensor +{% configuration %} +raw: + description: Should the raw serial output be shown as a sensor. + required: false + default: false + type: boolean +name: + description: The name of the device used in the frontend. + required: false + default: KWB + type: string +device: + description: (For serial use) The serial device of the machine. + required: true + type: string +host: + description: (For tcp use) The IP-address of the serial server. + required: true + type: string +port: + description: (For tcp use) The TCP-port of the serial server. + required: true + type: integer +type: + description: "Type of sensor, you can choose between: `serial` and `tcp`." + required: true + type: string +{% endconfiguration %}