Fix Remote Receiver Overflow for ESP8266 (#348)

* Remote Receiver Improvements

* Improvements

src/esphomelib/remote/lg.cpp

@@ -92,12 +92,13 @@ bool LGReceiver::matches(RemoteReceiveData *data) {
   return this->data_ == data_ && this->nbits_ == res.nbits;
 }
 
-void LGDumper::dump(RemoteReceiveData *data) {
+bool LGDumper::dump(RemoteReceiveData *data) {
   auto res = decode_lg(data);
   if (!res.valid)
-    return;
+    return false;
 
   ESP_LOGD(TAG, "Received LG: data=0x%08X, nbits=%d", res.data, res.nbits);
+  return true;
 }
 #endif
 

src/esphomelib/remote/lg.h

@@ -43,7 +43,7 @@ class LGReceiver : public RemoteReceiver {
 
 class LGDumper : public RemoteReceiveDumper {
  public:
-  void dump(RemoteReceiveData *data) override;
+  bool dump(RemoteReceiveData *data) override;
 };
 #endif
 

src/esphomelib/remote/nec.cpp

@@ -97,12 +97,13 @@ bool NECReceiver::matches(RemoteReceiveData *data) {
 
   return this->address_ == decode.address && this->command_ == decode.command;
 }
-void NECDumper::dump(RemoteReceiveData *data) {
+bool NECDumper::dump(RemoteReceiveData *data) {
   auto decode = decode_nec(data);
   if (!decode.valid)
-    return;
+    return false;
 
   ESP_LOGD(TAG, "Received NEC: address=0x%04X, command=0x%04X", decode.address, decode.command);
+  return true;
 }
 #endif
 

src/esphomelib/remote/nec.h

@@ -43,7 +43,7 @@ class NECReceiver : public RemoteReceiver {
 
 class NECDumper : public RemoteReceiveDumper {
  public:
-  void dump(RemoteReceiveData *data) override;
+  bool dump(RemoteReceiveData *data) override;
 };
 #endif
 

src/esphomelib/remote/panasonic.cpp

@@ -99,12 +99,13 @@ PanasonicReceiver::PanasonicReceiver(const std::string &name, uint16_t address,
 
 }
 
-void PanasonicDumper::dump(RemoteReceiveData *data) {
+bool PanasonicDumper::dump(RemoteReceiveData *data) {
   auto decode = decode_panasonic(data);
   if (!decode.valid)
-    return;
+    return false;
 
   ESP_LOGD(TAG, "Received Panasonic: address=0x%04X, command=0x%08X", decode.address, decode.command);
+  return true;
 }
 #endif
 

src/esphomelib/remote/panasonic.h

@@ -43,7 +43,7 @@ class PanasonicReceiver : public RemoteReceiver {
 
 class PanasonicDumper : public RemoteReceiveDumper {
  public:
-  void dump(RemoteReceiveData *data) override;
+  bool dump(RemoteReceiveData *data) override;
 };
 #endif
 

src/esphomelib/remote/raw.cpp

@@ -29,7 +29,7 @@ RawTransmitter::RawTransmitter(const std::string &name,
 #endif
 
 #ifdef USE_REMOTE_RECEIVER
-void RawDumper::dump(RemoteReceiveData *data) {
+bool RawDumper::dump(RemoteReceiveData *data) {
   char buffer[256];
   uint32_t buffer_offset = 0;
   buffer_offset += sprintf(buffer, "Received Raw: ");
@@ -63,6 +63,11 @@ void RawDumper::dump(RemoteReceiveData *data) {
   if (buffer_offset != 0) {
     ESP_LOGD(TAG, "%s", buffer);
   }
+
+  return true;
+}
+bool RawDumper::secondary_() {
+  return true;
 }
 bool RawReceiver::matches(RemoteReceiveData *data) {
   for (int32_t val : this->data_) {

src/esphomelib/remote/raw.h

@@ -39,7 +39,9 @@ class RawReceiver : public RemoteReceiver {
 
 class RawDumper : public RemoteReceiveDumper {
  public:
-  void dump(RemoteReceiveData *data) override;
+  bool dump(RemoteReceiveData *data) override;
+
+  bool secondary_() override;
 };
 #endif
 

src/esphomelib/remote/rc_switch.cpp

@@ -220,7 +220,8 @@ RCSwitchTypeDReceiver::RCSwitchTypeDReceiver(const std::string &name,
   RCSwitchProtocol::type_d_code(group, device, state, &this->code_, &this->nbits_);
 }
 
-void RCSwitchDumper::dump(RemoteReceiveData *data) {
+bool RCSwitchDumper::dump(RemoteReceiveData *data) {
+  bool ret = false;
   for (uint8_t i = 1; i <= 7; i++) {
     data->reset_index();
     uint32_t out_data;
@@ -233,8 +234,11 @@ void RCSwitchDumper::dump(RemoteReceiveData *data) {
 
       buffer[out_nbits] = '\0';
       ESP_LOGD(TAG, "Received RCSwitch: protocol=%u data='%s'", i, buffer);
+      ret = true;
     }
   }
+
+  return ret;
 }
 #endif
 

src/esphomelib/remote/rc_switch.h

@@ -112,7 +112,7 @@ class RCSwitchTypeDReceiver : public RCSwitchRawReceiver {
 
 class RCSwitchDumper : public RemoteReceiveDumper {
  public:
-  void dump(RemoteReceiveData *data) override;
+  bool dump(RemoteReceiveData *data) override;
 };
 #endif
 

src/esphomelib/remote/rc_switch_protocol.cpp

@@ -123,8 +123,8 @@ bool RCSwitchProtocol::expect_sync(RemoteReceiveData *data) const {
   return true;
 }
 bool RCSwitchProtocol::decode(RemoteReceiveData *data, uint32_t *out_data, uint8_t *out_nbits) const {
-  if (!this->expect_sync(data))
-    return false;
+  // ignore if sync doesn't exist
+  this->expect_sync(data);
 
   *out_data = 0;
   for (*out_nbits = 1; *out_nbits < 32; *out_nbits += 1) {

src/esphomelib/remote/remote_receiver.cpp

@@ -196,16 +196,7 @@ void RemoteReceiverComponent::loop() {
       return;
 
     RemoteReceiveData data(this, &this->temp_);
-    bool found_decoder = false;
-    for (auto *decoder : this->decoders_) {
-      if (decoder->process_(&data))
-        found_decoder = true;
-    }
-
-    if (!found_decoder) {
-      for (auto *dumper : this->dumpers_)
-        dumper->process_(&data);
-    }
+    this->process_(&data);
   }
 }
 void  RemoteReceiverComponent::decode_rmt_(rmt_item32_t *item, size_t len) {
@@ -283,7 +274,7 @@ void  RemoteReceiverComponent::decode_rmt_(rmt_item32_t *item, size_t len) {
 
 #ifdef ARDUINO_ARCH_ESP8266
 
-void ICACHE_RAM_ATTR RemoteReceiverComponent::gpio_intr() {
+void ICACHE_RAM_ATTR HOT RemoteReceiverComponent::gpio_intr() {
   const uint32_t now = micros();
   // If the lhs is 1 (rising edge) we should write to an uneven index and vice versa
   const uint32_t next = (this->buffer_write_at_ + 1) % this->buffer_size_;
@@ -294,6 +285,10 @@ void ICACHE_RAM_ATTR RemoteReceiverComponent::gpio_intr() {
     return;
 
   this->buffer_[this->buffer_write_at_ = next] = now;
+
+  if (next == this->buffer_read_at_) {
+    this->overflow_ = true;
+  }
 }
 
 void RemoteReceiverComponent::setup() {
@@ -322,7 +317,7 @@ void RemoteReceiverComponent::dump_config() {
   LOG_PIN("  Pin: ", this->pin_);
   if (this->pin_->digital_read()) {
     ESP_LOGW(TAG, "Remote Receiver Signal starts with a HIGH value. Usually this means you have to "
-                  "invert the signal using 'inverted: True' !");
+                  "invert the signal using 'inverted: True' in the pin schema!");
   }
   ESP_LOGCONFIG(TAG, "  Buffer Size: %u", this->buffer_size_);
   ESP_LOGCONFIG(TAG, "  Tolerance: %u%%", this->tolerance_);
@@ -335,6 +330,13 @@ void RemoteReceiverComponent::dump_config() {
 }
 
 void RemoteReceiverComponent::loop() {
+  if (this->overflow_) {
+    this->buffer_read_at_ = this->buffer_write_at_;
+    this->overflow_ = false;
+    ESP_LOGW(TAG, "Data is coming in too fast! Try increasing the buffer size.");
+    return;
+  }
+
   // copy write at to local variables, as it's volatile
   const uint32_t write_at = this->buffer_write_at_;
   const uint32_t dist = (this->buffer_size_ + write_at - this->buffer_read_at_) % this->buffer_size_;
@@ -362,7 +364,7 @@ void RemoteReceiverComponent::loop() {
   for (uint32_t i = 0; prev != write_at; i++) {
     int32_t delta = this->buffer_[this->buffer_read_at_] -  this->buffer_[prev];
     if (uint32_t(delta) >= this->idle_us_) {
-      ESP_LOGW(TAG, "Data is coming in too fast!");
+      // already found a space longer than idle. There must have been two pulses
       break;
     }
 
@@ -377,18 +379,8 @@ void RemoteReceiverComponent::loop() {
   this->temp_.push_back(this->idle_us_ * multiplier);
 
   RemoteReceiveData data(this, &this->temp_);
-  bool found_decoder = false;
-  for (auto *decoder : this->decoders_) {
-    if (decoder->process_(&data))
-      found_decoder = true;
-  }
-
-  if (!found_decoder) {
-    for (auto *dumper : this->dumpers_)
-      dumper->process_(&data);
-  }
+  this->process_(&data);
 }
-
 #endif
 
 RemoteReceiver *RemoteReceiverComponent::add_decoder(RemoteReceiver *decoder) {
@@ -410,6 +402,31 @@ void RemoteReceiverComponent::set_filter_us(uint8_t filter_us) {
 void RemoteReceiverComponent::set_idle_us(uint32_t idle_us) {
   this->idle_us_ = idle_us;
 }
+void RemoteReceiverComponent::process_(RemoteReceiveData *data) {
+  bool found_decoder = false;
+  for (auto *decoder : this->decoders_) {
+    if (decoder->process_(data))
+      found_decoder = true;
+  }
+
+  if (!found_decoder) {
+    bool found = false;
+
+    for (auto *dumper : this->dumpers_) {
+      if (!dumper->secondary_()) {
+        if (dumper->process_(data)) {
+          found = true;
+        }
+      }
+    }
+
+    for (auto *dumper : this->dumpers_) {
+      if (!found && dumper->secondary_()) {
+        dumper->process_(data);
+      }
+    }
+  }
+}
 
 RemoteReceiver::RemoteReceiver(const std::string &name)
     : BinarySensor(name) {
@@ -426,10 +443,13 @@ bool RemoteReceiver::process_(RemoteReceiveData *data) {
   }
   return false;
 }
+bool RemoteReceiveDumper::secondary_() {
+  return false;
+}
 
-void RemoteReceiveDumper::process_(RemoteReceiveData *data) {
+bool RemoteReceiveDumper::process_(RemoteReceiveData *data) {
   data->reset_index();
-  this->dump(data);
+  return this->dump(data);
 }
 
 } // namespace remote

src/esphomelib/remote/remote_receiver.h

@@ -102,9 +102,11 @@ class RemoteReceiver : public binary_sensor::BinarySensor {
 
 class RemoteReceiveDumper {
  public:
-  virtual void dump(RemoteReceiveData *data) = 0;
+  virtual bool dump(RemoteReceiveData *data) = 0;
 
-  void process_(RemoteReceiveData *data);
+  bool process_(RemoteReceiveData *data);
+
+  virtual bool secondary_();
 };
 
 class RemoteReceiverComponent : public RemoteControlComponentBase, public Component {
@@ -124,6 +126,8 @@ class RemoteReceiverComponent : public RemoteControlComponentBase, public Compon
   void set_filter_us(uint8_t filter_us);
   void set_idle_us(uint32_t idle_us);
 
+  void process_(RemoteReceiveData *data);
+
  protected:
   friend RemoteReceiveData;
 
@@ -143,13 +147,13 @@ class RemoteReceiverComponent : public RemoteControlComponentBase, public Compon
   volatile uint32_t buffer_write_at_;
   /// The position last read from
   uint32_t buffer_read_at_{0};
+  bool overflow_{false};
   void gpio_intr();
 #endif
 
 #ifdef ARDUINO_ARCH_ESP32
   uint32_t buffer_size_{10000};
 #endif
-  // On ESP8266, we can
 #ifdef ARDUINO_ARCH_ESP8266
   uint32_t buffer_size_{1000};
   HighFrequencyLoopRequester high_freq_;

src/esphomelib/remote/samsung.cpp

@@ -81,12 +81,13 @@ bool SamsungReceiver::matches(RemoteReceiveData *data) {
   return this->data_ == decode.data;
 }
 
-void SamsungDumper::dump(RemoteReceiveData *data) {
+bool SamsungDumper::dump(RemoteReceiveData *data) {
   auto decode = decode_samsung(data);
   if (!decode.valid)
-    return;
+    return false;
 
   ESP_LOGD(TAG, "Received Samsung: data=0x%08X", decode.data);
+  return true;
 }
 #endif
 

src/esphomelib/remote/samsung.h

@@ -41,7 +41,7 @@ class SamsungReceiver : public RemoteReceiver {
 
 class SamsungDumper : public RemoteReceiveDumper {
  public:
-  void dump(RemoteReceiveData *data) override;
+  bool dump(RemoteReceiveData *data) override;
 };
 #endif
 

src/esphomelib/remote/sony.cpp

@@ -87,12 +87,13 @@ bool SonyReceiver::matches(RemoteReceiveData *data) {
   return decode.valid && this->data_ == decode.data && this->nbits_ == decode.nbits;
 }
 
-void SonyDumper::dump(RemoteReceiveData *data) {
+bool SonyDumper::dump(RemoteReceiveData *data) {
   auto decode = decode_sony(data);
   if (!decode.valid)
-    return;
+    return false;
 
   ESP_LOGD(TAG, "Received Sony: data=0x%08X, nbits=%d", decode.data, decode.nbits);
+  return true;
 }
 #endif
 

src/esphomelib/remote/sony.h

@@ -44,7 +44,7 @@ class SonyReceiver : public RemoteReceiver {
 
 class SonyDumper : public RemoteReceiveDumper {
  public:
-  void dump(RemoteReceiveData *data) override;
+  bool dump(RemoteReceiveData *data) override;
 };
 #endif