IRremoteESP8266
ir_Electra.h
Go to the documentation of this file.
1 // Copyright 2019 David Conran
5 
6 // Supports:
7 // Brand: AUX, Model: KFR-35GW/BpNFW=3 A/C
8 // Brand: AUX, Model: YKR-T/011 remote
9 // Brand: Electra, Model: Classic INV 17 / AXW12DCS A/C
10 // Brand: Electra, Model: YKR-M/003E remote
11 
12 #ifndef IR_ELECTRA_H_
13 #define IR_ELECTRA_H_
14 
15 #define __STDC_LIMIT_MACROS
16 #include <stdint.h>
17 #ifndef UNIT_TEST
18 #include <Arduino.h>
19 #endif
20 #include "IRremoteESP8266.h"
21 #include "IRsend.h"
22 #ifdef UNIT_TEST
23 #include "IRsend_test.h"
24 #endif
25 
26 // Constants
27 // state[1]
28 // Temp 0b11111000
29 const uint8_t kElectraAcTempOffset = 3;
30 const uint8_t kElectraAcTempSize = 5; // Bits
31 const uint8_t kElectraAcMinTemp = 16; // 16C
32 const uint8_t kElectraAcMaxTemp = 32; // 32C
33 const uint8_t kElectraAcTempDelta = 8;
34 const uint8_t kElectraAcSwingSize = 3; // Bits
35 const uint8_t kElectraAcSwingOn = 0b000;
36 const uint8_t kElectraAcSwingOff = 0b111;
37 // SwingVMask = 0b00000111;
38 const uint8_t kElectraAcSwingVOffset = 0;
39 // state[2]
40 // SwingHMask = 0b11100000;
41 const uint8_t kElectraAcSwingHOffset = 5;
42 // state[4]
43 // FanMask = 0b11100000;
44 const uint8_t kElectraAcFanOffset = 5;
45 const uint8_t kElectraAcFanSize = 3; // Bits
46 
47 const uint8_t kElectraAcFanAuto = 0b101;
48 const uint8_t kElectraAcFanLow = 0b011;
49 const uint8_t kElectraAcFanMed = 0b010;
50 const uint8_t kElectraAcFanHigh = 0b001;
51 // state[5]
52 // TurboMask = 0b01000000;
53 const uint8_t kElectraAcTurboOffset = 6;
54 
55 // state[6]
56 // Mode 0b11100000
57 const uint8_t kElectraAcModeOffset = 5;
58 const uint8_t kElectraAcAuto = 0b000;
59 const uint8_t kElectraAcCool = 0b001;
60 const uint8_t kElectraAcDry = 0b010;
61 const uint8_t kElectraAcHeat = 0b100;
62 const uint8_t kElectraAcFan = 0b110;
63 // state[9]
64 //
65 const uint8_t kElectraAcCleanOffset = 2; // Bit 0b00000100
66 const uint8_t kElectraAcPowerOffset = 5; // Bit 0b00100000
67 // state[11]
68 //
69 const uint8_t kElectraAcLightToggleOn = 0x15;
70 // Light has known ON values of 0x15 (0b00010101) or 0x19 (0b00011001)
71 // Thus common bits ON are: 0b00010001 (0x11)
72 // We will use this for the getLightToggle() test.
73 const uint8_t kElectraAcLightToggleMask = 0x11;
74 // and known OFF values of 0x08 (0b00001000) & 0x05 (0x00000101)
75 const uint8_t kElectraAcLightToggleOff = 0x08;
76 
77 
78 // Classes
80 class IRElectraAc {
81  public:
82  explicit IRElectraAc(const uint16_t pin, const bool inverted = false,
83  const bool use_modulation = true);
84  void stateReset(void);
85 #if SEND_ELECTRA_AC
86  void send(const uint16_t repeat = kElectraAcMinRepeat);
91  int8_t calibrate(void) { return _irsend.calibrate(); }
92 #endif // SEND_ELECTRA_AC
93  void begin(void);
94  void on(void);
95  void off(void);
96  void setPower(const bool on);
97  bool getPower(void);
98  void setMode(const uint8_t mode);
99  uint8_t getMode(void);
100  void setTemp(const uint8_t temp);
101  uint8_t getTemp(void);
102  void setFan(const uint8_t speed);
103  uint8_t getFan(void);
104  void setSwingV(const bool on);
105  bool getSwingV(void);
106  void setSwingH(const bool on);
107  bool getSwingH(void);
108  void setClean(const bool on);
109  bool getClean(void);
110  void setLightToggle(const bool on);
111  bool getLightToggle(void);
112  void setTurbo(const bool on);
113  bool getTurbo(void);
114  uint8_t* getRaw(void);
115  void setRaw(const uint8_t new_code[],
116  const uint16_t length = kElectraAcStateLength);
117  static bool validChecksum(const uint8_t state[],
118  const uint16_t length = kElectraAcStateLength);
119  static uint8_t calcChecksum(const uint8_t state[],
120  const uint16_t length = kElectraAcStateLength);
121  String toString(void);
122  uint8_t convertMode(const stdAc::opmode_t mode);
123  uint8_t convertFan(const stdAc::fanspeed_t speed);
124  static stdAc::opmode_t toCommonMode(const uint8_t mode);
125  static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
126  stdAc::state_t toCommon(void);
127 #ifndef UNIT_TEST
128 
129  private:
131 #else
132  IRsendTest _irsend;
134 #endif
137  void checksum(const uint16_t length = kElectraAcStateLength);
138 };
139 #endif // IR_ELECTRA_H_
IRElectraAc::getSwingV
bool getSwingV(void)
Get the Vertical Swing mode of the A/C.
Definition: ir_Electra.cpp:263
IRElectraAc::convertMode
uint8_t convertMode(const stdAc::opmode_t mode)
Convert a stdAc::opmode_t enum into its native mode.
Definition: ir_Electra.cpp:167
IRElectraAc::checksum
void checksum(const uint16_t length=kElectraAcStateLength)
Calculate and set the checksum values for the internal state.
Definition: ir_Electra.cpp:96
IRElectraAc::getRaw
uint8_t * getRaw(void)
Get a PTR to the internal state/code for this protocol.
Definition: ir_Electra.cpp:111
IRElectraAc::getFan
uint8_t getFan(void)
Get the current fan speed setting.
Definition: ir_Electra.cpp:224
kElectraAcMinTemp
const uint8_t kElectraAcMinTemp
Definition: ir_Electra.h:31
IRElectraAc::getLightToggle
bool getLightToggle(void)
Get the Light (LED) Toggle mode of the A/C.
Definition: ir_Electra.cpp:290
IRElectraAc::getTurbo
bool getTurbo(void)
Get the Turbo mode of the A/C.
Definition: ir_Electra.cpp:315
kElectraAcMaxTemp
const uint8_t kElectraAcMaxTemp
Definition: ir_Electra.h:32
stdAc::fanspeed_t
fanspeed_t
Common A/C settings for Fan Speeds.
Definition: IRsend.h:58
IRElectraAc::validChecksum
static bool validChecksum(const uint8_t state[], const uint16_t length=kElectraAcStateLength)
Verify the checksum is valid for a given state.
Definition: ir_Electra.cpp:88
kElectraAcFanAuto
const uint8_t kElectraAcFanAuto
Definition: ir_Electra.h:47
IRElectraAc::getSwingH
bool getSwingH(void)
Get the Horizontal Swing mode of the A/C.
Definition: ir_Electra.cpp:277
kElectraAcPowerOffset
const uint8_t kElectraAcPowerOffset
Definition: ir_Electra.h:66
IRElectraAc::on
void on(void)
Change the power setting to On.
Definition: ir_Electra.cpp:124
kElectraAcTurboOffset
const uint8_t kElectraAcTurboOffset
Definition: ir_Electra.h:53
IRElectraAc::setClean
void setClean(const bool on)
Set the Clean mode of the A/C.
Definition: ir_Electra.cpp:297
IRsend.h
kElectraAcMinRepeat
const uint16_t kElectraAcMinRepeat
Definition: IRremoteESP8266.h:898
IRsend
Class for sending all basic IR protocols.
Definition: IRsend.h:176
IRElectraAc::IRElectraAc
IRElectraAc(const uint16_t pin, const bool inverted=false, const bool use_modulation=true)
Class constructor.
Definition: ir_Electra.cpp:57
IRsend::calibrate
int8_t calibrate(uint16_t hz=38000U)
Calculate & set any offsets to account for execution times during sending.
Definition: IRsend.cpp:207
IRElectraAc::toCommon
stdAc::state_t toCommon(void)
Convert the current internal state into its stdAc::state_t equivilant.
Definition: ir_Electra.cpp:321
kElectraAcHeat
const uint8_t kElectraAcHeat
Definition: ir_Electra.h:61
String
std::string String
Definition: IRremoteESP8266.h:1128
kElectraAcCool
const uint8_t kElectraAcCool
Definition: ir_Electra.h:59
IRElectraAc::setFan
void setFan(const uint8_t speed)
Set the speed of the fan.
Definition: ir_Electra.cpp:208
IRElectraAc
Class for handling detailed Electra A/C messages.
Definition: ir_Electra.h:80
kElectraAcTempSize
const uint8_t kElectraAcTempSize
Definition: ir_Electra.h:30
kElectraAcAuto
const uint8_t kElectraAcAuto
Definition: ir_Electra.h:58
IRremoteESP8266.h
kElectraAcTempOffset
const uint8_t kElectraAcTempOffset
Definition: ir_Electra.h:29
IRElectraAc::toCommonMode
static stdAc::opmode_t toCommonMode(const uint8_t mode)
Convert a native mode into its stdAc equivilant.
Definition: ir_Electra.cpp:180
kElectraAcDry
const uint8_t kElectraAcDry
Definition: ir_Electra.h:60
IRElectraAc::getClean
bool getClean(void)
Get the Clean mode of the A/C.
Definition: ir_Electra.cpp:303
IRElectraAc::setRaw
void setRaw(const uint8_t new_code[], const uint16_t length=kElectraAcStateLength)
Set the internal state from a valid code for this protocol.
Definition: ir_Electra.cpp:119
IRElectraAc::setPower
void setPower(const bool on)
Change the power setting.
Definition: ir_Electra.cpp:131
kElectraAcTempDelta
const uint8_t kElectraAcTempDelta
Definition: ir_Electra.h:33
IRElectraAc::calibrate
int8_t calibrate(void)
Run the calibration to calculate uSec timing offsets for this platform.
Definition: ir_Electra.h:91
kElectraAcLightToggleOff
const uint8_t kElectraAcLightToggleOff
Definition: ir_Electra.h:75
IRElectraAc::toCommonFanSpeed
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed)
Convert a native fan speed into its stdAc equivilant.
Definition: ir_Electra.cpp:245
IRElectraAc::getPower
bool getPower(void)
Get the value of the current power setting.
Definition: ir_Electra.cpp:137
IRElectraAc::toString
String toString(void)
Convert the current internal state into a human readable string.
Definition: ir_Electra.cpp:349
IRElectraAc::setTemp
void setTemp(const uint8_t temp)
Set the temperature.
Definition: ir_Electra.cpp:192
kElectraAcLightToggleOn
const uint8_t kElectraAcLightToggleOn
Definition: ir_Electra.h:69
IRElectraAc::setLightToggle
void setLightToggle(const bool on)
Set the Light (LED) Toggle mode of the A/C.
Definition: ir_Electra.cpp:284
kElectraAcFanLow
const uint8_t kElectraAcFanLow
Definition: ir_Electra.h:48
IRElectraAc::setSwingH
void setSwingH(const bool on)
Set the Horizontal Swing mode of the A/C.
Definition: ir_Electra.cpp:270
kElectraAcFanOffset
const uint8_t kElectraAcFanOffset
Definition: ir_Electra.h:44
kElectraAcModeOffset
const uint8_t kElectraAcModeOffset
Definition: ir_Electra.h:57
IRElectraAc::calcChecksum
static uint8_t calcChecksum(const uint8_t state[], const uint16_t length=kElectraAcStateLength)
Calculate the checksum for a given state.
Definition: ir_Electra.cpp:78
IRElectraAc::getMode
uint8_t getMode(void)
Get the operating mode setting of the A/C.
Definition: ir_Electra.cpp:160
kElectraAcSwingSize
const uint8_t kElectraAcSwingSize
Definition: ir_Electra.h:34
IRElectraAc::getTemp
uint8_t getTemp(void)
Get the current temperature setting.
Definition: ir_Electra.cpp:200
kElectraAcSwingHOffset
const uint8_t kElectraAcSwingHOffset
Definition: ir_Electra.h:41
IRElectraAc::off
void off(void)
Change the power setting to Off.
Definition: ir_Electra.cpp:127
IRElectraAc::send
void send(const uint16_t repeat=kElectraAcMinRepeat)
Send the current internal state as an IR message.
Definition: ir_Electra.cpp:104
IRElectraAc::_irsend
IRsend _irsend
instance of the IR send class
Definition: ir_Electra.h:130
kElectraAcSwingOn
const uint8_t kElectraAcSwingOn
Definition: ir_Electra.h:35
kElectraAcFanMed
const uint8_t kElectraAcFanMed
Definition: ir_Electra.h:49
kElectraAcFanHigh
const uint8_t kElectraAcFanHigh
Definition: ir_Electra.h:50
IRElectraAc::convertFan
uint8_t convertFan(const stdAc::fanspeed_t speed)
Convert a stdAc::fanspeed_t enum into it's native speed.
Definition: ir_Electra.cpp:231
IRElectraAc::begin
void begin(void)
Set up hardware to be able to send a message.
Definition: ir_Electra.cpp:72
IRElectraAc::setTurbo
void setTurbo(const bool on)
Set the Turbo mode of the A/C.
Definition: ir_Electra.cpp:309
IRElectraAc::setMode
void setMode(const uint8_t mode)
Set the operating mode of the A/C.
Definition: ir_Electra.cpp:143
kElectraAcSwingVOffset
const uint8_t kElectraAcSwingVOffset
Definition: ir_Electra.h:38
kElectraAcFan
const uint8_t kElectraAcFan
Definition: ir_Electra.h:62
IRElectraAc::remote_state
uint8_t remote_state[kElectraAcStateLength]
The state of the IR remote.
Definition: ir_Electra.h:136
kElectraAcLightToggleMask
const uint8_t kElectraAcLightToggleMask
Definition: ir_Electra.h:73
kElectraAcSwingOff
const uint8_t kElectraAcSwingOff
Definition: ir_Electra.h:36
stdAc::state_t
Structure to hold a common A/C state.
Definition: IRsend.h:97
kElectraAcFanSize
const uint8_t kElectraAcFanSize
Definition: ir_Electra.h:45
IRElectraAc::stateReset
void stateReset(void)
Reset the internal state to a fixed known good state.
Definition: ir_Electra.cpp:64
IRElectraAc::setSwingV
void setSwingV(const bool on)
Set the Vertical Swing mode of the A/C.
Definition: ir_Electra.cpp:256
kElectraAcStateLength
const uint16_t kElectraAcStateLength
Definition: IRremoteESP8266.h:896
stdAc::opmode_t
opmode_t
Common A/C settings for A/C operating modes.
Definition: IRsend.h:46
kElectraAcCleanOffset
const uint8_t kElectraAcCleanOffset
Definition: ir_Electra.h:65