Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions source/_components/switch.telnet.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
layout: page
title: "Telnet Switch"
description: "Instructions how to integrate telnet switches into Home Assistant."
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Telnet is commonly written with a capital T in documentation. This isn't necessarily correct but fairly common.

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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be rephrased since the word "slug" isn't a commonly used phrase for users new to this area.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Landrash Since you disagree with the current content, could you please provide a suggestion?

- **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.