forked from rweather/arduinolibs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
shell-telnet.dox
39 lines (34 loc) · 1.71 KB
/
shell-telnet.dox
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/*
* Copyright (C) 2016 Southern Storm Software, Pty Ltd.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
/**
\file shell-telnet.dox
\page shell_telnet Telnet server example
The Shell class provides a Unix-like shell for issuing commands to
the Arduino. The LoginShell class extends Shell to also include login
functionality. The user is prompted for username and password before
access is granted to shell commands.
This example shows how to use LoginShell to provide command-line access
over the Internet via the telnet protocol. The example has one command
"led" for turning the status LED on D13 on and off.
The full source code for the example follows:
\include Shell/examples/TelnetServer/TelnetServer.ino
*/