# IRremoteESP8266: src/ir_Gree.h Source File

ir_Gree.h
Go to the documentation of this file.
// Copyright 2016 David Conran
// Supports:
// Brand: Ultimate, Model: Heat Pump
// Brand: EKOKAI, Model: A/C
// Brand: RusClimate, Model: EACS/I-09HAR_X/N3 A/C
// Brand: RusClimate, Model: YAW1F remote
// Brand: Green, Model: YBOFB remote
// Brand: Green, Model: YBOFB2 remote
// Brand: Gree, Model: YAA1FBF remote
// Brand: Gree, Model: YB1F2F remote
// Brand: Amana, Model: PBC093G00CC A/C
// Brand: Amana, Model: YX1FF remote
#ifndef IR_GREE_H_
#define IR_GREE_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 GreeProtocol{
uint8_t remote_state[kGreeStateLength];
struct {
// Byte 0
uint8_t Mode :3;
uint8_t Power :1;
uint8_t Fan :2;
uint8_t SwingAuto :1;
uint8_t Sleep :1;
// Byte 1
uint8_t Temp :4;
uint8_t TimerHalfHr :1;
uint8_t TimerTensHr :2;
uint8_t TimerEnabled:1;
// Byte 2
uint8_t TimerHours:4;
uint8_t Turbo :1;
uint8_t Light :1;
uint8_t ModelA :1; // model==YAW1F
uint8_t Xfan :1;
// Byte 3
uint8_t :2;
uint8_t TempExtraDegreeF:1;
uint8_t UseFahrenheit :1;
uint8_t unknown1 :4; // value=0b0101
// Byte 4
uint8_t Swing:4;
uint8_t :0;
// Byte 5
uint8_t DisplayTemp :2;
uint8_t IFeel :1;
uint8_t unknown2 :3; // value = 0b100
uint8_t WiFi :1;
uint8_t :0;
// Byte 6
uint8_t :8;
// Byte 7
uint8_t :4;
uint8_t Sum:4;
};
};
// Constants
const uint8_t kGreeAuto = 0;
const uint8_t kGreeCool = 1;
const uint8_t kGreeDry = 2;
const uint8_t kGreeFan = 3;
const uint8_t kGreeHeat = 4;
const uint8_t kGreeFanAuto = 0;
const uint8_t kGreeFanMin = 1;
const uint8_t kGreeFanMed = 2;
const uint8_t kGreeFanMax = 3;
const uint8_t kGreeMinTempC = 16; // Celsius
const uint8_t kGreeMaxTempC = 30; // Celsius
const uint8_t kGreeMinTempF = 61; // Fahrenheit
const uint8_t kGreeMaxTempF = 86; // Fahrenheit
const uint16_t kGreeTimerMax = 24 * 60;
const uint8_t kGreeSwingLastPos = 0b0000;
const uint8_t kGreeSwingAuto = 0b0001;
const uint8_t kGreeSwingUp = 0b0010;
const uint8_t kGreeSwingMiddleUp = 0b0011;
const uint8_t kGreeSwingMiddle = 0b0100;
const uint8_t kGreeSwingMiddleDown = 0b0101;
const uint8_t kGreeSwingDown = 0b0110;
const uint8_t kGreeSwingDownAuto = 0b0111;
const uint8_t kGreeSwingMiddleAuto = 0b1001;
const uint8_t kGreeSwingUpAuto = 0b1011;
const uint8_t kGreeDisplayTempOff = 0b00; // 0
const uint8_t kGreeDisplayTempSet = 0b01; // 1
const uint8_t kGreeDisplayTempInside = 0b10; // 2
const uint8_t kGreeDisplayTempOutside = 0b11; // 3
// Legacy defines.
#define GREE_AUTO kGreeAuto
#define GREE_COOL kGreeCool
#define GREE_DRY kGreeDry
#define GREE_FAN kGreeFan
#define GREE_HEAT kGreeHeat
#define GREE_MIN_TEMP kGreeMinTempC
#define GREE_MAX_TEMP kGreeMaxTempC
#define GREE_FAN_MAX kGreeFanMax
#define GREE_SWING_LAST_POS kGreeSwingLastPos
#define GREE_SWING_AUTO kGreeSwingAuto
#define GREE_SWING_UP kGreeSwingUp
#define GREE_SWING_MIDDLE_UP kGreeSwingMiddleUp
#define GREE_SWING_MIDDLE kGreeSwingMiddle
#define GREE_SWING_MIDDLE_DOWN kGreeSwingMiddleDown
#define GREE_SWING_DOWN kGreeSwingDown
#define GREE_SWING_DOWN_AUTO kGreeSwingDownAuto
#define GREE_SWING_MIDDLE_AUTO kGreeSwingMiddleAuto
#define GREE_SWING_UP_AUTO kGreeSwingUpAuto
// Classes
class IRGreeAC {
public:
explicit 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);
void stateReset(void);
#if SEND_GREE
void send(const uint16_t repeat = kGreeDefaultRepeat);
int8_t calibrate(void) { return _irsend.calibrate(); }
#endif // SEND_GREE
void begin(void);
void on(void);
void off(void);
void setModel(const gree_ac_remote_model_t model);
gree_ac_remote_model_t getModel(void) const;
void setPower(const bool on);
bool getPower(void) const;
void setTemp(const uint8_t temp, const bool fahrenheit = false);
uint8_t getTemp(void) const;
void setUseFahrenheit(const bool on);
bool getUseFahrenheit(void) const;
void setFan(const uint8_t speed);
uint8_t getFan(void) const;
void setMode(const uint8_t new_mode);
uint8_t getMode(void) const;
void setLight(const bool on);
bool getLight(void) const;
void setXFan(const bool on);
bool getXFan(void) const;
void setSleep(const bool on);
bool getSleep(void) const;
void setTurbo(const bool on);
bool getTurbo(void) const;
void setIFeel(const bool on);
bool getIFeel(void) const;
void setWiFi(const bool on);
bool getWiFi(void) const;
void setSwingVertical(const bool automatic, const uint8_t position);
bool getSwingVerticalAuto(void) const;
uint8_t getSwingVerticalPosition(void) const;
uint16_t getTimer(void) const;
void setTimer(const uint16_t minutes);
void setDisplayTempSource(const uint8_t mode);
uint8_t getDisplayTempSource(void) const;
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);
static stdAc::swingv_t toCommonSwingV(const uint8_t pos);
stdAc::state_t toCommon(void);
uint8_t* getRaw(void);
void setRaw(const uint8_t new_code[]);
static bool validChecksum(const uint8_t state[],
const uint16_t length = kGreeStateLength);
String toString(void);
#ifndef UNIT_TEST
private:
IRsend _irsend;
#else // UNIT_TEST
IRsendTest _irsend;
#endif // UNIT_TEST
GreeProtocol _;
gree_ac_remote_model_t _model;
void checksum(const uint16_t length = kGreeStateLength);
void fixup(void);
void setTimerEnabled(const bool on);
bool getTimerEnabled(void) const;
};
#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:952
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:129
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:182
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:1178
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:130
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:954
stdAc::opmode_t
opmode_t
Common A/C settings for A/C operating modes.
Definition: IRsend.h:46