Command Line Interface

This module includes functions that control the Thread stack's execution. More...

Typedefs
typedef int(*	otCliConsoleOutputCallback )(const char *aBuf, uint16_t aBufLength, void *aContext)

Functions
void	otCliConsoleInit (otInstance *aInstance, otCliConsoleOutputCallback aCallback, void *aContext)
void	otCliConsoleInputLine (char *aBuf, uint16_t aBufLength)
void	otCliUartInit (otInstance *aInstance)
void	otCliUartSetUserCommands (const otCliCommand *aUserCommands, uint8_t aLength)
void	otCliUartOutputBytes (const uint8_t *aBytes, uint8_t aLength)
void	otCliUartOutputFormat (const char *aFmt,...)
void	otCliUartAppendResult (otError aError)
void	otCliPlatLogv (otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list ap)

Detailed Description

This module includes functions that control the Thread stack's execution.

Typedef Documentation

typedef int(* otCliConsoleOutputCallback)(const char *aBuf, uint16_t aBufLength, void *aContext)

This function pointer is called to notify about Console output.

Parameters

[in]	aBuf	A pointer to a buffer with an output.
[in]	aBufLength	A length of the output data stored in the buffer.
[out]	aContext	A user context pointer.

Returns

Number of bytes processed by the callback.

Function Documentation

void otCliConsoleInit	(	otInstance *	aInstance,
		otCliConsoleOutputCallback	aCallback,
		void *	aContext
	)

Initialize the CLI CONSOLE module.

Parameters

[in]	aInstance	The OpenThread instance structure.
[in]	aCallback	A callback method called to process console output.
[in]	aContext	A user context pointer.

void otCliConsoleInputLine	(	char *	aBuf,
		uint16_t	aBufLength
	)

This method is called to feed in a console input line.

Parameters

[in]	aBuf	A pointer to a buffer with an input.
[in]	aBufLength	A length of the input data stored in the buffer.

void otCliPlatLogv	(	otLogLevel	aLogLevel,
		otLogRegion	aLogRegion,
		const char *	aFormat,
		va_list	ap
	)

Callback to write the OpenThread Log to the CLI console

Parameters

[in]	aLogLevel	The log level.
[in]	aLogRegion	The log region.
[in]	aFormat	A pointer to the format string.
[in]	ap	va_list matching aFormat.

void otCliUartAppendResult

(

otError

aError

)

Write error code the CLI console

Parameters

[in]

aError

Error code value.

void otCliUartInit

(

otInstance *

aInstance

)

Initialize the CLI UART module.

Parameters

[in]

aInstance

The OpenThread instance structure.

void otCliUartOutputBytes	(	const uint8_t *	aBytes,
		uint8_t	aLength
	)

Write a number of bytes to the CLI console as a hex string.

Parameters

[in]	aBytes	A pointer to data which should be printed.
[in]	aLength	aBytes length.

void otCliUartOutputFormat	(	const char *	aFmt,
			...
	)

Write formatted string the CLI console

Parameters

[in]	aFmt	A pointer to the format string.
[in]	...	A matching list of arguments.

void otCliUartSetUserCommands	(	const otCliCommand *	aUserCommands,
		uint8_t	aLength
	)

Set a user command table.

Parameters

[in]	aUserCommands	A pointer to an array with user commands.
[in]	aLength	aUserCommands length.