Skip to content

Commit e0aef27

Browse files
multiholleballoob
authored andcommitted
Telnet switch docs (home-assistant#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.
1 parent 28b5ca9 commit e0aef27

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
layout: page
3+
title: "Telnet Switch"
4+
description: "Instructions how to integrate telnet switches into Home Assistant."
5+
date: 2017-08-10 19:19
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: home-assistant.png
11+
ha_category: Switch
12+
ha_release: 0.54
13+
ha_iot_class: "Local Polling"
14+
---
15+
16+
17+
The `telnet` switch platform allows you to control devices with telnet commands.
18+
19+
To enable this switch, add the following lines to your `configuration.yaml` file:
20+
21+
```yaml
22+
# Example configuration.yaml entry
23+
switch:
24+
platform: telnet
25+
switches:
26+
projector:
27+
resource: "host_or_ip"
28+
port: 4002
29+
command_on: "PWR ON"
30+
command_off: "PWR OFF"
31+
command_state: "PWR?"
32+
value_template: '{{ value == "PWR=01" }}'
33+
```
34+
35+
Configuration variables:
36+
37+
- **switches** (*Required*): The array that contains all switches.
38+
- **identifier** (*Required*): Name of the switch as slug. Multiple entries are possible.
39+
- **resource** (*Required*): Host or IP of the device.
40+
- **port** (*Optional*): Port to connect to. Default is 23 if not defined.
41+
- **command_on** (*Required*): Command to turn device on.
42+
- **command_off** (*Required*): Command to turn device off.
43+
- **command_state** (*Required*): Command to determine the state of the switch. If not defined the switch will assume successful state changes.
44+
- **value_template** (*Required*): The template evaluating to `true` will indicate the switch is on.
45+
- **name** (*Optional*): The name used to display the switch in the frontend.

0 commit comments

Comments
 (0)