IRremoteESP8266
ir_Amcor.h
Go to the documentation of this file.
1 // Copyright 2019 David Conran
2 
7 // Supports:
8 // Brand: Amcor, Model: ADR-853H A/C
9 // Brand: Amcor, Model: TAC-495 remote
10 // Brand: Amcor, Model: TAC-444 remote
11 
12 #ifndef IR_AMCOR_H_
13 #define IR_AMCOR_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 
27 // Constants
28 
29 // state[1]
30 const uint8_t kAmcorModeFanByte = 1;
31 // Fan Control
32 const uint8_t kAmcorFanMin = 0b001;
33 const uint8_t kAmcorFanMed = 0b010;
34 const uint8_t kAmcorFanMax = 0b011;
35 const uint8_t kAmcorFanAuto = 0b100;
36 const uint8_t kAmcorFanOffset = 4;
37 const uint8_t kAmcorFanSize = 3;
38 // Modes
39 const uint8_t kAmcorCool = 0b001;
40 const uint8_t kAmcorHeat = 0b010;
41 const uint8_t kAmcorFan = 0b011; // Aka "Vent"
42 const uint8_t kAmcorDry = 0b100;
43 const uint8_t kAmcorAuto = 0b101;
44 const uint8_t kAmcorModeOffset = 0;
45 const uint8_t kAmcorModeSize = 3;
46 
47 // state[2]
48 const uint8_t kAmcorTempByte = 2;
49 // Temperature
50 const uint8_t kAmcorMinTemp = 12; // Celsius
51 const uint8_t kAmcorMaxTemp = 32; // Celsius
52 const uint8_t kAmcorTempOffset = 1;
53 const uint8_t kAmcorTempSize = 6; // Bits
54 
55 // state[5]
56 // Power
57 const uint8_t kAmcorPowerByte = 5;
58 const uint8_t kAmcorPowerOffset = 4;
59 const uint8_t kAmcorPowerSize = 4;
60 const uint8_t kAmcorPowerOn = 0b0011; // 0x3
61 const uint8_t kAmcorPowerOff = 0b1100; // 0xC
62 
63 // state[6]
64 const uint8_t kAmcorSpecialByte = 6;
65 // Max Mode (aka "Lo" in Cool and "Hi" in Heat)
66 const uint8_t kAmcorMax = 0b11;
67 const uint8_t kAmcorMaxOffset = 0;
68 const uint8_t kAmcorMaxSize = 2;
69 
70 // "Vent" Mode
71 const uint8_t kAmcorVentOn = 0b11;
72 const uint8_t kAmcorVentOffset = 6;
73 const uint8_t kAmcorVentSize = 2;
74 // state[7]
75 // Checksum byte.
77 
78 // Classes
79 
81 class IRAmcorAc {
82  public:
83  explicit IRAmcorAc(const uint16_t pin, const bool inverted = false,
84  const bool use_modulation = true);
85 
86  void stateReset();
87 #if SEND_AMCOR
88  void send(const uint16_t repeat = kAmcorDefaultRepeat);
93  int8_t calibrate(void) { return _irsend.calibrate(); }
94 #endif // SEND_AMCOR
95  void begin();
96  static uint8_t calcChecksum(const uint8_t state[],
97  const uint16_t length = kAmcorStateLength);
98  static bool validChecksum(const uint8_t state[],
99  const uint16_t length = kAmcorStateLength);
100  void setPower(const bool state);
101  bool getPower();
102  void on();
103  void off();
104  void setTemp(const uint8_t temp);
105  uint8_t getTemp();
106  void setMax(const bool on);
107  bool getMax(void);
108  void setFan(const uint8_t speed);
109  uint8_t getFan();
110  void setMode(const uint8_t mode);
111  uint8_t getMode();
112  uint8_t* getRaw();
113  void setRaw(const uint8_t state[]);
114  uint8_t convertMode(const stdAc::opmode_t mode);
115  uint8_t convertFan(const stdAc::fanspeed_t speed);
116  static stdAc::opmode_t toCommonMode(const uint8_t mode);
117  static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
118  stdAc::state_t toCommon(void);
119  String toString();
120 #ifndef UNIT_TEST
121 
122  private:
124 #else
125  IRsendTest _irsend;
128 #endif
129  uint8_t remote_state[kAmcorStateLength]; // The state of the IR remote.
130  void checksum(void);
131 };
132 #endif // IR_AMCOR_H_
IRAmcorAc::IRAmcorAc
IRAmcorAc(const uint16_t pin, const bool inverted=false, const bool use_modulation=true)
Class constructor.
Definition: ir_Amcor.cpp:96
kAmcorSpecialByte
const uint8_t kAmcorSpecialByte
Definition: ir_Amcor.h:64
IRAmcorAc::setMode
void setMode(const uint8_t mode)
Set the desired operation mode.
Definition: ir_Amcor.cpp:247
IRAmcorAc::send
void send(const uint16_t repeat=kAmcorDefaultRepeat)
Send the current internal state as an IR message.
Definition: ir_Amcor.cpp:106
kAmcorCool
const uint8_t kAmcorCool
Definition: ir_Amcor.h:39
kAmcorStateLength
const uint16_t kAmcorStateLength
Definition: IRremoteESP8266.h:843
stdAc::fanspeed_t
fanspeed_t
Common A/C settings for Fan Speeds.
Definition: IRsend.h:58
IRAmcorAc::toCommonMode
static stdAc::opmode_t toCommonMode(const uint8_t mode)
Convert a native mode into its stdAc equivilant.
Definition: ir_Amcor.cpp:303
kAmcorPowerOn
const uint8_t kAmcorPowerOn
Definition: ir_Amcor.h:60
IRAmcorAc::calcChecksum
static uint8_t calcChecksum(const uint8_t state[], const uint16_t length=kAmcorStateLength)
Calculate the checksum for the supplied state.
Definition: ir_Amcor.cpp:115
kAmcorMax
const uint8_t kAmcorMax
Definition: ir_Amcor.h:66
IRAmcorAc::_irsend
IRsend _irsend
Definition: ir_Amcor.h:123
IRAmcorAc::convertFan
uint8_t convertFan(const stdAc::fanspeed_t speed)
Convert a stdAc::fanspeed_t enum into it's native speed.
Definition: ir_Amcor.cpp:285
kAmcorHeat
const uint8_t kAmcorHeat
Definition: ir_Amcor.h:40
IRAmcorAc::begin
void begin()
Set up hardware to be able to send a message.
Definition: ir_Amcor.cpp:101
IRAmcorAc::getFan
uint8_t getFan()
Get the current fan speed setting.
Definition: ir_Amcor.cpp:233
IRsend.h
kAmcorMaxOffset
const uint8_t kAmcorMaxOffset
Definition: ir_Amcor.h:67
kAmcorFanAuto
const uint8_t kAmcorFanAuto
Definition: ir_Amcor.h:35
IRAmcorAc::getRaw
uint8_t * getRaw()
Get the raw state of the object, suitable to be sent with the appropriate IRsend object method.
Definition: ir_Amcor.cpp:145
kAmcorVentSize
const uint8_t kAmcorVentSize
Definition: ir_Amcor.h:73
IRAmcorAc::getMode
uint8_t getMode()
Get the current operation mode setting.
Definition: ir_Amcor.cpp:240
IRsend
Class for sending all basic IR protocols.
Definition: IRsend.h:176
IRAmcorAc::setFan
void setFan(const uint8_t speed)
Set the speed of the fan.
Definition: ir_Amcor.cpp:217
IRsend::calibrate
int8_t calibrate(uint16_t hz=38000U)
Calculate & set any offsets to account for execution times during sending.
Definition: IRsend.cpp:207
kAmcorTempByte
const uint8_t kAmcorTempByte
Definition: ir_Amcor.h:48
IRAmcorAc::on
void on()
Set the internal state to have the power on.
Definition: ir_Amcor.cpp:157
String
std::string String
Definition: IRremoteESP8266.h:1128
kAmcorPowerSize
const uint8_t kAmcorPowerSize
Definition: ir_Amcor.h:59
IRAmcorAc
Class for handling detailed Amcor A/C messages.
Definition: ir_Amcor.h:81
kAmcorMinTemp
const uint8_t kAmcorMinTemp
Definition: ir_Amcor.h:50
IRAmcorAc::setMax
void setMax(const bool on)
Control the current Maximum Cooling or Heating setting. (i.e. Turbo)
Definition: ir_Amcor.cpp:195
kAmcorMaxSize
const uint8_t kAmcorMaxSize
Definition: ir_Amcor.h:68
kAmcorChecksumByte
const uint8_t kAmcorChecksumByte
Definition: ir_Amcor.h:76
IRAmcorAc::stateReset
void stateReset()
Reset the internals of the object to a known good state.
Definition: ir_Amcor.cpp:134
kAmcorFan
const uint8_t kAmcorFan
Definition: ir_Amcor.h:41
IRAmcorAc::setRaw
void setRaw(const uint8_t state[])
Set the raw state of the object.
Definition: ir_Amcor.cpp:152
kAmcorVentOn
const uint8_t kAmcorVentOn
Definition: ir_Amcor.h:71
kAmcorFanMin
const uint8_t kAmcorFanMin
Definition: ir_Amcor.h:32
IRremoteESP8266.h
IRAmcorAc::convertMode
uint8_t convertMode(const stdAc::opmode_t mode)
Convert a stdAc::opmode_t enum into its native mode.
Definition: ir_Amcor.cpp:267
kAmcorVentOffset
const uint8_t kAmcorVentOffset
Definition: ir_Amcor.h:72
kAmcorDry
const uint8_t kAmcorDry
Definition: ir_Amcor.h:42
kAmcorFanMed
const uint8_t kAmcorFanMed
Definition: ir_Amcor.h:33
IRAmcorAc::remote_state
uint8_t remote_state[kAmcorStateLength]
Definition: ir_Amcor.h:129
IRAmcorAc::setTemp
void setTemp(const uint8_t temp)
Set the temperature.
Definition: ir_Amcor.cpp:178
kAmcorPowerByte
const uint8_t kAmcorPowerByte
Definition: ir_Amcor.h:57
kAmcorTempSize
const uint8_t kAmcorTempSize
Definition: ir_Amcor.h:53
IRAmcorAc::off
void off()
Set the internal state to have the power off.
Definition: ir_Amcor.cpp:160
IRAmcorAc::setPower
void setPower(const bool state)
Set the internal state to have the desired power.
Definition: ir_Amcor.cpp:164
IRAmcorAc::getTemp
uint8_t getTemp()
Get the current temperature setting.
Definition: ir_Amcor.cpp:187
IRAmcorAc::calibrate
int8_t calibrate(void)
Run the calibration to calculate uSec timing offsets for this platform.
Definition: ir_Amcor.h:93
IRAmcorAc::getPower
bool getPower()
Get the power setting from the internal state.
Definition: ir_Amcor.cpp:171
kAmcorPowerOff
const uint8_t kAmcorPowerOff
Definition: ir_Amcor.h:61
kAmcorModeSize
const uint8_t kAmcorModeSize
Definition: ir_Amcor.h:45
IRAmcorAc::checksum
void checksum(void)
Update the checksum value for the internal state.
Definition: ir_Amcor.cpp:128
kAmcorFanSize
const uint8_t kAmcorFanSize
Definition: ir_Amcor.h:37
kAmcorModeOffset
const uint8_t kAmcorModeOffset
Definition: ir_Amcor.h:44
IRAmcorAc::validChecksum
static bool validChecksum(const uint8_t state[], const uint16_t length=kAmcorStateLength)
Verify the checksum is valid for a given state.
Definition: ir_Amcor.cpp:123
kAmcorPowerOffset
const uint8_t kAmcorPowerOffset
Definition: ir_Amcor.h:58
kAmcorAuto
const uint8_t kAmcorAuto
Definition: ir_Amcor.h:43
kAmcorModeFanByte
const uint8_t kAmcorModeFanByte
Definition: ir_Amcor.h:30
kAmcorMaxTemp
const uint8_t kAmcorMaxTemp
Definition: ir_Amcor.h:51
kAmcorDefaultRepeat
const uint16_t kAmcorDefaultRepeat
Definition: IRremoteESP8266.h:845
kAmcorFanOffset
const uint8_t kAmcorFanOffset
Definition: ir_Amcor.h:36
IRAmcorAc::toCommon
stdAc::state_t toCommon(void)
Convert the current internal state into its stdAc::state_t equivilant.
Definition: ir_Amcor.cpp:327
kAmcorFanMax
const uint8_t kAmcorFanMax
Definition: ir_Amcor.h:34
stdAc::state_t
Structure to hold a common A/C state.
Definition: IRsend.h:97
IRAmcorAc::toString
String toString()
Convert the current internal state into a human readable string.
Definition: ir_Amcor.cpp:353
IRAmcorAc::getMax
bool getMax(void)
Is the Maximum Cooling or Heating setting (i.e. Turbo) setting on?
Definition: ir_Amcor.cpp:210
IRAmcorAc::toCommonFanSpeed
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed)
Convert a native fan speed into its stdAc equivilant.
Definition: ir_Amcor.cpp:316
kAmcorTempOffset
const uint8_t kAmcorTempOffset
Definition: ir_Amcor.h:52
stdAc::opmode_t
opmode_t
Common A/C settings for A/C operating modes.
Definition: IRsend.h:46