History

Terry Ellison ce2e50c651 Updates following JM review		2020-06-09 22:26:06 +02:00
..
README.md	Add telnet example	2020-06-09 22:26:06 +02:00
telnet_fifosock.lua	Updates following JM review	2020-06-09 22:26:06 +02:00
telnet_pipe.lua	Updates following JM review	2020-06-09 22:26:06 +02:00

README.md

Telnet Module

Since	Origin / Contributor	Maintainer	Source
2014-12-22	Zeroday	Terry Ellison	simple_telnet.lua
2018-05-24	Terry Ellison	Terry Ellison	telnet.lua

This README discusses the packet marshalling versions of telnet. The first (fifosock) version was written for SDK 2 implementations, with all of the marshalling imlemented in Lua; the second (pipe) version uses the latest features added to the SDK 3 version that have been added to prepare for the lua53 implementation. These exploit the stdin / stdout pipe functionality and task integration that is now build into the NodeNMCU Lua core.

There are two nice advantages of this core implementation:

Errors are now written to stdout in a spearate task execution.
The pipes pretty much eliminate uart and telnet overrun.

Both have the same interface if required into the variable telnet

telnet:open()

Open a telnet server based on the provided parameters.

Syntax

telnet:open(ssid, pwd, port)

Parameters

ssid and password. Strings. SSID and Password for the Wifi network. If these are nil then the wifi is assumed to be configured or autoconfigured.

port. Integer TCP listenting port for the Telnet service. The default is 2323

Returns

Nothing returned (this is evaluted as nil in a scalar context).

telnet:close()

Close a telnet server and release all resources. Also set the variable telnet to nil to fully reference and GC the resources.

Syntax

telnet:close()

Parameters

None

Returns

Nothing returned (this is evaluted as nil in a scalar context).