 |
Serial Wombat Arduino Library
|
Go to the documentation of this file.
81 int16_t
begin(uint32_t baudRate,uint8_t
pin, uint8_t rxPin, uint8_t txPin);
89 int16_t
begin(uint32_t baudRate, uint8_t
pin, uint8_t rxPin, uint8_t txPin,uint8_t HWinterface );
110 size_t write(uint8_t data);
122 size_t write(
const uint8_t* buffer,
size_t size);
136 size_t readBytes(
char* buffer,
size_t length);
213 int16_t
begin(uint32_t baudRate, uint8_t
pin, uint8_t rxPin, uint8_t txPin, uint16_t userMemoryOffset, uint16_t rxLength, uint16_t txLength);
217 int16_t
begin(uint32_t baudRate, uint8_t
pin, uint8_t rxPin, uint8_t txPin, uint8_t HWinterface) =
delete;
229 size_t write(
const uint8_t* buffer,
size_t size);
Class for a Serial Wombat chip. Each Serial Wombat chip on a project should have its own instance.
Definition: SerialWombat.h:265
uint8_t _txPin
Definition: SerialWombatUART.h:142
uint8_t _rxPin
Definition: SerialWombatUART.h:141
@ COMMAND_UART0_RX_7BYTES
(0xB1)
SerialWombatUART(SerialWombatChip &serialWombat)
Constructor for the SerialWombatUART class. Only one instance is allowed per SerialWombatChip 4B.
Definition: SerialWombatUART.cpp:4
SerialWombatSWUART(SerialWombatChip &serialWombatChip)
Definition: SerialWombatUART.cpp:269
SerialWombatChip & _sw
Definition: SerialWombat.h:790
SerialWombatQueue txQueue
SerialWombatQueue created on the Serial Wombat chip for data to be sent by the SerialWombatSWUART.
Definition: SerialWombatUART.h:234
size_t write(uint8_t data)
Write a byte to the SerialWombatUART for Transmit.
Definition: SerialWombatUART.cpp:122
void flush()
Discard all received bytes.
Definition: SerialWombatUART.cpp:100
SerialWombatQueue rxQueue
SerialWombatQueue created on the Serial Wombat chip for data received by the SerialWombatSWUART.
Definition: SerialWombatUART.h:232
A class for the Serial Wombat 4B or SW18AB chips which creates an I2C to UART Bridge.
Definition: SerialWombatUART.h:69
int availableForWrite()
Queries the SerialWombatUART for the amount of free TX queue space.
Definition: SerialWombatUART.cpp:188
int available()
Queries the SerialWombatUART for number bytes available to read.
Definition: SerialWombatUART.cpp:73
Describes a Serial Wombat Pin. Is base class for other pin modes.
Definition: SerialWombat.h:719
size_t readBytes(char *buffer, size_t length)
Reads a specified number of bytes from the SerialWombatUART RX queue.
Definition: SerialWombatUART.cpp:208
int read()
Reads a byte from the SerialWombatUART.
Definition: SerialWombatUART.cpp:81
void setTimeout(long timeout_mS)
Definition: SerialWombatUART.cpp:196
uint8_t _rx7Command
Definition: SerialWombatUART.h:147
int peek()
Query the SerialWombatUART for the next avaialble byte, but don't remove it from the queue.
Definition: SerialWombatUART.cpp:107
uint8_t pin()
Returns the current SW pin number. Used primarily for virtual calls by derived classes.
Definition: SerialWombat.h:781
uint8_t _tx7Command
Definition: SerialWombatUART.h:146
uint32_t timeout
Definition: SerialWombatUART.h:144
uint8_t _baudMarker
Definition: SerialWombatUART.h:143
int16_t begin(uint32_t baudRate, uint8_t pin, uint8_t rxPin, uint8_t txPin, uint16_t userMemoryOffset, uint16_t rxLength, uint16_t txLength)
Definition: SerialWombatUART.cpp:273
A Class representing a Queue in the User Ram area on the Serial Wombat Chip.
Definition: SerialWombatQueue.h:39
uint8_t _pinMode
Definition: SerialWombatUART.h:145
int16_t begin(uint32_t baudRate, uint8_t pin, uint8_t rxPin, uint8_t txPin)
Initalize the SerialWombatUART.
size_t write(const uint8_t *buffer, size_t size)
Write bytes to the SerialWombatUART for Transmit.
Definition: SerialWombatUART.cpp:373
@ PIN_MODE_UART_RX_TX
(17)
Definition: SerialWombat.h:243
@ COMMAND_UART0_TX_7BYTES
(0xB0)
A class for the Serial Wombat 4B or SW18AB chips which creates a software based UART on the SW18AB.
Definition: SerialWombatUART.h:198