CC1352R1_LAUNCHXL/thread/oad_cli/otstack.h File Reference

#include <openthread/config.h>

Include dependency graph for CC1352R1_LAUNCHXL/thread/oad_cli/otstack.h:

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

Go to the source code of this file.

Macros
#define	OT_STACK_EVENT_DEV_ROLE_CHANGED   0x06
#define	OT_STACK_EVENT_NWK_DATA_CHANGED   0x05
#define	OT_STACK_EVENT_NWK_JOIN_IN_PROGRESS   0x02
#define	OT_STACK_EVENT_NWK_JOINED   0x03
#define	OT_STACK_EVENT_NWK_JOINED_FAILURE   0x04
#define	OT_STACK_EVENT_NWK_NOT_JOINED   0x01

Typedefs
typedef void(*	OtStack_EventsCallback_t) (uint8_t event, void *aContext)

Functions
void	handleNetifStateChanged (uint32_t aFlags, void *aContext)
	Callback function registered with the netif. More...
void	OtStack_joinConfiguredNetwork (void)
	Allows the application to start the network join process via the commissioner using the pre-configured PSKd. More...
void	OtStack_joinNetwork (const char *pskd)
	Allows the application to start the network join process via the commissioner. More...
uint8_t	OtStack_joinState (void)
	Returns the current network join event of the OpenThread stack. More...
void	OtStack_registerCallback (OtStack_EventsCallback_t appCB)
	Allows the application to register callback for ot stack events. More...
bool	OtStack_setupInterfaceAndNetwork (void)
	Allows the application to attempt to bring up the interface and setup the thread network (thread protocol operation) using the current device dataset. More...
bool	OtStack_setupNetwork (void)
	Allows the application to setup the thread network(thread protocol operation) after the device has successfully joined the network. More...

Macro Definition Documentation

OT_STACK_EVENT_NWK_NOT_JOINED

#define OT_STACK_EVENT_NWK_NOT_JOINED   0x01

Events reported to the registered application

OT_STACK_EVENT_NWK_JOIN_IN_PROGRESS

#define OT_STACK_EVENT_NWK_JOIN_IN_PROGRESS   0x02

OT_STACK_EVENT_NWK_JOINED

#define OT_STACK_EVENT_NWK_JOINED   0x03

OT_STACK_EVENT_NWK_JOINED_FAILURE

#define OT_STACK_EVENT_NWK_JOINED_FAILURE   0x04

OT_STACK_EVENT_NWK_DATA_CHANGED

#define OT_STACK_EVENT_NWK_DATA_CHANGED   0x05

OT_STACK_EVENT_DEV_ROLE_CHANGED

#define OT_STACK_EVENT_DEV_ROLE_CHANGED   0x06

Typedef Documentation

OtStack_EventsCallback_t

typedef void(* OtStack_EventsCallback_t) (uint8_t event, void *aContext)

Function Documentation

handleNetifStateChanged()

void handleNetifStateChanged	(	uint32_t	aFlags,
		void *	aContext
	)

Callback function registered with the netif.

Parameters

aFlags	A bit-field indicating specific state that has changed.
aContext	A pointer to application-specific context.

Returns

None

OtStack_registerCallback()

void OtStack_registerCallback

(

OtStack_EventsCallback_t

appCB

)

Allows the application to register callback for ot stack events.

Parameters

appCB

application callback function.

Returns

None

OtStack_joinState()

uint8_t OtStack_joinState

(

void

)

Returns the current network join event of the OpenThread stack.

Returns

uint8_t event value.

OtStack_joinNetwork()

void OtStack_joinNetwork

(

const char *

pskd

)

Allows the application to start the network join process via the commissioner.

Parameters

pskd	Pre-shared key of the device.

Returns

None

OtStack_joinConfiguredNetwork()

void OtStack_joinConfiguredNetwork

(

void

)

Allows the application to start the network join process via the commissioner using the pre-configured PSKd.

Returns

None

OtStack_setupNetwork()

bool OtStack_setupNetwork

(

void

)

Allows the application to setup the thread network(thread protocol operation) after the device has successfully joined the network.

Returns

bool true if successful in starting the thread protocol operation.

OtStack_setupInterfaceAndNetwork()

bool OtStack_setupInterfaceAndNetwork

(

void

)

Allows the application to attempt to bring up the interface and setup the thread network (thread protocol operation) using the current device dataset.

Returns

bool true if successful in starting the thread protocol operation.