Initial support for York AC protocol (#1889)

The protocol is known to almost every detail, checksum is calculated properly.
Some basic tests have been added.

Setting the sleep timer, scheduled power on, scheduled power off do not work
since there are some flags within byte 12 which is not correctly populated ATM.

Co-authored-by: David Conran <[email protected]>

Author: danielegobbetti

src/IRac.cpp

@@ -362,6 +362,9 @@ bool IRac::isProtocolSupported(const decode_type_t protocol) {
 #endif
 #if SEND_VOLTAS
     case decode_type_t::VOLTAS:
+#endif
+#if SEND_YORK
+    case decode_type_t::YORK:
 #endif
     case decode_type_t::WHIRLPOOL_AC:
       return true;
@@ -4493,6 +4496,13 @@ namespace IRAcUtils {
         return ac.toString();
       }
 #endif  // DECODE_WHIRLPOOL_AC
+#if DECODE_YORK
+      case decode_type_t::YORK: {
+        IRYorkAc ac(kGpioUnused);
+        ac.setRaw(result->state);
+        return ac.toString();
+      }
+#endif  // DECODE_YORK
       default:
         return "";
     }
@@ -5029,6 +5039,14 @@ namespace IRAcUtils {
         break;
       }
 #endif  // DECODE_WHIRLPOOL_AC
+#if DECODE_YORK
+      case decode_type_t::YORK: {
+        IRYorkAc ac(kGpioUnused);
+        ac.setRaw(decode->state);
+        *result = ac.toCommon(prev);
+        break;
+      }
+#endif  // DECODE_YORK
       default:
         return false;
     }

src/IRac.h

@@ -49,6 +49,7 @@
 #include "ir_Vestel.h"
 #include "ir_Voltas.h"
 #include "ir_Whirlpool.h"
+#include "ir_York.h"
 
 // Constants
 const int8_t kGpioUnused = -1;  ///< A placeholder for not using an actual GPIO.

src/IRrecv.cpp

@@ -1177,6 +1177,10 @@ bool IRrecv::decode(decode_results *results, irparams_t *save,
     DPRINTLN("Attempting Carrier A/C 84-bit decode");
     if (decodeCarrierAC84(results, offset)) return true;
 #endif  // DECODE_CARRIER_AC84
+#if DECODE_YORK
+    DPRINTLN("Attempting York decode");
+    if (decodeYork(results, offset, kYorkBits)) return true;
+#endif  // DECODE_YORK
   // Typically new protocols are added above this line.
   }
 #if DECODE_HASH

src/IRrecv.h

@@ -877,6 +877,12 @@ class IRrecv {
                     const uint16_t nbits = kWowweeBits,
                     const bool strict = true);
 #endif  // DECODE_WOWWEE
+#if DECODE_YORK
+  bool decodeYork(decode_results *results,
+                  uint16_t kStartOffset,
+                  const uint16_t kYorkBits,
+                  const bool strict = true);
+#endif  // DECODE_YORK
 };
 
 #endif  // IRRECV_H_

src/IRremoteESP8266.h

@@ -945,6 +945,13 @@
 #define SEND_CARRIER_AC84   _IR_ENABLE_DEFAULT_
 #endif  // SEND_CARRIER_AC84
 
+#ifndef DECODE_YORK
+#define DECODE_YORK         _IR_ENABLE_DEFAULT_
+#endif  // DECODE_YORK
+#ifndef SEND_YORK
+#define SEND_YORK           _IR_ENABLE_DEFAULT_
+#endif  // SEND_YORK
+
 #if (DECODE_ARGO || DECODE_DAIKIN || DECODE_FUJITSU_AC || DECODE_GREE || \
      DECODE_KELVINATOR || DECODE_MITSUBISHI_AC || DECODE_TOSHIBA_AC || \
      DECODE_TROTEC || DECODE_HAIER_AC || DECODE_HITACHI_AC || \
@@ -963,7 +970,7 @@
      DECODE_KELON168 || DECODE_HITACHI_AC296 || DECODE_CARRIER_AC128 || \
      DECODE_DAIKIN200 || DECODE_HAIER_AC160 || DECODE_TCL96AC || \
      DECODE_BOSCH144 || DECODE_SANYO_AC152 || DECODE_DAIKIN312 || \
-     DECODE_CARRIER_AC84 || \
+     DECODE_CARRIER_AC84 || DECODE_YORK || \
      false)
   // Add any DECODE to the above if it uses result->state (see kStateSizeMax)
   // you might also want to add the protocol to hasACState function
@@ -1129,8 +1136,9 @@ enum decode_type_t {
   GORENJE,
   WOWWEE,
   CARRIER_AC84,  // 125
+  YORK,
   // Add new entries before this one, and update it to point to the last entry.
-  kLastDecodeType = CARRIER_AC84,
+  kLastDecodeType = YORK,
 };
 
 // Message lengths & required repeat values
@@ -1423,6 +1431,8 @@ const uint16_t kRhossStateLength = 12;
 const uint16_t kRhossBits = kRhossStateLength * 8;
 const uint16_t kRhossDefaultRepeat = 0;
 const uint16_t kClimaButlerBits = 52;
+const uint16_t kYorkBits = 136;
+const uint16_t kYorkStateLength = 17;
 
 
 // Legacy defines. (Deprecated)

src/IRsend.cpp

@@ -796,6 +796,8 @@ uint16_t IRsend::defaultBits(const decode_type_t protocol) {
       return kWhirlpoolAcBits;
     case XMP:
       return kXmpBits;
+    case YORK:
+      return kYorkBits;
     // No default amount of bits.
     case FUJITSU_AC:
     case MWM:
@@ -1427,6 +1429,11 @@ bool IRsend::send(const decode_type_t type, const uint8_t *state,
       sendWhirlpoolAC(state, nbytes);
       break;
 #endif  // SEND_WHIRLPOOL_AC
+#if SEND_YORK
+    case YORK:
+      sendYork(state, nbytes);
+      break;
+#endif  // SEND_YORK
     default:
       return false;
   }

src/IRsend.h

@@ -879,6 +879,11 @@ class IRsend {
   void sendWowwee(const uint64_t data, const uint16_t nbits = kWowweeBits,
                   const uint16_t repeat = kWowweeDefaultRepeat);
 #endif  // SEND_WOWWEE
+#if SEND_YORK
+  void sendYork(const unsigned char data[],
+                    const uint16_t nbytes = kYorkStateLength,
+                    const uint16_t repeat = kNoRepeat);
+#endif  // SEND_YORK
 
  protected:
 #ifdef UNIT_TEST

src/IRtext.cpp

@@ -553,6 +553,8 @@ IRTEXT_CONST_BLOB_DECL(kAllProtocolNamesStr) {
             D_STR_WOWWEE, D_STR_UNSUPPORTED) "\x0"
     COND(DECODE_CARRIER_AC84 || SEND_CARRIER_AC84,
             D_STR_CARRIER_AC84, D_STR_UNSUPPORTED) "\x0"
+    COND(DECODE_YORK || SEND_YORK,
+            D_STR_YORK, D_STR_UNSUPPORTED) "\x0"
     ///< New protocol (macro) strings should be added just above this line.
     "\x0"  ///< This string requires double null termination.
 };

src/IRutils.cpp

@@ -226,6 +226,7 @@ bool hasACState(const decode_type_t protocol) {
     case TROTEC_3550:
     case VOLTAS:
     case WHIRLPOOL_AC:
+    case YORK:
       return true;
     default:
       return false;