Adafruit_Wippersnapper_Arduino/html/ws__uart_8h_source.html

 #ifndef WS_UART_H
 #define WS_UART_H

 #include "Wippersnapper.h"
 #include "drivers/ws_uart_drv.h"
 #include "drivers/ws_uart_drv_pm25aqi.h"

 /**************************************************************************/
 /**************************************************************************/
 class ws_uart {
 public:
   ws_uart(){};
   ~ws_uart(void);

   void
   initUARTBus(wippersnapper_uart_v1_UARTDeviceAttachRequest
                   *msgUARTRequest);
   bool initUARTDevice(wippersnapper_uart_v1_UARTDeviceAttachRequest
                           *msgUARTRequest);
   bool isUARTBusInitialized();
   void detachUARTDevice(
       wippersnapper_uart_v1_UARTDeviceDetachRequest
           *msgUARTDetachReq);
   void deinitUARTDevice(const char *device_id);
   void update();
 #ifdef USE_SW_UART
   bool initUARTDevicePM25AQI(SoftwareSerial *swSerial, int32_t pollingInterval,
                              const char *device_id);
 #else
   bool initUARTDevicePM25AQI(HardwareSerial *hwSerial, int32_t pollingInterval,
                              const char *device_id);
 #endif
 private:
 #ifdef USE_SW_UART
   SoftwareSerial *_swSerial = nullptr;
 #else
   HardwareSerial *_hwSerial = nullptr;
 #endif
   bool _is_bus_initialized = false;
   std::vector<ws_uart_drv *> uartDrivers;
   ws_uart_drv_pm25aqi *_pm25aqi = nullptr;
 };

 #endif // WS_UART_H
ws_uart::detachUARTDevice
void detachUARTDevice(wippersnapper_uart_v1_UARTDeviceDetachRequest *msgUARTDetachReq)
Detaches a UART device from the UART bus.
Definition: ws_uart.cpp:222

ws_uart::initUARTBus
void initUARTBus(wippersnapper_uart_v1_UARTDeviceAttachRequest *msgUARTRequest)
Initializes the UART bus, called once.
Definition: ws_uart.cpp:38

ws_uart::initUARTDevicePM25AQI
bool initUARTDevicePM25AQI(HardwareSerial *hwSerial, int32_t pollingInterval, const char *device_id)
Initializes the pms5003 device driver using HardwareSerial.
Definition: ws_uart.cpp:116

Wippersnapper.h

ws_uart_drv_pm25aqi
Class that provides an interface for a PM25 AQI UART sensor.
Definition: ws_uart_drv_pm25aqi.h:27

ws_uart_drv_pm25aqi.h

ws_uart::isUARTBusInitialized
bool isUARTBusInitialized()
Returns true if the UART bus is initialized.
Definition: ws_uart.cpp:144

ws_uart::update
void update()
Polls the UART driver for new data and sends it to IO.
Definition: ws_uart.cpp:233

ws_uart::initUARTDevice
bool initUARTDevice(wippersnapper_uart_v1_UARTDeviceAttachRequest *msgUARTRequest)
Initializes a UART driver.
Definition: ws_uart.cpp:154

ws_uart::~ws_uart
~ws_uart(void)
UART class destructor.
Definition: ws_uart.cpp:23

ws_uart::deinitUARTDevice
void deinitUARTDevice(const char *device_id)
Deinitializes a device from the UART bus and frees its memory.
Definition: ws_uart.cpp:197

ws_uart_drv.h

ws_uart
Class that provides an interface between WipperSnapper&#39;s app and the device&#39;s UART bus...
Definition: ws_uart.h:29