ws_uart_drv.h

Go to the documentation of this file.

#ifndef WS_UART_DRV_H
#define WS_UART_DRV_H
#include "Wippersnapper.h"
#include <Adafruit_Sensor.h>

// ESP8266 platform uses SoftwareSerial
// so does RP2040 (note that this has differences from the pure softwareserial
// library, see: https://arduino-pico.readthedocs.io/en/latest/piouart.html)
#if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_RP2040)
#define USE_SW_UART
#include <SoftwareSerial.h>
#else
#include <HardwareSerial.h>
#endif

/**************************************************************************/
/**************************************************************************/
class ws_uart_drv {
public:
#ifdef USE_SW_UART
  /*******************************************************************************/
  /*******************************************************************************/
  ws_uart_drv(SoftwareSerial *swSerial, int32_t interval){};
#else
  /*******************************************************************************/
  /*******************************************************************************/
  ws_uart_drv(HardwareSerial *hwSerial, int32_t interval){};
#endif
  ~ws_uart_drv(void) {}

  /*******************************************************************************/
  /*******************************************************************************/
  bool isReady() {
    if (millis() - _prvPoll > pollingInterval) {
      return true;
    }
    return false;
  }

  /*******************************************************************************/
  /*******************************************************************************/
  void setPrvPollTime(unsigned long curTime) { _prvPoll = curTime; }

  /*******************************************************************************/
  /*******************************************************************************/
  const char *getDriverID() { return _driverID; }

  /*******************************************************************************/
  /*******************************************************************************/
  void setDriverID(const char *id) { _driverID = strdup(id); }

  /*******************************************************************************/
  /*******************************************************************************/
  virtual void set_mqtt_client(Adafruit_MQTT *AMQTT, const char *mqtt_topic) {
    mqttClient = AMQTT;
    uartTopic = mqtt_topic;
  }

  /*******************************************************************************/
  /*******************************************************************************/
  virtual bool begin() { return false; }

  /*******************************************************************************/
  /*******************************************************************************/
  virtual bool read_data() { return false; }

  /*******************************************************************************/
  /*******************************************************************************/
  void packUARTResponse(wippersnapper_signal_v1_UARTResponse *msgUARTResponse,
                        int event_index,
                        wippersnapper_i2c_v1_SensorType sensor_type,
                        float sensor_value) {
    msgUARTResponse->payload.resp_uart_device_event.sensor_event[event_index]
        .type = sensor_type;
    msgUARTResponse->payload.resp_uart_device_event.sensor_event[event_index]
        .value = sensor_value;
  }

  /*******************************************************************************/
  /*******************************************************************************/
  virtual void send_data() {};

  const char *uartTopic = nullptr;     
  Adafruit_MQTT *mqttClient = nullptr; 
  unsigned long
      pollingInterval; 
private:
  long _prvPoll = millis() - (24 * 60 * 60 * 1000);
  const char *_driverID = nullptr; 
};

#endif // WS_UART_DRV_H