framedecoder.h

/*
   SpaIot Library (c) by epsilonrt - epsilonrt@epsilonrt.fr
   This file is part of SpaIot library <https://github.com/epsilonrt/spaiot-lib>
   This file is based on DIYSCIP (c) by Geoffroy HUBERT
 
   SPDX-License-Identifier: BSD-3-Clause
 
   SpaIot library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY;
*/
#pragma once
 
#include <map>
#include "bussettings.h"
#include "ledsettings.h"
 
namespace SpaIot {
 
  class FrameDecoder {
    public:
      FrameDecoder ();
 
      FrameDecoder (const BusSettings &bus,
                    const std::map <int, LedSettings> &leds);
 
      virtual ~FrameDecoder();
 
      virtual void begin (unsigned long waitingTimeMs = BeginWaitingTimeMs);
 
      virtual void begin (const BusSettings &settings,
                          const std::map <int, LedSettings> &leds,
                          unsigned long waitingTimeMs = BeginWaitingTimeMs);
 
      virtual void end();
 
      virtual bool isOpen() const;
 
      virtual bool isReady() const;
 
      bool hasLed (int key) const;
 
      const BusSettings &busSettings() const;
 
      const std::map <int, LedSettings> ledSettings() const;
 
      uint16_t  rawStatus() const;
 
      uint8_t   isLedOn (int key) const;
 
      inline uint8_t   isPowerOn() const;
 
      inline uint8_t   isFilterOn() const;
 
      inline uint8_t   isBubbleOn() const;
 
      inline uint8_t   isHeatReached() const;
 
      inline uint8_t   isJetOn() const;
 
      inline uint8_t   isSanitizerOn() const;
 
      uint8_t   isHeaterOn() const;
 
      uint16_t  waterTemp() const;
 
      uint16_t  desiredTemp() const;
 
      uint16_t  sanitizerTime() const;
 
      uint32_t  frameCounter() const;
 
      uint32_t  frameDropped() const;
 
      uint16_t  error() const;
 
      bool isSetupModeTriggered() const;
 
      uint8_t isDisplayBlink() const;
 
      uint8_t waitUntilDisplayBlink (unsigned long MaxWaitingTimeMs = 5000) const;
 
      uint16_t waitForWaterTemp (unsigned long MaxWaitingTimeMs = 25000) const;
 
      void clearTempUnitChangeCounter();
 
    protected:
      class Private;
      FrameDecoder (Private &dd);
      std::unique_ptr<Private> d_ptr;
    private:
      PIMPL_DECLARE_PRIVATE (FrameDecoder)
  };
 
  //----------------------------------------------------------------------------
  inline uint8_t FrameDecoder::isPowerOn() const {
 
    return isLedOn (Power);
  }
 
  //----------------------------------------------------------------------------
  inline uint8_t FrameDecoder::isFilterOn() const {
 
    return isLedOn (Filter);
  }
 
  //----------------------------------------------------------------------------
  inline uint8_t FrameDecoder::isBubbleOn() const {
 
    return isLedOn (Bubble);
  }
 
  //----------------------------------------------------------------------------
  inline uint8_t FrameDecoder::isHeatReached() const {
 
    return isLedOn (HeatReached);
  }
 
  //----------------------------------------------------------------------------
  inline uint8_t FrameDecoder::isJetOn() const {
 
    return isLedOn (Jet);
  }
 
  //----------------------------------------------------------------------------
  inline uint8_t FrameDecoder::isSanitizerOn() const {
 
    return isLedOn (Sanitizer);
  }
 
}