diff --git a/source/_components/switch.telnet.markdown b/source/_components/switch.telnet.markdown index ef1345cd5bf..7a11cff4cf1 100644 --- a/source/_components/switch.telnet.markdown +++ b/source/_components/switch.telnet.markdown @@ -12,33 +12,64 @@ 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: +{% raw %} ```yaml # Example configuration.yaml entry switch: platform: telnet switches: projector: - resource: "host_or_ip" + resource: THE_IP_ADDRESS port: 4002 command_on: "PWR ON" command_off: "PWR OFF" command_state: "PWR?" - value_template: '{% raw %}{{ value == "PWR=01" }}{% endraw %}' + value_template: '{{ value == "PWR=01" }}' ``` +{% endraw %} -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** (*Optional*): Command to determine the state of the switch. If not defined the switch will assume successful state changes. - - **value_template** (*Optional*): The template evaluating to `true` will indicate that the switch is on. - - **name** (*Optional*): The name used to display the switch in the frontend. +{% configuration %} +switches: + description: The array that contains all switches. + required: true + type: list + keys: + identifier: + description: Name of the switch as slug. Multiple entries are possible. + required: true + type: list + keys: + resource: + description: Host name or IP address of the device. + required: true + type: string + port: + description: Port to connect to. + required: false + default: 23 + type: integer + command_on: + description: Command to turn device on. + required: true + type: string + command_off: + description: Command to turn device off. + required: true + type: string + command_state: + description: Command to determine the state of the switch. If not defined the switch will assume successful state changes. + required: false + type: string + value_template: + description: The template evaluating to `true` will indicate that the switch is on. + required: false + type: template + name: + description: The name used to display the switch in the frontend. + required: false + type: string +{% endconfiguration %}