IRremoteESP8266
ir_Toshiba.h
Go to the documentation of this file.
1 // Copyright 2017 David Conran
2 
11 
12 // Supports:
13 // Brand: Toshiba, Model: RAS-B13N3KV2
14 // Brand: Toshiba, Model: Akita EVO II
15 // Brand: Toshiba, Model: RAS-B13N3KVP-E
16 // Brand: Toshiba, Model: RAS 18SKP-ES
17 // Brand: Toshiba, Model: WH-TA04NE
18 // Brand: Toshiba, Model: WC-L03SE
19 // Brand: Toshiba, Model: WH-UB03NJ remote
20 // Brand: Toshiba, Model: RAS-2558V A/C
21 // Brand: Carrier, Model: 42NQV060M2 / 38NYV060M2 A/C
22 // Brand: Carrier, Model: 42NQV050M2 / 38NYV050M2 A/C
23 // Brand: Carrier, Model: 42NQV035M2 / 38NYV035M2 A/C
24 // Brand: Carrier, Model: 42NQV025M2 / 38NYV025M2 A/C
25 
26 #ifndef IR_TOSHIBA_H_
27 #define IR_TOSHIBA_H_
28 
29 #define __STDC_LIMIT_MACROS
30 #include <stdint.h>
31 #ifdef ARDUINO
32 #include <Arduino.h>
33 #endif
34 #include "IRremoteESP8266.h"
35 #include "IRsend.h"
36 #ifdef UNIT_TEST
37 #include "IRsend_test.h"
38 #endif
39 
43  struct {
44  // Byte[0] - 0xF2
45  uint8_t :8;
46  // Byte[1] - 0x0D (inverted previous byte's value)
47  uint8_t :8;
48  // Byte[2] - The expected payload length (in bytes) past the Byte[4].
53  uint8_t Length :8;
54  // Byte[3] - The bit-inverted value of the "length" byte.
55  uint8_t :8;
56  // Byte[4]
57  uint8_t :3;
58  uint8_t LongMsg :1;
59  uint8_t :1;
60  uint8_t ShortMsg:1;
61  uint8_t :2;
62  // Byte[5]
63  uint8_t Swing :3;
64  uint8_t :1;
65  uint8_t Temp :4;
66  // Byte[6]
67  uint8_t Mode :3;
68  uint8_t :2;
69  uint8_t Fan :3;
70  // Byte[7]
71  uint8_t :8;
72  // Byte[8]
73  // (Checksum for 72 bit messages, Eco/Turbo for long 80 bit messages)
74  uint8_t EcoTurbo :8;
75  };
76 };
77 
78 // Constants
79 
80 const uint8_t kToshibaAcLengthByte = 2;
81 const uint8_t kToshibaAcMinLength = 6;
82 
83 const uint16_t kToshibaAcInvertedLength = 4;
84 
86 const uint8_t kToshibaAcSwingStep = 0;
87 const uint8_t kToshibaAcSwingOn = 1;
88 const uint8_t kToshibaAcSwingOff = 2;
89 const uint8_t kToshibaAcSwingToggle = 4;
90 
91 const uint8_t kToshibaAcMinTemp = 17;
92 const uint8_t kToshibaAcMaxTemp = 30;
93 
94 const uint8_t kToshibaAcAuto = 0; // 0b000
95 const uint8_t kToshibaAcCool = 1; // 0b001
96 const uint8_t kToshibaAcDry = 2; // 0b010
97 const uint8_t kToshibaAcHeat = 3; // 0b011
98 const uint8_t kToshibaAcFan = 4; // 0b100
99 const uint8_t kToshibaAcOff = 7; // 0b111
100 const uint8_t kToshibaAcFanAuto = 0; // 0b000
101 const uint8_t kToshibaAcFanMin = 1; // 0b001
102 const uint8_t kToshibaAcFanMed = 3; // 0b011
103 const uint8_t kToshibaAcFanMax = 5; // 0b101
104 
105 const uint8_t kToshibaAcTurboOn = 1; // 0b01
106 const uint8_t kToshibaAcEconoOn = 3; // 0b11
107 
108 // Legacy defines. (Deprecated)
109 #define TOSHIBA_AC_AUTO kToshibaAcAuto
110 #define TOSHIBA_AC_COOL kToshibaAcCool
111 #define TOSHIBA_AC_DRY kToshibaAcDry
112 #define TOSHIBA_AC_HEAT kToshibaAcHeat
113 #define TOSHIBA_AC_POWER kToshibaAcPower
114 #define TOSHIBA_AC_FAN_AUTO kToshibaAcFanAuto
115 #define TOSHIBA_AC_FAN_MAX kToshibaAcFanMax
116 #define TOSHIBA_AC_MIN_TEMP kToshibaAcMinTemp
117 #define TOSHIBA_AC_MAX_TEMP kToshibaAcMaxTemp
118 
119 // Classes
121 class IRToshibaAC {
122  public:
123  explicit IRToshibaAC(const uint16_t pin, const bool inverted = false,
124  const bool use_modulation = true);
125  void stateReset(void);
126 #if SEND_TOSHIBA_AC
127  void send(const uint16_t repeat = kToshibaACMinRepeat);
132  int8_t calibrate(void) { return _irsend.calibrate(); }
133 #endif // SEND_TOSHIBA_AC
134  void begin(void);
135  void on(void);
136  void off(void);
137  void setPower(const bool on);
138  bool getPower(void) const;
139  void setTemp(const uint8_t degrees);
140  uint8_t getTemp(void) const;
141  void setFan(const uint8_t speed);
142  uint8_t getFan(void) const;
143  void setTurbo(const bool on);
144  bool getTurbo(void) const;
145  void setEcono(const bool on);
146  bool getEcono(void) const;
147  void setMode(const uint8_t mode);
148  uint8_t getMode(const bool raw = false) const;
149  void setRaw(const uint8_t newState[],
150  const uint16_t length = kToshibaACStateLength);
151  uint8_t* getRaw(void);
152  static uint16_t getInternalStateLength(const uint8_t state[],
153  const uint16_t size);
154  uint16_t getStateLength(void) const;
155  static bool validChecksum(const uint8_t state[],
156  const uint16_t length = kToshibaACStateLength);
157  uint8_t getSwing(const bool raw = true) const;
158  void setSwing(const uint8_t setting);
159  static uint8_t convertMode(const stdAc::opmode_t mode);
160  static uint8_t convertFan(const stdAc::fanspeed_t speed);
161  static stdAc::opmode_t toCommonMode(const uint8_t mode);
162  static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
163  stdAc::state_t toCommon(const stdAc::state_t *prev = NULL) const;
164  String toString(void) const;
165 #ifndef UNIT_TEST
166 
167  private:
169 #else // UNIT_TEST
170  IRsendTest _irsend;
172 #endif // UNIT_TEST
176  uint8_t _prev_mode;
177  bool _send_swing;
178  uint8_t _swing_mode;
179  void checksum(const uint16_t length = kToshibaACStateLength);
180  static uint8_t calcChecksum(const uint8_t state[],
181  const uint16_t length = kToshibaACStateLength);
182  void setStateLength(const uint16_t size);
183  void _backupState(void);
184  void _restoreState(void);
185 };
186 
187 #endif // IR_TOSHIBA_H_
IRToshibaAC::off
void off(void)
Set the requested power state of the A/C to off.
Definition: ir_Toshiba.cpp:190
IRToshibaAC::toCommonMode
static stdAc::opmode_t toCommonMode(const uint8_t mode)
Convert a native mode into its stdAc equivalent.
Definition: ir_Toshiba.cpp:373
IRToshibaAC
Class for handling detailed Toshiba A/C messages.
Definition: ir_Toshiba.h:121
IRToshibaAC::getEcono
bool getEcono(void) const
Get the Economy mode setting of the A/C.
Definition: ir_Toshiba.cpp:324
IRToshibaAC::toCommon
stdAc::state_t toCommon(const stdAc::state_t *prev=NULL) const
Convert the current internal state into its stdAc::state_t equivalent.
Definition: ir_Toshiba.cpp:400
IRToshibaAC::setSwing
void setSwing(const uint8_t setting)
Set the swing setting of the A/C.
Definition: ir_Toshiba.cpp:251
kToshibaAcCool
const uint8_t kToshibaAcCool
Definition: ir_Toshiba.h:95
IRToshibaAC::setTurbo
void setTurbo(const bool on)
Set the Turbo (Powerful) setting of the A/C.
Definition: ir_Toshiba.cpp:313
IRToshibaAC::getSwing
uint8_t getSwing(const bool raw=true) const
Get the swing setting of the A/C.
Definition: ir_Toshiba.cpp:245
IRToshibaAC::calcChecksum
static uint8_t calcChecksum(const uint8_t state[], const uint16_t length=kToshibaACStateLength)
Calculate the checksum for a given state.
Definition: ir_Toshiba.cpp:155
IRToshibaAC::_swing_mode
uint8_t _swing_mode
The saved swing state/mode/command.
Definition: ir_Toshiba.h:178
IRToshibaAC::on
void on(void)
Set the requested power state of the A/C to on.
Definition: ir_Toshiba.cpp:187
IRToshibaAC::_backupState
void _backupState(void)
Make a copy of the internal code-form A/C state.
Definition: ir_Toshiba.cpp:125
IRToshibaAC::convertMode
static uint8_t convertMode(const stdAc::opmode_t mode)
Convert a stdAc::opmode_t enum into its native mode.
Definition: ir_Toshiba.cpp:345
stdAc::fanspeed_t
fanspeed_t
Common A/C settings for Fan Speeds.
Definition: IRsend.h:58
IRToshibaAC::getInternalStateLength
static uint16_t getInternalStateLength(const uint8_t state[], const uint16_t size)
Get the length of the supplied Toshiba state per it's protocol structure.
Definition: ir_Toshiba.cpp:104
kToshibaAcFanAuto
const uint8_t kToshibaAcFanAuto
Definition: ir_Toshiba.h:100
IRToshibaAC::send
void send(const uint16_t repeat=kToshibaACMinRepeat)
Send the current internal state as IR messages.
Definition: ir_Toshiba.cpp:84
IRToshibaAC::setRaw
void setRaw(const uint8_t newState[], const uint16_t length=kToshibaACStateLength)
Set the internal state from a valid code for this protocol.
Definition: ir_Toshiba.cpp:145
IRToshibaAC::setEcono
void setEcono(const bool on)
Set the Economy mode setting of the A/C.
Definition: ir_Toshiba.cpp:333
kToshibaAcInvertedLength
const uint16_t kToshibaAcInvertedLength
Nr. of leading bytes in inverted pairs.
Definition: ir_Toshiba.h:83
IRToshibaAC::setFan
void setFan(const uint8_t speed)
Set the speed of the fan.
Definition: ir_Toshiba.cpp:225
kToshibaAcMinTemp
const uint8_t kToshibaAcMinTemp
17C
Definition: ir_Toshiba.h:91
IRToshibaAC::_irsend
IRsend _irsend
Instance of the IR send class.
Definition: ir_Toshiba.h:168
IRToshibaAC::calibrate
int8_t calibrate(void)
Run the calibration to calculate uSec timing offsets for this platform.
Definition: ir_Toshiba.h:132
IRsend.h
IRToshibaAC::getRaw
uint8_t * getRaw(void)
Get a PTR to the internal state/code for this protocol with all integrity checks passing.
Definition: ir_Toshiba.cpp:137
IRToshibaAC::checksum
void checksum(const uint16_t length=kToshibaACStateLength)
Calculate & set the checksum for the current internal state of the remote.
Definition: ir_Toshiba.cpp:173
ToshibaProtocol::raw
uint8_t raw[kToshibaACStateLengthLong]
The state in code form.
Definition: ir_Toshiba.h:42
ToshibaProtocol::EcoTurbo
uint8_t EcoTurbo
Definition: ir_Toshiba.h:74
IRsend
Class for sending all basic IR protocols.
Definition: IRsend.h:187
IRsend::calibrate
int8_t calibrate(uint16_t hz=38000U)
Calculate & set any offsets to account for execution times during sending.
Definition: IRsend.cpp:207
kToshibaAcSwingOn
const uint8_t kToshibaAcSwingOn
0b001
Definition: ir_Toshiba.h:87
IRToshibaAC::setPower
void setPower(const bool on)
Change the power setting.
Definition: ir_Toshiba.cpp:194
String
std::string String
Definition: IRremoteESP8266.h:1208
IRToshibaAC::IRToshibaAC
IRToshibaAC(const uint16_t pin, const bool inverted=false, const bool use_modulation=true)
Class constructor.
Definition: ir_Toshiba.cpp:63
ToshibaProtocol::Fan
uint8_t Fan
Definition: ir_Toshiba.h:69
IRToshibaAC::getStateLength
uint16_t getStateLength(void) const
Get the length of the current internal state per the protocol structure.
Definition: ir_Toshiba.cpp:113
IRToshibaAC::toString
String toString(void) const
Convert the current internal state into a human readable string.
Definition: ir_Toshiba.cpp:451
ToshibaProtocol::LongMsg
uint8_t LongMsg
Definition: ir_Toshiba.h:58
kToshibaAcSwingOff
const uint8_t kToshibaAcSwingOff
0b010
Definition: ir_Toshiba.h:88
IRToshibaAC::getPower
bool getPower(void) const
Get the value of the current power setting.
Definition: ir_Toshiba.cpp:205
kToshibaAcFanMed
const uint8_t kToshibaAcFanMed
Definition: ir_Toshiba.h:102
IRremoteESP8266.h
IRToshibaAC::begin
void begin(void)
Set up hardware to be able to send a message.
Definition: ir_Toshiba.cpp:79
kToshibaAcMinLength
const uint8_t kToshibaAcMinLength
Min Nr. of bytes in a message.
Definition: ir_Toshiba.h:81
kToshibaAcSwingStep
const uint8_t kToshibaAcSwingStep
0b000
Definition: ir_Toshiba.h:86
IRToshibaAC::stateReset
void stateReset(void)
Reset the state of the remote to a known good state/sequence.
Definition: ir_Toshiba.cpp:69
IRToshibaAC::_restoreState
void _restoreState(void)
Recover the internal code-form A/C state from the backup.
Definition: ir_Toshiba.cpp:130
IRToshibaAC::getTemp
uint8_t getTemp(void) const
Get the current temperature setting.
Definition: ir_Toshiba.cpp:219
kToshibaAcFan
const uint8_t kToshibaAcFan
Definition: ir_Toshiba.h:98
IRToshibaAC::toCommonFanSpeed
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed)
Convert a native fan speed into its stdAc equivalent.
Definition: ir_Toshiba.cpp:387
kToshibaAcHeat
const uint8_t kToshibaAcHeat
Definition: ir_Toshiba.h:97
IRToshibaAC::setMode
void setMode(const uint8_t mode)
Set the operating mode of the A/C.
Definition: ir_Toshiba.cpp:280
ToshibaProtocol::Length
uint8_t Length
< Known lengths are: 1 (56 bit message) 3 (72 bit message) 4 (80 bit message)
Definition: ir_Toshiba.h:53
kToshibaAcTurboOn
const uint8_t kToshibaAcTurboOn
Definition: ir_Toshiba.h:105
ToshibaProtocol
Native representation of a Toshiba A/C message.
Definition: ir_Toshiba.h:41
ToshibaProtocol::Swing
uint8_t Swing
Definition: ir_Toshiba.h:63
kToshibaAcLengthByte
const uint8_t kToshibaAcLengthByte
Byte pos of the "length" attribute.
Definition: ir_Toshiba.h:80
IRToshibaAC::getMode
uint8_t getMode(const bool raw=false) const
Get the operating mode setting of the A/C.
Definition: ir_Toshiba.cpp:267
ToshibaProtocol::Mode
uint8_t Mode
Definition: ir_Toshiba.h:67
kToshibaACMinRepeat
const uint16_t kToshibaACMinRepeat
Definition: IRremoteESP8266.h:1104
kToshibaACStateLength
const uint16_t kToshibaACStateLength
Definition: IRremoteESP8266.h:1102
IRToshibaAC::_send_swing
bool _send_swing
Flag indicating if we need to send a swing message.
Definition: ir_Toshiba.h:177
kToshibaAcSwingToggle
const uint8_t kToshibaAcSwingToggle
0b100
Definition: ir_Toshiba.h:89
kToshibaACStateLengthLong
const uint16_t kToshibaACStateLengthLong
Definition: IRremoteESP8266.h:1107
IRToshibaAC::validChecksum
static bool validChecksum(const uint8_t state[], const uint16_t length=kToshibaACStateLength)
Verify the checksum is valid for a given state.
Definition: ir_Toshiba.cpp:164
kToshibaAcDry
const uint8_t kToshibaAcDry
Definition: ir_Toshiba.h:96
IRToshibaAC::getFan
uint8_t getFan(void) const
Get the current fan speed setting.
Definition: ir_Toshiba.cpp:236
IRToshibaAC::backup
uint8_t backup[kToshibaACStateLengthLong]
A backup copy of the state.
Definition: ir_Toshiba.h:175
ToshibaProtocol::ShortMsg
uint8_t ShortMsg
Definition: ir_Toshiba.h:60
IRToshibaAC::getTurbo
bool getTurbo(void) const
Get the Turbo (Powerful) setting of the A/C.
Definition: ir_Toshiba.cpp:304
kToshibaAcAuto
const uint8_t kToshibaAcAuto
Definition: ir_Toshiba.h:94
kToshibaAcMaxTemp
const uint8_t kToshibaAcMaxTemp
30C
Definition: ir_Toshiba.h:92
IRToshibaAC::convertFan
static uint8_t convertFan(const stdAc::fanspeed_t speed)
Convert a stdAc::fanspeed_t enum into it's native speed.
Definition: ir_Toshiba.cpp:359
IRToshibaAC::setTemp
void setTemp(const uint8_t degrees)
Set the temperature.
Definition: ir_Toshiba.cpp:211
ToshibaProtocol::Temp
uint8_t Temp
Definition: ir_Toshiba.h:65
IRToshibaAC::_prev_mode
uint8_t _prev_mode
Store of the previously set mode.
Definition: ir_Toshiba.h:176
stdAc::state_t
Structure to hold a common A/C state.
Definition: IRsend.h:97
kToshibaAcFanMax
const uint8_t kToshibaAcFanMax
Definition: ir_Toshiba.h:103
kToshibaAcEconoOn
const uint8_t kToshibaAcEconoOn
Definition: ir_Toshiba.h:106
IRToshibaAC::_
ToshibaProtocol _
Definition: ir_Toshiba.h:174
kToshibaAcFanMin
const uint8_t kToshibaAcFanMin
Definition: ir_Toshiba.h:101
IRToshibaAC::setStateLength
void setStateLength(const uint16_t size)
Set the internal length of the current internal state per the protocol.
Definition: ir_Toshiba.cpp:119
kToshibaAcOff
const uint8_t kToshibaAcOff
Definition: ir_Toshiba.h:99
stdAc::opmode_t
opmode_t
Common A/C settings for A/C operating modes.
Definition: IRsend.h:46