Telnet switch docs#3165
Conversation
Landrash
added
the
new-integration
Landrash
left a comment
Landrash
left a comment
There was a problem hiding this comment.
Looks good with some minor feedback.
If possible I would suggest adding in a practical example after the variables.
| footer: true | ||
| logo: home-assistant.png | ||
| ha_category: Switch | ||
| ha_release: 0.51 |
There was a problem hiding this comment.
Next release will be 0.51 but this most likely won't be able to merged into that since 0.51 is rather imminent.
Suggest you update this to 0.52.
| --- | ||
|
|
||
|
|
||
| The `telnet` switch platform allows you to control devices with telnet commands. It connects to a host on port 23. |
There was a problem hiding this comment.
Telnet is typically used over port 23 but there's some applications and hardware that may use different ports.
There was a problem hiding this comment.
I added a port parameter to the Telnet switch.
| --- | ||
| layout: page | ||
| title: "Telnet Switch" | ||
| description: "Instructions how to integrate telnet switches into Home Assistant." |
There was a problem hiding this comment.
Telnet is commonly written with a capital T in documentation. This isn't necessarily correct but fairly common.
| Configuration variables: | ||
|
|
||
| - **switches** (*Required*): The array that contains all switches. | ||
| - **identifier** (*Required*): Name of the switch as slug. Multiple entries are possible. |
There was a problem hiding this comment.
I think this should be rephrased since the word "slug" isn't a commonly used phrase for users new to this area.
There was a problem hiding this comment.
@Landrash Since you disagree with the current content, could you please provide a suggestion?
|
I don't think an extra example is needed. The configuration show already how to define a device. |
| - **command_off** (*Required*): Command to turn device off. | ||
| - **command_state** (*Required*): Command to determine the state of the switch. | ||
| - **value_template** (*Required*): The template evaluating to `true` will indicate the switch is on. | ||
| - **optimistic** (*Optional*): Flag that defines if switch works in optimistic mode. Default is `true` if no `command_state` defined, else `false`. |
There was a problem hiding this comment.
optimistic should be removed as well to reflect the latest changes.
|
Removed optimistic parameter. |
|
The parent PR has been merged. Could you guys take a look on how to move this documentation PR forward? Thanks! |
|
Everything fine from my side. |
5 participants
Description:
Docs for telnet switch.
Pull request in home-assistant (if applicable): home-assistant/core#8913