Telnet switch docs (#3165)

* Added telnet switch docs.

* Update switch.telnet.markdown

* Added port to Telnet switch docs.

* Optimistic attriute in Telnet switch removed.

* friendly_name -> name

* Updated release.
This commit is contained in:
Marcel Holle 2017-09-22 06:40:15 +02:00 committed by Paulus Schoutsen
parent 28b5ca9b5e
commit e0aef27a8a

View File

@ -0,0 +1,45 @@
---
layout: page
title: "Telnet Switch"
description: "Instructions how to integrate telnet switches into Home Assistant."
date: 2017-08-10 19:19
sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Switch
ha_release: 0.54
ha_iot_class: "Local Polling"
---
The `telnet` switch platform allows you to control devices with telnet commands.
To enable this switch, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
platform: telnet
switches:
projector:
resource: "host_or_ip"
port: 4002
command_on: "PWR ON"
command_off: "PWR OFF"
command_state: "PWR?"
value_template: '{{ value == "PWR=01" }}'
```
Configuration variables:
- **switches** (*Required*): The array that contains all switches.
- **identifier** (*Required*): Name of the switch as slug. Multiple entries are possible.
- **resource** (*Required*): Host or IP of the device.
- **port** (*Optional*): Port to connect to. Default is 23 if not defined.
- **command_on** (*Required*): Command to turn device on.
- **command_off** (*Required*): Command to turn device off.
- **command_state** (*Required*): Command to determine the state of the switch. If not defined the switch will assume successful state changes.
- **value_template** (*Required*): The template evaluating to `true` will indicate the switch is on.
- **name** (*Optional*): The name used to display the switch in the frontend.