IRremoteESP8266
ir_Fujitsu.h
Go to the documentation of this file.
1 // Copyright 2017 Jonny Graham
2 // Copyright 2018-2019 David Conran
3 
7 
8 // Supports:
9 // Brand: Fujitsu, Model: AR-RAH2E remote
10 // Brand: Fujitsu, Model: ASYG30LFCA A/C (ARRAH2E)
11 // Brand: Fujitsu, Model: AR-DB1 remote
12 // Brand: Fujitsu, Model: AST9RSGCW A/C (ARDB1)
13 // Brand: Fujitsu, Model: AR-REB1E remote
14 // Brand: Fujitsu, Model: ASYG7LMCA A/C (ARREB1E)
15 // Brand: Fujitsu, Model: AR-RAE1E remote
16 // Brand: Fujitsu, Model: AGTV14LAC A/C
17 // Brand: Fujitsu, Model: AR-RAC1E remote
18 // Brand: Fujitsu, Model: ASTB09LBC A/C
19 // Brand: Fujitsu, Model: AR-RY4 remote
20 // Brand: Fujitsu General, Model: AR-JW2 remote
21 // Brand: Fujitsu, Model: AR-DL10 remote
22 // Brand: Fujitsu, Model: ASU30C1 A/C
23 
24 #ifndef IR_FUJITSU_H_
25 #define IR_FUJITSU_H_
26 
27 #define __STDC_LIMIT_MACROS
28 #include <stdint.h>
29 #ifdef ARDUINO
30 #include <Arduino.h>
31 #endif
32 #include "IRrecv.h"
33 #include "IRremoteESP8266.h"
34 #include "IRsend.h"
35 #ifdef UNIT_TEST
36 #include "IRsend_test.h"
37 #endif
38 
39 
40 // Constants
41 const uint8_t kFujitsuAcModeAuto = 0x00;
42 const uint8_t kFujitsuAcModeCool = 0x01;
43 const uint8_t kFujitsuAcModeDry = 0x02;
44 const uint8_t kFujitsuAcModeFan = 0x03;
45 const uint8_t kFujitsuAcModeHeat = 0x04;
46 
47 const uint8_t kFujitsuAcCmdStayOn = 0x00; // b00000000
48 const uint8_t kFujitsuAcCmdTurnOn = 0x01; // b00000001
49 const uint8_t kFujitsuAcCmdTurnOff = 0x02; // b00000010
50 const uint8_t kFujitsuAcCmdEcono = 0x09; // b00001001
51 const uint8_t kFujitsuAcCmdPowerful = 0x39; // b00111001
52 const uint8_t kFujitsuAcCmdStepVert = 0x6C; // b01101100
53 const uint8_t kFujitsuAcCmdToggleSwingVert = 0x6D; // b01101101
54 const uint8_t kFujitsuAcCmdStepHoriz = 0x79; // b01111001
55 const uint8_t kFujitsuAcCmdToggleSwingHoriz = 0x7A; // b01111010
56 
57 const uint8_t kFujitsuAcFanAuto = 0x00;
58 const uint8_t kFujitsuAcFanHigh = 0x01;
59 const uint8_t kFujitsuAcFanMed = 0x02;
60 const uint8_t kFujitsuAcFanLow = 0x03;
61 const uint8_t kFujitsuAcFanQuiet = 0x04;
62 const uint8_t kFujitsuAcFanSize = 3; // Bits
63 
64 const uint8_t kFujitsuAcMinTemp = 16; // 16C
65 const uint8_t kFujitsuAcMaxTemp = 30; // 30C
66 
67 const uint8_t kFujitsuAcSwingSize = 2;
68 const uint8_t kFujitsuAcSwingOff = 0x00;
69 const uint8_t kFujitsuAcSwingVert = 0x01;
70 const uint8_t kFujitsuAcSwingHoriz = 0x02;
71 const uint8_t kFujitsuAcSwingBoth = 0x03;
72 
73 const uint8_t kFujitsuAcOutsideQuietOffset = 7;
74 const uint8_t kFujitsuAcCleanOffset = 3;
75 const uint8_t kFujitsuAcFilterOffset = 3;
76 
77 // Legacy defines.
78 #define FUJITSU_AC_MODE_AUTO kFujitsuAcModeAuto
79 #define FUJITSU_AC_MODE_COOL kFujitsuAcModeCool
80 #define FUJITSU_AC_MODE_DRY kFujitsuAcModeDry
81 #define FUJITSU_AC_MODE_FAN kFujitsuAcModeFan
82 #define FUJITSU_AC_MODE_HEAT kFujitsuAcModeHeat
83 #define FUJITSU_AC_CMD_STAY_ON kFujitsuAcCmdStayOn
84 #define FUJITSU_AC_CMD_TURN_ON kFujitsuAcCmdTurnOn
85 #define FUJITSU_AC_CMD_TURN_OFF kFujitsuAcCmdTurnOff
86 #define FUJITSU_AC_CMD_STEP_HORIZ kFujitsuAcCmdStepHoriz
87 #define FUJITSU_AC_CMD_STEP_VERT kFujitsuAcCmdStepVert
88 #define FUJITSU_AC_FAN_AUTO kFujitsuAcFanAuto
89 #define FUJITSU_AC_FAN_HIGH kFujitsuAcFanHigh
90 #define FUJITSU_AC_FAN_MED kFujitsuAcFanMed
91 #define FUJITSU_AC_FAN_LOW kFujitsuAcFanLow
92 #define FUJITSU_AC_FAN_QUIET kFujitsuAcFanQuiet
93 #define FUJITSU_AC_MIN_TEMP kFujitsuAcMinTemp
94 #define FUJITSU_AC_MAX_TEMP kFujitsuAcMaxTemp
95 #define FUJITSU_AC_SWING_OFF kFujitsuAcSwingOff
96 #define FUJITSU_AC_SWING_VERT kFujitsuAcSwingVert
97 #define FUJITSU_AC_SWING_HORIZ kFujitsuAcSwingHoriz
98 #define FUJITSU_AC_SWING_BOTH kFujitsuAcSwingBoth
99 
101 class IRFujitsuAC {
102  public:
103  explicit IRFujitsuAC(const uint16_t pin,
104  const fujitsu_ac_remote_model_t model = ARRAH2E,
105  const bool inverted = false,
106  const bool use_modulation = true);
107  void setModel(const fujitsu_ac_remote_model_t model);
109  void stateReset(void);
110 #if SEND_FUJITSU_AC
111  void send(const uint16_t repeat = kFujitsuAcMinRepeat);
116  int8_t calibrate(void) { return _irsend.calibrate(); }
117 #endif // SEND_FUJITSU_AC
118  void begin(void);
119  void stepHoriz(void);
120  void toggleSwingHoriz(const bool update = true);
121  void stepVert(void);
122  void toggleSwingVert(const bool update = true);
123  void setCmd(const uint8_t cmd);
124  uint8_t getCmd(const bool raw = false);
125  void setTemp(const uint8_t temp);
126  uint8_t getTemp(void);
127  void setFanSpeed(const uint8_t fan);
128  uint8_t getFanSpeed(void);
129  void setMode(const uint8_t mode);
130  uint8_t getMode(void);
131  void setSwing(const uint8_t mode);
132  uint8_t getSwing(const bool raw = false);
133  uint8_t* getRaw(void);
134  bool setRaw(const uint8_t newState[], const uint16_t length);
135  uint8_t getStateLength(void);
136  static bool validChecksum(uint8_t* state, const uint16_t length);
137  void setPower(const bool on);
138  void off(void);
139  void on(void);
140  bool getPower(void);
141  void setClean(const bool on);
142  bool getClean(const bool raw = false);
143  void setFilter(const bool on);
144  bool getFilter(const bool raw = false);
145  void setOutsideQuiet(const bool on);
146 
147  bool getOutsideQuiet(const bool raw = false);
148 
149  uint8_t convertMode(const stdAc::opmode_t mode);
150  uint8_t convertFan(stdAc::fanspeed_t speed);
151  static stdAc::opmode_t toCommonMode(const uint8_t mode);
152  static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
153  stdAc::state_t toCommon(void);
154  String toString(void);
155 #ifndef UNIT_TEST
156 
157  private:
159 #else
160  IRsendTest _irsend;
162 #endif
165  uint8_t _temp;
166  uint8_t _fanSpeed;
167  uint8_t _mode;
168  uint8_t _swingMode;
169  uint8_t _cmd;
171  uint8_t _state_length;
174  bool _clean;
175  bool _filter;
176  void buildState(void);
177  void buildFromState(const uint16_t length);
178 };
179 
180 #endif // IR_FUJITSU_H_
IRFujitsuAC::_clean
bool _clean
Definition: ir_Fujitsu.h:174
kFujitsuAcCmdTurnOff
const uint8_t kFujitsuAcCmdTurnOff
Definition: ir_Fujitsu.h:49
kFujitsuAcMinRepeat
const uint16_t kFujitsuAcMinRepeat
Definition: IRremoteESP8266.h:899
IRFujitsuAC::_cmd
uint8_t _cmd
Definition: ir_Fujitsu.h:169
stdAc::fanspeed_t
fanspeed_t
Common A/C settings for Fan Speeds.
Definition: IRsend.h:58
kFujitsuAcFilterOffset
const uint8_t kFujitsuAcFilterOffset
Definition: ir_Fujitsu.h:75
IRFujitsuAC::calibrate
int8_t calibrate(void)
Run the calibration to calculate uSec timing offsets for this platform.
Definition: ir_Fujitsu.h:116
IRFujitsuAC::setClean
void setClean(const bool on)
Set the Clean mode of the A/C.
Definition: ir_Fujitsu.cpp:491
kFujitsuAcCmdToggleSwingVert
const uint8_t kFujitsuAcCmdToggleSwingVert
Definition: ir_Fujitsu.h:53
IRFujitsuAC::_fanSpeed
uint8_t _fanSpeed
Definition: ir_Fujitsu.h:166
IRFujitsuAC::getRaw
uint8_t * getRaw(void)
Get a PTR to the internal state/code for this protocol.
Definition: ir_Fujitsu.cpp:229
IRFujitsuAC::_filter
bool _filter
Definition: ir_Fujitsu.h:175
IRsend.h
IRFujitsuAC::stepVert
void stepVert(void)
Request the A/C to step the Vertical Swing.
Definition: ir_Fujitsu.cpp:323
IRFujitsuAC::_outsideQuiet
bool _outsideQuiet
Definition: ir_Fujitsu.h:173
IRFujitsuAC::setTemp
void setTemp(const uint8_t temp)
Set the temperature.
Definition: ir_Fujitsu.cpp:418
IRsend
Class for sending all basic IR protocols.
Definition: IRsend.h:176
IRFujitsuAC::convertMode
uint8_t convertMode(const stdAc::opmode_t mode)
Convert a stdAc::opmode_t enum into its native mode.
Definition: ir_Fujitsu.cpp:559
IRFujitsuAC::stateReset
void stateReset(void)
Reset the state of the remote to a known good state/sequence.
Definition: ir_Fujitsu.cpp:95
kFujitsuAcCleanOffset
const uint8_t kFujitsuAcCleanOffset
Definition: ir_Fujitsu.h:74
IRsend::calibrate
int8_t calibrate(uint16_t hz=38000U)
Calculate & set any offsets to account for execution times during sending.
Definition: IRsend.cpp:207
kFujitsuAcFanAuto
const uint8_t kFujitsuAcFanAuto
Definition: ir_Fujitsu.h:57
IRFujitsuAC::setRaw
bool setRaw(const uint8_t newState[], const uint16_t length)
Set the internal state from a valid code for this protocol.
Definition: ir_Fujitsu.cpp:298
String
std::string String
Definition: IRremoteESP8266.h:1128
kFujitsuAcOutsideQuietOffset
const uint8_t kFujitsuAcOutsideQuietOffset
Definition: ir_Fujitsu.h:73
kFujitsuAcCmdTurnOn
const uint8_t kFujitsuAcCmdTurnOn
Definition: ir_Fujitsu.h:48
IRFujitsuAC::_state_length_short
uint8_t _state_length_short
Definition: ir_Fujitsu.h:172
kFujitsuAcMinTemp
const uint8_t kFujitsuAcMinTemp
Definition: ir_Fujitsu.h:64
kFujitsuAcFanHigh
const uint8_t kFujitsuAcFanHigh
Definition: ir_Fujitsu.h:58
kFujitsuAcModeHeat
const uint8_t kFujitsuAcModeHeat
Definition: ir_Fujitsu.h:45
IRFujitsuAC::setFilter
void setFilter(const bool on)
Set the Filter mode status of the A/C.
Definition: ir_Fujitsu.cpp:512
IRFujitsuAC::convertFan
uint8_t convertFan(stdAc::fanspeed_t speed)
Convert a stdAc::fanspeed_t enum into it's native speed.
Definition: ir_Fujitsu.cpp:572
IRremoteESP8266.h
IRFujitsuAC::stepHoriz
void stepHoriz(void)
Request the A/C to step the Horizontal Swing.
Definition: ir_Fujitsu.cpp:311
IRFujitsuAC::getModel
fujitsu_ac_remote_model_t getModel(void)
Get the currently emulated/detected model of the A/C.
Definition: ir_Fujitsu.cpp:92
kFujitsuAcCmdToggleSwingHoriz
const uint8_t kFujitsuAcCmdToggleSwingHoriz
Definition: ir_Fujitsu.h:55
IRFujitsuAC::_irsend
IRsend _irsend
Instance of the IR send class.
Definition: ir_Fujitsu.h:158
fujitsu_ac_remote_model_t
fujitsu_ac_remote_model_t
Fujitsu A/C model numbers.
Definition: IRsend.h:120
IRFujitsuAC::setCmd
void setCmd(const uint8_t cmd)
Set the requested (special) command part for the A/C message.
Definition: ir_Fujitsu.cpp:336
IRFujitsuAC::buildFromState
void buildFromState(const uint16_t length)
Build the internal state/config from the current (raw) A/C message.
Definition: ir_Fujitsu.cpp:236
IRFujitsuAC::_temp
uint8_t _temp
Definition: ir_Fujitsu.h:165
IRFujitsuAC::_swingMode
uint8_t _swingMode
Definition: ir_Fujitsu.h:168
IRFujitsuAC::begin
void begin(void)
Set up hardware to be able to send a message.
Definition: ir_Fujitsu.cpp:107
IRFujitsuAC
Class for handling detailed Fujitsu A/C messages.
Definition: ir_Fujitsu.h:101
kFujitsuAcCmdStepVert
const uint8_t kFujitsuAcCmdStepVert
Definition: ir_Fujitsu.h:52
IRFujitsuAC::setSwing
void setSwing(const uint8_t mode)
Set the requested swing operation mode of the A/C unit.
Definition: ir_Fujitsu.cpp:460
kFujitsuAcStateLength
const uint16_t kFujitsuAcStateLength
Definition: IRremoteESP8266.h:900
kFujitsuAcCmdPowerful
const uint8_t kFujitsuAcCmdPowerful
Definition: ir_Fujitsu.h:51
IRFujitsuAC::toCommonMode
static stdAc::opmode_t toCommonMode(const uint8_t mode)
Convert a native mode into its stdAc equivilant.
Definition: ir_Fujitsu.cpp:586
kFujitsuAcSwingSize
const uint8_t kFujitsuAcSwingSize
Definition: ir_Fujitsu.h:67
IRFujitsuAC::_mode
uint8_t _mode
Definition: ir_Fujitsu.h:167
IRFujitsuAC::toCommon
stdAc::state_t toCommon(void)
Convert the current internal state into its stdAc::state_t equivilant.
Definition: ir_Fujitsu.cpp:611
kFujitsuAcCmdStepHoriz
const uint8_t kFujitsuAcCmdStepHoriz
Definition: ir_Fujitsu.h:54
IRFujitsuAC::setMode
void setMode(const uint8_t mode)
Set the operating mode of the A/C.
Definition: ir_Fujitsu.cpp:444
kFujitsuAcSwingHoriz
const uint8_t kFujitsuAcSwingHoriz
Definition: ir_Fujitsu.h:70
kFujitsuAcSwingVert
const uint8_t kFujitsuAcSwingVert
Definition: ir_Fujitsu.h:69
IRFujitsuAC::toCommonFanSpeed
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed)
Convert a native fan speed into its stdAc equivilant.
Definition: ir_Fujitsu.cpp:599
IRFujitsuAC::toggleSwingVert
void toggleSwingVert(const bool update=true)
Request the A/C to toggle the Vertical Swing mode.
Definition: ir_Fujitsu.cpp:327
IRrecv.h
kFujitsuAcModeAuto
const uint8_t kFujitsuAcModeAuto
Definition: ir_Fujitsu.h:41
IRFujitsuAC::setOutsideQuiet
void setOutsideQuiet(const bool on)
Set the Outside Quiet mode of the A/C.
Definition: ir_Fujitsu.cpp:399
kFujitsuAcSwingOff
const uint8_t kFujitsuAcSwingOff
Definition: ir_Fujitsu.h:68
IRFujitsuAC::setModel
void setModel(const fujitsu_ac_remote_model_t model)
Set the currently emulated model of the A/C.
Definition: ir_Fujitsu.cpp:73
kFujitsuAcModeDry
const uint8_t kFujitsuAcModeDry
Definition: ir_Fujitsu.h:43
ARRAH2E
@ ARRAH2E
Definition: IRsend.h:121
IRFujitsuAC::getFilter
bool getFilter(const bool raw=false)
Get the Filter mode status of the A/C.
Definition: ir_Fujitsu.cpp:520
IRFujitsuAC::getStateLength
uint8_t getStateLength(void)
Get the length (size) of the state code for the current configuration.
Definition: ir_Fujitsu.cpp:214
kFujitsuAcFanSize
const uint8_t kFujitsuAcFanSize
Definition: ir_Fujitsu.h:62
kFujitsuAcFanMed
const uint8_t kFujitsuAcFanMed
Definition: ir_Fujitsu.h:59
IRFujitsuAC::IRFujitsuAC
IRFujitsuAC(const uint16_t pin, const fujitsu_ac_remote_model_t model=ARRAH2E, const bool inverted=false, const bool use_modulation=true)
Class Constructor.
Definition: ir_Fujitsu.cpp:63
kFujitsuAcSwingBoth
const uint8_t kFujitsuAcSwingBoth
Definition: ir_Fujitsu.h:71
IRFujitsuAC::getMode
uint8_t getMode(void)
Get the operating mode setting of the A/C.
Definition: ir_Fujitsu.cpp:454
IRFujitsuAC::getTemp
uint8_t getTemp(void)
Get the current temperature setting.
Definition: ir_Fujitsu.cpp:426
IRFujitsuAC::buildState
void buildState(void)
(Re)Build the state from the currently configured settings.
Definition: ir_Fujitsu.cpp:119
IRFujitsuAC::_model
fujitsu_ac_remote_model_t _model
Definition: ir_Fujitsu.h:170
kFujitsuAcMaxTemp
const uint8_t kFujitsuAcMaxTemp
Definition: ir_Fujitsu.h:65
kFujitsuAcCmdStayOn
const uint8_t kFujitsuAcCmdStayOn
Definition: ir_Fujitsu.h:47
IRFujitsuAC::getOutsideQuiet
bool getOutsideQuiet(const bool raw=false)
Get the Outside Quiet mode status of the A/C.
Definition: ir_Fujitsu.cpp:407
IRFujitsuAC::toString
String toString(void)
Convert the current internal state into a human readable string.
Definition: ir_Fujitsu.cpp:654
IRFujitsuAC::getFanSpeed
uint8_t getFanSpeed(void)
Get the current fan speed setting.
Definition: ir_Fujitsu.cpp:440
IRFujitsuAC::getCmd
uint8_t getCmd(const bool raw=false)
Set the requested (special) command part for the A/C message.
Definition: ir_Fujitsu.cpp:376
IRFujitsuAC::setFanSpeed
void setFanSpeed(const uint8_t fan)
Set the speed of the fan.
Definition: ir_Fujitsu.cpp:430
IRFujitsuAC::getSwing
uint8_t getSwing(const bool raw=false)
Get the requested swing operation mode of the A/C unit.
Definition: ir_Fujitsu.cpp:483
IRFujitsuAC::off
void off(void)
Set the requested power state of the A/C to off.
Definition: ir_Fujitsu.cpp:388
IRFujitsuAC::setPower
void setPower(const bool on)
Change the power setting.
Definition: ir_Fujitsu.cpp:383
IRFujitsuAC::on
void on(void)
Set the requested power state of the A/C to on.
Definition: ir_Fujitsu.cpp:391
IRFujitsuAC::send
void send(const uint16_t repeat=kFujitsuAcMinRepeat)
Send the current internal state as an IR message.
Definition: ir_Fujitsu.cpp:112
IRFujitsuAC::getClean
bool getClean(const bool raw=false)
Get the Clean mode status of the A/C.
Definition: ir_Fujitsu.cpp:499
IRFujitsuAC::getPower
bool getPower(void)
Get the value of the current power setting.
Definition: ir_Fujitsu.cpp:395
IRFujitsuAC::validChecksum
static bool validChecksum(uint8_t *state, const uint16_t length)
Verify the checksum is valid for a given state.
Definition: ir_Fujitsu.cpp:535
IRFujitsuAC::_state_length
uint8_t _state_length
Definition: ir_Fujitsu.h:171
IRFujitsuAC::toggleSwingHoriz
void toggleSwingHoriz(const bool update=true)
Request the A/C to toggle the Horizontal Swing mode.
Definition: ir_Fujitsu.cpp:315
kFujitsuAcModeFan
const uint8_t kFujitsuAcModeFan
Definition: ir_Fujitsu.h:44
stdAc::state_t
Structure to hold a common A/C state.
Definition: IRsend.h:97
kFujitsuAcCmdEcono
const uint8_t kFujitsuAcCmdEcono
Definition: ir_Fujitsu.h:50
IRFujitsuAC::remote_state
uint8_t remote_state[kFujitsuAcStateLength]
The state of the IR remote.
Definition: ir_Fujitsu.h:164
kFujitsuAcFanQuiet
const uint8_t kFujitsuAcFanQuiet
Definition: ir_Fujitsu.h:61
kFujitsuAcFanLow
const uint8_t kFujitsuAcFanLow
Definition: ir_Fujitsu.h:60
kFujitsuAcModeCool
const uint8_t kFujitsuAcModeCool
Definition: ir_Fujitsu.h:42
stdAc::opmode_t
opmode_t
Common A/C settings for A/C operating modes.
Definition: IRsend.h:46