IRremoteESP8266: src/ir_Gree.h Source File

IRremoteESP8266

ir_Gree.h
Go to the documentation of this file.
1 // Copyright 2016 David Conran
2
6
7 // Supports:
8 // Brand: Ultimate, Model: Heat Pump
9 // Brand: EKOKAI, Model: A/C
10 // Brand: RusClimate, Model: EACS/I-09HAR_X/N3 A/C
11 // Brand: RusClimate, Model: YAW1F remote
12 // Brand: Green, Model: YBOFB remote
13 // Brand: Green, Model: YBOFB2 remote
14 // Brand: Gree, Model: YAA1FBF remote
15 // Brand: Gree, Model: YB1F2F remote
16 // Brand: Amana, Model: PBC093G00CC A/C
17 // Brand: Amana, Model: YX1FF remote
18
19 #ifndef IR_GREE_H_
20 #define IR_GREE_H_
21
22 #define __STDC_LIMIT_MACROS
23 #include <stdint.h>
24 #ifndef UNIT_TEST
25 #include <Arduino.h>
26 #endif
27 #include "IRremoteESP8266.h"
28 #include "IRsend.h"
29 #ifdef UNIT_TEST
30 #include "IRsend_test.h"
31 #endif
32
34 union GreeProtocol{
35 uint8_t remote_state[kGreeStateLength];
36 struct {
37 // Byte 0
38 uint8_t Mode :3;
39 uint8_t Power :1;
40 uint8_t Fan :2;
41 uint8_t SwingAuto :1;
42 uint8_t Sleep :1;
43 // Byte 1
44 uint8_t Temp :4;
45 uint8_t TimerHalfHr :1;
46 uint8_t TimerTensHr :2;
47 uint8_t TimerEnabled:1;
48 // Byte 2
49 uint8_t TimerHours:4;
50 uint8_t Turbo :1;
51 uint8_t Light :1;
52 uint8_t ModelA :1; // model==YAW1F
53 uint8_t Xfan :1;
54 // Byte 3
55 uint8_t :2;
56 uint8_t TempExtraDegreeF:1;
57 uint8_t UseFahrenheit :1;
58 uint8_t unknown1 :4; // value=0b0101
59 // Byte 4
60 uint8_t Swing:4;
61 uint8_t :0;
62 // Byte 5
63 uint8_t DisplayTemp :2;
64 uint8_t IFeel :1;
65 uint8_t unknown2 :3; // value = 0b100
66 uint8_t WiFi :1;
67 uint8_t :0;
68 // Byte 6
69 uint8_t :8;
70 // Byte 7
71 uint8_t :4;
72 uint8_t Sum:4;
73 };
74 };
75
76 // Constants
77
78 const uint8_t kGreeAuto = 0;
79 const uint8_t kGreeCool = 1;
80 const uint8_t kGreeDry = 2;
81 const uint8_t kGreeFan = 3;
82 const uint8_t kGreeHeat = 4;
83
84 const uint8_t kGreeFanAuto = 0;
85 const uint8_t kGreeFanMin = 1;
86 const uint8_t kGreeFanMed = 2;
87 const uint8_t kGreeFanMax = 3;
88
89 const uint8_t kGreeMinTempC = 16; // Celsius
90 const uint8_t kGreeMaxTempC = 30; // Celsius
91 const uint8_t kGreeMinTempF = 61; // Fahrenheit
92 const uint8_t kGreeMaxTempF = 86; // Fahrenheit
93 const uint16_t kGreeTimerMax = 24 * 60;
94
95 const uint8_t kGreeSwingLastPos = 0b0000;
96 const uint8_t kGreeSwingAuto = 0b0001;
97 const uint8_t kGreeSwingUp = 0b0010;
98 const uint8_t kGreeSwingMiddleUp = 0b0011;
99 const uint8_t kGreeSwingMiddle = 0b0100;
100 const uint8_t kGreeSwingMiddleDown = 0b0101;
101 const uint8_t kGreeSwingDown = 0b0110;
102 const uint8_t kGreeSwingDownAuto = 0b0111;
103 const uint8_t kGreeSwingMiddleAuto = 0b1001;
104 const uint8_t kGreeSwingUpAuto = 0b1011;
105
106 const uint8_t kGreeDisplayTempOff = 0b00; // 0
107 const uint8_t kGreeDisplayTempSet = 0b01; // 1
108 const uint8_t kGreeDisplayTempInside = 0b10; // 2
109 const uint8_t kGreeDisplayTempOutside = 0b11; // 3
110
111 // Legacy defines.
112 #define GREE_AUTO kGreeAuto
113 #define GREE_COOL kGreeCool
114 #define GREE_DRY kGreeDry
115 #define GREE_FAN kGreeFan
116 #define GREE_HEAT kGreeHeat
117 #define GREE_MIN_TEMP kGreeMinTempC
118 #define GREE_MAX_TEMP kGreeMaxTempC
119 #define GREE_FAN_MAX kGreeFanMax
120 #define GREE_SWING_LAST_POS kGreeSwingLastPos
121 #define GREE_SWING_AUTO kGreeSwingAuto
122 #define GREE_SWING_UP kGreeSwingUp
123 #define GREE_SWING_MIDDLE_UP kGreeSwingMiddleUp
124 #define GREE_SWING_MIDDLE kGreeSwingMiddle
125 #define GREE_SWING_MIDDLE_DOWN kGreeSwingMiddleDown
126 #define GREE_SWING_DOWN kGreeSwingDown
127 #define GREE_SWING_DOWN_AUTO kGreeSwingDownAuto
128 #define GREE_SWING_MIDDLE_AUTO kGreeSwingMiddleAuto
129 #define GREE_SWING_UP_AUTO kGreeSwingUpAuto
130
131 // Classes
133 class IRGreeAC {
134 public:
135 explicit IRGreeAC(
136 const uint16_t pin,
137 const gree_ac_remote_model_t model = gree_ac_remote_model_t::YAW1F,
138 const bool inverted = false, const bool use_modulation = true);
139 void stateReset(void);
140 #if SEND_GREE
141 void send(const uint16_t repeat = kGreeDefaultRepeat);
146 int8_t calibrate(void) { return _irsend.calibrate(); }
147 #endif // SEND_GREE
148 void begin(void);
149 void on(void);
150 void off(void);
151 void setModel(const gree_ac_remote_model_t model);
152 gree_ac_remote_model_t getModel(void) const;
153 void setPower(const bool on);
154 bool getPower(void) const;
155 void setTemp(const uint8_t temp, const bool fahrenheit = false);
156 uint8_t getTemp(void) const;
157 void setUseFahrenheit(const bool on);
158 bool getUseFahrenheit(void) const;
159 void setFan(const uint8_t speed);
160 uint8_t getFan(void) const;
161 void setMode(const uint8_t new_mode);
162 uint8_t getMode(void) const;
163 void setLight(const bool on);
164 bool getLight(void) const;
165 void setXFan(const bool on);
166 bool getXFan(void) const;
167 void setSleep(const bool on);
168 bool getSleep(void) const;
169 void setTurbo(const bool on);
170 bool getTurbo(void) const;
171 void setIFeel(const bool on);
172 bool getIFeel(void) const;
173 void setWiFi(const bool on);
174 bool getWiFi(void) const;
175 void setSwingVertical(const bool automatic, const uint8_t position);
176 bool getSwingVerticalAuto(void) const;
177 uint8_t getSwingVerticalPosition(void) const;
178 uint16_t getTimer(void) const;
179 void setTimer(const uint16_t minutes);
180 void setDisplayTempSource(const uint8_t mode);
181 uint8_t getDisplayTempSource(void) const;
182 static uint8_t convertMode(const stdAc::opmode_t mode);
183 static uint8_t convertFan(const stdAc::fanspeed_t speed);
184 static uint8_t convertSwingV(const stdAc::swingv_t swingv);
185 static stdAc::opmode_t toCommonMode(const uint8_t mode);
186 static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
187 static stdAc::swingv_t toCommonSwingV(const uint8_t pos);
188 stdAc::state_t toCommon(void);
189 uint8_t* getRaw(void);
190 void setRaw(const uint8_t new_code[]);
191 static bool validChecksum(const uint8_t state[],
192 const uint16_t length = kGreeStateLength);
193 String toString(void);
194 #ifndef UNIT_TEST
195
196 private:
197 IRsend _irsend;
198 #else // UNIT_TEST
199 IRsendTest _irsend;
201 #endif // UNIT_TEST
203 GreeProtocol _;
204 gree_ac_remote_model_t _model;
205 void checksum(const uint16_t length = kGreeStateLength);
206 void fixup(void);
207 void setTimerEnabled(const bool on);
208 bool getTimerEnabled(void) const;
209 };
210
211 #endif // IR_GREE_H_
IRGreeAC::setSwingVertical
void setSwingVertical(const bool automatic, const uint8_t position)
Set the Vertical Swing mode of the A/C.
Definition: ir_Gree.cpp:386
GreeProtocol::ModelA
uint8_t ModelA
Definition: ir_Gree.h:52
GreeProtocol::Temp
uint8_t Temp
Definition: ir_Gree.h:44
GreeProtocol::Mode
uint8_t Mode
Definition: ir_Gree.h:38
IRGreeAC::_
GreeProtocol _
Definition: ir_Gree.h:203
IRGreeAC::getMode
uint8_t getMode(void) const
Get the operating mode setting of the A/C.
Definition: ir_Gree.cpp:307
IRGreeAC::getWiFi
bool getWiFi(void) const
Get the Wifi (enabled) setting of the A/C.
Definition: ir_Gree.cpp:343
kGreeStateLength
const uint16_t kGreeStateLength
Definition: IRremoteESP8266.h:970
kGreeSwingUp
const uint8_t kGreeSwingUp
Definition: ir_Gree.h:97
stdAc::swingv_t
swingv_t
Common A/C settings for Vertical Swing.
Definition: IRsend.h:70
IRGreeAC::validChecksum
static bool validChecksum(const uint8_t state[], const uint16_t length=kGreeStateLength)
Verify the checksum is valid for a given state.
Definition: ir_Gree.cpp:176
IRGreeAC::toString
String toString(void)
Convert the current internal state into a human readable string.
Definition: ir_Gree.cpp:595
IRGreeAC::off
void off(void)
Change the power setting to Off.
Definition: ir_Gree.cpp:200
kGreeFan
const uint8_t kGreeFan
Definition: ir_Gree.h:81
IRGreeAC::setXFan
void setXFan(const bool on)
Set the XFan (Mould) setting of the A/C.
Definition: ir_Gree.cpp:349
IRGreeAC::toCommonMode
static stdAc::opmode_t toCommonMode(const uint8_t mode)
Convert a native mode into its stdAc equivalent.
Definition: ir_Gree.cpp:528
IRGreeAC::getIFeel
bool getIFeel(void) const
Get the IFeel setting of the A/C.
Definition: ir_Gree.cpp:331
stdAc::fanspeed_t
fanspeed_t
Common A/C settings for Fan Speeds.
Definition: IRsend.h:58
IRGreeAC::getLight
bool getLight(void) const
Get the Light (LED) setting of the A/C.
Definition: ir_Gree.cpp:319
GreeProtocol::SwingAuto
uint8_t SwingAuto
Definition: ir_Gree.h:41
GreeProtocol::TempExtraDegreeF
uint8_t TempExtraDegreeF
Definition: ir_Gree.h:56
IRGreeAC::convertMode
static uint8_t convertMode(const stdAc::opmode_t mode)
Convert a stdAc::opmode_t enum into its native mode.
Definition: ir_Gree.cpp:487
kGreeDry
const uint8_t kGreeDry
Definition: ir_Gree.h:80
GreeProtocol::unknown1
uint8_t unknown1
Definition: ir_Gree.h:58
kGreeFanMax
const uint8_t kGreeFanMax
Definition: ir_Gree.h:87
kGreeMaxTempF
const uint8_t kGreeMaxTempF
Definition: ir_Gree.h:92
IRGreeAC::getTimer
uint16_t getTimer(void) const
Get the timer time value from the A/C.
Definition: ir_Gree.cpp:440
IRGreeAC::setMode
void setMode(const uint8_t new_mode)
Set the operating mode of the A/C.
Definition: ir_Gree.cpp:289
GreeProtocol::Fan
uint8_t Fan
Definition: ir_Gree.h:40
IRGreeAC::toCommon
stdAc::state_t toCommon(void)
Convert the current internal state into its stdAc::state_t equivalent.
Definition: ir_Gree.cpp:566
GreeProtocol::WiFi
uint8_t WiFi
Definition: ir_Gree.h:66
gree_ac_remote_model_t
gree_ac_remote_model_t
Gree A/C model numbers.
Definition: IRsend.h:133
IRGreeAC::send
void send(const uint16_t repeat=kGreeDefaultRepeat)
Send the current internal state as an IR message.
Definition: ir_Gree.cpp:140
kGreeSwingUpAuto
const uint8_t kGreeSwingUpAuto
Definition: ir_Gree.h:104
kGreeDisplayTempOutside
const uint8_t kGreeDisplayTempOutside
Definition: ir_Gree.h:109
IRGreeAC::fixup
void fixup(void)
Fix up the internal state so it is correct.
Definition: ir_Gree.cpp:129
GreeProtocol::remote_state
uint8_t remote_state[kGreeStateLength]
The state in native IR code form.
Definition: ir_Gree.h:35
kGreeSwingDownAuto
const uint8_t kGreeSwingDownAuto
Definition: ir_Gree.h:102
IRsend.h
IRGreeAC::setPower
void setPower(const bool on)
Change the power setting.
Definition: ir_Gree.cpp:205
IRGreeAC::setTimerEnabled
void setTimerEnabled(const bool on)
Set the timer enable setting of the A/C.
Definition: ir_Gree.cpp:428
IRGreeAC::getRaw
uint8_t * getRaw(void)
Get a PTR to the internal state/code for this protocol.
Definition: ir_Gree.cpp:147
IRsend
Class for sending all basic IR protocols.
Definition: IRsend.h:187
GreeProtocol::Turbo
uint8_t Turbo
Definition: ir_Gree.h:50
IRsend::calibrate
int8_t calibrate(uint16_t hz=38000U)
Calculate & set any offsets to account for execution times during sending.
Definition: IRsend.cpp:207
GreeProtocol::Swing
uint8_t Swing
Definition: ir_Gree.h:60
String
std::string String
Definition: IRremoteESP8266.h:1199
kGreeDisplayTempSet
const uint8_t kGreeDisplayTempSet
Definition: ir_Gree.h:107
GreeProtocol::TimerHours
uint8_t TimerHours
Definition: ir_Gree.h:49
GreeProtocol::TimerHalfHr
uint8_t TimerHalfHr
Definition: ir_Gree.h:45
kGreeSwingMiddleDown
const uint8_t kGreeSwingMiddleDown
Definition: ir_Gree.h:100
IRGreeAC::IRGreeAC
IRGreeAC(const uint16_t pin, const gree_ac_remote_model_t model=gree_ac_remote_model_t::YAW1F, const bool inverted=false, const bool use_modulation=true)
Class constructor.
Definition: ir_Gree.cpp:110
GreeProtocol::Sum
uint8_t Sum
Definition: ir_Gree.h:72
kGreeFanMed
const uint8_t kGreeFanMed
Definition: ir_Gree.h:86
IRremoteESP8266.h
kGreeSwingMiddleAuto
const uint8_t kGreeSwingMiddleAuto
Definition: ir_Gree.h:103
IRGreeAC::convertFan
static uint8_t convertFan(const stdAc::fanspeed_t speed)
Convert a stdAc::fanspeed_t enum into it's native speed.
Definition: ir_Gree.cpp:500
kGreeHeat
const uint8_t kGreeHeat
Definition: ir_Gree.h:82
IRGreeAC::setSleep
void setSleep(const bool on)
Set the Sleep setting of the A/C.
Definition: ir_Gree.cpp:361
IRGreeAC::begin
void begin(void)
Set up hardware to be able to send a message.
Definition: ir_Gree.cpp:135
kGreeTimerMax
const uint16_t kGreeTimerMax
Definition: ir_Gree.h:93
YAW1F
@ YAW1F
Definition: IRsend.h:134
kGreeMaxTempC
const uint8_t kGreeMaxTempC
Definition: ir_Gree.h:90
IRGreeAC::calibrate
int8_t calibrate(void)
Run the calibration to calculate uSec timing offsets for this platform.
Definition: ir_Gree.h:146
GreeProtocol::Sleep
uint8_t Sleep
Definition: ir_Gree.h:42
kGreeMinTempF
const uint8_t kGreeMinTempF
Definition: ir_Gree.h:91
kGreeDisplayTempOff
const uint8_t kGreeDisplayTempOff
Definition: ir_Gree.h:106
IRGreeAC::setFan
void setFan(const uint8_t speed)
Set the speed of the fan.
Definition: ir_Gree.cpp:274
IRGreeAC::setUseFahrenheit
void setUseFahrenheit(const bool on)
Set the default temperature units to use.
Definition: ir_Gree.cpp:222
IRGreeAC::toCommonFanSpeed
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed)
Convert a native fan speed into its stdAc equivalent.
Definition: ir_Gree.cpp:541
GreeProtocol::unknown2
uint8_t unknown2
Definition: ir_Gree.h:65
IRGreeAC::getTurbo
bool getTurbo(void) const
Get the Turbo setting of the A/C.
Definition: ir_Gree.cpp:379
GreeProtocol::TimerTensHr
uint8_t TimerTensHr
Definition: ir_Gree.h:46
IRGreeAC::getPower
bool getPower(void) const
Get the value of the current power setting.
Definition: ir_Gree.cpp:214
IRGreeAC::getXFan
bool getXFan(void) const
Get the XFan (Mould) setting of the A/C.
Definition: ir_Gree.cpp:355
IRGreeAC::checksum
void checksum(const uint16_t length=kGreeStateLength)
Calculate and set the checksum values for the internal state.
Definition: ir_Gree.cpp:167
GreeProtocol::Xfan
uint8_t Xfan
Definition: ir_Gree.h:53
GreeProtocol::Light
uint8_t Light
Definition: ir_Gree.h:51
IRGreeAC::setTimer
void setTimer(const uint16_t minutes)
Set the A/C's timer to turn off in X many minutes.
Definition: ir_Gree.cpp:450
IRGreeAC::setModel
void setModel(const gree_ac_remote_model_t model)
Set the model of the A/C to emulate.
Definition: ir_Gree.cpp:184
IRGreeAC::getModel
gree_ac_remote_model_t getModel(void) const
Get/Detect the model of the A/C.
Definition: ir_Gree.cpp:194
kGreeAuto
const uint8_t kGreeAuto
Definition: ir_Gree.h:78
IRGreeAC::setWiFi
void setWiFi(const bool on)
Set the Wifi (enabled) setting of the A/C.
Definition: ir_Gree.cpp:337
IRGreeAC::getFan
uint8_t getFan(void) const
Get the current fan speed setting.
Definition: ir_Gree.cpp:283
IRGreeAC::convertSwingV
static uint8_t convertSwingV(const stdAc::swingv_t swingv)
Convert a stdAc::swingv_t enum into it's native setting.
Definition: ir_Gree.cpp:514
IRGreeAC::getUseFahrenheit
bool getUseFahrenheit(void) const
Get the default temperature units in use.
Definition: ir_Gree.cpp:228
IRGreeAC::setIFeel
void setIFeel(const bool on)
Set the IFeel setting of the A/C.
Definition: ir_Gree.cpp:325
kGreeSwingMiddleUp
const uint8_t kGreeSwingMiddleUp
Definition: ir_Gree.h:98
IRGreeAC::getTemp
uint8_t getTemp(void) const
Get the set temperature.
Definition: ir_Gree.cpp:261
GreeProtocol::IFeel
uint8_t IFeel
Definition: ir_Gree.h:64
kGreeFanMin
const uint8_t kGreeFanMin
Definition: ir_Gree.h:85
kGreeCool
const uint8_t kGreeCool
Definition: ir_Gree.h:79
IRGreeAC::getSwingVerticalPosition
uint8_t getSwingVerticalPosition(void) const
Get the Vertical Swing position setting of the A/C.
Definition: ir_Gree.cpp:422
kGreeSwingMiddle
const uint8_t kGreeSwingMiddle
Definition: ir_Gree.h:99
GreeProtocol
Native representation of a Gree A/C message.
Definition: ir_Gree.h:34
kGreeSwingLastPos
const uint8_t kGreeSwingLastPos
Definition: ir_Gree.h:95
IRGreeAC::setTemp
void setTemp(const uint8_t temp, const bool fahrenheit=false)
Set the temp. in degrees.
Definition: ir_Gree.cpp:238
IRGreeAC::getTimerEnabled
bool getTimerEnabled(void) const
Get the timer enabled setting of the A/C.
Definition: ir_Gree.cpp:434
IRGreeAC::_model
gree_ac_remote_model_t _model
Definition: ir_Gree.h:204
IRGreeAC::getSwingVerticalAuto
bool getSwingVerticalAuto(void) const
Get the Vertical Swing Automatic mode setting of the A/C.
Definition: ir_Gree.cpp:416
IRGreeAC::setTurbo
void setTurbo(const bool on)
Set the Turbo setting of the A/C.
Definition: ir_Gree.cpp:373
kGreeSwingDown
const uint8_t kGreeSwingDown
Definition: ir_Gree.h:101
IRGreeAC::toCommonSwingV
static stdAc::swingv_t toCommonSwingV(const uint8_t pos)
Convert a stdAc::swingv_t enum into it's native setting.
Definition: ir_Gree.cpp:553
kGreeFanAuto
const uint8_t kGreeFanAuto
Definition: ir_Gree.h:84
GreeProtocol::Power
uint8_t Power
Definition: ir_Gree.h:39
IRGreeAC::getSleep
bool getSleep(void) const
Get the Sleep setting of the A/C.
Definition: ir_Gree.cpp:367
GreeProtocol::TimerEnabled
uint8_t TimerEnabled
Definition: ir_Gree.h:47
kGreeMinTempC
const uint8_t kGreeMinTempC
Definition: ir_Gree.h:89
IRGreeAC::getDisplayTempSource
uint8_t getDisplayTempSource(void) const
Get the temperature display mode. i.e. Internal, External temperature sensing.
Definition: ir_Gree.cpp:480
IRGreeAC::setDisplayTempSource
void setDisplayTempSource(const uint8_t mode)
Set temperature display mode. i.e. Internal, External temperature sensing.
Definition: ir_Gree.cpp:473
GreeProtocol::UseFahrenheit
uint8_t UseFahrenheit
Definition: ir_Gree.h:57
kGreeSwingAuto
const uint8_t kGreeSwingAuto
Definition: ir_Gree.h:96
IRGreeAC
Class for handling detailed Gree A/C messages.
Definition: ir_Gree.h:133
GreeProtocol::DisplayTemp
uint8_t DisplayTemp
Definition: ir_Gree.h:63
kGreeDisplayTempInside
const uint8_t kGreeDisplayTempInside
Definition: ir_Gree.h:108
IRGreeAC::stateReset
void stateReset(void)
Reset the internal state to a fixed known good state.
Definition: ir_Gree.cpp:118
stdAc::state_t
Structure to hold a common A/C state.
Definition: IRsend.h:97
IRGreeAC::setRaw
void setRaw(const uint8_t new_code[])
Set the internal state from a valid code for this protocol.
Definition: ir_Gree.cpp:154
IRGreeAC::_irsend
IRsend _irsend
Instance of the IR send class.
Definition: ir_Gree.h:197
IRGreeAC::on
void on(void)
Change the power setting to On.
Definition: ir_Gree.cpp:197
IRGreeAC::setLight
void setLight(const bool on)
Set the Light (LED) setting of the A/C.
Definition: ir_Gree.cpp:313
kGreeDefaultRepeat
const uint16_t kGreeDefaultRepeat
Definition: IRremoteESP8266.h:972
stdAc::opmode_t
opmode_t
Common A/C settings for A/C operating modes.
Definition: IRsend.h:46