// Copyright 2016 David Conran /// @file /// @brief Support for Kelvinator A/C protocols. // Supports: // Brand: Kelvinator, Model: YALIF Remote // Brand: Kelvinator, Model: KSV26CRC A/C // Brand: Kelvinator, Model: KSV26HRC A/C // Brand: Kelvinator, Model: KSV35CRC A/C // Brand: Kelvinator, Model: KSV35HRC A/C // Brand: Kelvinator, Model: KSV53HRC A/C // Brand: Kelvinator, Model: KSV62HRC A/C // Brand: Kelvinator, Model: KSV70CRC A/C // Brand: Kelvinator, Model: KSV70HRC A/C // Brand: Kelvinator, Model: KSV80HRC A/C // Brand: Green, Model: YAPOF3 remote #ifndef IR_KELVINATOR_H_ #define IR_KELVINATOR_H_ #define __STDC_LIMIT_MACROS #include #ifndef UNIT_TEST #include #endif #include "IRremoteESP8266.h" #include "IRsend.h" #ifdef UNIT_TEST #include "IRsend_test.h" #endif // Constants const uint8_t kKelvinatorAuto = 0; const uint8_t kKelvinatorCool = 1; const uint8_t kKelvinatorDry = 2; const uint8_t kKelvinatorFan = 3; const uint8_t kKelvinatorHeat = 4; const uint8_t kKelvinatorBasicFanMax = 3; const uint8_t kKelvinatorFanAuto = 0; const uint8_t kKelvinatorFanMin = 1; const uint8_t kKelvinatorFanMax = 5; const uint8_t kKelvinatorMinTemp = 16; // 16C const uint8_t kKelvinatorMaxTemp = 30; // 30C const uint8_t kKelvinatorAutoTemp = 25; // 25C // Legacy defines (Deprecated) #define KELVINATOR_MIN_TEMP kKelvinatorMinTemp #define KELVINATOR_MAX_TEMP kKelvinatorMaxTemp #define KELVINATOR_HEAT kKelvinatorHeat #define KELVINATOR_FAN_MAX kKelvinatorFanMax #define KELVINATOR_FAN_AUTO kKelvinatorFanAuto #define KELVINATOR_FAN kKelvinatorFan #define KELVINATOR_DRY kKelvinatorDry #define KELVINATOR_COOL kKelvinatorCool #define KELVINATOR_BASIC_FAN_MAX kKelvinatorBasicFanMax #define KELVINATOR_AUTO_TEMP kKelvinatorAutoTemp #define KELVINATOR_AUTO kKelvinatorAuto /* Kelvinator AC map (header mark and space) byte 0 = Basic Modes b2-0 = Modes Modes: 000 = Auto (temp = 25C) 001 = Cool 010 = Dry (temp = 25C, but not shown) 011 = Fan 100 = Heat b3 = Power Status (1 = On, 0 = Off) b5-4 = Fan (Basic modes) Fan: 00 = Auto 01 = Fan 1 10 = Fan 2 11 = Fan 3 or higher (See byte 14) b6 = Vent swing (1 = On, 0 = Off) (See byte 4) b7 = Sleep Modes 1 & 3 (1 = On, 0 = Off) byte 1 = Temperature b3-0: Degrees C. 0000 (0) = 16C 0001 (1) = 17C 0010 (2) = 18C ... 1101 (13) = 29C 1110 (14) = 30C byte 2 = Extras b3-0 = UNKNOWN, typically 0. b4 = Turbo Fan (1 = On, 0 = Off) b5 = Light (Display) (1 = On, 0 = Off) b6 = Ion Filter (1 = On, 0 = Off) b7 = X-Fan (Fan runs for a while after power off) (1 = On, 0 = Off) byte 3 = Section Indicator b3-0 = Unused (Typically 0) b5-4 = Unknown (possibly timer related) (Typically 0b01) b7-6 = End of command block (B01) (B010 marker and a gap of 20ms) byte 4 = Extended options b0 = Swing Vent Vertical (1 = On, 0 = Off) b4 = Swing Vent Horizontal (1 = On, 0 = Off) byte 5-6 = Timer related. Typically 0 except when timer in use. byte 7 = checksum b3-0 = Unknown (Used in Timer mode) b7-4 = checksum of the previous bytes (0-6) (gap of 40ms) (header mark and space) byte 8 = Repeat of byte 0 byte 9 = Repeat of byte 1 byte 10 = Repeat of byte 2 byte 11 = Section Indicator b3-0 = Unused (Typically 0) b5-4 = Unknown (possibly timer related) (Typically 0b11) b7-6 = End of command block (B01) (B010 marker and a gap of 20ms) byte 12 = Extended options b0 = Sleep mode 2 (1 = On, 0=Off) b6-1 = Unknown (Used in Sleep Mode 3, Typically 0b000000) b7 = Quiet Mode (1 = On, 0=Off) byte 13 = Unknown (Sleep Mode 3 related, Typically 0x00) byte 14 = Fan control b3-0 = Unknown (Sleep Mode 3 related, Typically 0b0000) b6-4 = Fan speed 0b000 (0) = Automatic 0b001 (1) = Fan 1 0b010 (2) = Fan 2 0b011 (3) = Fan 3 0b100 (4) = Fan 4 0b101 (5) = Fan 5 byte 15 = checksum b3-0 = Unknown (Typically 0b0000) b7-4 = checksum of the previous bytes (8-14) */ // Classes /// Class for handling detailed Kelvinator A/C messages. class IRKelvinatorAC { public: explicit IRKelvinatorAC(const uint16_t pin, const bool inverted = false, const bool use_modulation = true); void stateReset(void); #if SEND_KELVINATOR void send(const uint16_t repeat = kKelvinatorDefaultRepeat); /// Run the calibration to calculate uSec timing offsets for this platform. /// @return The uSec timing offset needed per modulation of the IR Led. /// @note This will produce a 65ms IR signal pulse at 38kHz. /// Only ever needs to be run once per object instantiation, if at all. int8_t calibrate(void) { return _irsend.calibrate(); } #endif // SEND_KELVINATOR void begin(void); void on(void); void off(void); void setPower(const bool on); bool getPower(void); void setTemp(const uint8_t degrees); uint8_t getTemp(void); void setFan(const uint8_t speed); uint8_t getFan(void); void setMode(const uint8_t mode); uint8_t getMode(void); void setSwingVertical(const bool on); bool getSwingVertical(void); void setSwingHorizontal(const bool on); bool getSwingHorizontal(void); void setQuiet(const bool on); bool getQuiet(void); void setIonFilter(const bool on); bool getIonFilter(void); void setLight(const bool on); bool getLight(void); void setXFan(const bool on); bool getXFan(void); void setTurbo(const bool on); bool getTurbo(void); uint8_t* getRaw(void); void setRaw(const uint8_t new_code[]); static uint8_t calcBlockChecksum( const uint8_t* block, const uint16_t length = kKelvinatorStateLength / 2); static bool validChecksum(const uint8_t state[], const uint16_t length = kKelvinatorStateLength); uint8_t convertMode(const stdAc::opmode_t mode); static stdAc::opmode_t toCommonMode(const uint8_t mode); static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed); stdAc::state_t toCommon(void); String toString(void); #ifndef UNIT_TEST private: IRsend _irsend; ///< Instance of the IR send class #else // UNIT_TEST /// @cond IGNORE IRsendTest _irsend; ///< Instance of the testing IR send class /// @endcond #endif // UNIT_TEST uint8_t remote_state[kKelvinatorStateLength]; ///< The state in IR code form. void checksum(const uint16_t length = kKelvinatorStateLength); void fixup(void); }; #endif // IR_KELVINATOR_H_