[nextion] New trigger on_buffer_overflow (#7772)

esphome/components/nextion/automation.h

@@ -42,5 +42,12 @@ class TouchTrigger : public Trigger<uint8_t, uint8_t, bool> {
   }
 };
 
+class BufferOverflowTrigger : public Trigger<> {
+ public:
+  explicit BufferOverflowTrigger(Nextion *nextion) {
+    nextion->add_buffer_overflow_event_callback([this]() { this->trigger(); });
+  }
+};
+
 }  // namespace nextion
 }  // namespace esphome

esphome/components/nextion/base_component.py

@@ -18,6 +18,7 @@ CONF_ON_SLEEP = "on_sleep"
 CONF_ON_WAKE = "on_wake"
 CONF_ON_SETUP = "on_setup"
 CONF_ON_PAGE = "on_page"
+CONF_ON_BUFFER_OVERFLOW = "on_buffer_overflow"
 CONF_TOUCH_SLEEP_TIMEOUT = "touch_sleep_timeout"
 CONF_WAKE_UP_PAGE = "wake_up_page"
 CONF_START_UP_PAGE = "start_up_page"

esphome/components/nextion/display.py

@@ -13,6 +13,7 @@ from esphome.const import (
 from esphome.core import CORE
 from . import Nextion, nextion_ns, nextion_ref
 from .base_component import (
+    CONF_ON_BUFFER_OVERFLOW,
     CONF_ON_SLEEP,
     CONF_ON_WAKE,
     CONF_ON_SETUP,
@@ -36,6 +37,9 @@ SleepTrigger = nextion_ns.class_("SleepTrigger", automation.Trigger.template())
 WakeTrigger = nextion_ns.class_("WakeTrigger", automation.Trigger.template())
 PageTrigger = nextion_ns.class_("PageTrigger", automation.Trigger.template())
 TouchTrigger = nextion_ns.class_("TouchTrigger", automation.Trigger.template())
+BufferOverflowTrigger = nextion_ns.class_(
+    "BufferOverflowTrigger", automation.Trigger.template()
+)
 
 CONFIG_SCHEMA = (
     display.BASIC_DISPLAY_SCHEMA.extend(
@@ -68,6 +72,13 @@ CONFIG_SCHEMA = (
                     cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(TouchTrigger),
                 }
             ),
+            cv.Optional(CONF_ON_BUFFER_OVERFLOW): automation.validate_automation(
+                {
+                    cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(
+                        BufferOverflowTrigger
+                    ),
+                }
+            ),
             cv.Optional(CONF_TOUCH_SLEEP_TIMEOUT): cv.int_range(min=3, max=65535),
             cv.Optional(CONF_WAKE_UP_PAGE): cv.uint8_t,
             cv.Optional(CONF_START_UP_PAGE): cv.uint8_t,
@@ -151,3 +162,7 @@ async def to_code(config):
             ],
             conf,
         )
+
+    for conf in config.get(CONF_ON_BUFFER_OVERFLOW, []):
+        trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
+        await automation.build_automation(trigger, [], conf)

esphome/components/nextion/nextion.cpp

@@ -190,6 +190,10 @@ void Nextion::add_touch_event_callback(std::function<void(uint8_t, uint8_t, bool
   this->touch_callback_.add(std::move(callback));
 }
 
+void Nextion::add_buffer_overflow_event_callback(std::function<void()> &&callback) {
+  this->buffer_overflow_callback_.add(std::move(callback));
+}
+
 void Nextion::update_all_components() {
   if ((!this->is_setup() && !this->ignore_is_setup_) || this->is_sleeping())
     return;
@@ -458,7 +462,9 @@ void Nextion::process_nextion_commands_() {
         this->remove_from_q_();
         break;
       case 0x24:  //  Serial Buffer overflow occurs
-        ESP_LOGW(TAG, "Nextion reported Serial Buffer overflow!");
+        // Buffer will continue to receive the current instruction, all previous instructions are lost.
+        ESP_LOGE(TAG, "Nextion reported Serial Buffer overflow!");
+        this->buffer_overflow_callback_.call();
         break;
       case 0x65: {  // touch event return data
         if (to_process_length != 3) {

esphome/components/nextion/nextion.h

@@ -1134,6 +1134,12 @@ class Nextion : public NextionBase, public PollingComponent, public uart::UARTDe
    */
   void add_touch_event_callback(std::function<void(uint8_t, uint8_t, bool)> &&callback);
 
+  /** Add a callback to be notified when the nextion reports a buffer overflow.
+   *
+   * @param callback The void() callback.
+   */
+  void add_buffer_overflow_event_callback(std::function<void()> &&callback);
+
   void update_all_components();
 
   /**
@@ -1323,6 +1329,7 @@ class Nextion : public NextionBase, public PollingComponent, public uart::UARTDe
   CallbackManager<void()> wake_callback_{};
   CallbackManager<void(uint8_t)> page_callback_{};
   CallbackManager<void(uint8_t, uint8_t, bool)> touch_callback_{};
+  CallbackManager<void()> buffer_overflow_callback_{};
 
   optional<nextion_writer_t> writer_;
   float brightness_{1.0};

tests/components/nextion/test.esp32-ard.yaml

@@ -58,3 +58,6 @@ display:
     on_page:
       then:
         lambda: 'ESP_LOGD("display","Display shows new page %u", x);'
+    on_buffer_overflow:
+      then:
+        logger.log: "Nextion reported a buffer overflow!"

tests/components/nextion/test.esp32-c3-ard.yaml

@@ -58,3 +58,6 @@ display:
     on_page:
       then:
         lambda: 'ESP_LOGD("display","Display shows new page %u", x);'
+    on_buffer_overflow:
+      then:
+        logger.log: "Nextion reported a buffer overflow!"

tests/components/nextion/test.esp32-c3-idf.yaml

@@ -58,3 +58,6 @@ display:
     on_page:
       then:
         lambda: 'ESP_LOGD("display","Display shows new page %u", x);'
+    on_buffer_overflow:
+      then:
+        logger.log: "Nextion reported a buffer overflow!"

tests/components/nextion/test.esp32-idf.yaml

@@ -58,3 +58,6 @@ display:
     on_page:
       then:
         lambda: 'ESP_LOGD("display","Display shows new page %u", x);'
+    on_buffer_overflow:
+      then:
+        logger.log: "Nextion reported a buffer overflow!"

tests/components/nextion/test.esp8266-ard.yaml

@@ -58,3 +58,6 @@ display:
     on_page:
       then:
         lambda: 'ESP_LOGD("display","Display shows new page %u", x);'
+    on_buffer_overflow:
+      then:
+        logger.log: "Nextion reported a buffer overflow!"

tests/components/nextion/test.rp2040-ard.yaml

@@ -53,3 +53,6 @@ display:
     on_page:
       then:
         lambda: 'ESP_LOGD("display","Display shows new page %u", x);'
+    on_buffer_overflow:
+      then:
+        logger.log: "Nextion reported a buffer overflow!"