doxygen/html/ir__Kelon_8h_source.html

// Copyright 2021 Davide Depau


// Supports:

//   Brand: Kelon,  Model: ON/OFF 9000-12000 (KELON)

//   Brand: Kelon,  Model: DG11R2-01 remote (KELON168)

//   Brand: Kelon,  Model: AST-09UW4RVETG00A A/C (KELON168)

//   Brand: Hisense,  Model: AST-09UW4RVETG00A A/C (KELON168)


#ifndef IR_KELON_H_

#define IR_KELON_H_


#ifdef UNIT_TEST

#include "IRsend_test.h"

#endif


#include "IRremoteESP8266.h"

#include "IRsend.h"

#include "IRutils.h"


union KelonProtocol {

  uint64_t raw;


  struct {

    uint8_t preamble[2];

    uint8_t Fan: 2;

    uint8_t PowerToggle: 1;

    uint8_t SleepEnabled: 1;

    uint8_t DehumidifierGrade: 3;

    uint8_t SwingVToggle: 1;

    uint8_t Mode: 3;

    uint8_t TimerEnabled: 1;

    uint8_t Temperature: 4;

    uint8_t TimerHalfHour: 1;

    uint8_t TimerHours: 6;

    uint8_t SmartModeEnabled: 1;

    uint8_t pad1: 4;

    uint8_t SuperCoolEnabled1: 1;

    uint8_t pad2: 2;

    uint8_t SuperCoolEnabled2: 1;

  };

};


// Constants

const uint8_t kKelonModeHeat = 0;

const uint8_t kKelonModeSmart = 1;  // (temp = 26C, but not shown)

const uint8_t kKelonModeCool = 2;

const uint8_t kKelonModeDry = 3;    // (temp = 25C, but not shown)

const uint8_t kKelonModeFan = 4;    // (temp = 25C, but not shown)

const uint8_t kKelonFanAuto = 0;

// Note! Kelon fan speeds are actually 0:AUTO, 1:MAX, 2:MED, 3:MIN

// Since this is insane, I decided to invert them in the public API, they are

// converted back in setFan/getFan

const uint8_t kKelonFanMin = 1;

const uint8_t kKelonFanMedium = 2;

const uint8_t kKelonFanMax = 3;


const int8_t kKelonDryGradeMin = -2;

const int8_t kKelonDryGradeMax = +2;

const uint8_t kKelonMinTemp = 18;

const uint8_t kKelonMaxTemp = 32;


class IRKelonAc {

 public:

  explicit IRKelonAc(uint16_t pin, bool inverted = false,

                     bool use_modulation = true);

  void stateReset(void);

  #if SEND_KELON

  void send(const uint16_t repeat = kNoRepeat);

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

  void ensurePower(const bool on);

  #endif  // SEND_KELON


  void begin(void);

  void setTogglePower(const bool toggle);

  bool getTogglePower(void) const;

  void setTemp(const uint8_t degrees);

  uint8_t getTemp(void) const;

  void setFan(const uint8_t speed);

  uint8_t getFan(void) const;

  void setDryGrade(const int8_t grade);

  int8_t getDryGrade(void) const;

  void setMode(const uint8_t mode);

  uint8_t getMode(void) const;

  void setToggleSwingVertical(const bool toggle);

  bool getToggleSwingVertical(void) const;

  void setSleep(const bool on);

  bool getSleep(void) const;

  void setSupercool(const bool on);

  bool getSupercool(void) const;

  void setTimer(const uint16_t mins);

  uint16_t getTimer(void) const;

  void setTimerEnabled(const bool on);

  bool getTimerEnabled(void) const;

  uint64_t getRaw(void) const;

  void setRaw(const uint64_t new_code);

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

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

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

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

  stdAc::state_t toCommon(const stdAc::state_t *prev = nullptr) const;

  String toString(void) const;


 private:

#ifndef UNIT_TEST

  IRsend _irsend;

#else  // UNIT_TEST

  IRsendTest _irsend;

#endif  // UNIT_TEST

  KelonProtocol _;


  // Used when exiting supercool mode

  uint8_t _previousMode = 0;

  uint8_t _previousTemp = kKelonMinTemp;

  uint8_t _previousFan = kKelonFanAuto;

};

#endif  // IR_KELON_H_