IRremoteESP8266
IRrecv.h
Go to the documentation of this file.
1 // Copyright 2009 Ken Shirriff
2 // Copyright 2015 Mark Szabo
3 // Copyright 2015 Sebastien Warin
4 // Copyright 2017 David Conran
5 
6 #ifndef IRRECV_H_
7 #define IRRECV_H_
8 
9 #ifndef UNIT_TEST
10 #include <Arduino.h>
11 #endif
12 #include <stddef.h>
13 #define __STDC_LIMIT_MACROS
14 #include <stdint.h>
15 #include "IRremoteESP8266.h"
16 
17 // Constants
18 const uint16_t kHeader = 2; // Usual nr. of header entries.
19 const uint16_t kFooter = 2; // Usual nr. of footer (stop bits) entries.
20 const uint16_t kStartOffset = 1; // Usual rawbuf entry to start from.
21 #define MS_TO_USEC(x) (x * 1000U) // Convert milli-Seconds to micro-Seconds.
22 // Marks tend to be 100us too long, and spaces 100us too short
23 // when received due to sensor lag.
24 const uint16_t kMarkExcess = 50;
25 const uint16_t kRawBuf = 100; // Default length of raw capture buffer
26 const uint64_t kRepeat = UINT64_MAX;
27 // Default min size of reported UNKNOWN messages.
28 const uint16_t kUnknownThreshold = 6;
29 
30 // receiver states
31 const uint8_t kIdleState = 2;
32 const uint8_t kMarkState = 3;
33 const uint8_t kSpaceState = 4;
34 const uint8_t kStopState = 5;
35 const uint8_t kTolerance = 25; // default percent tolerance in measurements.
36 const uint8_t kUseDefTol = 255; // Indicate to use the class default tolerance.
37 const uint16_t kRawTick = 2; // Capture tick to uSec factor.
38 #define RAWTICK kRawTick // Deprecated. For legacy user code support only.
39 // How long (ms) before we give up wait for more data?
40 // Don't exceed kMaxTimeoutMs without a good reason.
41 // That is the capture buffers maximum value size. (UINT16_MAX / kRawTick)
42 // Typically messages/protocols tend to repeat around the 100ms timeframe,
43 // thus we should timeout before that to give us some time to try to decode
44 // before we need to start capturing a possible new message.
45 // Typically 15ms suits most applications. However, some protocols demand a
46 // higher value. e.g. 90ms for XMP-1 and some aircon units.
47 const uint8_t kTimeoutMs = 15; // In MilliSeconds.
48 #define TIMEOUT_MS kTimeoutMs // For legacy documentation.
49 const uint16_t kMaxTimeoutMs = kRawTick * (UINT16_MAX / MS_TO_USEC(1));
50 
51 // Use FNV hash algorithm: http://isthe.com/chongo/tech/comp/fnv/#FNV-param
52 const uint32_t kFnvPrime32 = 16777619UL;
53 const uint32_t kFnvBasis32 = 2166136261UL;
54 
55 // Which of the ESP32 timers to use by default. (0-3)
56 const uint8_t kDefaultESP32Timer = 3;
57 
58 #if DECODE_AC
59 // Hitachi AC is the current largest state size.
61 #else
62 // Just define something
63 const uint16_t kStateSizeMax = 0;
64 #endif
65 
66 // Types
67 
69 typedef struct {
70  uint8_t recvpin; // pin for IR data from detector
71  uint8_t rcvstate; // state machine
72  uint16_t timer; // state timer, counts 50uS ticks.
73  uint16_t bufsize; // max. nr. of entries in the capture buffer.
74  uint16_t *rawbuf; // raw data
75  // uint16_t is used for rawlen as it saves 3 bytes of iram in the interrupt
76  // handler. Don't ask why, I don't know. It just does.
77  uint16_t rawlen; // counter of entries in rawbuf.
78  uint8_t overflow; // Buffer overflow indicator.
79  uint8_t timeout; // Nr. of milliSeconds before we give up.
80 } irparams_t;
81 
83 typedef struct {
84  bool success; // Was the match successful?
85  uint64_t data; // The data found.
86  uint16_t used; // How many buffer positions were used.
88 
89 // Classes
90 
93  public:
94  decode_type_t decode_type; // NEC, SONY, RC5, UNKNOWN
95  // value, address, & command are all mutually exclusive with state.
96  // i.e. They MUST NOT be used at the same time as state, so we can use a union
97  // structure to save us a handful of valuable bytes of memory.
98  union {
99  struct {
100  uint64_t value; // Decoded value
101  uint32_t address; // Decoded device address.
102  uint32_t command; // Decoded command.
103  };
104  uint8_t state[kStateSizeMax]; // Multi-byte results.
105  };
106  uint16_t bits; // Number of bits in decoded value
107  volatile uint16_t *rawbuf; // Raw intervals in .5 us ticks
108  uint16_t rawlen; // Number of records in rawbuf.
109  bool overflow;
110  bool repeat; // Is the result a repeat code?
111 };
112 
114 class IRrecv {
115  public:
116 #if defined(ESP32)
117  explicit IRrecv(const uint16_t recvpin, const uint16_t bufsize = kRawBuf,
118  const uint8_t timeout = kTimeoutMs,
119  const bool save_buffer = false,
120  const uint8_t timer_num = kDefaultESP32Timer); // Constructor
121 #else // ESP32
122  explicit IRrecv(const uint16_t recvpin, const uint16_t bufsize = kRawBuf,
123  const uint8_t timeout = kTimeoutMs,
124  const bool save_buffer = false); // Constructor
125 #endif // ESP32
126  ~IRrecv(void); // Destructor
127  void setTolerance(const uint8_t percent = kTolerance);
128  uint8_t getTolerance(void);
129  bool decode(decode_results *results, irparams_t *save = NULL,
130  uint8_t max_skip = 0, uint16_t noise_floor = 0);
131  void enableIRIn(const bool pullup = false);
132  void disableIRIn(void);
133  void resume(void);
134  uint16_t getBufSize(void);
135 #if DECODE_HASH
136  void setUnknownThreshold(const uint16_t length);
137 #endif
138  bool match(const uint32_t measured, const uint32_t desired,
139  const uint8_t tolerance = kUseDefTol,
140  const uint16_t delta = 0);
141  bool matchMark(const uint32_t measured, const uint32_t desired,
142  const uint8_t tolerance = kUseDefTol,
143  const int16_t excess = kMarkExcess);
144  bool matchSpace(const uint32_t measured, const uint32_t desired,
145  const uint8_t tolerance = kUseDefTol,
146  const int16_t excess = kMarkExcess);
147 #ifndef UNIT_TEST
148 
149  private:
150 #endif
152  uint8_t _tolerance;
153 #if defined(ESP32)
154  uint8_t _timer_num;
155 #endif // defined(ESP32)
156 #if DECODE_HASH
158 #endif
159  // These are called by decode
160  uint8_t _validTolerance(const uint8_t percentage);
161  void copyIrParams(volatile irparams_t *src, irparams_t *dst);
162  uint16_t compare(const uint16_t oldval, const uint16_t newval);
163  uint32_t ticksLow(const uint32_t usecs,
164  const uint8_t tolerance = kUseDefTol,
165  const uint16_t delta = 0);
166  uint32_t ticksHigh(const uint32_t usecs,
167  const uint8_t tolerance = kUseDefTol,
168  const uint16_t delta = 0);
169  bool matchAtLeast(const uint32_t measured, const uint32_t desired,
170  const uint8_t tolerance = kUseDefTol,
171  const uint16_t delta = 0);
172  uint16_t _matchGeneric(volatile uint16_t *data_ptr,
173  uint64_t *result_bits_ptr,
174  uint8_t *result_ptr,
175  const bool use_bits,
176  const uint16_t remaining,
177  const uint16_t required,
178  const uint16_t hdrmark,
179  const uint32_t hdrspace,
180  const uint16_t onemark,
181  const uint32_t onespace,
182  const uint16_t zeromark,
183  const uint32_t zerospace,
184  const uint16_t footermark,
185  const uint32_t footerspace,
186  const bool atleast = false,
187  const uint8_t tolerance = kUseDefTol,
188  const int16_t excess = kMarkExcess,
189  const bool MSBfirst = true);
190  match_result_t matchData(volatile uint16_t *data_ptr, const uint16_t nbits,
191  const uint16_t onemark, const uint32_t onespace,
192  const uint16_t zeromark, const uint32_t zerospace,
193  const uint8_t tolerance = kUseDefTol,
194  const int16_t excess = kMarkExcess,
195  const bool MSBfirst = true);
196  uint16_t matchBytes(volatile uint16_t *data_ptr, uint8_t *result_ptr,
197  const uint16_t remaining, const uint16_t nbytes,
198  const uint16_t onemark, const uint32_t onespace,
199  const uint16_t zeromark, const uint32_t zerospace,
200  const uint8_t tolerance = kUseDefTol,
201  const int16_t excess = kMarkExcess,
202  const bool MSBfirst = true);
203  uint16_t matchGeneric(volatile uint16_t *data_ptr,
204  uint64_t *result_ptr,
205  const uint16_t remaining, const uint16_t nbits,
206  const uint16_t hdrmark, const uint32_t hdrspace,
207  const uint16_t onemark, const uint32_t onespace,
208  const uint16_t zeromark, const uint32_t zerospace,
209  const uint16_t footermark, const uint32_t footerspace,
210  const bool atleast = false,
211  const uint8_t tolerance = kUseDefTol,
212  const int16_t excess = kMarkExcess,
213  const bool MSBfirst = true);
214  uint16_t matchGeneric(volatile uint16_t *data_ptr, uint8_t *result_ptr,
215  const uint16_t remaining, const uint16_t nbits,
216  const uint16_t hdrmark, const uint32_t hdrspace,
217  const uint16_t onemark, const uint32_t onespace,
218  const uint16_t zeromark, const uint32_t zerospace,
219  const uint16_t footermark,
220  const uint32_t footerspace,
221  const bool atleast = false,
222  const uint8_t tolerance = kUseDefTol,
223  const int16_t excess = kMarkExcess,
224  const bool MSBfirst = true);
225  uint16_t matchGenericConstBitTime(volatile uint16_t *data_ptr,
226  uint64_t *result_ptr,
227  const uint16_t remaining,
228  const uint16_t nbits,
229  const uint16_t hdrmark,
230  const uint32_t hdrspace,
231  const uint16_t one,
232  const uint32_t zero,
233  const uint16_t footermark,
234  const uint32_t footerspace,
235  const bool atleast = false,
236  const uint8_t tolerance = kUseDefTol,
237  const int16_t excess = kMarkExcess,
238  const bool MSBfirst = true);
239  uint16_t matchManchesterData(volatile const uint16_t *data_ptr,
240  uint64_t *result_ptr,
241  const uint16_t remaining,
242  const uint16_t nbits,
243  const uint16_t half_period,
244  const uint16_t starting_balance = 0,
245  const uint8_t tolerance = kUseDefTol,
246  const int16_t excess = kMarkExcess,
247  const bool MSBfirst = true,
248  const bool GEThomas = true);
249  uint16_t matchManchester(volatile const uint16_t *data_ptr,
250  uint64_t *result_ptr,
251  const uint16_t remaining,
252  const uint16_t nbits,
253  const uint16_t hdrmark,
254  const uint32_t hdrspace,
255  const uint16_t clock_period,
256  const uint16_t footermark,
257  const uint32_t footerspace,
258  const bool atleast = false,
259  const uint8_t tolerance = kUseDefTol,
260  const int16_t excess = kMarkExcess,
261  const bool MSBfirst = true,
262  const bool GEThomas = true);
263  void crudeNoiseFilter(decode_results *results, const uint16_t floor = 0);
264  bool decodeHash(decode_results *results);
265 #if (DECODE_NEC || DECODE_SHERWOOD || DECODE_AIWA_RC_T501 || DECODE_SANYO)
266  bool decodeNEC(decode_results *results, uint16_t offset = kStartOffset,
267  const uint16_t nbits = kNECBits, const bool strict = true);
268 #endif
269 #if DECODE_ARGO
270  bool decodeArgo(decode_results *results, uint16_t offset = kStartOffset,
271  const uint16_t nbits = kArgoBits, const bool strict = true);
272 #endif // DECODE_ARGO
273 #if DECODE_SONY
274  bool decodeSony(decode_results *results, uint16_t offset = kStartOffset,
275  const uint16_t nbits = kSonyMinBits,
276  const bool strict = false);
277 #endif
278 #if DECODE_SANYO
279  // DISABLED due to poor quality.
280  // bool decodeSanyo(decode_results *results, uint16_t offset = kStartOffset,
281  // uint16_t nbits = kSanyoSA8650BBits,
282  // bool strict = false);
283  bool decodeSanyoLC7461(decode_results *results,
284  uint16_t offset = kStartOffset,
285  const uint16_t nbits = kSanyoLC7461Bits,
286  bool strict = true);
287 #endif
288 #if DECODE_MITSUBISHI
289  bool decodeMitsubishi(decode_results *results, uint16_t offset = kStartOffset,
290  const uint16_t nbits = kMitsubishiBits,
291  const bool strict = true);
292 #endif
293 #if DECODE_MITSUBISHI2
294  bool decodeMitsubishi2(decode_results *results,
295  uint16_t offset = kStartOffset,
296  const uint16_t nbits = kMitsubishiBits,
297  const bool strict = true);
298 #endif
299 #if DECODE_MITSUBISHI_AC
300  bool decodeMitsubishiAC(decode_results *results,
301  uint16_t offset = kStartOffset,
302  const uint16_t nbits = kMitsubishiACBits,
303  const bool strict = false);
304 #endif
305 #if DECODE_MITSUBISHI136
306  bool decodeMitsubishi136(decode_results *results,
307  uint16_t offset = kStartOffset,
308  const uint16_t nbits = kMitsubishi136Bits,
309  const bool strict = true);
310 #endif
311 #if DECODE_MITSUBISHI112
312  bool decodeMitsubishi112(decode_results *results,
313  uint16_t offset = kStartOffset,
314  const uint16_t nbits = kMitsubishi112Bits,
315  const bool strict = true);
316 #endif
317 #if DECODE_MITSUBISHIHEAVY
319  uint16_t offset = kStartOffset,
320  const uint16_t nbits = kMitsubishiHeavy152Bits,
321  const bool strict = true);
322 #endif
323 #if (DECODE_RC5 || DECODE_R6 || DECODE_LASERTAG || DECODE_MWM)
324  int16_t getRClevel(decode_results *results, uint16_t *offset, uint16_t *used,
325  uint16_t bitTime, const uint8_t tolerance = kUseDefTol,
326  const int16_t excess = kMarkExcess,
327  const uint16_t delta = 0, const uint8_t maxwidth = 3);
328 #endif
329 #if DECODE_RC5
330  bool decodeRC5(decode_results *results, uint16_t offset = kStartOffset,
331  const uint16_t nbits = kRC5XBits,
332  const bool strict = true);
333 #endif
334 #if DECODE_RC6
335  bool decodeRC6(decode_results *results, uint16_t offset = kStartOffset,
336  const uint16_t nbits = kRC6Mode0Bits,
337  const bool strict = false);
338 #endif
339 #if DECODE_RCMM
340  bool decodeRCMM(decode_results *results, uint16_t offset = kStartOffset,
341  const uint16_t nbits = kRCMMBits,
342  const bool strict = false);
343 #endif
344 #if (DECODE_PANASONIC || DECODE_DENON)
345  bool decodePanasonic(decode_results *results, uint16_t offset = kStartOffset,
346  const uint16_t nbits = kPanasonicBits,
347  const bool strict = false,
348  const uint32_t manufacturer = kPanasonicManufacturer);
349 #endif
350 #if DECODE_LG
351  bool decodeLG(decode_results *results, uint16_t offset = kStartOffset,
352  const uint16_t nbits = kLgBits,
353  const bool strict = false);
354 #endif
355 #if DECODE_INAX
356  bool decodeInax(decode_results *results, uint16_t offset = kStartOffset,
357  const uint16_t nbits = kInaxBits,
358  const bool strict = true);
359 #endif // DECODE_INAX
360 #if DECODE_JVC
361  bool decodeJVC(decode_results *results, uint16_t offset = kStartOffset,
362  const uint16_t nbits = kJvcBits,
363  const bool strict = true);
364 #endif
365 #if DECODE_SAMSUNG
366  bool decodeSAMSUNG(decode_results *results, uint16_t offset = kStartOffset,
367  const uint16_t nbits = kSamsungBits,
368  const bool strict = true);
369 #endif
370 #if DECODE_SAMSUNG
371  bool decodeSamsung36(decode_results *results, uint16_t offset = kStartOffset,
372  const uint16_t nbits = kSamsung36Bits,
373  const bool strict = true);
374 #endif
375 #if DECODE_SAMSUNG_AC
376  bool decodeSamsungAC(decode_results *results, uint16_t offset = kStartOffset,
377  const uint16_t nbits = kSamsungAcBits,
378  const bool strict = true);
379 #endif
380 #if DECODE_WHYNTER
381  bool decodeWhynter(decode_results *results, uint16_t offset = kStartOffset,
382  const uint16_t nbits = kWhynterBits,
383  const bool strict = true);
384 #endif
385 #if DECODE_COOLIX
386  bool decodeCOOLIX(decode_results *results, uint16_t offset = kStartOffset,
387  const uint16_t nbits = kCoolixBits,
388  const bool strict = true);
389 #endif
390 #if DECODE_DENON
391  bool decodeDenon(decode_results *results, uint16_t offset = kStartOffset,
392  const uint16_t nbits = kDenonBits,
393  const bool strict = true);
394 #endif
395 #if DECODE_DISH
396  bool decodeDISH(decode_results *results, uint16_t offset = kStartOffset,
397  const uint16_t nbits = kDishBits,
398  const bool strict = true);
399 #endif
400 #if (DECODE_SHARP || DECODE_DENON)
401  bool decodeSharp(decode_results *results, uint16_t offset = kStartOffset,
402  const uint16_t nbits = kSharpBits,
403  const bool strict = true, const bool expansion = true);
404 #endif
405 #if DECODE_SHARP_AC
406  bool decodeSharpAc(decode_results *results, uint16_t offset = kStartOffset,
407  const uint16_t nbits = kSharpAcBits,
408  const bool strict = true);
409 #endif
410 #if DECODE_AIWA_RC_T501
411  bool decodeAiwaRCT501(decode_results *results, uint16_t offset = kStartOffset,
412  const uint16_t nbits = kAiwaRcT501Bits,
413  const bool strict = true);
414 #endif
415 #if DECODE_NIKAI
416  bool decodeNikai(decode_results *results, uint16_t offset = kStartOffset,
417  const uint16_t nbits = kNikaiBits,
418  const bool strict = true);
419 #endif
420 #if DECODE_MAGIQUEST
421  bool decodeMagiQuest(decode_results *results, uint16_t offset = kStartOffset,
422  const uint16_t nbits = kMagiquestBits,
423  const bool strict = true);
424 #endif
425 #if DECODE_KELVINATOR
426  bool decodeKelvinator(decode_results *results, uint16_t offset = kStartOffset,
427  const uint16_t nbits = kKelvinatorBits,
428  const bool strict = true);
429 #endif
430 #if DECODE_DAIKIN
431  bool decodeDaikin(decode_results *results, uint16_t offset = kStartOffset,
432  const uint16_t nbits = kDaikinBits,
433  const bool strict = true);
434 #endif
435 #if DECODE_DAIKIN64
436  bool decodeDaikin64(decode_results *results, uint16_t offset = kStartOffset,
437  const uint16_t nbits = kDaikin64Bits,
438  const bool strict = true);
439 #endif // DECODE_DAIKIN64
440 #if DECODE_DAIKIN128
441  bool decodeDaikin128(decode_results *results, uint16_t offset = kStartOffset,
442  const uint16_t nbits = kDaikin128Bits,
443  const bool strict = true);
444 #endif // DECODE_DAIKIN128
445 #if DECODE_DAIKIN152
446  bool decodeDaikin152(decode_results *results, uint16_t offset = kStartOffset,
447  const uint16_t nbits = kDaikin152Bits,
448  const bool strict = true);
449 #endif // DECODE_DAIKIN152
450 #if DECODE_DAIKIN160
451  bool decodeDaikin160(decode_results *results, uint16_t offset = kStartOffset,
452  const uint16_t nbits = kDaikin160Bits,
453  const bool strict = true);
454 #endif // DECODE_DAIKIN160
455 #if DECODE_DAIKIN176
456  bool decodeDaikin176(decode_results *results, uint16_t offset = kStartOffset,
457  const uint16_t nbits = kDaikin176Bits,
458  const bool strict = true);
459 #endif // DECODE_DAIKIN176
460 #if DECODE_DAIKIN2
461  bool decodeDaikin2(decode_results *results, uint16_t offset = kStartOffset,
462  const uint16_t nbits = kDaikin2Bits,
463  const bool strict = true);
464 #endif
465 #if DECODE_DAIKIN216
466  bool decodeDaikin216(decode_results *results, uint16_t offset = kStartOffset,
467  const uint16_t nbits = kDaikin216Bits,
468  const bool strict = true);
469 #endif
470 #if DECODE_TOSHIBA_AC
471  bool decodeToshibaAC(decode_results *results, uint16_t offset = kStartOffset,
472  const uint16_t nbytes = kToshibaACBits,
473  const bool strict = true);
474 #endif
475 #if DECODE_TROTEC
476  bool decodeTrotec(decode_results *results, uint16_t offset = kStartOffset,
477  const uint16_t nbits = kTrotecBits,
478  const bool strict = true);
479 #endif // DECODE_TROTEC
480 #if DECODE_MIDEA
481  bool decodeMidea(decode_results *results, uint16_t offset = kStartOffset,
482  const uint16_t nbits = kMideaBits,
483  const bool strict = true);
484 #endif // DECODE_MIDEA
485 #if DECODE_MIDEA24
486  bool decodeMidea24(decode_results *results, uint16_t offset = kStartOffset,
487  const uint16_t nbits = kMidea24Bits,
488  const bool strict = true);
489 #endif // DECODE_MIDEA24
490 #if DECODE_FUJITSU_AC
491  bool decodeFujitsuAC(decode_results *results, uint16_t offset = kStartOffset,
492  const uint16_t nbits = kFujitsuAcBits,
493  const bool strict = false);
494 #endif
495 #if DECODE_LASERTAG
496  bool decodeLasertag(decode_results *results, uint16_t offset = kStartOffset,
497  const uint16_t nbits = kLasertagBits,
498  const bool strict = true);
499 #endif
500 #if DECODE_CARRIER_AC
501  bool decodeCarrierAC(decode_results *results, uint16_t offset = kStartOffset,
502  const uint16_t nbits = kCarrierAcBits,
503  const bool strict = true);
504 #endif // DECODE_CARRIER_AC
505 #if DECODE_CARRIER_AC40
506  bool decodeCarrierAC40(decode_results *results,
507  uint16_t offset = kStartOffset,
508  const uint16_t nbits = kCarrierAc40Bits,
509  const bool strict = true);
510 #endif // DECODE_CARRIER_AC40
511 #if DECODE_CARRIER_AC64
512  bool decodeCarrierAC64(decode_results *results,
513  uint16_t offset = kStartOffset,
514  const uint16_t nbits = kCarrierAc64Bits,
515  const bool strict = true);
516 #endif // DECODE_CARRIER_AC64
517 #if DECODE_GOODWEATHER
518  bool decodeGoodweather(decode_results *results,
519  uint16_t offset = kStartOffset,
520  const uint16_t nbits = kGoodweatherBits,
521  const bool strict = true);
522 #endif // DECODE_GOODWEATHER
523 #if DECODE_GREE
524  bool decodeGree(decode_results *results, uint16_t offset = kStartOffset,
525  const uint16_t nbits = kGreeBits,
526  const bool strict = true);
527 #endif
528 #if (DECODE_HAIER_AC | DECODE_HAIER_AC_YRW02)
529  bool decodeHaierAC(decode_results *results, uint16_t offset = kStartOffset,
530  const uint16_t nbits = kHaierACBits,
531  const bool strict = true);
532 #endif
533 #if DECODE_HAIER_AC_YRW02
534  bool decodeHaierACYRW02(decode_results *results,
535  uint16_t offset = kStartOffset,
536  const uint16_t nbits = kHaierACYRW02Bits,
537  const bool strict = true);
538 #endif
539 #if (DECODE_HITACHI_AC || DECODE_HITACHI_AC2 || DECODE_HITACHI_AC344)
540  bool decodeHitachiAC(decode_results *results, uint16_t offset = kStartOffset,
541  const uint16_t nbits = kHitachiAcBits,
542  const bool strict = true, const bool MSBfirst = true);
543 #endif
544 #if DECODE_HITACHI_AC1
545  bool decodeHitachiAC1(decode_results *results, uint16_t offset = kStartOffset,
546  const uint16_t nbits = kHitachiAc1Bits,
547  const bool strict = true);
548 #endif
549 #if DECODE_HITACHI_AC3
550  bool decodeHitachiAc3(decode_results *results,
551  uint16_t offset = kStartOffset,
552  const uint16_t nbits = kHitachiAc3Bits,
553  const bool strict = true);
554 #endif // DECODE_HITACHI_AC3
555 #if DECODE_HITACHI_AC424
556  bool decodeHitachiAc424(decode_results *results,
557  uint16_t offset = kStartOffset,
558  const uint16_t nbits = kHitachiAc424Bits,
559  const bool strict = true);
560 #endif // DECODE_HITACHI_AC424
561 #if DECODE_GICABLE
562  bool decodeGICable(decode_results *results, uint16_t offset = kStartOffset,
563  const uint16_t nbits = kGicableBits,
564  const bool strict = true);
565 #endif
566 #if DECODE_WHIRLPOOL_AC
567  bool decodeWhirlpoolAC(decode_results *results,
568  uint16_t offset = kStartOffset,
569  const uint16_t nbits = kWhirlpoolAcBits,
570  const bool strict = true);
571 #endif
572 #if DECODE_LUTRON
573  bool decodeLutron(decode_results *results, uint16_t offset = kStartOffset,
574  const uint16_t nbits = kLutronBits,
575  const bool strict = true);
576 #endif
577 #if DECODE_ELECTRA_AC
578  bool decodeElectraAC(decode_results *results, uint16_t offset = kStartOffset,
579  const uint16_t nbits = kElectraAcBits,
580  const bool strict = true);
581 #endif
582 #if DECODE_PANASONIC_AC
583  bool decodePanasonicAC(decode_results *results,
584  uint16_t offset = kStartOffset,
585  const uint16_t nbits = kPanasonicAcBits,
586  const bool strict = true);
587 #endif
588 #if DECODE_PIONEER
589  bool decodePioneer(decode_results *results, uint16_t offset = kStartOffset,
590  const uint16_t nbits = kPioneerBits,
591  const bool strict = true);
592 #endif
593 #if DECODE_MWM
594  bool decodeMWM(decode_results *results, uint16_t offset = kStartOffset,
595  const uint16_t nbits = 24,
596  const bool strict = true);
597 #endif
598 #if DECODE_VESTEL_AC
599  bool decodeVestelAc(decode_results *results, uint16_t offset = kStartOffset,
600  const uint16_t nbits = kVestelAcBits,
601  const bool strict = true);
602 #endif
603 #if DECODE_TECO
604  bool decodeTeco(decode_results *results, uint16_t offset = kStartOffset,
605  const uint16_t nbits = kTecoBits,
606  const bool strict = false);
607 #endif
608 #if DECODE_LEGOPF
609  bool decodeLegoPf(decode_results *results, uint16_t offset = kStartOffset,
610  const uint16_t nbits = kLegoPfBits,
611  const bool strict = true);
612 #endif
613 #if DECODE_NEOCLIMA
614  bool decodeNeoclima(decode_results *results, uint16_t offset = kStartOffset,
615  const uint16_t nbits = kNeoclimaBits,
616  const bool strict = true);
617 #endif // DECODE_NEOCLIMA
618 #if DECODE_AMCOR
619  bool decodeAmcor(decode_results *results, uint16_t offset = kStartOffset,
620  const uint16_t nbits = kAmcorBits,
621  const bool strict = true);
622 #endif // DECODE_AMCOR
623 #if DECODE_EPSON
624  bool decodeEpson(decode_results *results, uint16_t offset = kStartOffset,
625  const uint16_t nbits = kEpsonBits,
626  const bool strict = true);
627 #endif // DECODE_EPSON
628 #if DECODE_SYMPHONY
629  bool decodeSymphony(decode_results *results, uint16_t offset = kStartOffset,
630  const uint16_t nbits = kSymphonyBits,
631  const bool strict = true);
632 #endif // DECODE_SYMPHONY
633 #if DECODE_AIRWELL
634  bool decodeAirwell(decode_results *results, uint16_t offset = kStartOffset,
635  const uint16_t nbits = kAirwellBits,
636  const bool strict = true);
637 #endif // DECODE_AIRWELL
638 #if DECODE_DELONGHI_AC
639  bool decodeDelonghiAc(decode_results *results, uint16_t offset = kStartOffset,
640  const uint16_t nbits = kDelonghiAcBits,
641  const bool strict = true);
642 #endif // DECODE_DELONGHI_AC
643 #if DECODE_DOSHISHA
644  bool decodeDoshisha(decode_results *results, uint16_t offset = kStartOffset,
645  const uint16_t nbits = kDoshishaBits,
646  const bool strict = true);
647 #endif // DECODE_DOSHISHA
648 #if DECODE_MULTIBRACKETS
649  bool decodeMultibrackets(decode_results *results,
650  uint16_t offset = kStartOffset,
651  const uint16_t nbits = kMultibracketsBits,
652  const bool strict = true);
653 #endif // DECODE_MULTIBRACKETS
654 #if DECODE_CORONA_AC
655  bool decodeCoronaAc(decode_results *results, uint16_t offset = kStartOffset,
656  const uint16_t nbits = kCoronaAcBitsShort,
657  const bool strict = true);
658 #endif // DECODE_CORONA_AC
659 #if DECODE_ZEPEAL
660 bool decodeZepeal(decode_results *results, uint16_t offset = kStartOffset,
661  const uint16_t nbits = kZepealBits,
662  const bool strict = true);
663 #endif // DECODE_ZEPEAL
664 };
665 
666 #endif // IRRECV_H_
IRrecv::decodeMultibrackets
bool decodeMultibrackets(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kMultibracketsBits, const bool strict=true)
Decode the Multibrackets message. Status: BETA / Appears to be working.
Definition: ir_Multibrackets.cpp:59
kDelonghiAcBits
const uint16_t kDelonghiAcBits
Definition: IRremoteESP8266.h:861
IRrecv::decodeMitsubishi
bool decodeMitsubishi(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kMitsubishiBits, const bool strict=true)
Decode the supplied Mitsubishi 16-bit message. Status: STABLE / Working.
Definition: ir_Mitsubishi.cpp:123
IRrecv::decodeHaierAC
bool decodeHaierAC(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kHaierACBits, const bool strict=true)
Decode the supplied Haier HSU07-HEA03 remote message. Status: STABLE / Known to be working.
Definition: ir_Haier.cpp:993
IRrecv::decodeNEC
bool decodeNEC(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kNECBits, const bool strict=true)
Decode the supplied NEC (Renesas) message. Status: STABLE / Known good.
Definition: ir_NEC.cpp:81
kFnvPrime32
const uint32_t kFnvPrime32
Definition: IRrecv.h:52
decode_results::overflow
bool overflow
Definition: IRrecv.h:109
IRrecv::decodeDaikin128
bool decodeDaikin128(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kDaikin128Bits, const bool strict=true)
Decode the supplied Daikin 128-bit message. (DAIKIN128) Status: STABLE / Known Working.
Definition: ir_Daikin.cpp:3109
kGicableBits
const uint16_t kGicableBits
Definition: IRremoteESP8266.h:879
IRrecv::matchGeneric
uint16_t matchGeneric(volatile uint16_t *data_ptr, uint64_t *result_ptr, const uint16_t remaining, const uint16_t nbits, const uint16_t hdrmark, const uint32_t hdrspace, const uint16_t onemark, const uint32_t onespace, const uint16_t zeromark, const uint32_t zerospace, const uint16_t footermark, const uint32_t footerspace, const bool atleast=false, const uint8_t tolerance=kUseDefTol, const int16_t excess=kMarkExcess, const bool MSBfirst=true)
Match & decode a generic/typical <= 64bit IR message. The data is stored at result_ptr.
Definition: IRrecv.cpp:1268
decode_type_t
decode_type_t
Enumerator for defining and numbering of supported IR protocol.
Definition: IRremoteESP8266.h:714
kCarrierAcBits
const uint16_t kCarrierAcBits
Definition: IRremoteESP8266.h:826
IRrecv::getRClevel
int16_t getRClevel(decode_results *results, uint16_t *offset, uint16_t *used, uint16_t bitTime, const uint8_t tolerance=kUseDefTol, const int16_t excess=kMarkExcess, const uint16_t delta=0, const uint8_t maxwidth=3)
Gets one undecoded level at a time from the raw buffer. The RC5/6 decoding is easier if the data is b...
Definition: ir_RC5_RC6.cpp:243
kMultibracketsBits
const uint16_t kMultibracketsBits
Definition: IRremoteESP8266.h:945
kSharpAcBits
const uint16_t kSharpAcBits
Definition: IRremoteESP8266.h:983
kWhynterBits
const uint16_t kWhynterBits
Definition: IRremoteESP8266.h:1008
irparams_t::overflow
uint8_t overflow
Definition: IRrecv.h:78
IRrecv::decodeMitsubishi2
bool decodeMitsubishi2(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kMitsubishiBits, const bool strict=true)
Decode the supplied second variation of a Mitsubishi 16-bit message. Status: STABLE / Working.
Definition: ir_Mitsubishi.cpp:188
IRrecv::decodeGree
bool decodeGree(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kGreeBits, const bool strict=true)
Decode the supplied Gree HVAC message. Status: STABLE / Working.
Definition: ir_Gree.cpp:673
kAirwellBits
const uint16_t kAirwellBits
Definition: IRremoteESP8266.h:813
IRrecv::irparams_save
irparams_t * irparams_save
Definition: IRrecv.h:151
kMitsubishiACBits
const uint16_t kMitsubishiACBits
Definition: IRremoteESP8266.h:931
IRrecv::decodeFujitsuAC
bool decodeFujitsuAC(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kFujitsuAcBits, const bool strict=false)
Decode the supplied Fujitsu AC IR message if possible. Status: STABLE / Working.
Definition: ir_Fujitsu.cpp:745
IRrecv::decodeTrotec
bool decodeTrotec(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kTrotecBits, const bool strict=true)
Decode the supplied Trotec message. Status: STABLE / Works. Untested on real devices.
Definition: ir_Trotec.cpp:313
IRrecv::decodeNeoclima
bool decodeNeoclima(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kNeoclimaBits, const bool strict=true)
Decode the supplied Neoclima message. Status: STABLE / Known working.
Definition: ir_Neoclima.cpp:548
IRrecv::decodeMitsubishi112
bool decodeMitsubishi112(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kMitsubishi112Bits, const bool strict=true)
Decode the supplied Mitsubishi/TCL 112-bit A/C message. (MITSUBISHI112, TCL112AC) Status: STABLE / Re...
Definition: ir_Mitsubishi.cpp:1216
IRrecv::decodeSamsungAC
bool decodeSamsungAC(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kSamsungAcBits, const bool strict=true)
Decode the supplied Samsung A/C message. Status: Stable / Known to be working.
Definition: ir_Samsung.cpp:781
IRrecv::decodeAirwell
bool decodeAirwell(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kAirwellBits, const bool strict=true)
Decode the supplied Airwell "Manchester code" message.
Definition: ir_Airwell.cpp:50
kRC5XBits
const uint16_t kRC5XBits
Definition: IRremoteESP8266.h:963
IRrecv::decodeMagiQuest
bool decodeMagiQuest(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kMagiquestBits, const bool strict=true)
Decode the supplied MagiQuest message. Status: Beta / Should work.
Definition: ir_Magiquest.cpp:69
irparams_t::rawlen
uint16_t rawlen
Definition: IRrecv.h:77
kUseDefTol
const uint8_t kUseDefTol
Definition: IRrecv.h:36
IRrecv::decodeDelonghiAc
bool decodeDelonghiAc(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kDelonghiAcBits, const bool strict=true)
Decode the supplied Delonghi A/C message. Status: STABLE / Expected to be working.
Definition: ir_Delonghi.cpp:60
IRrecv
Class for receiving IR messages.
Definition: IRrecv.h:114
irparams_t::bufsize
uint16_t bufsize
Definition: IRrecv.h:73
decode_results
Results returned from the decoder.
Definition: IRrecv.h:92
IRrecv::matchGenericConstBitTime
uint16_t matchGenericConstBitTime(volatile uint16_t *data_ptr, uint64_t *result_ptr, const uint16_t remaining, const uint16_t nbits, const uint16_t hdrmark, const uint32_t hdrspace, const uint16_t one, const uint32_t zero, const uint16_t footermark, const uint32_t footerspace, const bool atleast=false, const uint8_t tolerance=kUseDefTol, const int16_t excess=kMarkExcess, const bool MSBfirst=true)
Match & decode a generic/typical constant bit time <= 64bit IR message. The data is stored at result_...
Definition: IRrecv.cpp:1362
IRrecv::decodeCarrierAC64
bool decodeCarrierAC64(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kCarrierAc64Bits, const bool strict=true)
Decode the supplied Carrier 64-bit HVAC message. Status: STABLE / Known to be working.
Definition: ir_Carrier.cpp:197
kCoolixBits
const uint16_t kCoolixBits
Definition: IRremoteESP8266.h:824
IRrecv::decodeArgo
bool decodeArgo(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kArgoBits, const bool strict=true)
Decode the supplied Argo message. Status: BETA / Probably works.
Definition: ir_Argo.cpp:459
kCoronaAcBitsShort
const uint16_t kCoronaAcBitsShort
Definition: IRremoteESP8266.h:834
match_result_t::data
uint64_t data
Definition: IRrecv.h:85
kSamsung36Bits
const uint16_t kSamsung36Bits
Definition: IRremoteESP8266.h:968
kMagiquestBits
const uint16_t kMagiquestBits
Definition: IRremoteESP8266.h:921
irparams_t::rawbuf
uint16_t * rawbuf
Definition: IRrecv.h:74
irparams_t
Information for the interrupt handler.
Definition: IRrecv.h:69
IRrecv::getBufSize
uint16_t getBufSize(void)
Obtain the maximum number of entries possible in the capture buffer. i.e. It's size.
Definition: IRrecv.cpp:319
kSanyoLC7461Bits
const uint16_t kSanyoLC7461Bits
Definition: IRremoteESP8266.h:977
IRrecv::decodeToshibaAC
bool decodeToshibaAC(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbytes=kToshibaACBits, const bool strict=true)
Decode the supplied Toshiba A/C message. Status: STABLE / Working.
Definition: ir_Toshiba.cpp:322
decode_results::repeat
bool repeat
Definition: IRrecv.h:110
IRrecv::decodeHitachiAC
bool decodeHitachiAC(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kHitachiAcBits, const bool strict=true, const bool MSBfirst=true)
Decode the supplied Hitachi A/C message. Status: STABLE / Expected to work.
Definition: ir_Hitachi.cpp:868
kTrotecBits
const uint16_t kTrotecBits
Definition: IRremoteESP8266.h:1003
IRrecv::decodeVestelAc
bool decodeVestelAc(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kVestelAcBits, const bool strict=true)
Decode the supplied Vestel message. Status: Alpha / Needs testing against a real device.
Definition: ir_Vestel.cpp:572
kIdleState
const uint8_t kIdleState
Definition: IRrecv.h:31
IRrecv::decodeAmcor
bool decodeAmcor(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kAmcorBits, const bool strict=true)
Decode the supplied Amcor HVAC message. Status: STABLE / Reported as working.
Definition: ir_Amcor.cpp:59
IRrecv::decodeDaikin
bool decodeDaikin(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kDaikinBits, const bool strict=true)
Decode the supplied Daikin 280-bit message. (DAIKIN) Status: STABLE / Reported as working.
Definition: ir_Daikin.cpp:619
irparams_t::recvpin
uint8_t recvpin
Definition: IRrecv.h:70
irparams_t::timer
uint16_t timer
Definition: IRrecv.h:72
IRrecv::decodeDaikin64
bool decodeDaikin64(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kDaikin64Bits, const bool strict=true)
Decode the supplied Daikin 64-bit message. (DAIKIN64) Status: Beta / Probably Working.
Definition: ir_Daikin.cpp:3591
match_result_t::success
bool success
Definition: IRrecv.h:84
IRrecv::decodeDaikin2
bool decodeDaikin2(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kDaikin2Bits, const bool strict=true)
Decode the supplied Daikin 312-bit message. (DAIKIN2) Status: STABLE / Works as expected.
Definition: ir_Daikin.cpp:1415
kElectraAcBits
const uint16_t kElectraAcBits
Definition: IRremoteESP8266.h:872
IRrecv::matchSpace
bool matchSpace(const uint32_t measured, const uint32_t desired, const uint8_t tolerance=kUseDefTol, const int16_t excess=kMarkExcess)
Check if we match a space signal(measured) with the desired within +/-tolerance percent,...
Definition: IRrecv.cpp:1000
kSonyMinBits
const uint16_t kSonyMinBits
Definition: IRremoteESP8266.h:990
kStopState
const uint8_t kStopState
Definition: IRrecv.h:34
decode_results::rawlen
uint16_t rawlen
Definition: IRrecv.h:108
kMaxTimeoutMs
const uint16_t kMaxTimeoutMs
Definition: IRrecv.h:49
kDaikin2Bits
const uint16_t kDaikin2Bits
Definition: IRremoteESP8266.h:842
IRrecv::decodePanasonic
bool decodePanasonic(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kPanasonicBits, const bool strict=false, const uint32_t manufacturer=kPanasonicManufacturer)
Decode the supplied Panasonic message. Status: STABLE / Should be working.
Definition: ir_Panasonic.cpp:130
kHitachiAc1Bits
const uint16_t kHitachiAc1Bits
Definition: IRremoteESP8266.h:896
IRrecv::decodeElectraAC
bool decodeElectraAC(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kElectraAcBits, const bool strict=true)
Decode the supplied Electra A/C message. Status: STABLE / Known working.
Definition: ir_Electra.cpp:377
IRrecv::decodeDaikin216
bool decodeDaikin216(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kDaikin216Bits, const bool strict=true)
Decode the supplied Daikin 216-bit message. (DAIKIN216) Status: STABLE / Should be working.
Definition: ir_Daikin.cpp:1789
IRrecv::decodeDaikin152
bool decodeDaikin152(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kDaikin152Bits, const bool strict=true)
Decode the supplied Daikin 152-bit message. (DAIKIN152) Status: STABLE / Known Working.
Definition: ir_Daikin.cpp:3198
IRrecv::decodeDenon
bool decodeDenon(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kDenonBits, const bool strict=true)
Decode the supplied Delonghi A/C message. Status: STABLE / Should work fine.
Definition: ir_Denon.cpp:70
kPanasonicBits
const uint16_t kPanasonicBits
Definition: IRremoteESP8266.h:952
IRrecv::decodeSanyoLC7461
bool decodeSanyoLC7461(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kSanyoLC7461Bits, bool strict=true)
Decode the supplied SANYO LC7461 message. Status: BETA / Probably works.
Definition: ir_Sanyo.cpp:117
decode_results::decode_type
decode_type_t decode_type
Definition: IRrecv.h:94
kPanasonicAcBits
const uint16_t kPanasonicAcBits
Definition: IRremoteESP8266.h:956
kRepeat
const uint64_t kRepeat
Definition: IRrecv.h:26
IRrecv::setTolerance
void setTolerance(const uint8_t percent=kTolerance)
Set the base tolerance percentage for matching incoming IR messages.
Definition: IRrecv.cpp:332
IRrecv::decodeMidea
bool decodeMidea(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kMideaBits, const bool strict=true)
Decode the supplied Midea message. Status: Alpha / Needs testing against a real device.
Definition: ir_Midea.cpp:415
kDaikin160Bits
const uint16_t kDaikin160Bits
Definition: IRremoteESP8266.h:847
IRrecv::copyIrParams
void copyIrParams(volatile irparams_t *src, irparams_t *dst)
Make a copy of the interrupt state & buffer data. Needed because irparams is marked as volatile,...
Definition: IRrecv.cpp:295
IRrecv::decodeKelvinator
bool decodeKelvinator(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kKelvinatorBits, const bool strict=true)
Decode the supplied Kelvinator message. Status: STABLE / Known working.
Definition: ir_Kelvinator.cpp:489
kGoodweatherBits
const uint16_t kGoodweatherBits
Definition: IRremoteESP8266.h:881
IRrecv::decodeMWM
bool decodeMWM(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=24, const bool strict=true)
Decode the supplied MWM message. Status: Implemented.
Definition: ir_MWM.cpp:81
IRrecv::enableIRIn
void enableIRIn(const bool pullup=false)
Set up and (re)start the IR capture mechanism.
Definition: IRrecv.cpp:228
kDaikin152Bits
const uint16_t kDaikin152Bits
Definition: IRremoteESP8266.h:853
IRrecv::decodePanasonicAC
bool decodePanasonicAC(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kPanasonicAcBits, const bool strict=true)
Decode the supplied Panasonic AC message. Status: STABLE / Works with real device(s).
Definition: ir_Panasonic.cpp:879
IRrecv::decodeDoshisha
bool decodeDoshisha(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kDoshishaBits, const bool strict=true)
Decode the supplied Doshisha message. Status: STABLE / Works on real device.
Definition: ir_Doshisha.cpp:85
IRrecv::decodeZepeal
bool decodeZepeal(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kZepealBits, const bool strict=true)
Decode the supplied Zepeal message. Status: STABLE / Works on real device.
Definition: ir_Zepeal.cpp:67
IRrecv::decodeDaikin160
bool decodeDaikin160(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kDaikin160Bits, const bool strict=true)
Decode the supplied Daikin 160-bit message. (DAIKIN160) Status: STABLE / Confirmed working.
Definition: ir_Daikin.cpp:2162
IRrecv::decodeLasertag
bool decodeLasertag(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kLasertagBits, const bool strict=true)
Decode the supplied Lasertag message. Status: BETA / Appears to be working 90% of the time.
Definition: ir_Lasertag.cpp:70
IRremoteESP8266.h
kTimeoutMs
const uint8_t kTimeoutMs
Definition: IRrecv.h:47
IRrecv::_matchGeneric
uint16_t _matchGeneric(volatile uint16_t *data_ptr, uint64_t *result_bits_ptr, uint8_t *result_ptr, const bool use_bits, const uint16_t remaining, const uint16_t required, const uint16_t hdrmark, const uint32_t hdrspace, const uint16_t onemark, const uint32_t onespace, const uint16_t zeromark, const uint32_t zerospace, const uint16_t footermark, const uint32_t footerspace, const bool atleast=false, const uint8_t tolerance=kUseDefTol, const int16_t excess=kMarkExcess, const bool MSBfirst=true)
Match & decode a generic/typical IR message. The data is stored in result_bits_ptr or result_bytes_pt...
Definition: IRrecv.cpp:1168
kMarkState
const uint8_t kMarkState
Definition: IRrecv.h:32
IRrecv::setUnknownThreshold
void setUnknownThreshold(const uint16_t length)
Set the minimum length we will consider for reporting UNKNOWN message types.
Definition: IRrecv.cpp:324
kSymphonyBits
const uint16_t kSymphonyBits
Definition: IRremoteESP8266.h:992
kRC6Mode0Bits
const uint16_t kRC6Mode0Bits
Definition: IRremoteESP8266.h:964
kStateSizeMax
const uint16_t kStateSizeMax
Definition: IRrecv.h:60
match_result_t
Results from a data match.
Definition: IRrecv.h:83
irparams_t::rcvstate
uint8_t rcvstate
Definition: IRrecv.h:71
IRrecv::decodeRC6
bool decodeRC6(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kRC6Mode0Bits, const bool strict=false)
Decode the supplied RC6 message. Status: Stable.
Definition: ir_RC5_RC6.cpp:383
IRrecv::decodeRC5
bool decodeRC5(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kRC5XBits, const bool strict=true)
Decode the supplied RC-5/RC5X message. Status: RC-5 (stable), RC-5X (alpha)
Definition: ir_RC5_RC6.cpp:309
IRrecv::~IRrecv
~IRrecv(void)
Class destructor Cleans up after the object is no longer needed. e.g. Frees up all memory used by the...
Definition: IRrecv.cpp:213
IRrecv::decodeHitachiAc3
bool decodeHitachiAc3(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kHitachiAc3Bits, const bool strict=true)
Decode the supplied Hitachi 15to27-byte/120to216-bit A/C message. Status: STABLE / Works fine.
Definition: ir_Hitachi.cpp:1456
IRrecv::decodeWhynter
bool decodeWhynter(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kWhynterBits, const bool strict=true)
Decode the supplied Whynter message. Status: STABLE / Working. Strict mode is ALPHA.
Definition: ir_Whynter.cpp:74
IRrecv::decodeCarrierAC
bool decodeCarrierAC(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kCarrierAcBits, const bool strict=true)
Decode the supplied Carrier HVAC message.
Definition: ir_Carrier.cpp:84
IRrecv::matchData
match_result_t matchData(volatile uint16_t *data_ptr, const uint16_t nbits, const uint16_t onemark, const uint32_t onespace, const uint16_t zeromark, const uint32_t zerospace, const uint8_t tolerance=kUseDefTol, const int16_t excess=kMarkExcess, const bool MSBfirst=true)
Match & decode the typical data section of an IR message. The data value is stored in the least signi...
Definition: IRrecv.cpp:1076
kMitsubishiHeavy152Bits
const uint16_t kMitsubishiHeavy152Bits
Definition: IRremoteESP8266.h:943
kDoshishaBits
const uint16_t kDoshishaBits
Definition: IRremoteESP8266.h:868
kCarrierAc40Bits
const uint16_t kCarrierAc40Bits
Definition: IRremoteESP8266.h:828
kStartOffset
const uint16_t kStartOffset
Definition: IRrecv.h:20
kAmcorBits
const uint16_t kAmcorBits
Definition: IRremoteESP8266.h:819
IRrecv::decodeRCMM
bool decodeRCMM(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kRCMMBits, const bool strict=false)
Decode a Philips RC-MM packet (between 12 & 32 bits) if possible. Status: STABLE / Should be working.
Definition: ir_RCMM.cpp:96
IRrecv::IRrecv
IRrecv(const uint16_t recvpin, const uint16_t bufsize=kRawBuf, const uint8_t timeout=kTimeoutMs, const bool save_buffer=false, const uint8_t timer_num=kDefaultESP32Timer)
Class constructor Args:
Definition: IRrecv.cpp:152
IRrecv::decodeMitsubishi136
bool decodeMitsubishi136(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kMitsubishi136Bits, const bool strict=true)
Decode the supplied Mitsubishi 136-bit A/C message. (MITSUBISHI136) Status: STABLE / Reported as work...
Definition: ir_Mitsubishi.cpp:835
decode_results::rawbuf
volatile uint16_t * rawbuf
Definition: IRrecv.h:107
kTolerance
const uint8_t kTolerance
Definition: IRrecv.h:35
IRrecv::decodeSharp
bool decodeSharp(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kSharpBits, const bool strict=true, const bool expansion=true)
Decode the supplied Sharp message. Status: STABLE / Working fine.
Definition: ir_Sharp.cpp:156
match_result_t::used
uint16_t used
Definition: IRrecv.h:86
kPanasonicManufacturer
const uint32_t kPanasonicManufacturer
Definition: IRremoteESP8266.h:953
decode_results::address
uint32_t address
Definition: IRrecv.h:101
IRrecv::decodeNikai
bool decodeNikai(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kNikaiBits, const bool strict=true)
Decode the supplied Nikai message. Status: STABLE / Working.
Definition: ir_Nikai.cpp:52
kMitsubishiBits
const uint16_t kMitsubishiBits
Definition: IRremoteESP8266.h:926
IRrecv::match
bool match(const uint32_t measured, const uint32_t desired, const uint8_t tolerance=kUseDefTol, const uint16_t delta=0)
Check if we match a pulse(measured) with the desired within +/-tolerance percent and/or +/- a fixed d...
Definition: IRrecv.cpp:908
IRrecv::decodeSymphony
bool decodeSymphony(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kSymphonyBits, const bool strict=true)
Decode the supplied Symphony packet/message. Status: STABLE / Should be working.
Definition: ir_Symphony.cpp:60
kSamsungAcBits
const uint16_t kSamsungAcBits
Definition: IRremoteESP8266.h:970
kUnknownThreshold
const uint16_t kUnknownThreshold
Definition: IRrecv.h:28
kMideaBits
const uint16_t kMideaBits
Definition: IRremoteESP8266.h:922
IRrecv::decodeAiwaRCT501
bool decodeAiwaRCT501(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kAiwaRcT501Bits, const bool strict=true)
Decode the supplied Aiwa RC T501 message. Status: BETA / Should work.
Definition: ir_Aiwa.cpp:61
kKelvinatorBits
const uint16_t kKelvinatorBits
Definition: IRremoteESP8266.h:911
IRrecv::decodeGICable
bool decodeGICable(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kGicableBits, const bool strict=true)
Decode the supplied G.I. Cable message. Status: Alpha / Not tested against a real device.
Definition: ir_GICable.cpp:63
IRrecv::decodeTeco
bool decodeTeco(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kTecoBits, const bool strict=false)
Decode the supplied Teco message. Status: STABLE / Tested.
Definition: ir_Teco.cpp:365
IRrecv::decodeCarrierAC40
bool decodeCarrierAC40(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kCarrierAc40Bits, const bool strict=true)
Decode the supplied Carrier 40-bit HVAC message. Carrier HVAC messages contain only 40 bits,...
Definition: ir_Carrier.cpp:149
kNECBits
const uint16_t kNECBits
Definition: IRremoteESP8266.h:948
kDenonBits
const uint16_t kDenonBits
Definition: IRremoteESP8266.h:863
kHaierACBits
const uint16_t kHaierACBits
Definition: IRremoteESP8266.h:887
IRrecv::matchAtLeast
bool matchAtLeast(const uint32_t measured, const uint32_t desired, const uint8_t tolerance=kUseDefTol, const uint16_t delta=0)
Check if we match a pulse(measured) of at least desired within tolerance percent and/or a fixed delta...
Definition: IRrecv.cpp:939
kZepealBits
const uint16_t kZepealBits
Definition: IRremoteESP8266.h:1010
kMidea24Bits
const uint16_t kMidea24Bits
Definition: IRremoteESP8266.h:924
IRrecv::decodeDaikin176
bool decodeDaikin176(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kDaikin176Bits, const bool strict=true)
Decode the supplied Daikin 176-bit message. (DAIKIN176) Status: STABLE / Expected to work.
Definition: ir_Daikin.cpp:2553
kNeoclimaBits
const uint16_t kNeoclimaBits
Definition: IRremoteESP8266.h:950
kWhirlpoolAcBits
const uint16_t kWhirlpoolAcBits
Definition: IRremoteESP8266.h:1006
IRrecv::decodeSharpAc
bool decodeSharpAc(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kSharpAcBits, const bool strict=true)
Decode the supplied Sharp A/C message. Status: STABLE / Known working.
Definition: ir_Sharp.cpp:723
IRrecv::decodeJVC
bool decodeJVC(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kJvcBits, const bool strict=true)
Decode the supplied JVC message. Status: Stable / Known working.
Definition: ir_JVC.cpp:94
IRrecv::decodeMitsubishiAC
bool decodeMitsubishiAC(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kMitsubishiACBits, const bool strict=false)
Decode the supplied Mitsubish 144-bit A/C message. Status: BETA / Probably works.
Definition: ir_Mitsubishi.cpp:254
kCarrierAc64Bits
const uint16_t kCarrierAc64Bits
Definition: IRremoteESP8266.h:830
kPioneerBits
const uint16_t kPioneerBits
Definition: IRremoteESP8266.h:959
decode_results::bits
uint16_t bits
Definition: IRrecv.h:106
kGreeBits
const uint16_t kGreeBits
Definition: IRremoteESP8266.h:884
kJvcBits
const uint16_t kJvcBits
Definition: IRremoteESP8266.h:909
kLasertagBits
const uint16_t kLasertagBits
Definition: IRremoteESP8266.h:913
kDaikin128Bits
const uint16_t kDaikin128Bits
Definition: IRremoteESP8266.h:850
kAiwaRcT501Bits
const uint16_t kAiwaRcT501Bits
Definition: IRremoteESP8266.h:815
IRrecv::ticksLow
uint32_t ticksLow(const uint32_t usecs, const uint8_t tolerance=kUseDefTol, const uint16_t delta=0)
Calculate the lower bound of the nr. of ticks.
Definition: IRrecv.cpp:882
kTecoBits
const uint16_t kTecoBits
Definition: IRremoteESP8266.h:997
IRrecv::decodeEpson
bool decodeEpson(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kEpsonBits, const bool strict=true)
Decode the supplied Epson message. Status: Beta / Probably works.
Definition: ir_Epson.cpp:45
kToshibaACBits
const uint16_t kToshibaACBits
Definition: IRremoteESP8266.h:1000
IRrecv::decodeSony
bool decodeSony(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kSonyMinBits, const bool strict=false)
Decode the supplied Sony/SIRC message. Status: STABLE / Should be working. strict mode is ALPHA / Unt...
Definition: ir_Sony.cpp:121
kDaikinBits
const uint16_t kDaikinBits
Definition: IRremoteESP8266.h:837
IRrecv::matchMark
bool matchMark(const uint32_t measured, const uint32_t desired, const uint8_t tolerance=kUseDefTol, const int16_t excess=kMarkExcess)
Check if we match a mark signal(measured) with the desired within +/-tolerance percent,...
Definition: IRrecv.cpp:981
kHitachiAcBits
const uint16_t kHitachiAcBits
Definition: IRremoteESP8266.h:893
kHitachiAc3Bits
const uint16_t kHitachiAc3Bits
Definition: IRremoteESP8266.h:900
kRawBuf
const uint16_t kRawBuf
Definition: IRrecv.h:25
IRrecv::decode
bool decode(decode_results *results, irparams_t *save=NULL, uint8_t max_skip=0, uint16_t noise_floor=0)
Decodes the received IR message. If the interrupt state is saved, we will immediately resume waiting ...
Definition: IRrecv.cpp:409
IRrecv::decodePioneer
bool decodePioneer(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kPioneerBits, const bool strict=true)
Decode the supplied Pioneer message. Status: STABLE / Should be working. (Self decodes & real example...
Definition: ir_Pioneer.cpp:96
IRrecv::getTolerance
uint8_t getTolerance(void)
Get the base tolerance percentage for matching incoming IR messages.
Definition: IRrecv.cpp:338
kDishBits
const uint16_t kDishBits
Definition: IRremoteESP8266.h:866
IRrecv::compare
uint16_t compare(const uint16_t oldval, const uint16_t newval)
Compare two tick values.
Definition: IRrecv.cpp:1018
decode_results::command
uint32_t command
Definition: IRrecv.h:102
kFujitsuAcBits
const uint16_t kFujitsuAcBits
Definition: IRremoteESP8266.h:877
decode_results::value
uint64_t value
Definition: IRrecv.h:100
kArgoBits
const uint16_t kArgoBits
Definition: IRremoteESP8266.h:822
kHitachiAc2StateLength
const uint16_t kHitachiAc2StateLength
Definition: IRremoteESP8266.h:897
IRrecv::decodeSamsung36
bool decodeSamsung36(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kSamsung36Bits, const bool strict=true)
Decode the supplied Samsung36 message. Status: Alpha / Experimental.
Definition: ir_Samsung.cpp:186
kFooter
const uint16_t kFooter
Definition: IRrecv.h:19
kNikaiBits
const uint16_t kNikaiBits
Definition: IRremoteESP8266.h:947
kLutronBits
const uint16_t kLutronBits
Definition: IRremoteESP8266.h:920
irparams_t::timeout
uint8_t timeout
Definition: IRrecv.h:79
IRrecv::decodeCoronaAc
bool decodeCoronaAc(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kCoronaAcBitsShort, const bool strict=true)
Decode the supplied CoronaAc message. Status: STABLE / Appears to be working.
Definition: ir_Corona.cpp:89
IRrecv::decodeLutron
bool decodeLutron(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kLutronBits, const bool strict=true)
Decode the supplied Lutron message. Status: STABLE / Working.
Definition: ir_Lutron.cpp:65
IRrecv::decodeDISH
bool decodeDISH(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kDishBits, const bool strict=true)
Decode the supplied DISH NETWORK message. Status: ALPHA (untested and unconfirmed....
Definition: ir_Dish.cpp:77
kRawTick
const uint16_t kRawTick
Definition: IRrecv.h:37
IRrecv::matchManchesterData
uint16_t matchManchesterData(volatile const uint16_t *data_ptr, uint64_t *result_ptr, const uint16_t remaining, const uint16_t nbits, const uint16_t half_period, const uint16_t starting_balance=0, const uint8_t tolerance=kUseDefTol, const int16_t excess=kMarkExcess, const bool MSBfirst=true, const bool GEThomas=true)
Match & decode a Manchester Code data (<= 64bits.
Definition: IRrecv.cpp:1556
IRrecv::resume
void resume(void)
Resume collection of received IR data.
Definition: IRrecv.cpp:280
kHaierACYRW02Bits
const uint16_t kHaierACYRW02Bits
Definition: IRremoteESP8266.h:890
kHitachiAc424Bits
const uint16_t kHitachiAc424Bits
Definition: IRremoteESP8266.h:906
IRrecv::decodeWhirlpoolAC
bool decodeWhirlpoolAC(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kWhirlpoolAcBits, const bool strict=true)
Decode the supplied Whirlpool A/C message. Status: STABLE / Working as intended.
Definition: ir_Whirlpool.cpp:642
kMarkExcess
const uint16_t kMarkExcess
Definition: IRrecv.h:24
IRrecv::decodeHaierACYRW02
bool decodeHaierACYRW02(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kHaierACYRW02Bits, const bool strict=true)
Decode the supplied Haier YR-W02 remote A/C message. Status: BETA / Appears to be working.
Definition: ir_Haier.cpp:1039
IRrecv::decodeLG
bool decodeLG(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kLgBits, const bool strict=false)
Decode the supplied LG message. Status: STABLE / Working.
Definition: ir_LG.cpp:154
IRrecv::decodeCOOLIX
bool decodeCOOLIX(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kCoolixBits, const bool strict=true)
Decode the supplied Coolix A/C message. Status: STABLE / Known Working.
Definition: ir_Coolix.cpp:650
kLegoPfBits
const uint16_t kLegoPfBits
Definition: IRremoteESP8266.h:915
kSharpBits
const uint16_t kSharpBits
Definition: IRremoteESP8266.h:981
IRrecv::decodeGoodweather
bool decodeGoodweather(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kGoodweatherBits, const bool strict=true)
Decode the supplied Goodweather message. Status: BETA / Probably works.
Definition: ir_Goodweather.cpp:429
IRrecv::_tolerance
uint8_t _tolerance
Definition: IRrecv.h:152
kDefaultESP32Timer
const uint8_t kDefaultESP32Timer
Definition: IRrecv.h:56
IRrecv::matchManchester
uint16_t matchManchester(volatile const uint16_t *data_ptr, uint64_t *result_ptr, const uint16_t remaining, const uint16_t nbits, const uint16_t hdrmark, const uint32_t hdrspace, const uint16_t clock_period, const uint16_t footermark, const uint32_t footerspace, const bool atleast=false, const uint8_t tolerance=kUseDefTol, const int16_t excess=kMarkExcess, const bool MSBfirst=true, const bool GEThomas=true)
Match & decode a Manchester Code <= 64bit IR message. The data is stored at result_ptr.
Definition: IRrecv.cpp:1449
IRrecv::decodeInax
bool decodeInax(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kInaxBits, const bool strict=true)
Decode the supplied Inax Toilet message. Status: Stable / Known working.
Definition: ir_Inax.cpp:51
IRrecv::crudeNoiseFilter
void crudeNoiseFilter(decode_results *results, const uint16_t floor=0)
Remove or merge pulses in the capture buffer that are too short.
Definition: IRrecv.cpp:345
IRrecv::decodeHitachiAC1
bool decodeHitachiAC1(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kHitachiAc1Bits, const bool strict=true)
IRrecv::decodeSAMSUNG
bool decodeSAMSUNG(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kSamsungBits, const bool strict=true)
Decode the supplied Samsung 32-bit message. Status: STABLE.
Definition: ir_Samsung.cpp:112
IRrecv::decodeLegoPf
bool decodeLegoPf(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kLegoPfBits, const bool strict=true)
Decode the supplied LEGO Power Functions message. Status: STABLE / Appears to work.
Definition: ir_Lego.cpp:71
kRCMMBits
const uint16_t kRCMMBits
Definition: IRremoteESP8266.h:966
kVestelAcBits
const uint8_t kVestelAcBits
Definition: IRremoteESP8266.h:1009
kInaxBits
const uint16_t kInaxBits
Definition: IRremoteESP8266.h:907
IRrecv::decodeMitsubishiHeavy
bool decodeMitsubishiHeavy(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kMitsubishiHeavy152Bits, const bool strict=true)
Decode the supplied Mitsubishi Heavy Industries A/C message. Status: BETA / Appears to be working....
Definition: ir_MitsubishiHeavy.cpp:1121
IRrecv::_unknown_threshold
uint16_t _unknown_threshold
Definition: IRrecv.h:157
kDaikin176Bits
const uint16_t kDaikin176Bits
Definition: IRremoteESP8266.h:856
IRrecv::decodeMidea24
bool decodeMidea24(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kMidea24Bits, const bool strict=true)
Decode the supplied Midea24 message. Status: STABLE / Confirmed working on a real device.
Definition: ir_Midea.cpp:506
IRrecv::disableIRIn
void disableIRIn(void)
Stop collection of any received IR data. Disable any timers and interrupts.
Definition: IRrecv.cpp:264
IRrecv::decodeHitachiAc424
bool decodeHitachiAc424(decode_results *results, uint16_t offset=kStartOffset, const uint16_t nbits=kHitachiAc424Bits, const bool strict=true)
Decode the supplied Hitachi 53-byte/424-bit A/C message. Status: STABLE / Reported as working.
Definition: ir_Hitachi.cpp:981
IRrecv::ticksHigh
uint32_t ticksHigh(const uint32_t usecs, const uint8_t tolerance=kUseDefTol, const uint16_t delta=0)
Calculate the upper bound of the nr. of ticks.
Definition: IRrecv.cpp:895
kSamsungBits
const uint16_t kSamsungBits
Definition: IRremoteESP8266.h:967
IRrecv::_timer_num
uint8_t _timer_num
Definition: IRrecv.h:154
kDaikin64Bits
const uint16_t kDaikin64Bits
Definition: IRremoteESP8266.h:844
kDaikin216Bits
const uint16_t kDaikin216Bits
Definition: IRremoteESP8266.h:859
kMitsubishi136Bits
const uint16_t kMitsubishi136Bits
Definition: IRremoteESP8266.h:934
IRrecv::matchBytes
uint16_t matchBytes(volatile uint16_t *data_ptr, uint8_t *result_ptr, const uint16_t remaining, const uint16_t nbytes, const uint16_t onemark, const uint32_t onespace, const uint16_t zeromark, const uint32_t zerospace, const uint8_t tolerance=kUseDefTol, const int16_t excess=kMarkExcess, const bool MSBfirst=true)
Match & decode the typical data section of an IR message. The bytes are stored at result_ptr....
Definition: IRrecv.cpp:1118
kMitsubishi112Bits
const uint16_t kMitsubishi112Bits
Definition: IRremoteESP8266.h:937
kEpsonBits
const uint16_t kEpsonBits
Definition: IRremoteESP8266.h:869
decode_results::state
uint8_t state[kStateSizeMax]
Definition: IRrecv.h:104
IRrecv::decodeHash
bool decodeHash(decode_results *results)
Decode any arbitrary IR message into a 32-bit code value. Instead of decoding using a standard encodi...
Definition: IRrecv.cpp:1039
kSpaceState
const uint8_t kSpaceState
Definition: IRrecv.h:33
kLgBits
const uint16_t kLgBits
Definition: IRremoteESP8266.h:917
IRrecv::_validTolerance
uint8_t _validTolerance(const uint8_t percentage)
Convert the tolerance percentage into something valid.
Definition: IRrecv.cpp:873
kHeader
const uint16_t kHeader
Definition: IRrecv.h:18
kFnvBasis32
const uint32_t kFnvBasis32
Definition: IRrecv.h:53