jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 01:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update configuration description for binary_sensor.tcp (#6704)

Browse Source 
* Update configuration description for binary_sensor.tcp

* Fix some mistakes...oops.
This commit is contained in:
Travis Carr 2018-10-13 04:09:06 -07:00 committed by Franck Nijhof
parent 5f86763e72
commit 56855dec14
1 changed files with 34 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
source/_components/binary_sensor.tcp.markdown
View File

@ -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 %}