Serial Wombat Arduino Library
SerialWombatUART.h
Go to the documentation of this file.
1 #pragma once
2 #include "Stream.h"
3 #include "SerialWombat.h"
65  public Stream
66 {
67 public:
70  SerialWombatUART(SerialWombat& serialWombat);
76  void begin(int baudRate,uint8_t pin, uint8_t rxPin, uint8_t txPin);
79  int available();
82  int read();
84  void flush();
87  int peek();
97  size_t write(uint8_t data);
98 
109  size_t write(const uint8_t* buffer, size_t size);
110 
113  int availableForWrite();
114 
123  size_t readBytes(char* buffer, size_t length);
124 
125 private:
126  SerialWombat& _sw;
127  uint8_t _rxPin = 255;
128  uint8_t _txPin = 255;
129  uint8_t _pin = 255;
130  uint8_t _baudMarker = 0;
131 };
132 
SerialWombatUART::write
size_t write(uint8_t data)
Write a byte to the Serial Wombat UART for Transmit.
Definition: SerialWombatUART.cpp:102
SerialWombatUART::flush
void flush()
Discard all received bytes.
Definition: SerialWombatUART.cpp:80
SerialWombat.h
SerialWombatUART::begin
void begin(int baudRate, uint8_t pin, uint8_t rxPin, uint8_t txPin)
Initalize the SerialWombatUART.
Definition: SerialWombatUART.cpp:10
SerialWombatUART
A class for the Serial Wombat 4B which creates an I2C to UART Bridge.
Definition: SerialWombatUART.h:64
SerialWombatUART::availableForWrite
int availableForWrite()
Queries the Serial Wombat for the amount of free TX queue space.
Definition: SerialWombatUART.cpp:161
SerialWombatUART::SerialWombatUART
SerialWombatUART(SerialWombat &serialWombat)
Constructor for the SerialWombatUART class. Only one instance is allowed per SerialWombat 4B.
Definition: SerialWombatUART.cpp:4
SerialWombatUART::available
int available()
Queries the Serial Wombat for number bytes available to read.
Definition: SerialWombatUART.cpp:57
SerialWombatUART::readBytes
size_t readBytes(char *buffer, size_t length)
Reads a specified number of bytes from the Serial Wombat RX queue.
Definition: SerialWombatUART.cpp:169
SerialWombatUART::read
int read()
Reads a byte from the Serial Wombat.
Definition: SerialWombatUART.cpp:65
SerialWombatUART::peek
int peek()
Query the Serial Wombat for the next avaialble byte, but don't remove it from the queue.
Definition: SerialWombatUART.cpp:87
SerialWombat
Definition: SerialWombat.h:86