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)

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 otCliUartInit

(

otInstance *

aInstance

)

Initialize the CLI UART module.

Parameters

[in]

aInstance

The OpenThread instance structure.