nRF5 SDK for Thread and Zigbee v1.0.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages

This module includes the platform abstraction for UART communication. More...

Functions

otError otPlatUartEnable (void)
 
otError otPlatUartDisable (void)
 
otError otPlatUartSend (const uint8_t *aBuf, uint16_t aBufLength)
 
void otPlatUartSendDone (void)
 
void otPlatUartReceived (const uint8_t *aBuf, uint16_t aBufLength)
 

Detailed Description

This module includes the platform abstraction for UART communication.

Function Documentation

otError otPlatUartDisable ( void  )

Disable the UART.

Return values
OT_ERROR_NONESuccessfully disabled the UART.
OT_ERROR_FAILEDFailed to disable the UART.
otError otPlatUartEnable ( void  )

Enable the UART.

Return values
OT_ERROR_NONESuccessfully enabled the UART.
OT_ERROR_FAILEDFailed to enabled the UART.
void otPlatUartReceived ( const uint8_t *  aBuf,
uint16_t  aBufLength 
)

The UART driver calls this method to notify OpenThread that bytes have been received.

Parameters
[in]aBufA pointer to the received bytes.
[in]aBufLengthThe number of bytes received.
otError otPlatUartSend ( const uint8_t *  aBuf,
uint16_t  aBufLength 
)

Send bytes over the UART.

Parameters
[in]aBufA pointer to the data buffer.
[in]aBufLengthNumber of bytes to transmit.
Return values
OT_ERROR_NONESuccessfully started transmission.
OT_ERROR_FAILEDFailed to start the transmission.
void otPlatUartSendDone ( void  )

The UART driver calls this method to notify OpenThread that the requested bytes have been sent.