From 56855dec14ef8884e4ce5d5c4c083e0f71e4389b Mon Sep 17 00:00:00 2001 From: Travis Carr Date: Sat, 13 Oct 2018 04:09:06 -0700 Subject: [PATCH] Update configuration description for binary_sensor.tcp (#6704) * Update configuration description for binary_sensor.tcp * Fix some mistakes...oops. --- source/_components/binary_sensor.tcp.markdown | 43 +++++++++++++++---- 1 file changed, 34 insertions(+), 9 deletions(-) diff --git a/source/_components/binary_sensor.tcp.markdown b/source/_components/binary_sensor.tcp.markdown index ff5aed010c6..e5651d954b6 100644 --- a/source/_components/binary_sensor.tcp.markdown +++ b/source/_components/binary_sensor.tcp.markdown @@ -30,12 +30,37 @@ binary_sensor: Configuration options for the a TCP Sensor: -- **name** (*Required*): The name you'd like to give the sensor in Home Assistant. -- **host** (*Required*): The hostname/IP address to connect to. -- **port** (*Required*): The port to connect to the host on. -- **payload** (*Required*): What to send to the host in order to get the response we're interested in. -- **value_on** (*Required*): The value returned when the device is "on". -- **timeout** (*Optional*): How long in seconds to wait for a response from the service before giving up and disconnecting. Defaults to 10. -- **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value. By default it's assumed that the entire response is the value. -- **buffer_size** (*Optional*): The size of the receive buffer in bytes. Set this to a larger value if you expect to receive a response larger than the default. Defaults to 1024. - +{% configuration %} +name: + required: true + description: The name you'd like to give the sensor in Home Assistant. + type: string +host: + required: true + description: The hostname/IP address to connect to. + type: string +port: + required: true + description: The port to connect to the host on. + type: integer +payload: + required: true + description: What to send to the host in order to get the response we're interested in. + type: string +value_on: + required: true + description: The value returned when the device is "on". + type: string +timeout: + required: false + description: How long in seconds to wait for a response from the service before giving up and disconnecting. Defaults to 10. + type: integer +value_template: + required: false + description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value. By default it's assumed that the entire response is the value. + type: string +buffer_size: + required: false + description: The size of the receive buffer in bytes. Set this to a larger value if you expect to receive a response larger than the default. Defaults to 1024. + type: integer +{% endconfiguration %} \ No newline at end of file