CC1352P_4_LAUNCHXL/thread/shade/tiop_ui.h File Reference

#include "cui.h"
#include <openthread/thread.h>

Include dependency graph for CC1352P_4_LAUNCHXL/thread/shade/tiop_ui.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	cuiConn {   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail,   CUI_conn_disabled, CUI_conn_joining, CUI_conn_joined, CUI_conn_join_fail }

Functions
void	processKeyChangeCB (Button_Handle _buttonHandle, Button_EventMask _buttonEvents)
	Handles the key pressed events for examples. More...
void	processMenuUpdateFn (void)
	Handles CUI Menu update events for examples. More...
void	tiopCUIInit (char *appString, Button_Handle *rightButtonHandle)
	Initialize example CUI functionality. More...
void	tiopCUINwkReset (const char _input, char *_pLines[3], CUI_cursorInfo_t *_pCurInfo)
	Reset the OpenThread Instance as well as clear out the previous network data. CUI function type that is called when the Nwk reset menu option is selected in the Example CUI menu. More...
void	tiopCUIReset (const char _input, char *_pLines[3], CUI_cursorInfo_t *_pCurInfo)
	Reset the OpenThread Instance without clearing out previous network data. CUI function type that is called when the reset menu option is selected in the Example CUI menu. More...
void	tiopCUIUpdateApp (char *appInfo)
	Update Application specific CUI output line. More...
void	tiopCUIUpdateChannel (uint8_t ch)
	Update channel CUI output. More...
void	tiopCUIUpdateConnStatus (cuiConn status)
	Update connection status CUI output line. More...
void	tiopCUIUpdateDeviceInfo (void)
	Update device info CUI output line. More...
void	tiopCUIUpdateExtPANID (otExtendedPanId extPan)
	Update Extended panid CUI output. More...
void	tiopCUIUpdateMasterkey (otMasterKey key)
	Update masterkey CUI output. More...
void	tiopCUIUpdateNwkName (const char *name)
	Update network name CUI output. More...
void	tiopCUIUpdatePANID (otPanId pan)
	Update panid CUI output. More...
void	tiopCUIUpdateRole (otDeviceRole role)
	Update device role CUI output line. More...
void	tiopCUIUpdateShortAddr (otShortAddress s)
	Update short address CUI output. More...
void	uiActionAttach (const int32_t _itemEntry)
	Handles attach menu option event for examples. More...
void	uiActionJoin (const int32_t _itemEntry)
	Handles join menu option event for examples. More...
void	uiActionProcessConfigureChannel (const char _input, char *_pLines[3], CUI_cursorInfo_t *_pCurInfo)
	Handle reading user input into the channel configuration in CUI. More...
void	uiActionProcessConfigurePanId (const char _input, char *_pLines[3], CUI_cursorInfo_t *_pCurInfo)
	Handle reading user input into the panid configuration in CUI. More...

Enumeration Type Documentation

cuiConn

enum cuiConn

Connection status

Enumerator
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail
CUI_conn_disabled
CUI_conn_joining
CUI_conn_joined
CUI_conn_join_fail

Function Documentation

tiopCUIInit()

void tiopCUIInit	(	char *	appString,
		Button_Handle *	rightButtonHandle
	)

Initialize example CUI functionality.

Parameters

rightButtonHandle	a pointer to the button handle to be filled for the application
appString	contains the application specific string to be output

Returns

None

documented in tiop_ui.h

tiopCUIUpdateRole()

void tiopCUIUpdateRole

(

otDeviceRole

role

)

Update device role CUI output line.

Parameters

role	contains the role the device is in the network

Returns

None

documented in tiop_ui.h

tiopCUIUpdateDeviceInfo()

void tiopCUIUpdateDeviceInfo

(

void

)

Update device info CUI output line.

Returns

None

documented in tiop_ui.h

tiopCUIUpdatePANID()

void tiopCUIUpdatePANID

