Interface: tos.interfaces.UartStream

interface UartStream

Author:
Jonathan Hui <jhui@archedrock.com>
Version:
$Revision: 1.5 $ $Date: 2008/06/04 03:00:35 $

Commands
command error_t disableReceiveInterrupt() Disable the receive byte interrupt.
command error_t enableReceiveInterrupt() Enable the receive byte interrupt.
command error_t receive(uint8_t *buf, uint16_t len) Begin reception of a UART stream.
command error_t send(uint8_t *buf, uint16_t len) Begin transmission of a UART stream.

Events
event void receivedByte(uint8_t byte) Signals the receipt of a byte.
event void receiveDone(uint8_t *buf, uint16_t len, error_t error) Signal completion of receiving a stream.
event void sendDone(uint8_t *buf, uint16_t len, error_t error) Signal completion of sending a stream.

Commands - Details

disableReceiveInterrupt

command error_t disableReceiveInterrupt()

Disable the receive byte interrupt.

Returns:
SUCCESS if interrupt was disabled, FAIL otherwise.

enableReceiveInterrupt

command error_t enableReceiveInterrupt()

Enable the receive byte interrupt. The receive event is signalled each time a byte is received.

Returns:
SUCCESS if interrupt was enabled, FAIL otherwise.

receive

command error_t receive(uint8_t *buf, uint16_t len)

Begin reception of a UART stream. If SUCCESS is returned, receiveDone will be signalled when reception is complete.

Parameters:
'uint8_t* COUNT(len) buf' Buffer for received bytes.
len - Number of bytes to receive.
Returns:
SUCCESS if request was accepted, FAIL otherwise.

send

command error_t send(uint8_t *buf, uint16_t len)

Begin transmission of a UART stream. If SUCCESS is returned, sendDone will be signalled when transmission is complete.

Parameters:
'uint8_t* COUNT(len) buf' Buffer for bytes to send.
len - Number of bytes to send.
Returns:
SUCCESS if request was accepted, FAIL otherwise.

Events - Details

receivedByte

event void receivedByte(uint8_t byte)

Signals the receipt of a byte.

Parameters:
byte - The byte received.

receiveDone

event void receiveDone(uint8_t *buf, uint16_t len, error_t error)

Signal completion of receiving a stream.

Parameters:
'uint8_t* COUNT(len) buf' Buffer for bytes received.
len - Number of bytes received.
error - SUCCESS if the reception was successful, FAIL otherwise.

sendDone

event void sendDone(uint8_t *buf, uint16_t len, error_t error)

Signal completion of sending a stream.

Parameters:
'uint8_t* COUNT(len) buf' Bytes sent.
len - Number of bytes sent.
error - SUCCESS if the transmission was successful, FAIL otherwise.