doxygen/html/ir__Goodweather_8h_source.html

// Copyright 2019 ribeirodanielf

// Copyright 2019 David Conran


// Supports:

//   Brand: Goodweather,  Model: ZH/JT-03 remote


#ifndef IR_GOODWEATHER_H_

#define IR_GOODWEATHER_H_


#define __STDC_LIMIT_MACROS

#include <stdint.h>

#ifndef UNIT_TEST

#include <Arduino.h>

#endif

#include "IRremoteESP8266.h"

#include "IRsend.h"

#ifdef UNIT_TEST

#include "IRsend_test.h"

#endif


union GoodweatherProtocol {

  uint64_t raw;

  struct {

    // Byte 0

    uint8_t :8;

    // Byte 1

    uint8_t Light :1;

    uint8_t       :2;

    uint8_t Turbo :1;

    uint8_t       :0;

    // Byte 2

    uint8_t Command :4;

    uint8_t         :0;

    // Byte 3

    uint8_t Sleep   :1;

    uint8_t Power   :1;

    uint8_t Swing   :2;

    uint8_t AirFlow :1;

    uint8_t Fan     :2;

    uint8_t         :0;

    // Byte 4

    uint8_t Temp  :4;

    uint8_t       :1;

    uint8_t Mode  :3;

    uint8_t       :0;

  };

};


// Constants

// Timing

const uint16_t kGoodweatherBitMark = 580;

const uint16_t kGoodweatherOneSpace = 580;

const uint16_t kGoodweatherZeroSpace = 1860;

const uint16_t kGoodweatherHdrMark = 6820;

const uint16_t kGoodweatherHdrSpace = 6820;

const uint8_t  kGoodweatherExtraTolerance = 12;  // +12% extra


// Modes

const uint8_t kGoodweatherAuto = 0b000;

const uint8_t kGoodweatherCool = 0b001;

const uint8_t kGoodweatherDry =  0b010;

const uint8_t kGoodweatherFan =  0b011;

const uint8_t kGoodweatherHeat = 0b100;

// Swing

const uint8_t kGoodweatherSwingFast = 0b00;

const uint8_t kGoodweatherSwingSlow = 0b01;

const uint8_t kGoodweatherSwingOff =  0b10;

// Fan Control

const uint8_t kGoodweatherFanAuto = 0b00;

const uint8_t kGoodweatherFanHigh = 0b01;

const uint8_t kGoodweatherFanMed =  0b10;

const uint8_t kGoodweatherFanLow =  0b11;

// Temperature

const uint8_t kGoodweatherTempMin = 16;  // Celsius

const uint8_t kGoodweatherTempMax = 31;  // Celsius

// Commands

const uint8_t kGoodweatherCmdPower    = 0x00;

const uint8_t kGoodweatherCmdMode     = 0x01;

const uint8_t kGoodweatherCmdUpTemp   = 0x02;

const uint8_t kGoodweatherCmdDownTemp = 0x03;

const uint8_t kGoodweatherCmdSwing    = 0x04;

const uint8_t kGoodweatherCmdFan      = 0x05;

const uint8_t kGoodweatherCmdTimer    = 0x06;

const uint8_t kGoodweatherCmdAirFlow  = 0x07;

const uint8_t kGoodweatherCmdHold     = 0x08;

const uint8_t kGoodweatherCmdSleep    = 0x09;

const uint8_t kGoodweatherCmdTurbo    = 0x0A;

const uint8_t kGoodweatherCmdLight    = 0x0B;

// PAD EOF

const uint64_t kGoodweatherStateInit  = 0xD50000000000;


// Classes

class IRGoodweatherAc {

 public:

  explicit IRGoodweatherAc(const uint16_t pin, const bool inverted = false,

                           const bool use_modulation = true);

  void stateReset(void);

#if SEND_GOODWEATHER

  void send(const uint16_t repeat = kGoodweatherMinRepeat);

  int8_t calibrate(void) { return _irsend.calibrate(); }

#endif  // SEND_GOODWEATHER

  void begin(void);

  void on(void);

  void off(void);

  void setPower(const bool on);

  bool getPower(void) const;

  void setTemp(const uint8_t temp);

  uint8_t getTemp(void) const;

  void setFan(const uint8_t speed);

  uint8_t getFan(void) const;

  void setMode(const uint8_t mode);

  uint8_t getMode(void) const;

  void setSwing(const uint8_t speed);

  uint8_t getSwing(void) const;

  void setSleep(const bool toggle);

  bool getSleep(void) const;

  void setTurbo(const bool toggle);

  bool getTurbo(void) const;

  void setLight(const bool toggle);

  bool getLight(void) const;

  void setCommand(const uint8_t cmd);

  uint8_t getCommand(void) const;

  uint64_t getRaw(void);

  void setRaw(const uint64_t state);

  static uint8_t convertMode(const stdAc::opmode_t mode);

  static uint8_t convertFan(const stdAc::fanspeed_t speed);

  static uint8_t convertSwingV(const stdAc::swingv_t swingv);

  static stdAc::opmode_t toCommonMode(const uint8_t mode);

  static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);

  stdAc::state_t toCommon(void) const;

  String toString(void) const;

#ifndef UNIT_TEST


 private:

  IRsend _irsend;

#else  // UNIT_TEST

  IRsendTest _irsend;

#endif  // UNIT_TEST

  GoodweatherProtocol _;

};

#endif  // IR_GOODWEATHER_H_