(

otPanId

pan

)

Update panid CUI output.

Parameters

pan	contains the panid for the network

Returns

None

documented in tiop_ui.h

tiopCUIUpdateChannel()

void tiopCUIUpdateChannel

(

uint8_t

ch

)

Update channel CUI output.

Parameters

ch	contains the channel for the network

Returns

None

documented in tiop_ui.h

tiopCUIUpdateShortAddr()

void tiopCUIUpdateShortAddr

(

otShortAddress

s

)

Update short address CUI output.

Parameters

s	contains the short address for the device

Returns

None

documented in tiop_ui.h

tiopCUIUpdateMasterkey()

void tiopCUIUpdateMasterkey

(

otMasterKey

key

)

Update masterkey CUI output.

Parameters

key	contains the masterkey for the network

Returns

None

documented in tiop_ui.h

tiopCUIUpdateExtPANID()

void tiopCUIUpdateExtPANID

(

otExtendedPanId

extPan

)

Update Extended panid CUI output.

Parameters

extPan

contains the extended pan id for the network

Returns

None

documented in tiop_ui.h

tiopCUIUpdateNwkName()

void tiopCUIUpdateNwkName

(

const char *

name

)

Update network name CUI output.

Parameters

name	contains the name of the network

Note

name must be in persistent memory as the pointer is kept for future screen refreshes

Returns

None

documented in tiop_ui.h

tiopCUIUpdateConnStatus()

void tiopCUIUpdateConnStatus

(

cuiConn

status

)

Update connection status CUI output line.

Parameters

status

contains the connection status for the device to the network

Returns

None

documented in tiop_ui.h

tiopCUIUpdateApp()

void tiopCUIUpdateApp

(

char *

appInfo

)

Update Application specific CUI output line.

Parameters

appInfo

contains the application specific string to be output

Returns

None

documented in tiop_ui.h

uiActionProcessConfigurePanId()

void uiActionProcessConfigurePanId	(	const char	_input,
		char *	_pLines[3],
		CUI_cursorInfo_t *	_pCurInfo
	)

Handle reading user input into the panid configuration in CUI.

Returns

None

documented in tiop_ui.h

uiActionProcessConfigureChannel()

void uiActionProcessConfigureChannel	(	const char	_input,
		char *	_pLines[3],
		CUI_cursorInfo_t *	_pCurInfo
	)

Handle reading user input into the channel configuration in CUI.

Returns

None

documented in tiop_ui.h

uiActionAttach()

void uiActionAttach

(

const int32_t

_itemEntry

)

Handles attach menu option event for examples.

Returns

None

uiActionJoin()

void uiActionJoin

(

const int32_t

_itemEntry

)

Handles join menu option event for examples.

Returns

None

processKeyChangeCB()

void processKeyChangeCB	(	Button_Handle	_buttonHandle,
		Button_EventMask	_buttonEvents
	)

Handles the key pressed events for examples.

Returns

None

Handles the key pressed events for examples.

Parameters

_buttonHandle	identifies which keys were pressed
_buttonEvents	identifies the event that occurred on the key

Returns

None

processMenuUpdateFn()

void processMenuUpdateFn

(

void

)

Handles CUI Menu update events for examples.

Returns

None

tiopCUINwkReset()

void tiopCUINwkReset	(	const char	_input,
		char *	_pLines[3],
		CUI_cursorInfo_t *	_pCurInfo
	)

Reset the OpenThread Instance as well as clear out the previous network data. CUI function type that is called when the Nwk reset menu option is selected in the Example CUI menu.

Returns

None

tiopCUIReset()

void tiopCUIReset	(	const char	_input,
		char *	_pLines[3],
		CUI_cursorInfo_t *	_pCurInfo
	)

Reset the OpenThread Instance without clearing out previous network data. CUI function type that is called when the reset menu option is selected in the Example CUI menu.

Returns

None