mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-05 10:38:58 +00:00
66 lines
2.0 KiB
Markdown
66 lines
2.0 KiB
Markdown
---
|
|
layout: page
|
|
title: TCP Binary Sensor
|
|
description: "Instructions on how to set up TCP binary sensors within Home Assistant."
|
|
date: 2016-02-22 11:05
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: tcp_ip.png
|
|
ha_category: Binary Sensor
|
|
ha_release: 0.14
|
|
---
|
|
|
|
The TCP Binary Sensor is a type of [TCP Sensor](/components/sensor.tcp/) which is either "off" or "on". In order to use this sensor type, in addition to the configuration for the TCP Sensor, you must supply a `value_on` value to represent what is returned when the device is turned on.
|
|
|
|
To enable this sensor, add the following lines to your `configuration.yaml`:
|
|
|
|
```yaml
|
|
binary_sensor:
|
|
# Example configuration.yaml entry
|
|
platform: tcp
|
|
name: TCP Binary Sensor
|
|
host: IP_ADDRESS
|
|
port: PORT
|
|
payload: "r State\n"
|
|
value_on: 1
|
|
timeout: 5
|
|
```
|
|
|
|
Configuration options for the a TCP Sensor:
|
|
|
|
{% 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 %} |