IRremoteESP8266
ir_Corona.h
Go to the documentation of this file.
1 // Corona A/C
2 //
3 // Copyright 2020 Christian Nilsson
4 
5 // Supports:
6 // Brand: Corona, Model: CSH-N2211 A/C
7 // Brand: Corona, Model: CSH-N2511 A/C
8 // Brand: Corona, Model: CSH-N2811 A/C
9 // Brand: Corona, Model: CSH-N4011 A/C
10 // Brand: Corona, Model: AR-01 remote
11 //
12 // Ref: https://docs.google.com/spreadsheets/d/1zzDEUQ52y7MZ7_xCU3pdjdqbRXOwZLsbTGvKWcicqCI/
13 // Ref: https://www.corona.co.jp/box/download.php?id=145060636229
14 
15 #ifndef IR_CORONA_H_
16 #define IR_CORONA_H_
17 
18 #define __STDC_LIMIT_MACROS
19 #include <stdint.h>
20 #ifndef UNIT_TEST
21 #include <Arduino.h>
22 #endif
23 #include "IRremoteESP8266.h"
24 #include "IRsend.h"
25 #ifdef UNIT_TEST
26 #include "IRsend_test.h"
27 #endif
28 
29 // Constants
30 
31 // CORONA_AC
32 const uint8_t kCoronaAcSectionBytes = 7; // kCoronaAcStateLengthShort
33 const uint8_t kCoronaAcSections = 3;
34 const uint8_t kCoronaAcSectionHeader0Pos = 0;
35 const uint8_t kCoronaAcSectionHeader0 = 0x28;
36 const uint8_t kCoronaAcSectionHeader1Pos = 1;
37 const uint8_t kCoronaAcSectionHeader1 = 0x61;
38 const uint8_t kCoronaAcSectionLabelPos = 2;
39 const uint8_t kCoronaAcSectionLabelBase = 0x0D; // 0b1101
40 const uint8_t kCoronaAcSectionData0Pos = 3;
41 const uint8_t kCoronaAcSectionData0InvPos = 4;
42 const uint8_t kCoronaAcSectionData1Pos = 5;
43 const uint8_t kCoronaAcSectionData1InvPos = 6;
44 const uint8_t kCoronaAcSectionData0Base = 0x10; // D0 Pos 4 always on
45 
46 const uint8_t kCoronaAcSettingsSection = 0;
47 // D0
48 const uint8_t kCoronaAcFanOffset = 0; // D0 LSB Pos 0-1
49 const uint8_t kCoronaAcFanSize = 2;
50 const uint8_t kCoronaAcFanAuto = 0b00; // 0
51 const uint8_t kCoronaAcFanLow = 0b01; // 1
52 const uint8_t kCoronaAcFanMedium = 0b10; // 2
53 const uint8_t kCoronaAcFanHigh = 0b11; // 3
54 
55 // One bit unknown // D0 Pos 2
56 const uint8_t kCoronaAcPowerSaveOffset = 3; // D0 Pos 3
57 // One bit unknown always on // D0 Pos 4
58 // One bit unknown // D0 Pos 5
59 const uint8_t kCoronaAcSwingVToggleOffset = 6; // D0 Pos 6
60 // One bit unknown // D0 MSB Pos 7
61 
62 // D1
63 /* full auto mode not supported by this code yet
64 const uint8_t kCoronaAcAutoD0 = 0b00010100; // only combined with power save
65 const uint8_t kCoronaAcAutoD1 = 0b10000011; // only combined with power
66 */
67 const uint8_t kCoronaAcTempOffset = 0; // D1 LSB Pos 0
68 const uint8_t kCoronaAcTempSize = 4;
69 const uint8_t kCoronaAcMinTemp = 17; // Celsius = 0b0001
70 const uint8_t kCoronaAcMaxTemp = 30; // Celsius = 0b1110
71 const uint8_t kCoronaAcPowerOffset =
74  kCoronaAcPowerOffset + 1; // D1 Pos 5
75 const uint8_t kCoronaAcModeOffset =
76  kCoronaAcPowerButtonOffset + 1; // D1 MSB Pos 6-7
77 const uint8_t kCoronaAcModeSize = 2;
78 const uint8_t kCoronaAcModeHeat = 0b00; // 0
79 const uint8_t kCoronaAcModeDry = 0b01; // 1
80 const uint8_t kCoronaAcModeCool = 0b10; // 2
81 const uint8_t kCoronaAcModeFan = 0b11; // 3
82 
83 const uint8_t kCoronaAcOnTimerSection = 1;
84 const uint8_t kCoronaAcOffTimerSection = 2;
85 const uint16_t kCoronaAcTimerMax = 12 * 60; // 12H in Minutes
86 // Min value on remote is 1 hour, actual sent value can be 2 secs
87 const uint16_t kCoronaAcTimerOff = 0xffff;
88 const uint16_t kCoronaAcTimerUnitsPerMin = 30; // 30 units = 1 minute
89 
90 // Classes
91 
93 class IRCoronaAc {
94  public:
95  explicit IRCoronaAc(const uint16_t pin, const bool inverted = false,
96  const bool use_modulation = true);
97 
98  void stateReset();
99 #if SEND_CORONA_AC
100  void send(const uint16_t repeat = kNoRepeat);
105  int8_t calibrate(void) { return _irsend.calibrate(); }
106 #endif // SEND_CORONA_AC
107  void begin();
108  static bool validSection(const uint8_t state[], const uint16_t pos,
109  const uint8_t section);
110  void setPower(const bool on);
111  bool getPower();
112  bool getPowerButton();
113  void on();
114  void off();
115  void setTemp(const uint8_t temp);
116  uint8_t getTemp();
117  void setSwingVToggle(const bool on);
118  bool getSwingVToggle(void);
119  void setFan(const uint8_t speed);
120  uint8_t getFan();
121  void setMode(const uint8_t mode);
122  uint8_t getMode();
123  void setEcono(const bool on);
124  bool getEcono(void);
125  void setOnTimer(const uint16_t nr_of_mins);
126  uint16_t getOnTimer(void);
127  void setOffTimer(const uint16_t nr_of_mins);
128  uint16_t getOffTimer(void);
129  uint8_t* getRaw();
130  void setRaw(const uint8_t new_code[],
131  const uint16_t length = kCoronaAcStateLength);
132  uint8_t convertMode(const stdAc::opmode_t mode);
133  uint8_t convertFan(const stdAc::fanspeed_t speed);
134  static stdAc::opmode_t toCommonMode(const uint8_t mode);
135  static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
137  String toString();
138 #ifndef UNIT_TEST
139 
140  private:
142 #else
143  IRsendTest _irsend;
145 #endif
148  static uint8_t getSectionByte(const uint8_t section);
149  static void checksum(uint8_t* data);
150  void setPowerButton(const bool on);
151  void _setPower(const bool on);
152  void _setTimer(const uint8_t section, const uint16_t nr_of_mins);
153  uint16_t _getTimer(const uint8_t section);
154 };
155 #endif // IR_CORONA_H_
IRCoronaAc::getPowerButton
bool getPowerButton()
Get the value of the current power button setting.
Definition: ir_Corona.cpp:346
IRCoronaAc::getOnTimer
uint16_t getOnTimer(void)
Get the current On Timer time.
Definition: ir_Corona.cpp:518
kCoronaAcSectionBytes
const uint8_t kCoronaAcSectionBytes
Definition: ir_Corona.h:32
kCoronaAcTempOffset
const uint8_t kCoronaAcTempOffset
Definition: ir_Corona.h:67
IRCoronaAc::setFan
void setFan(const uint8_t speed)
Set the operating speed of the A/C Fan.
Definition: ir_Corona.cpp:415
IRCoronaAc::setEcono
void setEcono(const bool on)
Change the powersave setting.
Definition: ir_Corona.cpp:425
kCoronaAcSectionHeader0Pos
const uint8_t kCoronaAcSectionHeader0Pos
Definition: ir_Corona.h:34
IRCoronaAc::setRaw
void setRaw(const uint8_t new_code[], const uint16_t length=kCoronaAcStateLength)
Set the internal state from a valid code for this protocol.
Definition: ir_Corona.cpp:285
kCoronaAcSectionLabelBase
const uint8_t kCoronaAcSectionLabelBase
Definition: ir_Corona.h:39
kCoronaAcModeFan
const uint8_t kCoronaAcModeFan
Definition: ir_Corona.h:81
IRCoronaAc::setPowerButton
void setPowerButton(const bool on)
Change the power button setting.
Definition: ir_Corona.cpp:339
IRCoronaAc
Class for handling detailed Corona A/C messages.
Definition: ir_Corona.h:93
stdAc::fanspeed_t
fanspeed_t
Common A/C settings for Fan Speeds.
Definition: IRsend.h:58
kCoronaAcModeDry
const uint8_t kCoronaAcModeDry
Definition: ir_Corona.h:79
kCoronaAcSectionData0Base
const uint8_t kCoronaAcSectionData0Base
Definition: ir_Corona.h:44
kCoronaAcPowerSaveOffset
const uint8_t kCoronaAcPowerSaveOffset
Definition: ir_Corona.h:56
IRCoronaAc::setPower
void setPower(const bool on)
Change the power setting. (in practice Standby, remote power)
Definition: ir_Corona.cpp:315
IRCoronaAc::stateReset
void stateReset()
Reset the internal state to a fixed known good state.
Definition: ir_Corona.cpp:155
kCoronaAcTempSize
const uint8_t kCoronaAcTempSize
Definition: ir_Corona.h:68
IRCoronaAc::begin
void begin()
Set up hardware to be able to send a message.
Definition: ir_Corona.cpp:255
kCoronaAcFanMedium
const uint8_t kCoronaAcFanMedium
Definition: ir_Corona.h:52
kCoronaAcTimerUnitsPerMin
const uint16_t kCoronaAcTimerUnitsPerMin
Definition: ir_Corona.h:88
IRCoronaAc::setOffTimer
void setOffTimer(const uint16_t nr_of_mins)
Set the Off Timer time.
Definition: ir_Corona.cpp:541
kCoronaAcFanLow
const uint8_t kCoronaAcFanLow
Definition: ir_Corona.h:51
IRCoronaAc::toCommon
stdAc::state_t toCommon()
Convert the A/C state to it's common stdAc::state_t equivalent.
Definition: ir_Corona.cpp:575
IRsend.h
IRCoronaAc::setTemp
void setTemp(const uint8_t temp)
Set the temp in deg C.
Definition: ir_Corona.cpp:291
kCoronaAcSectionHeader0
const uint8_t kCoronaAcSectionHeader0
Definition: ir_Corona.h:35
IRCoronaAc::setOnTimer
void setOnTimer(const uint16_t nr_of_mins)
Set the On Timer time.
Definition: ir_Corona.cpp:525
IRsend
Class for sending all basic IR protocols.
Definition: IRsend.h:176
IRCoronaAc::remote_state
uint8_t remote_state[kCoronaAcStateLength]
The state of the IR remote.
Definition: ir_Corona.h:147
IRCoronaAc::convertFan
uint8_t convertFan(const stdAc::fanspeed_t speed)
Convert a standard A/C Fan speed into its native fan speed.
Definition: ir_Corona.cpp:439
kCoronaAcSwingVToggleOffset
const uint8_t kCoronaAcSwingVToggleOffset
Definition: ir_Corona.h:59
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:1128
kCoronaAcOffTimerSection
const uint8_t kCoronaAcOffTimerSection
Definition: ir_Corona.h:84
IRCoronaAc::on
void on()
Change the power setting to On.
Definition: ir_Corona.cpp:352
kCoronaAcTimerMax
const uint16_t kCoronaAcTimerMax
Definition: ir_Corona.h:85
IRCoronaAc::validSection
static bool validSection(const uint8_t state[], const uint16_t pos, const uint8_t section)
Check that a CoronaAc Section part is valid with section byte and inverted.
Definition: ir_Corona.cpp:188
IRCoronaAc::getPower
bool getPower()
Get the current power setting. (in practice Standby, remote power)
Definition: ir_Corona.cpp:326
kCoronaAcSectionHeader1
const uint8_t kCoronaAcSectionHeader1
Definition: ir_Corona.h:37
IRCoronaAc::getTemp
uint8_t getTemp()
Get the current temperature from the internal state.
Definition: ir_Corona.cpp:300
IRCoronaAc::getEcono
bool getEcono(void)
Get the value of the current powersave setting.
Definition: ir_Corona.cpp:431
IRCoronaAc::getSwingVToggle
bool getSwingVToggle(void)
Get the Vertical Swing toggle setting.
Definition: ir_Corona.cpp:473
IRremoteESP8266.h
IRCoronaAc::getMode
uint8_t getMode()
Get the operating mode setting of the A/C.
Definition: ir_Corona.cpp:359
IRCoronaAc::send
void send(const uint16_t repeat=kNoRepeat)
Send the current internal state as an IR message.
Definition: ir_Corona.cpp:260
kCoronaAcSectionData1InvPos
const uint8_t kCoronaAcSectionData1InvPos
Definition: ir_Corona.h:43
kCoronaAcPowerOffset
const uint8_t kCoronaAcPowerOffset
Definition: ir_Corona.h:71
kCoronaAcPowerButtonOffset
const uint8_t kCoronaAcPowerButtonOffset
Definition: ir_Corona.h:73
kCoronaAcSections
const uint8_t kCoronaAcSections
Definition: ir_Corona.h:33
kCoronaAcSectionData0InvPos
const uint8_t kCoronaAcSectionData0InvPos
Definition: ir_Corona.h:41
kNoRepeat
const uint16_t kNoRepeat
Definition: IRremoteESP8266.h:835
kCoronaAcFanHigh
const uint8_t kCoronaAcFanHigh
Definition: ir_Corona.h:53
kCoronaAcSectionData1Pos
const uint8_t kCoronaAcSectionData1Pos
Definition: ir_Corona.h:42
kCoronaAcStateLength
const uint16_t kCoronaAcStateLength
Definition: IRremoteESP8266.h:858
IRCoronaAc::checksum
static void checksum(uint8_t *data)
Calculate and set the check values for the internal state.
Definition: ir_Corona.cpp:240
IRCoronaAc::convertMode
uint8_t convertMode(const stdAc::opmode_t mode)
Convert a standard A/C mode into its native mode.
Definition: ir_Corona.cpp:385
IRCoronaAc::_getTimer
uint16_t _getTimer(const uint8_t section)
Get the current Timer time.
Definition: ir_Corona.cpp:504
IRCoronaAc::getFan
uint8_t getFan()
Get the operating speed of the A/C Fan.
Definition: ir_Corona.cpp:408
kCoronaAcFanSize
const uint8_t kCoronaAcFanSize
Definition: ir_Corona.h:49
IRCoronaAc::_setTimer
void _setTimer(const uint8_t section, const uint16_t nr_of_mins)
Set the Timer time.
Definition: ir_Corona.cpp:483
kCoronaAcModeCool
const uint8_t kCoronaAcModeCool
Definition: ir_Corona.h:80
kCoronaAcMinTemp
const uint8_t kCoronaAcMinTemp
Definition: ir_Corona.h:69
kCoronaAcSectionData0Pos
const uint8_t kCoronaAcSectionData0Pos
Definition: ir_Corona.h:40
kCoronaAcSectionLabelPos
const uint8_t kCoronaAcSectionLabelPos
Definition: ir_Corona.h:38
IRCoronaAc::toCommonMode
static stdAc::opmode_t toCommonMode(const uint8_t mode)
Convert a native mode to it's common stdAc::opmode_t equivalent.
Definition: ir_Corona.cpp:397
IRCoronaAc::getOffTimer
uint16_t getOffTimer(void)
Get the current Off Timer time.
Definition: ir_Corona.cpp:534
kCoronaAcSectionHeader1Pos
const uint8_t kCoronaAcSectionHeader1Pos
Definition: ir_Corona.h:36
IRCoronaAc::IRCoronaAc
IRCoronaAc(const uint16_t pin, const bool inverted=false, const bool use_modulation=true)
Class constructor for handling detailed Corona A/C messages.
Definition: ir_Corona.cpp:149
IRCoronaAc::getRaw
uint8_t * getRaw()
Get a copy of the internal state as a valid code for this protocol.
Definition: ir_Corona.cpp:277
kCoronaAcSettingsSection
const uint8_t kCoronaAcSettingsSection
Definition: ir_Corona.h:46
kCoronaAcFanOffset
const uint8_t kCoronaAcFanOffset
Definition: ir_Corona.h:48
kCoronaAcModeHeat
const uint8_t kCoronaAcModeHeat
Definition: ir_Corona.h:78
IRCoronaAc::_irsend
IRsend _irsend
Instance of the IR send class.
Definition: ir_Corona.h:141
IRCoronaAc::setSwingVToggle
void setSwingVToggle(const bool on)
Set the Vertical Swing toggle setting.
Definition: ir_Corona.cpp:466
kCoronaAcModeOffset
const uint8_t kCoronaAcModeOffset
Definition: ir_Corona.h:75
IRCoronaAc::getSectionByte
static uint8_t getSectionByte(const uint8_t section)
Get the byte that identifies the section.
Definition: ir_Corona.cpp:172
IRCoronaAc::setMode
void setMode(const uint8_t mode)
Set the operating mode of the A/C.
Definition: ir_Corona.cpp:366
IRCoronaAc::off
void off()
Change the power setting to Off.
Definition: ir_Corona.cpp:355
IRCoronaAc::_setPower
void _setPower(const bool on)
Change the power setting. (in practice Standby, remote power)
Definition: ir_Corona.cpp:307
IRCoronaAc::toCommonFanSpeed
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed)
Convert a native fan speed to it's common equivalent.
Definition: ir_Corona.cpp:453
IRCoronaAc::calibrate
int8_t calibrate(void)
Run the calibration to calculate uSec timing offsets for this platform.
Definition: ir_Corona.h:105
kCoronaAcTimerOff
const uint16_t kCoronaAcTimerOff
Definition: ir_Corona.h:87
kCoronaAcOnTimerSection
const uint8_t kCoronaAcOnTimerSection
Definition: ir_Corona.h:83
stdAc::state_t
Structure to hold a common A/C state.
Definition: IRsend.h:97
IRCoronaAc::toString
String toString()
Convert the internal state into a human readable string.
Definition: ir_Corona.cpp:550
kCoronaAcMaxTemp
const uint8_t kCoronaAcMaxTemp
Definition: ir_Corona.h:70
kCoronaAcFanAuto
const uint8_t kCoronaAcFanAuto
Definition: ir_Corona.h:50
kCoronaAcModeSize
const uint8_t kCoronaAcModeSize
Definition: ir_Corona.h:77
stdAc::opmode_t
opmode_t
Common A/C settings for A/C operating modes.
Definition: IRsend.h:46