esphome 2024.12.0b3__py3-none-any.whl → 2024.12.1__py3-none-any.whl

esphome/const.py

@@ -1,6 +1,6 @@
 """Constants used by esphome."""
 
-__version__ = "2024.12.0b3"
+__version__ = "2024.12.1"
 
 ALLOWED_NAME_CHARS = "abcdefghijklmnopqrstuvwxyz0123456789-_"
 VALID_SUBSTITUTIONS_CHARACTERS = (

esphome/core/ring_buffer.cpp

@@ -13,8 +13,8 @@ static const char *const TAG = "ring_buffer";
 
 RingBuffer::~RingBuffer() {
   if (this->handle_ != nullptr) {
-    vStreamBufferDelete(this->handle_);
-    ExternalRAMAllocator<uint8_t> allocator(ExternalRAMAllocator<uint8_t>::ALLOW_FAILURE);
+    vRingbufferDelete(this->handle_);
+    RAMAllocator<uint8_t> allocator(RAMAllocator<uint8_t>::ALLOW_FAILURE);
     allocator.deallocate(this->storage_, this->size_);
   }
 }
@@ -22,26 +22,49 @@ RingBuffer::~RingBuffer() {
 std::unique_ptr<RingBuffer> RingBuffer::create(size_t len) {
   std::unique_ptr<RingBuffer> rb = make_unique<RingBuffer>();
 
-  rb->size_ = len + 1;
+  rb->size_ = len;
 
-  ExternalRAMAllocator<uint8_t> allocator(ExternalRAMAllocator<uint8_t>::ALLOW_FAILURE);
+  RAMAllocator<uint8_t> allocator(RAMAllocator<uint8_t>::ALLOW_FAILURE);
   rb->storage_ = allocator.allocate(rb->size_);
   if (rb->storage_ == nullptr) {
     return nullptr;
   }
 
-  rb->handle_ = xStreamBufferCreateStatic(rb->size_, 1, rb->storage_, &rb->structure_);
+  rb->handle_ = xRingbufferCreateStatic(rb->size_, RINGBUF_TYPE_BYTEBUF, rb->storage_, &rb->structure_);
   ESP_LOGD(TAG, "Created ring buffer with size %u", len);
+
   return rb;
 }
 
 size_t RingBuffer::read(void *data, size_t len, TickType_t ticks_to_wait) {
-  if (ticks_to_wait > 0)
-    xStreamBufferSetTriggerLevel(this->handle_, len);
+  size_t bytes_read = 0;
+
+  void *buffer_data = xRingbufferReceiveUpTo(this->handle_, &bytes_read, ticks_to_wait, len);
+
+  if (buffer_data == nullptr) {
+    return 0;
+  }
+
+  std::memcpy(data, buffer_data, bytes_read);
 
-  size_t bytes_read = xStreamBufferReceive(this->handle_, data, len, ticks_to_wait);
+  vRingbufferReturnItem(this->handle_, buffer_data);
 
-  xStreamBufferSetTriggerLevel(this->handle_, 1);
+  if (bytes_read < len) {
+    // Data may have wrapped around, so read a second time to receive the remainder
+    size_t follow_up_bytes_read = 0;
+    size_t bytes_remaining = len - bytes_read;
+
+    buffer_data = xRingbufferReceiveUpTo(this->handle_, &follow_up_bytes_read, 0, bytes_remaining);
+
+    if (buffer_data == nullptr) {
+      return bytes_read;
+    }
+
+    std::memcpy((void *) ((uint8_t *) (data) + bytes_read), buffer_data, follow_up_bytes_read);
+
+    vRingbufferReturnItem(this->handle_, buffer_data);
+    bytes_read += follow_up_bytes_read;
+  }
 
   return bytes_read;
 }
@@ -49,22 +72,55 @@ size_t RingBuffer::read(void *data, size_t len, TickType_t ticks_to_wait) {
 size_t RingBuffer::write(const void *data, size_t len) {
   size_t free = this->free();
   if (free < len) {
-    size_t needed = len - free;
-    uint8_t discard[needed];
-    xStreamBufferReceive(this->handle_, discard, needed, 0);
+    // Free enough space in the ring buffer to fit the new data
+    this->discard_bytes_(len - free);
   }
-  return xStreamBufferSend(this->handle_, data, len, 0);
+  return this->write_without_replacement(data, len, 0);
 }
 
 size_t RingBuffer::write_without_replacement(const void *data, size_t len, TickType_t ticks_to_wait) {
-  return xStreamBufferSend(this->handle_, data, len, ticks_to_wait);
+  if (!xRingbufferSend(this->handle_, data, len, ticks_to_wait)) {
+    // Couldn't fit all the data, so only write what will fit
+    size_t free = std::min(this->free(), len);
+    if (xRingbufferSend(this->handle_, data, free, 0)) {
+      return free;
+    }
+    return 0;
+  }
+  return len;
+}
+
+size_t RingBuffer::available() const {
+  UBaseType_t ux_items_waiting = 0;
+  vRingbufferGetInfo(this->handle_, nullptr, nullptr, nullptr, nullptr, &ux_items_waiting);
+  return ux_items_waiting;
 }
 
-size_t RingBuffer::available() const { return xStreamBufferBytesAvailable(this->handle_); }
+size_t RingBuffer::free() const { return xRingbufferGetCurFreeSize(this->handle_); }
+
+BaseType_t RingBuffer::reset() {
+  // Discards all the available data
+  return this->discard_bytes_(this->available());
+}
 
-size_t RingBuffer::free() const { return xStreamBufferSpacesAvailable(this->handle_); }
+bool RingBuffer::discard_bytes_(size_t discard_bytes) {
+  size_t bytes_read = 0;
 
-BaseType_t RingBuffer::reset() { return xStreamBufferReset(this->handle_); }
+  void *buffer_data = xRingbufferReceiveUpTo(this->handle_, &bytes_read, 0, discard_bytes);
+  if (buffer_data != nullptr)
+    vRingbufferReturnItem(this->handle_, buffer_data);
+
+  if (bytes_read < discard_bytes) {
+    size_t wrapped_bytes_read = 0;
+    buffer_data = xRingbufferReceiveUpTo(this->handle_, &wrapped_bytes_read, 0, discard_bytes - bytes_read);
+    if (buffer_data != nullptr) {
+      vRingbufferReturnItem(this->handle_, buffer_data);
+      bytes_read += wrapped_bytes_read;
+    }
+  }
+
+  return (bytes_read == discard_bytes);
+}
 
 }  // namespace esphome
 

esphome/core/ring_buffer.h

@@ -3,7 +3,7 @@
 #ifdef USE_ESP32
 
 #include <freertos/FreeRTOS.h>
-#include <freertos/stream_buffer.h>
+#include <freertos/ringbuf.h>
 
 #include <cinttypes>
 #include <memory>
@@ -82,9 +82,14 @@ class RingBuffer {
   static std::unique_ptr<RingBuffer> create(size_t len);
 
  protected:
-  StreamBufferHandle_t handle_;
-  StaticStreamBuffer_t structure_;
-  uint8_t *storage_;
+  /// @brief Discards data from the ring buffer.
+  /// @param discard_bytes amount of bytes to discard
+  /// @return True if all bytes were successfully discarded, false otherwise
+  bool discard_bytes_(size_t discard_bytes);
+
+  RingbufHandle_t handle_{nullptr};
+  StaticRingbuffer_t structure_;
+  uint8_t *storage_{nullptr};
   size_t size_{0};
 };
 

{esphome-2024.12.0b3.dist-info → esphome-2024.12.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: esphome
-Version: 2024.12.0b3
+Version: 2024.12.1
 Summary: ESPHome is a system to configure your microcontrollers by simple yet powerful configuration files and control them remotely through Home Automation systems.
 Author-email: The ESPHome Authors <esphome@nabucasa.com>
 License: MIT

{esphome-2024.12.0b3.dist-info → esphome-2024.12.1.dist-info}/RECORD

@@ -5,7 +5,7 @@ esphome/codegen.py,sha256=GePHUM7xdXb_Pil59SHVsXg2F4VBPgkH-Fz2PDX8Z54,1873
 esphome/config.py,sha256=nOiXPZv8wHtmytkNlGcewp0uuJd9G5rRjkqevYXtjzo,39618
 esphome/config_helpers.py,sha256=MKf_wzO35nn41FvigXE0iYKDslPgL2ruf8R-EPtTT2I,3256
 esphome/config_validation.py,sha256=jtqGmSF_0mAIMxRMV3eJj7dQ71Jmlc51NOx6AvWlnqs,66374
-esphome/const.py,sha256=EyLP-Pp3YiJLFBhMfJBByzMd3r3KhclcQBnPac3aRW8,40646
+esphome/const.py,sha256=sS1ZWXJZo5TVwhs2fLSA8udcqUVTvj5lo41VEoFOIjY,40644
 esphome/coroutine.py,sha256=j_14z8dIIzIBeuNO30D4c1RJvMMt1xZFZ58Evd-EvJA,9344
 esphome/cpp_generator.py,sha256=lXPXHYUsFIvBSAoZ93mXYlGcXYg5L18nTtYGHE4_rr8,31203
 esphome/cpp_helpers.py,sha256=6C2vNbOIhZKi43xRVlk5hp9GfshfBn-rc5D_ZFUEYaE,4801
@@ -3355,8 +3355,8 @@ esphome/core/log.h,sha256=sMwmrs64vOG0G9jIibKJWv_C-COl175T8JymmBVRHWI,6369
 esphome/core/macros.h,sha256=YRip3XYzXw2pg3AFpBFA0Js-Y5GMtPkuCp2km2g5uhc,196
 esphome/core/optional.h,sha256=Di5V9YFV4vvMgVoORXe7Ojd3kLlBF7wTE4KeQGAaLSk,6968
 esphome/core/preferences.h,sha256=RxgWuAi-uo6SZiK8UKX4KTwVfIMnaaLvrZP2rqTn_mE,1959
-esphome/core/ring_buffer.cpp,sha256=HdlCZCNquSJP4Awc9nJZdaLHGj1j2Oj6IYfSBqf5uAg,2036
-esphome/core/ring_buffer.h,sha256=vK_TXVLeXV8ociUyrKqIr7hSqRAQI8W6u1xKLFUruDI,2766
+esphome/core/ring_buffer.cpp,sha256=8lEn4WbgEU9Mbc1KrR2RLzjbcAA6xsyL9IjZ82-QmB8,3602
+esphome/core/ring_buffer.h,sha256=4SeN2DYZLCHrLIjSPDsiAynIjwOoItiRUDO-u1wjq-o,2997
 esphome/core/scheduler.cpp,sha256=fH2E-e0jQ0nd90lojK5voee1lBY7rYzLWWjWZj6rbHA,12072
 esphome/core/scheduler.h,sha256=OZaBsLlo2R2nJvYcq7LyUGPXLzLAJdMEmtBewWF_9Ps,2455
 esphome/core/string_ref.cpp,sha256=of1TYMY6t3t4HjjPLSiItuPSa62AMG0lK_CU2HS1RvM,242
@@ -3385,9 +3385,9 @@ esphome/dashboard/util/itertools.py,sha256=8eLrWEWmICLtXNxkKdYPQV0c_N4GEz8m9Npnb
 esphome/dashboard/util/password.py,sha256=cQz3b9B-ijTe7zS6BeCW0hc3pWv6JjC78jmnycYYAh8,321
 esphome/dashboard/util/subprocess.py,sha256=T8EW6dbU4LPd2DG1dRrdh8li71tt6J1isn411poMhkk,1022
 esphome/dashboard/util/text.py,sha256=ENDnfN4O0NdA3CKVJjQYabFbwbrsIhVKrAMQe53qYu4,534
-esphome-2024.12.0b3.dist-info/LICENSE,sha256=HzEjkBInJe44L4WvAOPfhPJJDNj6YbnqFyvGWRzArGM,36664
-esphome-2024.12.0b3.dist-info/METADATA,sha256=7T_vwlwbh7KKVj0DjgXXNNAgfZ_lGHYniDmpx18-bkY,3551
-esphome-2024.12.0b3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-esphome-2024.12.0b3.dist-info/entry_points.txt,sha256=mIxVNuWtbYzeEcaWCl-AQ-97aBOWbnYBAK8nbF6P4M0,50
-esphome-2024.12.0b3.dist-info/top_level.txt,sha256=0GSXEW3cnITpgG3qnsSMz0qoqJHAFyfw7Y8MVtEf1Yk,8
-esphome-2024.12.0b3.dist-info/RECORD,,
+esphome-2024.12.1.dist-info/LICENSE,sha256=HzEjkBInJe44L4WvAOPfhPJJDNj6YbnqFyvGWRzArGM,36664
+esphome-2024.12.1.dist-info/METADATA,sha256=TcKwI2U3CTXq2e0CwlwlGsSESRTq91beQftFo9ZHhqc,3549
+esphome-2024.12.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+esphome-2024.12.1.dist-info/entry_points.txt,sha256=mIxVNuWtbYzeEcaWCl-AQ-97aBOWbnYBAK8nbF6P4M0,50
+esphome-2024.12.1.dist-info/top_level.txt,sha256=0GSXEW3cnITpgG3qnsSMz0qoqJHAFyfw7Y8MVtEf1Yk,8
+esphome-2024.12.1.dist-info/RECORD,,