GM6000 Digital Heater Controller
Build: 16 (Branch = develop)
SDX-1330
Main Page
Namespaces
Components
Files
File List
File Members
Driver
Wifi
Station
TShell
Wifi.h
Go to the documentation of this file.
1
#ifndef Driver_Wifi_Station_TShell_Dm_h
2
#define Driver_Wifi_Station_TShell_Dm_h
3
/*-----------------------------------------------------------------------------
4
* This file is part of the Colony.Core Project. The Colony.Core Project is an
5
* open source project with a BSD type of licensing agreement. See the license
6
* agreement (license.txt) in the top/ directory or on the Internet at
7
* http://integerfox.com/colony.core/license.txt
8
*
9
* Copyright (c) 2014-2025 John T. Taylor
10
*
11
* Redistributions of the source code must retain the above copyright notice.
12
*----------------------------------------------------------------------------*/
13
/** @file */
14
15
#include "colony_config.h"
16
#include "
Cpl/TShell/Cmd/Command.h
"
17
#include "
Driver/Wifi/Station/Connection.h
"
18
19
20
///
21
namespace
Driver
{
22
///
23
namespace
Wifi {
24
///
25
namespace
Station {
26
///
27
namespace
TShell {
28
29
30
/** This class implements a TShell command.
31
*/
32
class
Wifi
:
public
Cpl::TShell::Cmd::Command
33
{
34
public
:
35
/// The command verb/identifier
36
static
constexpr
const
char
*
verb
=
"wifista"
;
37
38
/// The command usage string
39
static
constexpr
const
char
*
usage
=
40
"wifista\n"
41
"wifista <auth-method> <ssid> <passwd>}\n"
42
"wifista disconnect"
;
43
44
/** The command detailed help string (recommended that lines do not exceed 80 chars)
45
1 2 3 4 5 6 7 8
46
12345678901234567890123456789012345678901234567890123456789012345678901234567890
47
*/
48
static
constexpr
const
char
*
detailedHelp
=
49
" Displays the current Wifi Station connection, connects and disconnect to a\n"
50
" a WIFI network. <auth-method> selection:\n"
51
" 0: No authorization required\n"
52
" 1: WPA authorization\n"
53
" 2: WPA2 authorization (preferred)\n"
54
" 3: eWPA2_MIXED_PSK"
;
55
56
public
:
57
/// See Cpl::TShell::Command `
58
const
char
*
getUsage
() const noexcept {
return
usage
; }
59
60
/// See Cpl::TShell::Command
61
const
char
*
getHelp
() const noexcept {
return
detailedHelp
; }
62
63
64
public
:
65
/// Constructor
66
Wifi
(
Cpl::Container::SList<Cpl::TShell::Command>
& commandList,
67
Cpl::TShell::Security::Permission_T
minPermLevel =
OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL
)
noexcept
;
68
69
70
public
:
71
/// See Cpl::TShell::Command
72
Cpl::TShell::Command::Result_T
execute
(
Cpl::TShell::Context_
& context,
char
* cmdString,
Cpl::Io::Output
& outfd )
noexcept
;
73
};
74
75
};
// end namespaces
76
};
77
};
78
};
79
#endif
// end header latch
Command.h
OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL
#define OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL
Default Permission level for all commands.
Definition
Command.h:22
Connection.h
Cpl::Container::RingBufferMT
This template class implements a THREAD SAFE Ring Buffer.
Definition
RingBufferMT.h:33
Cpl::Io::Output
This partially abstract class defines a interface for operating on an output stream (example of a str...
Definition
Output.h:34
Cpl::TShell::Cmd::Command
This partially concrete class implements infrastructure and/or common functionality for a Shell comma...
Definition
Command.h:37
Cpl::TShell::Command::Result_T
Result_T
Possible result codes when executing a command.
Definition
Command.h:35
Cpl::TShell::Context_
This Private Namespace class defines a "Context" for a TShell command.
Definition
Context_.h:32
Cpl::TShell::Security::Permission_T
Permission_T
Permissions levels.
Definition
Security.h:34
Driver::Wifi::Station::TShell::Wifi
This class implements a TShell command.
Definition
Wifi.h:33
Driver::Wifi::Station::TShell::Wifi::getUsage
const char * getUsage() const noexcept
See Cpl::TShell::Command `.
Definition
Wifi.h:58
Driver::Wifi::Station::TShell::Wifi::execute
Cpl::TShell::Command::Result_T execute(Cpl::TShell::Context_ &context, char *cmdString, Cpl::Io::Output &outfd) noexcept
See Cpl::TShell::Command.
Driver::Wifi::Station::TShell::Wifi::detailedHelp
static constexpr const char * detailedHelp
The command detailed help string (recommended that lines do not exceed 80 chars) 1 2 3 4 5 6 7 8 1234...
Definition
Wifi.h:48
Driver::Wifi::Station::TShell::Wifi::verb
static constexpr const char * verb
The command verb/identifier.
Definition
Wifi.h:36
Driver::Wifi::Station::TShell::Wifi::getHelp
const char * getHelp() const noexcept
See Cpl::TShell::Command.
Definition
Wifi.h:61
Driver::Wifi::Station::TShell::Wifi::Wifi
Wifi(Cpl::Container::SList< Cpl::TShell::Command > &commandList, Cpl::TShell::Security::Permission_T minPermLevel=OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL) noexcept
Constructor.
Driver::Wifi::Station::TShell::Wifi::usage
static constexpr const char * usage
The command usage string.
Definition
Wifi.h:39
Driver
namespace
Generated on Sun Jun 8 2025 21:10:10 for GM6000 Digital Heater Controller by
1.10.0