Command Line Interface
This module includes functions that control the Thread stack's execution.
Summary
Typedefs |
|
---|---|
otCliConsoleOutputCallback)(const char *aBuf, uint16_t aBufLength, void *aContext)
|
typedefint(*
This function pointer is called to notify about Console output. |
Functions |
|
---|---|
otCliAppendResult(otError aError)
|
void
Write error code to the CLI console.
|
otCliConsoleInit(otInstance *aInstance, otCliConsoleOutputCallback aCallback, void *aContext)
|
void
Initialize the CLI CONSOLE module.
|
otCliConsoleInputLine(char *aBuf, uint16_t aBufLength)
|
void
This method is called to feed in a console input line.
|
otCliOutput(const char *aString, uint16_t aLength)
|
void
Write string to the CLI console.
|
otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength)
|
void
Write a number of bytes to the CLI console as a hex string.
|
otCliOutputFormat(const char *aFmt, ...)
|
void
Write formatted string to the CLI console.
|
otCliPlatLogLine(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aLogLine)
|
void
Function to write the OpenThread Log to the CLI console.
|
otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
|
void
Callback to write the OpenThread Log to the CLI console.
|
otCliSetUserCommands(const otCliCommand *aUserCommands, uint8_t aLength, void *aContext)
|
void
Set a user command table.
|
otCliUartInit(otInstance *aInstance)
|
void
Initialize the CLI UART module.
|
Typedefs
otCliConsoleOutputCallback
int(* otCliConsoleOutputCallback)(const char *aBuf, uint16_t aBufLength, void *aContext)
This function pointer is called to notify about Console output.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Returns |
Number of bytes processed by the callback.
|
Functions
otCliAppendResult
void otCliAppendResult( otError aError )
Write error code to the CLI console.
If the aError
is OT_ERROR_PENDING
nothing will be outputted.
Details | |||
---|---|---|---|
Parameters |
|
otCliConsoleInit
void otCliConsoleInit( otInstance *aInstance, otCliConsoleOutputCallback aCallback, void *aContext )
Initialize the CLI CONSOLE module.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
otCliConsoleInputLine
void otCliConsoleInputLine( char *aBuf, uint16_t aBufLength )
This method is called to feed in a console input line.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otCliOutput
void otCliOutput( const char *aString, uint16_t aLength )
Write string to the CLI console.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otCliOutputBytes
void otCliOutputBytes( const uint8_t *aBytes, uint8_t aLength )
Write a number of bytes to the CLI console as a hex string.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otCliOutputFormat
void otCliOutputFormat( const char *aFmt, ... )
Write formatted string to the CLI console.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otCliPlatLogLine
void otCliPlatLogLine( otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aLogLine )
Function to write the OpenThread Log to the CLI console.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
otCliPlatLogv
void otCliPlatLogv( otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs )
Callback to write the OpenThread Log to the CLI console.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
otCliSetUserCommands
void otCliSetUserCommands( const otCliCommand *aUserCommands, uint8_t aLength, void *aContext )
Set a user command table.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
otCliUartInit
void otCliUartInit( otInstance *aInstance )
Initialize the CLI UART module.
Details | |||
---|---|---|---|
Parameters |
|