![]() |
Serial Wombat Arduino Library
|
A Class representing a Queue in the User Ram area on the Serial Wombat Chip. More...
#include <SerialWombatQueue.h>
Public Member Functions | |
SerialWombatQueue (SerialWombatChip &serialWombat) | |
Constructor for SerialWombatWS2812 class. More... | |
int16_t | begin (uint16_t index, uint16_t length, SerialWombatQueueType qtype=SerialWombatQueueType::QUEUE_TYPE_RAM_BYTE) |
Initialize a Serial Wombat Queue (RAM Bytes) in User Memory Area on Serial Wombat Chip. More... | |
int | available () |
Queries the Serial Wombat for number bytes available to read. More... | |
int | read () |
Reads a byte from the Serial Wombat. More... | |
void | flush () |
Discard all received bytes. More... | |
int | peek () |
Query the Serial Wombat for the next avaialble byte, but don't remove it from the queue. More... | |
size_t | write (uint8_t data) |
Write a byte to the Serial Wombat Queue. More... | |
size_t | write (const uint8_t *buffer, size_t size) |
Write bytes to the Serial Wombat Queue. More... | |
int | availableForWrite () |
Queries the Serial Wombat for the amount of free queue space. More... | |
size_t | readBytes (char *buffer, size_t length) |
Reads a specified number of bytes from the Serial Wombat Queue. More... | |
void | setTimeout (long timeout_mS) |
Public Attributes | |
uint16_t | startIndex = 0xFFFF |
uint16_t | length = 0 |
A Class representing a Queue in the User Ram area on the Serial Wombat Chip.
SerialWombatQueue::SerialWombatQueue | ( | SerialWombatChip & | serialWombat | ) |
Constructor for SerialWombatWS2812 class.
serialWombat | SerialWombat chip on which the driver will run |
int SerialWombatQueue::available | ( | ) |
Queries the Serial Wombat for number bytes available to read.
int SerialWombatQueue::availableForWrite | ( | ) |
Queries the Serial Wombat for the amount of free queue space.
int16_t SerialWombatQueue::begin | ( | uint16_t | index, |
uint16_t | length, | ||
SerialWombatQueueType | qtype = SerialWombatQueueType::QUEUE_TYPE_RAM_BYTE |
||
) |
Initialize a Serial Wombat Queue (RAM Bytes) in User Memory Area on Serial Wombat Chip.
index | An index in bytes for the beginning of the Queue location in Serial Wombat User Memory Area |
length | The length in bytes of avaialble queue space |
void SerialWombatQueue::flush | ( | ) |
Discard all received bytes.
int SerialWombatQueue::peek | ( | ) |
Query the Serial Wombat for the next avaialble byte, but don't remove it from the queue.
int SerialWombatQueue::read | ( | ) |
Reads a byte from the Serial Wombat.
size_t SerialWombatQueue::readBytes | ( | char * | buffer, |
size_t | length | ||
) |
Reads a specified number of bytes from the Serial Wombat Queue.
buffer | An array into which to put received bytes |
length | The maximum number of bytes to be received |
This function will read bytes from the Serial Wombat Queue into buffer. If 'length' characters are not available to read then the value returned will be less than length.
void SerialWombatQueue::setTimeout | ( | long | timeout_mS | ) |
size_t SerialWombatQueue::write | ( | const uint8_t * | buffer, |
size_t | size | ||
) |
Write bytes to the Serial Wombat Queue.
buffer | An array of uint8_t bytes to send |
size | the number of bytes to send |
This function queries the Serial Wombat Queue buffer space, and sends bytes as buffer space is avaialble. If avaialable buffer space is not sufficient to send the entire array then the function will block and continue trying until the entire message has been sent to the Serial Wombat queue.
size_t SerialWombatQueue::write | ( | uint8_t | data | ) |
Write a byte to the Serial Wombat Queue.
data | Byte to write |
uint16_t SerialWombatQueue::length = 0 |
uint16_t SerialWombatQueue::startIndex = 0xFFFF |