ESPHome  2024.9.0
ring_buffer.cpp
Go to the documentation of this file.
1 #include "ring_buffer.h"
2 
3 #include "esphome/core/helpers.h"
4 #include "esphome/core/log.h"
5 
6 #ifdef USE_ESP32
7 
8 #include "helpers.h"
9 
10 namespace esphome {
11 
12 static const char *const TAG = "ring_buffer";
13 
14 std::unique_ptr<RingBuffer> RingBuffer::create(size_t len) {
15  std::unique_ptr<RingBuffer> rb = make_unique<RingBuffer>();
16 
18  rb->storage_ = allocator.allocate(len + 1);
19  if (rb->storage_ == nullptr) {
20  return nullptr;
21  }
22 
23  rb->handle_ = xStreamBufferCreateStatic(len + 1, 1, rb->storage_, &rb->structure_);
24  ESP_LOGD(TAG, "Created ring buffer with size %u", len);
25  return rb;
26 }
27 
28 size_t RingBuffer::read(void *data, size_t len, TickType_t ticks_to_wait) {
29  if (ticks_to_wait > 0)
30  xStreamBufferSetTriggerLevel(this->handle_, len);
31 
32  size_t bytes_read = xStreamBufferReceive(this->handle_, data, len, ticks_to_wait);
33 
34  xStreamBufferSetTriggerLevel(this->handle_, 1);
35 
36  return bytes_read;
37 }
38 
39 size_t RingBuffer::write(void *data, size_t len) {
40  size_t free = this->free();
41  if (free < len) {
42  size_t needed = len - free;
43  uint8_t discard[needed];
44  xStreamBufferReceive(this->handle_, discard, needed, 0);
45  }
46  return xStreamBufferSend(this->handle_, data, len, 0);
47 }
48 
49 size_t RingBuffer::write_without_replacement(void *data, size_t len, TickType_t ticks_to_wait) {
50  return xStreamBufferSend(this->handle_, data, len, ticks_to_wait);
51 }
52 
53 size_t RingBuffer::available() const { return xStreamBufferBytesAvailable(this->handle_); }
54 
55 size_t RingBuffer::free() const { return xStreamBufferSpacesAvailable(this->handle_); }
56 
57 BaseType_t RingBuffer::reset() { return xStreamBufferReset(this->handle_); }
58 
59 } // namespace esphome
60 
61 #endif
size_t write_without_replacement(void *data, size_t len, TickType_t ticks_to_wait=0)
Writes to the ring buffer without overwriting oldest data.
Definition: ring_buffer.cpp:49
size_t free() const
Returns the number of free bytes in the ring buffer.
Definition: ring_buffer.cpp:55
BaseType_t reset()
Resets the ring buffer, discarding all stored data.
Definition: ring_buffer.cpp:57
size_t read(void *data, size_t len, TickType_t ticks_to_wait=0)
Reads from the ring buffer, waiting up to a specified number of ticks if necessary.
Definition: ring_buffer.cpp:28
const char *const TAG
Definition: spi.cpp:8
size_t available() const
Returns the number of available bytes in the ring buffer.
Definition: ring_buffer.cpp:53
std::string size_t len
Definition: helpers.h:292
Implementation of SPI Controller mode.
Definition: a01nyub.cpp:7
size_t write(void *data, size_t len)
Writes to the ring buffer, overwriting oldest data if necessary.
Definition: ring_buffer.cpp:39
static std::unique_ptr< RingBuffer > create(size_t len)
Definition: ring_buffer.cpp:14
StreamBufferHandle_t handle_
Definition: ring_buffer.h:83