-
Notifications
You must be signed in to change notification settings - Fork 830
/
ir_MitsubishiHeavy.h
346 lines (298 loc) · 11.6 KB
/
ir_MitsubishiHeavy.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
// Copyright 2019 David Conran
/// @file
/// @brief Support for Mitsubishi Heavy Industry protocols.
/// Code to emulate Mitsubishi Heavy Industries A/C IR remote control units.
/// @note This code was *heavily* influenced by ToniA's great work & code,
/// but it has been written from scratch.
/// Nothing was copied other than constants and message analysis.
/// @see https://github.com/crankyoldgit/IRremoteESP8266/issues/660
/// @see https://github.com/ToniA/Raw-IR-decoder-for-Arduino/blob/master/MitsubishiHeavy.cpp
/// @see https://github.com/ToniA/arduino-heatpumpir/blob/master/MitsubishiHeavyHeatpumpIR.cpp
// Supports:
// Brand: Mitsubishi Heavy Industries, Model: RLA502A700B remote (152 bit)
// Brand: Mitsubishi Heavy Industries, Model: SRKxxZM-S A/C (152 bit)
// Brand: Mitsubishi Heavy Industries, Model: SRKxxZMXA-S A/C (152 bit)
// Brand: Mitsubishi Heavy Industries, Model: RKX502A001C remote (88 bit)
// Brand: Mitsubishi Heavy Industries, Model: SRKxxZJ-S A/C (88 bit)
#ifndef IR_MITSUBISHIHEAVY_H_
#define IR_MITSUBISHIHEAVY_H_
#ifndef UNIT_TEST
#include <Arduino.h>
#endif
#include "IRremoteESP8266.h"
#include "IRsend.h"
#ifdef UNIT_TEST
#include "IRsend_test.h"
#endif
/// Native representation of a Mitsubishi Heavy 152-bit A/C message.
union Mitsubishi152Protocol{
uint8_t raw[kMitsubishiHeavy152StateLength]; ///< State in code form
struct {
// Byte 0~4
uint8_t Sig[5];
// Byte 5
uint8_t Mode :3;
uint8_t Power :1;
uint8_t :1;
uint8_t Clean :1;
uint8_t Filter:1;
uint8_t :1;
// Byte 6
uint8_t :8;
// Byte 7
uint8_t Temp :4;
uint8_t :4;
// Byte 8
uint8_t :8;
// Byte 9
uint8_t Fan :4;
uint8_t :4;
// Byte 10
uint8_t :8;
// Byte 11
uint8_t :1;
uint8_t Three :1;
uint8_t :2;
uint8_t D :1; // binding with "Three"
uint8_t SwingV :3;
// Byte 12
uint8_t :8;
// Byte 13
uint8_t SwingH :4;
uint8_t :4;
// Byte 14
uint8_t :8;
// Byte 15
uint8_t :6;
uint8_t Night :1;
uint8_t Silent :1;
};
};
// Constants.
const uint8_t kMitsubishiHeavySigLength = 5;
// ZMS (152 bit)
const uint8_t kMitsubishiHeavyZmsSig[kMitsubishiHeavySigLength] = {
0xAD, 0x51, 0x3C, 0xE5, 0x1A};
const uint8_t kMitsubishiHeavyAuto = 0; // 0b000
const uint8_t kMitsubishiHeavyCool = 1; // 0b001
const uint8_t kMitsubishiHeavyDry = 2; // 0b010
const uint8_t kMitsubishiHeavyFan = 3; // 0b011
const uint8_t kMitsubishiHeavyHeat = 4; // 0b100
const uint8_t kMitsubishiHeavyMinTemp = 17; // 17C
const uint8_t kMitsubishiHeavyMaxTemp = 31; // 31C
const uint8_t kMitsubishiHeavy152FanAuto = 0x0; // 0b0000
const uint8_t kMitsubishiHeavy152FanLow = 0x1; // 0b0001
const uint8_t kMitsubishiHeavy152FanMed = 0x2; // 0b0010
const uint8_t kMitsubishiHeavy152FanHigh = 0x3; // 0b0011
const uint8_t kMitsubishiHeavy152FanMax = 0x4; // 0b0100
const uint8_t kMitsubishiHeavy152FanEcono = 0x6; // 0b0110
const uint8_t kMitsubishiHeavy152FanTurbo = 0x8; // 0b1000
const uint8_t kMitsubishiHeavy152SwingVAuto = 0; // 0b000
const uint8_t kMitsubishiHeavy152SwingVHighest = 1; // 0b001
const uint8_t kMitsubishiHeavy152SwingVHigh = 2; // 0b010
const uint8_t kMitsubishiHeavy152SwingVMiddle = 3; // 0b011
const uint8_t kMitsubishiHeavy152SwingVLow = 4; // 0b100
const uint8_t kMitsubishiHeavy152SwingVLowest = 5; // 0b101
const uint8_t kMitsubishiHeavy152SwingVOff = 6; // 0b110
const uint8_t kMitsubishiHeavy152SwingHAuto = 0; // 0b0000
const uint8_t kMitsubishiHeavy152SwingHLeftMax = 1; // 0b0001
const uint8_t kMitsubishiHeavy152SwingHLeft = 2; // 0b0010
const uint8_t kMitsubishiHeavy152SwingHMiddle = 3; // 0b0011
const uint8_t kMitsubishiHeavy152SwingHRight = 4; // 0b0100
const uint8_t kMitsubishiHeavy152SwingHRightMax = 5; // 0b0101
const uint8_t kMitsubishiHeavy152SwingHRightLeft = 6; // 0b0110
const uint8_t kMitsubishiHeavy152SwingHLeftRight = 7; // 0b0111
const uint8_t kMitsubishiHeavy152SwingHOff = 8; // 0b1000
/// Native representation of a Mitsubishi Heavy 88-bit A/C message.
union Mitsubishi88Protocol{
uint8_t raw[kMitsubishiHeavy88StateLength]; ///< State in code form
struct {
// Byte 0~4
uint8_t Sig[5];
// Byte 5
uint8_t :1;
uint8_t SwingV5 :1;
uint8_t SwingH1 :2;
uint8_t :1;
uint8_t Clean :1;
uint8_t SwingH2 :2;
// Byte 6
uint8_t :8;
// Byte 7
uint8_t :3;
uint8_t SwingV7 :2;
uint8_t Fan :3;
// Byte 8
uint8_t :8;
// Byte 9
uint8_t Mode :3;
uint8_t Power :1;
uint8_t Temp :4;
};
};
// ZJS (88 bit)
const uint8_t kMitsubishiHeavyZjsSig[kMitsubishiHeavySigLength] = {
0xAD, 0x51, 0x3C, 0xD9, 0x26};
const uint8_t kMitsubishiHeavy88SwingHSize = 2; // Bits (per offset)
const uint8_t kMitsubishiHeavy88SwingHOff = 0b0000;
const uint8_t kMitsubishiHeavy88SwingHAuto = 0b1000;
const uint8_t kMitsubishiHeavy88SwingHLeftMax = 0b0001;
const uint8_t kMitsubishiHeavy88SwingHLeft = 0b0101;
const uint8_t kMitsubishiHeavy88SwingHMiddle = 0b1001;
const uint8_t kMitsubishiHeavy88SwingHRight = 0b1101;
const uint8_t kMitsubishiHeavy88SwingHRightMax = 0b0010;
const uint8_t kMitsubishiHeavy88SwingHRightLeft = 0b1010;
const uint8_t kMitsubishiHeavy88SwingHLeftRight = 0b0110;
const uint8_t kMitsubishiHeavy88SwingH3D = 0b1110;
const uint8_t kMitsubishiHeavy88FanAuto = 0; // 0b000
const uint8_t kMitsubishiHeavy88FanLow = 2; // 0b010
const uint8_t kMitsubishiHeavy88FanMed = 3; // 0b011
const uint8_t kMitsubishiHeavy88FanHigh = 4; // 0b100
const uint8_t kMitsubishiHeavy88FanTurbo = 6; // 0b110
const uint8_t kMitsubishiHeavy88FanEcono = 7; // 0b111
const uint8_t kMitsubishiHeavy88SwingVByte5Size = 1;
// Mask 0b111
const uint8_t kMitsubishiHeavy88SwingVOff = 0b000; // 0
const uint8_t kMitsubishiHeavy88SwingVAuto = 0b100; // 4
const uint8_t kMitsubishiHeavy88SwingVHighest = 0b110; // 6
const uint8_t kMitsubishiHeavy88SwingVHigh = 0b001; // 1
const uint8_t kMitsubishiHeavy88SwingVMiddle = 0b011; // 3
const uint8_t kMitsubishiHeavy88SwingVLow = 0b101; // 5
const uint8_t kMitsubishiHeavy88SwingVLowest = 0b111; // 7
// Classes
/// Class for handling detailed Mitsubishi Heavy 152-bit A/C messages.
class IRMitsubishiHeavy152Ac {
public:
explicit IRMitsubishiHeavy152Ac(const uint16_t pin,
const bool inverted = false,
const bool use_modulation = true);
void stateReset(void);
#if SEND_MITSUBISHIHEAVY
void send(const uint16_t repeat = kMitsubishiHeavy152MinRepeat);
/// Run the calibration to calculate uSec timing offsets for this platform.
/// @return The uSec timing offset needed per modulation of the IR Led.
/// @note This will produce a 65ms IR signal pulse at 38kHz.
/// Only ever needs to be run once per object instantiation, if at all.
int8_t calibrate(void) { return _irsend.calibrate(); }
#endif // SEND_MITSUBISHIHEAVY
void begin(void);
void on(void);
void off(void);
void setPower(const bool on);
bool getPower(void) const;
void setTemp(const uint8_t temp);
uint8_t getTemp(void) const;
void setFan(const uint8_t fan);
uint8_t getFan(void) const;
void setMode(const uint8_t mode);
uint8_t getMode(void) const;
void setSwingVertical(const uint8_t pos);
uint8_t getSwingVertical(void) const;
void setSwingHorizontal(const uint8_t pos);
uint8_t getSwingHorizontal(void) const;
void setNight(const bool on);
bool getNight(void) const;
void set3D(const bool on);
bool get3D(void) const;
void setSilent(const bool on);
bool getSilent(void) const;
void setFilter(const bool on);
bool getFilter(void) const;
void setClean(const bool on);
bool getClean(void) const;
void setTurbo(const bool on);
bool getTurbo(void) const;
void setEcono(const bool on);
bool getEcono(void) const;
uint8_t* getRaw(void);
void setRaw(const uint8_t* data);
static bool checkZmsSig(const uint8_t *state);
static bool validChecksum(
const uint8_t *state,
const uint16_t length = kMitsubishiHeavy152StateLength);
static uint8_t convertMode(const stdAc::opmode_t mode);
static uint8_t convertFan(const stdAc::fanspeed_t speed);
static uint8_t convertSwingV(const stdAc::swingv_t position);
static uint8_t convertSwingH(const stdAc::swingh_t position);
static stdAc::opmode_t toCommonMode(const uint8_t mode);
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
static stdAc::swingv_t toCommonSwingV(const uint8_t pos);
static stdAc::swingh_t toCommonSwingH(const uint8_t pos);
stdAc::state_t toCommon(void) const;
String toString(void) const;
#ifndef UNIT_TEST
private:
IRsend _irsend; ///< Instance of the IR send class
#else // UNIT_TEST
/// @cond IGNORE
IRsendTest _irsend; ///< Instance of the testing IR send class
/// @endcond
#endif // UNIT_TEST
Mitsubishi152Protocol _;
void checksum(void);
};
/// Class for handling detailed Mitsubishi Heavy 88-bit A/C messages.
class IRMitsubishiHeavy88Ac {
public:
explicit IRMitsubishiHeavy88Ac(const uint16_t pin,
const bool inverted = false,
const bool use_modulation = true);
void stateReset(void);
#if SEND_MITSUBISHIHEAVY
void send(const uint16_t repeat = kMitsubishiHeavy88MinRepeat);
/// Run the calibration to calculate uSec timing offsets for this platform.
/// @return The uSec timing offset needed per modulation of the IR Led.
/// @note This will produce a 65ms IR signal pulse at 38kHz.
/// Only ever needs to be run once per object instantiation, if at all.
int8_t calibrate(void) { return _irsend.calibrate(); }
#endif // SEND_MITSUBISHIHEAVY
void begin(void);
void on(void);
void off(void);
void setPower(const bool on);
bool getPower(void) const;
void setTemp(const uint8_t temp);
uint8_t getTemp(void) const;
void setFan(const uint8_t fan);
uint8_t getFan(void) const;
void setMode(const uint8_t mode);
uint8_t getMode(void) const;
void setSwingVertical(const uint8_t pos);
uint8_t getSwingVertical(void) const;
void setSwingHorizontal(const uint8_t pos);
uint8_t getSwingHorizontal(void) const;
void setTurbo(const bool on);
bool getTurbo(void) const;
void setEcono(const bool on);
bool getEcono(void) const;
void set3D(const bool on);
bool get3D(void) const;
void setClean(const bool on);
bool getClean(void) const;
uint8_t* getRaw(void);
void setRaw(const uint8_t* data);
static bool checkZjsSig(const uint8_t *state);
static bool validChecksum(
const uint8_t *state,
const uint16_t length = kMitsubishiHeavy88StateLength);
static uint8_t convertMode(const stdAc::opmode_t mode);
static uint8_t convertFan(const stdAc::fanspeed_t speed);
static uint8_t convertSwingV(const stdAc::swingv_t position);
static uint8_t convertSwingH(const stdAc::swingh_t position);
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
static stdAc::swingv_t toCommonSwingV(const uint8_t pos);
static stdAc::swingh_t toCommonSwingH(const uint8_t pos);
stdAc::state_t toCommon(void) const;
String toString(void) const;
#ifndef UNIT_TEST
private:
IRsend _irsend; ///< Instance of the IR send class
#else // UNIT_TEST
/// @cond IGNORE
IRsendTest _irsend; ///< Instance of the testing IR send class
/// @endcond
#endif // UNIT_TEST
Mitsubishi88Protocol _;
void checksum(void);
};
#endif // IR_MITSUBISHIHEAVY_H_