IRremoteESP8266

ir_Kelvinator.h
Go to the documentation of this file.
1 // Copyright 2016 David Conran
4
5 // Supports:
6 // Brand: Kelvinator, Model: YALIF Remote
7 // Brand: Kelvinator, Model: KSV26CRC A/C
8 // Brand: Kelvinator, Model: KSV26HRC A/C
9 // Brand: Kelvinator, Model: KSV35CRC A/C
10 // Brand: Kelvinator, Model: KSV35HRC A/C
11 // Brand: Kelvinator, Model: KSV53HRC A/C
12 // Brand: Kelvinator, Model: KSV62HRC A/C
13 // Brand: Kelvinator, Model: KSV70CRC A/C
14 // Brand: Kelvinator, Model: KSV70HRC A/C
15 // Brand: Kelvinator, Model: KSV80HRC A/C
16 // Brand: Gree, Model: YAPOF3 remote
17 // Brand: Gree, Model: YAP0F8 remote
18 // Brand: Sharp, Model: YB1FA remote
19 // Brand: Sharp, Model: A5VEY A/C
20
21 #ifndef IR_KELVINATOR_H_
22 #define IR_KELVINATOR_H_
23
24 #define __STDC_LIMIT_MACROS
25 #include <stdint.h>
26 #ifndef UNIT_TEST
27 #include <Arduino.h>
28 #endif
29 #include "IRremoteESP8266.h"
30 #include "IRsend.h"
31 #ifdef UNIT_TEST
32 #include "IRsend_test.h"
33 #endif
34
36 union KelvinatorProtocol{
37 uint8_t raw[kKelvinatorStateLength];
38 struct {
39 // Byte 0
40 uint8_t Mode :3;
41 uint8_t Power :1;
42 uint8_t BasicFan :2;
43 uint8_t SwingAuto :1;
44 uint8_t :1; // Sleep Modes 1 & 3 (1 = On, 0 = Off)
45 // Byte 1
46 uint8_t Temp :4; // Degrees C.
47 uint8_t :4;
48 // Byte 2
49 uint8_t :4;
50 uint8_t Turbo :1;
51 uint8_t Light :1;
52 uint8_t IonFilter :1;
53 uint8_t XFan :1;
54 // Byte 3
55 uint8_t :4;
56 uint8_t :2; // (possibly timer related) (Typically 0b01)
57 uint8_t :2; // End of command block (B01)
58 // (B010 marker and a gap of 20ms)
59 // Byte 4
60 uint8_t SwingV :4;
61 uint8_t SwingH :1;
62 uint8_t :3;
63 // Byte 5~6
64 uint8_t pad0[2]; // Timer related. Typically 0 except when timer in use.
65 // Byte 7
66 uint8_t :4; // (Used in Timer mode)
67 uint8_t Sum1 :4; // checksum of the previous bytes (0-6)
68 // (gap of 40ms)
69 // (header mark and space)
70 // Byte 8~10
71 uint8_t pad1[3]; // Repeat of byte 0~2
72 // Byte 11
73 uint8_t :4;
74 uint8_t :2; // (possibly timer related) (Typically 0b11)
75 uint8_t :2; // End of command block (B01)
76 // (B010 marker and a gap of 20ms)
77 // Byte 12
78 uint8_t :1; // Sleep mode 2 (1 = On, 0=Off)
79 uint8_t :6; // (Used in Sleep Mode 3, Typically 0b000000)
80 uint8_t Quiet :1;
81 // Byte 13
82 uint8_t :8; // (Sleep Mode 3 related, Typically 0x00)
83 // Byte 14
84 uint8_t :4; // (Sleep Mode 3 related, Typically 0b0000)
85 uint8_t Fan :3;
86 // Byte 15
87 uint8_t :4;
88 uint8_t Sum2 :4; // checksum of the previous bytes (8-14)
89 };
90 };
91
92 // Constants
93 const uint8_t kKelvinatorAuto = 0; // (temp = 25C)
94 const uint8_t kKelvinatorCool = 1;
95 const uint8_t kKelvinatorDry = 2; // (temp = 25C, but not shown)
96 const uint8_t kKelvinatorFan = 3;
97 const uint8_t kKelvinatorHeat = 4;
98 const uint8_t kKelvinatorBasicFanMax = 3;
99 const uint8_t kKelvinatorFanAuto = 0;
100 const uint8_t kKelvinatorFanMin = 1;
101 const uint8_t kKelvinatorFanMax = 5;
102 const uint8_t kKelvinatorMinTemp = 16; // 16C
103 const uint8_t kKelvinatorMaxTemp = 30; // 30C
104 const uint8_t kKelvinatorAutoTemp = 25; // 25C
105
106 const uint8_t kKelvinatorSwingVOff = 0b0000; // 0
107 const uint8_t kKelvinatorSwingVAuto = 0b0001; // 1
108 const uint8_t kKelvinatorSwingVHighest = 0b0010; // 2
109 const uint8_t kKelvinatorSwingVUpperMiddle = 0b0011; // 3
110 const uint8_t kKelvinatorSwingVMiddle = 0b0100; // 4
111 const uint8_t kKelvinatorSwingVLowerMiddle = 0b0101; // 5
112 const uint8_t kKelvinatorSwingVLowest = 0b0110; // 6
113 const uint8_t kKelvinatorSwingVLowAuto = 0b0111; // 7
114 const uint8_t kKelvinatorSwingVMiddleAuto = 0b1001; // 9
115 const uint8_t kKelvinatorSwingVHighAuto = 0b1011; // 11
116
117 // Legacy defines (Deprecated)
118 #define KELVINATOR_MIN_TEMP kKelvinatorMinTemp
119 #define KELVINATOR_MAX_TEMP kKelvinatorMaxTemp
120 #define KELVINATOR_HEAT kKelvinatorHeat
121 #define KELVINATOR_FAN_MAX kKelvinatorFanMax
122 #define KELVINATOR_FAN_AUTO kKelvinatorFanAuto
123 #define KELVINATOR_FAN kKelvinatorFan
124 #define KELVINATOR_DRY kKelvinatorDry
125 #define KELVINATOR_COOL kKelvinatorCool
126 #define KELVINATOR_BASIC_FAN_MAX kKelvinatorBasicFanMax
127 #define KELVINATOR_AUTO_TEMP kKelvinatorAutoTemp
128 #define KELVINATOR_AUTO kKelvinatorAuto
129
130 // Classes
132 class IRKelvinatorAC {
133 public:
134 explicit IRKelvinatorAC(const uint16_t pin, const bool inverted = false,
135 const bool use_modulation = true);
136 void stateReset(void);
137 #if SEND_KELVINATOR
138 void send(const uint16_t repeat = kKelvinatorDefaultRepeat);
143 int8_t calibrate(void) { return _irsend.calibrate(); }
144 #endif // SEND_KELVINATOR
145 void begin(void);
146 void on(void);
147 void off(void);
148 void setPower(const bool on);
149 bool getPower(void) const;
150 void setTemp(const uint8_t degrees);
151 uint8_t getTemp(void) const;
152 void setFan(const uint8_t speed);
153 uint8_t getFan(void) const;
154 void setMode(const uint8_t mode);
155 uint8_t getMode(void) const;
156 void setSwingVertical(const bool automatic, const uint8_t position);
157 bool getSwingVerticalAuto(void) const;
158 uint8_t getSwingVerticalPosition(void) const;
159 static uint8_t convertSwingV(const stdAc::swingv_t swingv);
160 static stdAc::swingv_t toCommonSwingV(const uint8_t pos);
161 void setSwingHorizontal(const bool on);
162 bool getSwingHorizontal(void) const;
163 void setQuiet(const bool on);
164 bool getQuiet(void) const;
165 void setIonFilter(const bool on);
166 bool getIonFilter(void) const;
167 void setLight(const bool on);
168 bool getLight(void) const;
169 void setXFan(const bool on);
170 bool getXFan(void) const;
171 void setTurbo(const bool on);
172 bool getTurbo(void) const;
173 uint8_t* getRaw(void);
174 void setRaw(const uint8_t new_code[]);
175 static uint8_t calcBlockChecksum(
176 const uint8_t* block, const uint16_t length = kKelvinatorStateLength / 2);
177 static bool validChecksum(const uint8_t state[],
178 const uint16_t length = kKelvinatorStateLength);
179 static uint8_t convertMode(const stdAc::opmode_t mode);
180 static stdAc::opmode_t toCommonMode(const uint8_t mode);
181 static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
182 stdAc::state_t toCommon(void) const;
183 String toString(void) const;
184 #ifndef UNIT_TEST
185
186 private:
187 IRsend _irsend;
188 #else // UNIT_TEST
189 IRsendTest _irsend;
191 #endif // UNIT_TEST
193 KelvinatorProtocol _;
194 void checksum(void);
195 void fixup(void);
196 };
197
198 #endif // IR_KELVINATOR_H_
kKelvinatorSwingVAuto
const uint8_t kKelvinatorSwingVAuto
Definition: ir_Kelvinator.h:107
kKelvinatorSwingVLowerMiddle
const uint8_t kKelvinatorSwingVLowerMiddle
Definition: ir_Kelvinator.h:111
kKelvinatorSwingVUpperMiddle
const uint8_t kKelvinatorSwingVUpperMiddle
Definition: ir_Kelvinator.h:109
kKelvinatorSwingVHighest
const uint8_t kKelvinatorSwingVHighest
Definition: ir_Kelvinator.h:108
IRKelvinatorAC::setSwingHorizontal
void setSwingHorizontal(const bool on)
Control the current horizontal swing setting.
Definition: ir_Kelvinator.cpp:324
IRKelvinatorAC::stateReset
void stateReset(void)
Reset the internals of the object to a known good state.
Definition: ir_Kelvinator.cpp:115
IRKelvinatorAC::setTurbo
void setTurbo(const bool on)
Control the current Turbo setting.
Definition: ir_Kelvinator.cpp:390
kKelvinatorFanAuto
const uint8_t kKelvinatorFanAuto
Definition: ir_Kelvinator.h:99
stdAc::swingv_t
swingv_t
Common A/C settings for Vertical Swing.
Definition: IRsend.h:74
IRKelvinatorAC::on
void on(void)
Set the internal state to have the power on.
Definition: ir_Kelvinator.cpp:197
kKelvinatorFanMax
const uint8_t kKelvinatorFanMax
Definition: ir_Kelvinator.h:101
kKelvinatorCool
const uint8_t kKelvinatorCool
Definition: ir_Kelvinator.h:94
stdAc::fanspeed_t
fanspeed_t
Common A/C settings for Fan Speeds.
Definition: IRsend.h:61
kKelvinatorSwingVHighAuto
const uint8_t kKelvinatorSwingVHighAuto
Definition: ir_Kelvinator.h:115
IRKelvinatorAC::setLight
void setLight(const bool on)
Control the current Light setting. i.e. The LED display on the A/C unit that shows the basic settings...
Definition: ir_Kelvinator.cpp:362
KelvinatorProtocol::IonFilter
uint8_t IonFilter
Definition: ir_Kelvinator.h:52
kKelvinatorSwingVLowAuto
const uint8_t kKelvinatorSwingVLowAuto
Definition: ir_Kelvinator.h:113
kKelvinatorSwingVLowest
const uint8_t kKelvinatorSwingVLowest
Definition: ir_Kelvinator.h:112
KelvinatorProtocol::SwingV
uint8_t SwingV
Definition: ir_Kelvinator.h:60
IRKelvinatorAC::setSwingVertical
void setSwingVertical(const bool automatic, const uint8_t position)
Set the Vertical Swing mode of the A/C.
Definition: ir_Kelvinator.cpp:281
KelvinatorProtocol::pad0
uint8_t pad0[2]
Definition: ir_Kelvinator.h:64
IRKelvinatorAC::toCommonFanSpeed
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed)
Convert a native fan speed to it's stdAc::fanspeed_t equivalent.
Definition: ir_Kelvinator.cpp:443
kKelvinatorAutoTemp
const uint8_t kKelvinatorAutoTemp
Definition: ir_Kelvinator.h:104
KelvinatorProtocol::SwingAuto
uint8_t SwingAuto
Definition: ir_Kelvinator.h:43
IRKelvinatorAC::toCommonSwingV
static stdAc::swingv_t toCommonSwingV(const uint8_t pos)
IRKelvinatorAC::getRaw
uint8_t * getRaw(void)
Get the raw state of the object, suitable to be sent with the appropriate IRsend object method.
Definition: ir_Kelvinator.cpp:147
IRsend.h
IRKelvinatorAC::getLight
bool getLight(void) const
Is the Light (Display) setting on?
Definition: ir_Kelvinator.cpp:368
KelvinatorProtocol::XFan
uint8_t XFan
Definition: ir_Kelvinator.h:53
IRKelvinatorAC::setIonFilter
void setIonFilter(const bool on)
Control the current Ion Filter setting.
Definition: ir_Kelvinator.cpp:349
IRKelvinatorAC::getTemp
uint8_t getTemp(void) const
Get the current temperature setting.
Definition: ir_Kelvinator.cpp:224
IRKelvinatorAC::setFan
void setFan(const uint8_t speed)
Set the speed of the fan.
Definition: ir_Kelvinator.cpp:230
IRsend
Class for sending all basic IR protocols.
Definition: IRsend.h:237
kKelvinatorMinTemp
const uint8_t kKelvinatorMinTemp
Definition: ir_Kelvinator.h:102
IRKelvinatorAC::calibrate
int8_t calibrate(void)
Run the calibration to calculate uSec timing offsets for this platform.
Definition: ir_Kelvinator.h:143
IRsend::calibrate
int8_t calibrate(uint16_t hz=38000U)
Calculate & set any offsets to account for execution times during sending.
Definition: IRsend.cpp:207
String
std::string String
Definition: IRremoteESP8266.h:1521
IRKelvinatorAC::getSwingHorizontal
bool getSwingHorizontal(void) const
Is the horizontal swing setting on?
Definition: ir_Kelvinator.cpp:331
IRKelvinatorAC::setPower
void setPower(const bool on)
Set the internal state to have the desired power.
Definition: ir_Kelvinator.cpp:204
IRKelvinatorAC::setMode
void setMode(const uint8_t mode)
Set the desired operation mode.
Definition: ir_Kelvinator.cpp:258
IRKelvinatorAC::send
void send(const uint16_t repeat=kKelvinatorDefaultRepeat)
Send the current internal state as an IR message.
Definition: ir_Kelvinator.cpp:139
kKelvinatorSwingVMiddle
const uint8_t kKelvinatorSwingVMiddle
Definition: ir_Kelvinator.h:110
IRKelvinatorAC::setRaw
void setRaw(const uint8_t new_code[])
Set the raw state of the object.
Definition: ir_Kelvinator.cpp:154
kKelvinatorSwingVMiddleAuto
const uint8_t kKelvinatorSwingVMiddleAuto
Definition: ir_Kelvinator.h:114
IRKelvinatorAC::begin
void begin(void)
Set up hardware to be able to send a message.
Definition: ir_Kelvinator.cpp:122
IRKelvinatorAC::calcBlockChecksum
static uint8_t calcBlockChecksum(const uint8_t *block, const uint16_t length=kKelvinatorStateLength/2)
Calculate the checksum for a given block of state.
Definition: ir_Kelvinator.cpp:163
KelvinatorProtocol::Power
uint8_t Power
Definition: ir_Kelvinator.h:41
IRremoteESP8266.h
IRKelvinatorAC::_irsend
IRsend _irsend
Instance of the IR send class.
Definition: ir_Kelvinator.h:187
kKelvinatorSwingVOff
const uint8_t kKelvinatorSwingVOff
Definition: ir_Kelvinator.h:106
KelvinatorProtocol::Light
uint8_t Light
Definition: ir_Kelvinator.h:51
KelvinatorProtocol::raw
uint8_t raw[kKelvinatorStateLength]
The state in IR code form.
Definition: ir_Kelvinator.h:37
IRKelvinatorAC::getPower
bool getPower(void) const
Get the power setting from the internal state.
Definition: ir_Kelvinator.cpp:210
IRKelvinatorAC::validChecksum
static bool validChecksum(const uint8_t state[], const uint16_t length=kKelvinatorStateLength)
Verify the checksum is valid for a given state.
Definition: ir_Kelvinator.cpp:185
IRKelvinatorAC
Class for handling detailed Kelvinator A/C messages.
Definition: ir_Kelvinator.h:132
kKelvinatorMaxTemp
const uint8_t kKelvinatorMaxTemp
Definition: ir_Kelvinator.h:103
KelvinatorProtocol::Mode
uint8_t Mode
Definition: ir_Kelvinator.h:40
KelvinatorProtocol::Sum1
uint8_t Sum1
Definition: ir_Kelvinator.h:67
IRKelvinatorAC::checksum
void checksum(void)
Calculate the checksum for the internal state.
Definition: ir_Kelvinator.cpp:176
IRKelvinatorAC::fixup
void fixup(void)
Fix up any odd conditions for the current state.
Definition: ir_Kelvinator.cpp:125
KelvinatorProtocol::pad1
uint8_t pad1[3]
Definition: ir_Kelvinator.h:71
kKelvinatorStateLength
const uint16_t kKelvinatorStateLength
Definition: IRremoteESP8266.h:1289
IRKelvinatorAC::toCommon
stdAc::state_t toCommon(void) const
Convert the internal A/C object state to it's stdAc::state_t equivalent.
Definition: ir_Kelvinator.cpp:449
IRKelvinatorAC::setQuiet
void setQuiet(const bool on)
Control the current Quiet setting.
Definition: ir_Kelvinator.cpp:337
IRKelvinatorAC::setXFan
void setXFan(const bool on)
Control the current XFan setting. This setting will cause the unit blow air after power off to dry ou...
Definition: ir_Kelvinator.cpp:377
KelvinatorProtocol::SwingH
uint8_t SwingH
Definition: ir_Kelvinator.h:61
kKelvinatorFan
const uint8_t kKelvinatorFan
Definition: ir_Kelvinator.h:96
IRKelvinatorAC::toString
String toString(void) const
Convert the internal settings into a human readable string.
Definition: ir_Kelvinator.cpp:475
IRKelvinatorAC::setTemp
void setTemp(const uint8_t degrees)
Set the temperature setting.
Definition: ir_Kelvinator.cpp:216
KelvinatorProtocol::Sum2
uint8_t Sum2
Definition: ir_Kelvinator.h:88
kKelvinatorBasicFanMax
const uint8_t kKelvinatorBasicFanMax
Definition: ir_Kelvinator.h:98
kKelvinatorFanMin
const uint8_t kKelvinatorFanMin
Definition: ir_Kelvinator.h:100
IRKelvinatorAC::getTurbo
bool getTurbo(void) const
Is the Turbo setting on?
Definition: ir_Kelvinator.cpp:396
IRKelvinatorAC::_
KelvinatorProtocol _
Definition: ir_Kelvinator.h:193
IRKelvinatorAC::getMode
uint8_t getMode(void) const
Get the current operation mode setting.
Definition: ir_Kelvinator.cpp:252
IRKelvinatorAC::getSwingVerticalAuto
bool getSwingVerticalAuto(void) const
Get the Vertical Swing Automatic mode setting of the A/C.
Definition: ir_Kelvinator.cpp:312
KelvinatorProtocol::BasicFan
uint8_t BasicFan
Definition: ir_Kelvinator.h:42
kKelvinatorHeat
const uint8_t kKelvinatorHeat
Definition: ir_Kelvinator.h:97
IRKelvinatorAC::getQuiet
bool getQuiet(void) const
Is the Quiet setting on?
Definition: ir_Kelvinator.cpp:343
IRKelvinatorAC::IRKelvinatorAC
IRKelvinatorAC(const uint16_t pin, const bool inverted=false, const bool use_modulation=true)
Class constructor.
Definition: ir_Kelvinator.cpp:110
IRKelvinatorAC::off
void off(void)
Set the internal state to have the power off.
Definition: ir_Kelvinator.cpp:200
kKelvinatorDefaultRepeat
const uint16_t kKelvinatorDefaultRepeat
Definition: IRremoteESP8266.h:1291
IRKelvinatorAC::getFan
uint8_t getFan(void) const
Get the current fan speed setting.
Definition: ir_Kelvinator.cpp:246
kKelvinatorDry
const uint8_t kKelvinatorDry
Definition: ir_Kelvinator.h:95
IRKelvinatorAC::convertSwingV
static uint8_t convertSwingV(const stdAc::swingv_t swingv)
Convert a stdAc::swingv_t enum into it's native setting.
Definition: ir_Kelvinator.cpp:416
KelvinatorProtocol::Quiet
uint8_t Quiet
Definition: ir_Kelvinator.h:80
IRKelvinatorAC::getXFan
bool getXFan(void) const
Is the XFan setting on?
Definition: ir_Kelvinator.cpp:383
KelvinatorProtocol
Native representation of a Kelvinator A/C message.
Definition: ir_Kelvinator.h:36
IRKelvinatorAC::getIonFilter
bool getIonFilter(void) const
Is the Ion Filter setting on?
Definition: ir_Kelvinator.cpp:355
IRKelvinatorAC::toCommonMode
static stdAc::opmode_t toCommonMode(const uint8_t mode)
Convert a native mode to it's stdAc::opmode_t equivalent.
Definition: ir_Kelvinator.cpp:430
stdAc::state_t
Structure to hold a common A/C state.
Definition: IRsend.h:114
KelvinatorProtocol::Turbo
uint8_t Turbo
Definition: ir_Kelvinator.h:50
KelvinatorProtocol::Temp
uint8_t Temp
Definition: ir_Kelvinator.h:46
KelvinatorProtocol::Fan
uint8_t Fan
Definition: ir_Kelvinator.h:85
kKelvinatorAuto
const uint8_t kKelvinatorAuto
Definition: ir_Kelvinator.h:93
IRKelvinatorAC::getSwingVerticalPosition
uint8_t getSwingVerticalPosition(void) const
Get the Vertical Swing position setting of the A/C.
Definition: ir_Kelvinator.cpp:318
IRKelvinatorAC::convertMode
static uint8_t convertMode(const stdAc::opmode_t mode)
Convert a standard A/C mode (stdAc::opmode_t) into it a native mode.
Definition: ir_Kelvinator.cpp:403
stdAc::opmode_t
opmode_t
Common A/C settings for A/C operating modes.
Definition: IRsend.h:49