Home Assistant Home Assistant

Telnet

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:

# Example configuration.yaml entry
switch:
  - platform: telnet
    switches:
      projector:
        resource: THE_IP_ADDRESS
        port: 4002
        command_on: "PWR ON"
        command_off: "PWR OFF"
        command_state: "PWR?"
        value_template: '{{ value == "PWR=01" }}'
        timeout: 0.9

Configuration Variables

Looking for your configuration file?
switches list Required

The array that contains all switches.

identifier list Required

Name of the switch as slug. Multiple entries are possible.

resource string Required

Host name or IP address of the device.

port integer (Optional, default: 23)

Port to connect to.

command_on string Required

Command to turn device on.

command_off string Required

Command to turn device off.

command_state string (Optional)

Command to determine the state of the switch. If not defined the switch will assume successful state changes.

value_template template (Optional)

The template evaluating to true will indicate that the switch is on.

name string (Optional)

The name used to display the switch in the frontend.

timeout float (Optional, default: 0.2)

How long to wait for a reply after a telnet command is sent.