utils_temp.h

Go to the documentation of this file.

 
#ifndef UTILS_TEMP_H
#define UTILS_TEMP_H
 
#include <Arduino.h>
 
#include "constants.h"
#include "config.h"
 
#if TEMP_SENSOR_PRESENT
#include <OneWire.h>  // for temperature sensing
#endif

struct DeviceAddress
{
  uint8_t addr[8]{}; 
};
 
// Mock class for OneWire
class MockOneWire
{
public:
  // Mock constructor
  MockOneWire() = default;
 
  void begin(uint8_t) {}
 
  bool reset()
  {
    return true;
  }
 
  void skip() {}
 
  void select(const uint8_t*) {}
 
  void write(uint8_t) {}
 
  uint8_t read()
  {
    return 0x00;
  }
 
  uint8_t crc8(const uint8_t*, uint8_t)
  {
    return 0x00;
  }
};
 
// Include the real OneWire library if needed
#if TEMP_SENSOR_PRESENT
#include <OneWire.h>          // for temperature sensing
using OneWireType = OneWire;  // Use the real implementation
#else
using OneWireType = MockOneWire;  // Use the mock implementation
#endif

template< uint8_t N >
class TemperatureSensing
{
  using ScratchPad = uint8_t[9];
 
public:
  constexpr TemperatureSensing() = delete;

  constexpr TemperatureSensing(uint8_t pin, const DeviceAddress (&ref)[N])
    : sensorPin{ pin }, sensorAddrs(ref)
  {
  }

  void requestTemperatures() const
  {
    if constexpr (TEMP_SENSOR_PRESENT)
    {
      oneWire.reset();
      oneWire.skip();
      oneWire.write(CONVERT_TEMPERATURE);
    }
  }

  void initTemperatureSensors() const
  {
    if constexpr (TEMP_SENSOR_PRESENT)
    {
      oneWire.begin(sensorPin);
      requestTemperatures();
    }
  }

  constexpr auto get_size() const
  {
    return N;
  }

  constexpr auto get_pin() const
  {
    return sensorPin;
  }

  template< uint8_t IDX >
  [[nodiscard]] int16_t readTemperature() const
  {
    static_assert(IDX < N, "Sensor index out of bounds! Check your sensor configuration.");
    return readTemperature(IDX);
  }

  [[nodiscard]] int16_t readTemperature(const uint8_t idx) const
  {
    static ScratchPad buf;
 
    if constexpr (TEMP_SENSOR_PRESENT)
    {
      if (!oneWire.reset())
      {
        return DEVICE_DISCONNECTED_RAW;
      }
      oneWire.select(sensorAddrs[idx].addr);
      oneWire.write(READ_SCRATCHPAD);
 
      for (auto& buf_elem : buf)
      {
        buf_elem = oneWire.read();
      }
 
      if (!oneWire.reset())
      {
        return DEVICE_DISCONNECTED_RAW;
      }
      if (oneWire.crc8(buf, 8) != buf[8])
      {
        return DEVICE_DISCONNECTED_RAW;
      }
    }
    else
    {
      // Suppress unused parameter warning when temperature sensing is disabled
      (void)idx;
    }
 
    // result is temperature x16, multiply by 6.25 to convert to temperature x100
    int16_t result = (buf[1] << 8) | buf[0];
    result = (result * 6) + (result >> 2);
    if (result <= TEMP_RANGE_LOW || result >= TEMP_RANGE_HIGH)
    {
      return OUTOFRANGE_TEMPERATURE;  // return value ('Out of range')
    }
 
    return result;
  }
 
private:
  const uint8_t sensorPin{ unused_pin }; 
 
  const DeviceAddress sensorAddrs[N]; 
 
  static inline OneWireType oneWire; 
};
 
#endif /* UTILS_TEMP_H */