 |
Serial Wombat Arduino Library
|
Go to the documentation of this file.
69 size_t write(uint8_t data);
81 size_t write(
const uint8_t* buffer,
size_t size);
107 uint32_t _timeout = 500;
Class for a Serial Wombat chip. Each Serial Wombat chip on a project should have its own instance.
Definition: SerialWombat.h:279
size_t write(uint8_t data)
Write a byte to the Serial Wombat Queue.
Definition: SerialWombatQueue.cpp:71
void setTimeout(long timeout_mS)
Definition: SerialWombatQueue.cpp:240
@ QUEUE_TYPE_RAM_BYTE
A queue that queues byte-sized data in a queue in the User RAM area.
uint16_t startIndex
Definition: SerialWombatQueue.h:97
uint16_t length
Definition: SerialWombatQueue.h:98
void flush()
Discard all received bytes.
Definition: SerialWombatQueue.cpp:51
int read()
Reads a byte from the Serial Wombat.
Definition: SerialWombatQueue.cpp:38
SerialWombatQueue(SerialWombatChip &serialWombat)
Constructor for SerialWombatWS2812 class.
Definition: SerialWombatQueue.cpp:4
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.
Definition: SerialWombatQueue.cpp:9
@ QUEUE_TYPE_RAM_BYTE_SHIFT
A queue that queues byte-sized data in a queue in the User RAM area.
SerialWombatQueueType
Definition: SerialWombatQueue.h:31
size_t readBytes(char *buffer, size_t length)
Reads a specified number of bytes from the Serial Wombat Queue.
Definition: SerialWombatQueue.cpp:187
int available()
Queries the Serial Wombat for number bytes available to read.
Definition: SerialWombatQueue.cpp:26
int peek()
Query the Serial Wombat for the next avaialble byte, but don't remove it from the queue.
Definition: SerialWombatQueue.cpp:56
A Class representing a Queue in the User Ram area on the Serial Wombat Chip.
Definition: SerialWombatQueue.h:39
int availableForWrite()
Queries the Serial Wombat for the amount of free queue space.
Definition: SerialWombatQueue.cpp:175