Telnet - xoseperez/espurna GitHub Wiki

Description

Basic socket server. When terminal support is also enabled, allows commands input. Prints debug messages when debug support is enabled.

  • Recommended clients are nc or nmap-ncat
  • Will not work in real TELNET mode w/ programms like PuTTY, make sure to use RAW connection and disable things like Telnet line-endings, environment and state control.
  • By default, telnet server will disallow connections in STA mode!

Build settings

Build flag Description Default value
DEBUG_TELNET_SUPPORT Show debug messages 1 (on)
TELNET_AUTHENTICATION Require password when connecting 1 (on)
TELNET_LINE_BUFFER_SIZE Temporary buffer size; when data arrives in multiple pacckets, without a trailing new line 256
TELNET_MAX_CLIENTS Maximum amount of simultaniously connected clients 1
TELNET_PORT 23
TELNET_REVERSE_SUPPORT Initiate connection with a remote server using telnet.reverse terminal command or MQTT topic 0 (disabled)
TELNET_STA Allow connections when in STA mode 0 (off)
TELNET_SUPPORT 1 (enabled)

Configuration

Key Description Possible values Default value
telnetAuth Require password when connecting 0 (no) or 1 (yes) 1 (yes)
telnetPort 23
telnetSTA Allow connections in STA mode 0 (no) or 1 (yes) 0 (no)