IRremoteESP8266
ir_Neoclima.h
Go to the documentation of this file.
1 // Copyright 2019 David Conran
2 
8 
9 // Supports:
10 // Brand: Neoclima, Model: NS-09AHTI A/C
11 // Brand: Neoclima, Model: ZH/TY-01 remote
12 
13 #ifndef IR_NEOCLIMA_H_
14 #define IR_NEOCLIMA_H_
15 
16 #define __STDC_LIMIT_MACROS
17 #include <stdint.h>
18 #ifndef UNIT_TEST
19 #include <Arduino.h>
20 #endif
21 #include "IRremoteESP8266.h"
22 #include "IRsend.h"
23 #ifdef UNIT_TEST
24 #include "IRsend_test.h"
25 #endif
26 
27 // Constants
28 // state[1]
29 const uint8_t kNeoclima8CHeatOffset = 1;
30 const uint8_t kNeoclimaIonOffset = 2;
31 // state[3]
32 const uint8_t kNeoclimaLightOffset = 0;
33 const uint8_t kNeoclimaHoldOffset = 2;
34 const uint8_t kNeoclimaTurboOffset = 3;
35 const uint8_t kNeoclimaEyeOffset = 6;
36 // state[5]
37 const uint8_t kNeoclimaFreshOffset = 7;
38 const uint8_t kNeoclimaButtonOffset = 0;
39 const uint8_t kNeoclimaButtonSize = 5;
40 const uint8_t kNeoclimaButtonPower = 0x00;
41 const uint8_t kNeoclimaButtonMode = 0x01;
42 const uint8_t kNeoclimaButtonTempUp = 0x02;
43 const uint8_t kNeoclimaButtonTempDown = 0x03;
44 const uint8_t kNeoclimaButtonSwing = 0x04;
45 const uint8_t kNeoclimaButtonFanSpeed = 0x05;
46 const uint8_t kNeoclimaButtonAirFlow = 0x07;
47 const uint8_t kNeoclimaButtonHold = 0x08;
48 const uint8_t kNeoclimaButtonSleep = 0x09;
49 const uint8_t kNeoclimaButtonTurbo = 0x0A;
50 const uint8_t kNeoclimaButtonLight = 0x0B;
51 const uint8_t kNeoclimaButtonEye = 0x0E;
52 const uint8_t kNeoclimaButtonFollow = 0x13;
53 const uint8_t kNeoclimaButtonIon = 0x14;
54 const uint8_t kNeoclimaButtonFresh = 0x15;
55 const uint8_t kNeoclimaButton8CHeat = 0x1D;
56 // state[7]
57 const uint8_t kNeoclimaSleepOffset = 0;
58 const uint8_t kNeoclimaPowerOffset = 1;
59 const uint8_t kNeoclimaSwingVOffset = 2;
60 const uint8_t kNeoclimaSwingVSize = 2; // Bits
61 const uint8_t kNeoclimaSwingVOn = 0b01;
62 const uint8_t kNeoclimaSwingVOff = 0b10;
63 const uint8_t kNeoclimaSwingHOffset = 4;
64 const uint8_t kNeoclimaFanOffest = 5;
65 const uint8_t kNeoclimaFanSize = 2;
66 const uint8_t kNeoclimaFanAuto = 0b00;
67 const uint8_t kNeoclimaFanHigh = 0b01;
68 const uint8_t kNeoclimaFanMed = 0b10;
69 const uint8_t kNeoclimaFanLow = 0b11;
70 // state[8]
71 const uint8_t kNeoclimaFollowMe = 0x5D; // Also 0x5F
72 // state[9]
73 const uint8_t kNeoclimaTempOffset = 0;
74 const uint8_t kNeoclimaTempSize = 5; // Bits
75 const uint8_t kNeoclimaMinTemp = 16; // 16C
76 const uint8_t kNeoclimaMaxTemp = 32; // 32C
77 const uint8_t kNeoclimaModeOffset = 5;
78 const uint8_t kNeoclimaAuto = 0b000;
79 const uint8_t kNeoclimaCool = 0b001;
80 const uint8_t kNeoclimaDry = 0b010;
81 const uint8_t kNeoclimaFan = 0b011;
82 const uint8_t kNeoclimaHeat = 0b100;
83 
84 // Classes
86 class IRNeoclimaAc {
87  public:
88  explicit IRNeoclimaAc(const uint16_t pin, const bool inverted = false,
89  const bool use_modulation = true);
90  void stateReset(void);
91 #if SEND_NEOCLIMA
92  void send(const uint16_t repeat = kNeoclimaMinRepeat);
97  int8_t calibrate(void) { return _irsend.calibrate(); }
98 #endif // SEND_NEOCLIMA
99  void begin(void);
100  void setButton(const uint8_t button);
101  uint8_t getButton(void);
102  void on(void);
103  void off(void);
104  void setPower(const bool on);
105  bool getPower(void);
106  void setMode(const uint8_t mode);
107  uint8_t getMode(void);
108  void setTemp(const uint8_t temp);
109  uint8_t getTemp(void);
110  void setFan(const uint8_t speed);
111  uint8_t getFan(void);
112  void setSwingV(const bool on);
113  bool getSwingV(void);
114  void setSwingH(const bool on);
115  bool getSwingH(void);
116  void setSleep(const bool on);
117  bool getSleep(void);
118  void setTurbo(const bool on);
119  bool getTurbo(void);
120  void setFresh(const bool on);
121  bool getFresh(void);
122  void setHold(const bool on);
123  bool getHold(void);
124  void setIon(const bool on);
125  bool getIon(void);
126  void setLight(const bool on);
127  bool getLight(void);
128  void set8CHeat(const bool on);
129  bool get8CHeat(void);
130  void setEye(const bool on);
131  bool getEye(void);
132  // DISABLED: See TODO in ir_Neoclima.cpp
133  // void setFollow(const bool on);
134  bool getFollow(void);
135  uint8_t* getRaw(void);
136  void setRaw(const uint8_t new_code[],
137  const uint16_t length = kNeoclimaStateLength);
138  static bool validChecksum(const uint8_t state[],
139  const uint16_t length = kNeoclimaStateLength);
140  static uint8_t calcChecksum(const uint8_t state[],
141  const uint16_t length = kNeoclimaStateLength);
142  String toString(void);
143  uint8_t convertMode(const stdAc::opmode_t mode);
144  uint8_t convertFan(const stdAc::fanspeed_t speed);
145  static stdAc::opmode_t toCommonMode(const uint8_t mode);
146  static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
147  stdAc::state_t toCommon(void);
148 #ifndef UNIT_TEST
149 
150  private:
152 #else // UNIT_TEST
153  IRsendTest _irsend;
155 #endif // UNIT_TEST
158  void checksum(const uint16_t length = kNeoclimaStateLength);
159 };
160 
161 #endif // IR_NEOCLIMA_H_
kNeoclimaFanHigh
const uint8_t kNeoclimaFanHigh
Definition: ir_Neoclima.h:67
IRNeoclimaAc::setTemp
void setTemp(const uint8_t temp)
Set the temperature.
Definition: ir_Neoclima.cpp:237
IRNeoclimaAc::toCommonFanSpeed
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed)
Convert a native fan speed into its stdAc equivilant.
Definition: ir_Neoclima.cpp:301
kNeoclimaButtonFanSpeed
const uint8_t kNeoclimaButtonFanSpeed
Definition: ir_Neoclima.h:45
kNeoclimaButtonTurbo
const uint8_t kNeoclimaButtonTurbo
Definition: ir_Neoclima.h:49
kNeoclimaFollowMe
const uint8_t kNeoclimaFollowMe
Definition: ir_Neoclima.h:71
IRNeoclimaAc::getSleep
bool getSleep(void)
Get the Sleep setting of the A/C.
Definition: ir_Neoclima.cpp:319
kNeoclimaEyeOffset
const uint8_t kNeoclimaEyeOffset
Definition: ir_Neoclima.h:35
kNeoclimaTempOffset
const uint8_t kNeoclimaTempOffset
Definition: ir_Neoclima.h:73
IRNeoclimaAc::getEye
bool getEye(void)
Get the Eye (Sensor) setting of the A/C.
Definition: ir_Neoclima.cpp:442
IRNeoclimaAc::getFollow
bool getFollow(void)
Get the Follow Me setting of the A/C.
Definition: ir_Neoclima.cpp:459
stdAc::fanspeed_t
fanspeed_t
Common A/C settings for Fan Speeds.
Definition: IRsend.h:58
kNeoclimaIonOffset
const uint8_t kNeoclimaIonOffset
Definition: ir_Neoclima.h:30
kNeoclimaDry
const uint8_t kNeoclimaDry
Definition: ir_Neoclima.h:80
IRNeoclimaAc::calcChecksum
static uint8_t calcChecksum(const uint8_t state[], const uint16_t length=kNeoclimaStateLength)
Calculate the checksum for a given state.
Definition: ir_Neoclima.cpp:84
IRNeoclimaAc::calibrate
int8_t calibrate(void)
Run the calibration to calculate uSec timing offsets for this platform.
Definition: ir_Neoclima.h:97
kNeoclimaMaxTemp
const uint8_t kNeoclimaMaxTemp
Definition: ir_Neoclima.h:76
IRNeoclimaAc::set8CHeat
void set8CHeat(const bool on)
Set the 8°C Heat setting of the A/C.
Definition: ir_Neoclima.cpp:422
kNeoclimaButtonEye
const uint8_t kNeoclimaButtonEye
Definition: ir_Neoclima.h:51
kNeoclimaMinTemp
const uint8_t kNeoclimaMinTemp
Definition: ir_Neoclima.h:75
kNeoclimaButtonPower
const uint8_t kNeoclimaButtonPower
Definition: ir_Neoclima.h:40
IRNeoclimaAc::setFan
void setFan(const uint8_t speed)
Set the speed of the fan.
Definition: ir_Neoclima.cpp:258
kNeoclimaSwingVOn
const uint8_t kNeoclimaSwingVOn
Definition: ir_Neoclima.h:61
kNeoclimaButtonMode
const uint8_t kNeoclimaButtonMode
Definition: ir_Neoclima.h:41
kNeoclimaStateLength
const uint16_t kNeoclimaStateLength
Definition: IRremoteESP8266.h:976
IRNeoclimaAc::setHold
void setHold(const bool on)
Set the Hold setting of the A/C.
Definition: ir_Neoclima.cpp:379
kNeoclimaSleepOffset
const uint8_t kNeoclimaSleepOffset
Definition: ir_Neoclima.h:57
IRNeoclimaAc::getMode
uint8_t getMode(void)
Get the operating mode setting of the A/C.
Definition: ir_Neoclima.cpp:205
IRNeoclimaAc::getPower
bool getPower(void)
Get the value of the current power setting.
Definition: ir_Neoclima.cpp:178
IRNeoclimaAc::setRaw
void setRaw(const uint8_t new_code[], const uint16_t length=kNeoclimaStateLength)
Set the internal state from a valid code for this protocol.
Definition: ir_Neoclima.cpp:125
kNeoclimaButtonHold
const uint8_t kNeoclimaButtonHold
Definition: ir_Neoclima.h:47
IRsend.h
kNeoclimaSwingVSize
const uint8_t kNeoclimaSwingVSize
Definition: ir_Neoclima.h:60
kNeoclimaAuto
const uint8_t kNeoclimaAuto
Definition: ir_Neoclima.h:78
IRNeoclimaAc::getFan
uint8_t getFan(void)
Get the current fan speed setting.
Definition: ir_Neoclima.cpp:280
IRNeoclimaAc::setLight
void setLight(const bool on)
Set the Light(LED display) setting of the A/C.
Definition: ir_Neoclima.cpp:405
kNeoclimaFan
const uint8_t kNeoclimaFan
Definition: ir_Neoclima.h:81
IRsend
Class for sending all basic IR protocols.
Definition: IRsend.h:176
IRNeoclimaAc::getRaw
uint8_t * getRaw(void)
Get a PTR to the internal state/code for this protocol.
Definition: ir_Neoclima.cpp:117
kNeoclimaFanAuto
const uint8_t kNeoclimaFanAuto
Definition: ir_Neoclima.h:66
IRsend::calibrate
int8_t calibrate(uint16_t hz=38000U)
Calculate & set any offsets to account for execution times during sending.
Definition: IRsend.cpp:207
kNeoclimaFreshOffset
const uint8_t kNeoclimaFreshOffset
Definition: ir_Neoclima.h:37
IRNeoclimaAc::getFresh
bool getFresh(void)
Get the Frsh (air) setting of the A/C.
Definition: ir_Neoclima.cpp:373
IRNeoclimaAc::getButton
uint8_t getButton(void)
Get the Button/Command setting of the A/C.
Definition: ir_Neoclima.cpp:159
String
std::string String
Definition: IRremoteESP8266.h:1128
IRNeoclimaAc::getSwingH
bool getSwingH(void)
Get the horizontal swing (Air Flow) setting of the A/C.
Definition: ir_Neoclima.cpp:347
kNeoclimaButtonFresh
const uint8_t kNeoclimaButtonFresh
Definition: ir_Neoclima.h:54
IRNeoclimaAc::getTurbo
bool getTurbo(void)
Get the Turbo setting of the A/C.
Definition: ir_Neoclima.cpp:360
kNeoclimaButtonAirFlow
const uint8_t kNeoclimaButtonAirFlow
Definition: ir_Neoclima.h:46
IRremoteESP8266.h
IRNeoclimaAc::stateReset
void stateReset(void)
Reset the state of the remote to a known good state/sequence.
Definition: ir_Neoclima.cpp:71
IRNeoclimaAc::convertFan
uint8_t convertFan(const stdAc::fanspeed_t speed)
Convert a stdAc::fanspeed_t enum into it's native speed.
Definition: ir_Neoclima.cpp:287
kNeoclimaButtonOffset
const uint8_t kNeoclimaButtonOffset
Definition: ir_Neoclima.h:38
kNeoclimaButtonTempDown
const uint8_t kNeoclimaButtonTempDown
Definition: ir_Neoclima.h:43
IRNeoclimaAc::begin
void begin(void)
Set up hardware to be able to send a message.
Definition: ir_Neoclima.cpp:78
kNeoclima8CHeatOffset
const uint8_t kNeoclima8CHeatOffset
Definition: ir_Neoclima.h:29
kNeoclimaSwingHOffset
const uint8_t kNeoclimaSwingHOffset
Definition: ir_Neoclima.h:63
kNeoclimaPowerOffset
const uint8_t kNeoclimaPowerOffset
Definition: ir_Neoclima.h:58
IRNeoclimaAc::getTemp
uint8_t getTemp(void)
Get the current temperature setting.
Definition: ir_Neoclima.cpp:251
kNeoclimaFanSize
const uint8_t kNeoclimaFanSize
Definition: ir_Neoclima.h:65
IRNeoclimaAc::getSwingV
bool getSwingV(void)
Get the vertical swing setting of the A/C.
Definition: ir_Neoclima.cpp:333
kNeoclimaButtonSize
const uint8_t kNeoclimaButtonSize
Definition: ir_Neoclima.h:39
kNeoclimaLightOffset
const uint8_t kNeoclimaLightOffset
Definition: ir_Neoclima.h:32
IRNeoclimaAc::remote_state
uint8_t remote_state[kNeoclimaStateLength]
State of the remote in code.
Definition: ir_Neoclima.h:157
kNeoclimaTempSize
const uint8_t kNeoclimaTempSize
Definition: ir_Neoclima.h:74
kNeoclimaButtonLight
const uint8_t kNeoclimaButtonLight
Definition: ir_Neoclima.h:50
IRNeoclimaAc::setIon
void setIon(const bool on)
Set the Ion (filter) setting of the A/C.
Definition: ir_Neoclima.cpp:392
kNeoclimaButtonSwing
const uint8_t kNeoclimaButtonSwing
Definition: ir_Neoclima.h:44
kNeoclimaButtonFollow
const uint8_t kNeoclimaButtonFollow
Definition: ir_Neoclima.h:52
IRNeoclimaAc::getHold
bool getHold(void)
Get the Hold setting of the A/C.
Definition: ir_Neoclima.cpp:386
IRNeoclimaAc::_irsend
IRsend _irsend
Instance of the IR send class.
Definition: ir_Neoclima.h:151
kNeoclimaSwingVOff
const uint8_t kNeoclimaSwingVOff
Definition: ir_Neoclima.h:62
IRNeoclimaAc::setSwingV
void setSwingV(const bool on)
Set the vertical swing setting of the A/C.
Definition: ir_Neoclima.cpp:325
IRNeoclimaAc::setEye
void setEye(const bool on)
Set the Eye (Sensor) setting of the A/C.
Definition: ir_Neoclima.cpp:435
IRNeoclimaAc::toCommonMode
static stdAc::opmode_t toCommonMode(const uint8_t mode)
Convert a native mode into its stdAc equivilant.
Definition: ir_Neoclima.cpp:225
kNeoclimaButtonSleep
const uint8_t kNeoclimaButtonSleep
Definition: ir_Neoclima.h:48
kNeoclimaTurboOffset
const uint8_t kNeoclimaTurboOffset
Definition: ir_Neoclima.h:34
IRNeoclimaAc::on
void on(void)
Set the requested power state of the A/C to on.
Definition: ir_Neoclima.cpp:164
kNeoclimaFanMed
const uint8_t kNeoclimaFanMed
Definition: ir_Neoclima.h:68
IRNeoclimaAc::setFresh
void setFresh(const bool on)
Set the Fresh (air) setting of the A/C.
Definition: ir_Neoclima.cpp:366
IRNeoclimaAc::toCommon
stdAc::state_t toCommon(void)
Convert the current internal state into its stdAc::state_t equivilant.
Definition: ir_Neoclima.cpp:465
IRNeoclimaAc::setPower
void setPower(const bool on)
Change the power setting.
Definition: ir_Neoclima.cpp:171
kNeoclimaCool
const uint8_t kNeoclimaCool
Definition: ir_Neoclima.h:79
kNeoclimaHoldOffset
const uint8_t kNeoclimaHoldOffset
Definition: ir_Neoclima.h:33
kNeoclimaButton8CHeat
const uint8_t kNeoclimaButton8CHeat
Definition: ir_Neoclima.h:55
IRNeoclimaAc::getIon
bool getIon(void)
Get the Ion (filter) setting of the A/C.
Definition: ir_Neoclima.cpp:399
kNeoclimaSwingVOffset
const uint8_t kNeoclimaSwingVOffset
Definition: ir_Neoclima.h:59
IRNeoclimaAc::get8CHeat
bool get8CHeat(void)
Get the 8°C Heat setting of the A/C.
Definition: ir_Neoclima.cpp:429
kNeoclimaFanOffest
const uint8_t kNeoclimaFanOffest
Definition: ir_Neoclima.h:64
IRNeoclimaAc::convertMode
uint8_t convertMode(const stdAc::opmode_t mode)
Convert a stdAc::opmode_t enum into its native mode.
Definition: ir_Neoclima.cpp:212
kNeoclimaHeat
const uint8_t kNeoclimaHeat
Definition: ir_Neoclima.h:82
IRNeoclimaAc::setButton
void setButton(const uint8_t button)
Set the Button/Command pressed setting of the A/C.
Definition: ir_Neoclima.cpp:131
kNeoclimaButtonIon
const uint8_t kNeoclimaButtonIon
Definition: ir_Neoclima.h:53
IRNeoclimaAc::toString
String toString(void)
Convert the current internal state into a human readable string.
Definition: ir_Neoclima.cpp:493
IRNeoclimaAc::setMode
void setMode(const uint8_t mode)
Set the operating mode of the A/C.
Definition: ir_Neoclima.cpp:184
kNeoclimaFanLow
const uint8_t kNeoclimaFanLow
Definition: ir_Neoclima.h:69
IRNeoclimaAc::setTurbo
void setTurbo(const bool on)
Set the Turbo setting of the A/C.
Definition: ir_Neoclima.cpp:353
IRNeoclimaAc::checksum
void checksum(const uint16_t length=kNeoclimaStateLength)
Calculate & update the checksum for the internal state.
Definition: ir_Neoclima.cpp:102
kNeoclimaModeOffset
const uint8_t kNeoclimaModeOffset
Definition: ir_Neoclima.h:77
IRNeoclimaAc::setSwingH
void setSwingH(const bool on)
Set the horizontal swing setting of the A/C.
Definition: ir_Neoclima.cpp:340
IRNeoclimaAc::send
void send(const uint16_t repeat=kNeoclimaMinRepeat)
Send the current internal state as an IR message.
Definition: ir_Neoclima.cpp:110
IRNeoclimaAc::off
void off(void)
Set the requested power state of the A/C to off.
Definition: ir_Neoclima.cpp:167
stdAc::state_t
Structure to hold a common A/C state.
Definition: IRsend.h:97
kNeoclimaMinRepeat
const uint16_t kNeoclimaMinRepeat
Definition: IRremoteESP8266.h:978
IRNeoclimaAc::IRNeoclimaAc
IRNeoclimaAc(const uint16_t pin, const bool inverted=false, const bool use_modulation=true)
Class constructor.
Definition: ir_Neoclima.cpp:64
IRNeoclimaAc
Class for handling detailed Neoclima A/C messages.
Definition: ir_Neoclima.h:86
IRNeoclimaAc::getLight
bool getLight(void)
Get the Light (LED display) setting of the A/C.
Definition: ir_Neoclima.cpp:412
IRNeoclimaAc::setSleep
void setSleep(const bool on)
Set the Sleep setting of the A/C.
Definition: ir_Neoclima.cpp:312
IRNeoclimaAc::validChecksum
static bool validChecksum(const uint8_t state[], const uint16_t length=kNeoclimaStateLength)
Verify the checksum is valid for a given state.
Definition: ir_Neoclima.cpp:94
kNeoclimaButtonTempUp
const uint8_t kNeoclimaButtonTempUp
Definition: ir_Neoclima.h:42
stdAc::opmode_t
opmode_t
Common A/C settings for A/C operating modes.
Definition: IRsend.h:46