0.01.00
cli.h File Reference

This file defines the top-level functions for the OpenThread CLI server. More...

#include <stdint.h>
#include <stdarg.h>
#include <openthread/types.h>

Go to the source code of this file.

Classes

struct  otCliCommand
 This structure represents a CLI command. More...
 

Typedefs

typedef struct otCliCommand otCliCommand
 This structure represents a CLI command.
 
typedef int(* otCliConsoleOutputCallback) (const char *aBuf, uint16_t aBufLength, void *aContext)
 This function pointer is called to notify about Console output. More...
 

Functions

void otCliConsoleInit (otInstance *aInstance, otCliConsoleOutputCallback aCallback, void *aContext)
 Initialize the CLI CONSOLE module. More...
 
void otCliConsoleInputLine (char *aBuf, uint16_t aBufLength)
 This method is called to feed in a console input line. More...
 
void otCliUartInit (otInstance *aInstance)
 Initialize the CLI UART module. More...
 
void otCliUartSetUserCommands (const otCliCommand *aUserCommands, uint8_t aLength)
 Set a user command table. More...
 
void otCliUartOutputBytes (const uint8_t *aBytes, uint8_t aLength)
 Write a number of bytes to the CLI console as a hex string. More...
 
void otCliUartOutputFormat (const char *aFmt,...)
 Write formatted string the CLI console. More...
 
void otCliUartAppendResult (otError aError)
 Write error code the CLI console. More...
 
void otCliPlatLogv (otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list ap)
 Callback to write the OpenThread Log to the CLI console. More...
 

Detailed Description

This file defines the top-level functions for the OpenThread CLI server.