41#include <esp_heap_caps.h>
45#include <freertos/FreeRTOS.h>
46#include <freertos/semphr.h>
47#elif defined(USE_LIBRETINY)
56#define HOT __attribute__((hot))
57#define ESPDEPRECATED(msg, when) __attribute__((deprecated(msg)))
58#define ESPHOME_ALWAYS_INLINE __attribute__((always_inline))
59#define PACKED __attribute__((packed))
71using std::is_trivially_copyable;
72using std::make_unique;
73using std::enable_if_t;
75using std::is_invocable;
76#if __cpp_lib_bit_cast >= 201806
81 typename To,
typename From,
82 enable_if_t<
sizeof(To) ==
sizeof(From) && is_trivially_copyable<From>::value && is_trivially_copyable<To>::value,
86 memcpy(&dst, &
src,
sizeof(To));
92inline float lerp(
float completion,
float start,
float end) =
delete;
96template<
typename T>
constexpr T
byteswap(T n) {
98 for (
size_t i = 0; i <
sizeof(T); i++)
99 reinterpret_cast<uint8_t *
>(&
m)[i] =
reinterpret_cast<uint8_t *
>(&n)[
sizeof(T) - 1 - i];
102template<>
constexpr uint8_t
byteswap(uint8_t n) {
return n; }
105template<>
inline uint16_t
byteswap(uint16_t n) {
return __builtin_bswap16(n); }
107template<>
inline uint64_t
byteswap(uint64_t n) {
return __builtin_bswap64(n); }
108template<>
inline int8_t
byteswap(int8_t n) {
return n; }
109template<>
inline int16_t
byteswap(int16_t n) {
return __builtin_bswap16(n); }
110template<>
inline int32_t
byteswap(int32_t n) {
return __builtin_bswap32(n); }
111template<>
inline int64_t
byteswap(int64_t n) {
return __builtin_bswap64(n); }
113template<>
constexpr uint16_t
byteswap(uint16_t n) {
return __builtin_bswap16(n); }
115template<>
constexpr uint64_t
byteswap(uint64_t n) {
return __builtin_bswap64(n); }
116template<>
constexpr int8_t
byteswap(int8_t n) {
return n; }
117template<>
constexpr int16_t
byteswap(int16_t n) {
return __builtin_bswap16(n); }
118template<>
constexpr int32_t
byteswap(int32_t n) {
return __builtin_bswap32(n); }
119template<>
constexpr int64_t
byteswap(int64_t n) {
return __builtin_bswap64(n); }
152 delete[] this->
heap_;
157 if (other.is_inline_()) {
158 memcpy(this->
inline_, other.inline_, this->len_);
160 this->
heap_ = other.heap_;
161 other.heap_ =
nullptr;
168 if (
this != &other) {
170 delete[] this->
heap_;
171 this->
len_ = other.len_;
172 if (other.is_inline_()) {
173 memcpy(this->
inline_, other.inline_, this->len_);
175 this->
heap_ = other.heap_;
176 other.heap_ =
nullptr;
190 operator std::span<const uint8_t>()
const {
return std::span<const uint8_t>(this->
data(), this->
len_); }
198 delete[] this->
heap_;
199 this->
heap_ =
nullptr;
202 if (size > InlineSize && (this->
is_inline_() || size != this->len_)) {
230 using iterator =
typename std::array<T, N>::iterator;
236 std::array<T, N> data_;
245 while (first != last && count_ < N) {
246 data_[count_++] = *first++;
252 for (
const auto &
val : init) {
255 data_[count_++] =
val;
261 static_assert(M <= N,
"Source StaticVector cannot be larger than the destination");
267 data_[count_++] = value;
275 template<
typename InputIt>
void assign(InputIt first, InputIt last) {
277 while (first != last && count_ < N) {
278 data_[count_++] = *first++;
289 return data_[count_++];
292 size_t size()
const {
return count_; }
293 bool empty()
const {
return count_ == 0; }
296 T *
data() {
return data_.data(); }
297 const T *
data()
const {
return data_.data(); }
315 operator std::span<T>() {
return std::span<T>(data_.data(), count_); }
316 operator std::span<const T>()
const {
return std::span<const T>(data_.data(), count_); }
327 using index_type = std::conditional_t<(N <= std::numeric_limits<uint8_t>::max()), uint8_t, uint16_t>;
405template<typename T, size_t MAX_CAPACITY = std::numeric_limits<uint16_t>::max()>
class FixedRingBuffer {
406 using index_type = std::conditional_t<
407 (MAX_CAPACITY <= std::numeric_limits<uint8_t>::max()), uint8_t,
408 std::conditional_t<(MAX_CAPACITY <= std::numeric_limits<uint16_t>::max()), uint16_t,
uint32_t>>;
443 if constexpr (std::is_trivially_copyable<T>::value && std::is_trivially_default_constructible<T>::value) {
444 ::operator
delete(this->
data_);
446 delete[] this->
data_;
456 if constexpr (std::is_trivially_copyable<T>::value && std::is_trivially_default_constructible<T>::value) {
459 this->
data_ =
static_cast<T *
>(::operator
new(
capacity *
sizeof(T)));
527template<
typename T,
size_t N>
inline void init_array_from(std::array<T, N> &dest, std::initializer_list<T>
src) {
529 assert(
src.size() == N);
531 if constexpr (std::is_trivially_copyable_v<T>) {
532 __builtin_memcpy(dest.data(),
src.begin(), N *
sizeof(T));
535 for (
const auto &v :
src) {
551 void destroy_elements_() {
553 if constexpr (!std::is_trivially_destructible<T>::value) {
554 for (
size_t i = 0; i < size_; i++) {
562 if (data_ !=
nullptr) {
565 ::operator
delete(data_);
577 void assign_from_initializer_list_(std::initializer_list<T> init_list) {
578 init(init_list.size());
580 for (
const auto &item : init_list) {
581 new (data_ + idx) T(item);
584 size_ = init_list.size();
592 FixedVector(std::initializer_list<T> init_list) { assign_from_initializer_list_(init_list); }
606 operator std::vector<T>()
const {
return {data_, data_ + size_}; }
609 if (
this != &other) {
615 capacity_ = other.capacity_;
627 assign_from_initializer_list_(init_list);
641 data_ =
static_cast<T *
>(::operator
new(n *
sizeof(T)));
662 if (size_ < capacity_) {
664 new (&data_[size_]) T(value);
673 if (size_ < capacity_) {
675 new (&data_[size_]) T(std::move(value));
686 new (&data_[size_]) T(std::forward<Args>(
args)...);
688 return data_[size_ - 1];
694 const T &
front()
const {
return data_[0]; }
698 T &
back() {
return data_[size_ - 1]; }
699 const T &
back()
const {
return data_[size_ - 1]; }
704 if constexpr (!std::is_trivially_destructible<T>::value) {
705 data_[size_ - 1].~T();
710 size_t size()
const {
return size_; }
711 bool empty()
const {
return size_ == 0; }
713 bool full()
const {
return size_ == capacity_; }
722 T &
at(
size_t i) {
return data_[i]; }
723 const T &
at(
size_t i)
const {
return data_[i]; }
727 T *
end() {
return data_ + size_; }
728 const T *
begin()
const {
return data_; }
729 const T *
end()
const {
return data_ + size_; }
740 if (
size <= STACK_SIZE) {
741 this->buffer_ = this->stack_buffer_;
743 this->heap_buffer_ =
new T[
size];
744 this->buffer_ = this->heap_buffer_;
755 T *
get() {
return this->buffer_; }
758 T stack_buffer_[STACK_SIZE];
759 T *heap_buffer_{
nullptr};
771int8_t
ilog10(
float value);
779 for (int8_t i = 0; i < exp; i++)
782 for (int8_t i = exp; i < 0; i++)
789template<
typename T,
typename U> T
remap(U value, U min, U max, T min_out, T max_out) {
790 return (value - min) * (max_out - min_out) / (max - min) + min_out;
794uint8_t
crc8(
const uint8_t *data, uint8_t
len, uint8_t crc = 0x00, uint8_t poly = 0x8C,
bool msb_first =
false);
797uint16_t
crc16(
const uint8_t *data, uint16_t
len, uint16_t crc = 0xffff, uint16_t reverse_poly = 0xa001,
798 bool refin =
false,
bool refout =
false);
799uint16_t
crc16be(
const uint8_t *data, uint16_t
len, uint16_t crc = 0, uint16_t poly = 0x1021,
bool refin =
false,
800 bool refout =
false);
814 using UnsignedT = std::make_unsigned_t<T>;
815 UnsignedT uvalue =
static_cast<UnsignedT
>(value);
816 for (
size_t i = 0; i <
sizeof(T); i++) {
818 hash ^= (uvalue >> (i * 8)) & 0xFF;
849 using UnsignedT = std::make_unsigned_t<T>;
850 UnsignedT uvalue =
static_cast<UnsignedT
>(value);
851 for (
size_t i = 0; i <
sizeof(T); i++) {
852 hash ^= (uvalue >> (i * 8)) & 0xFF;
884 return (
static_cast<uint16_t
>(msb) << 8) | (
static_cast<uint16_t
>(lsb));
892 return (
static_cast<uint32_t>(byte1) << 24) | (
static_cast<uint32_t>(byte2) << 16) |
897template<typename T, enable_if_t<std::is_unsigned<T>::value,
int> = 0>
constexpr T
encode_value(
const uint8_t *bytes) {
899 for (
size_t i = 0; i <
sizeof(T); i++) {
906template<typename T, enable_if_t<std::is_unsigned<T>::value,
int> = 0>
911template<typename T, enable_if_t<std::is_unsigned<T>::value,
int> = 0>
913 std::array<uint8_t,
sizeof(T)>
ret{};
914 for (
size_t i =
sizeof(T); i > 0; i--) {
923 x = ((
x & 0xAA) >> 1) | ((
x & 0x55) << 1);
924 x = ((
x & 0xCC) >> 2) | ((
x & 0x33) << 2);
925 x = ((
x & 0xF0) >> 4) | ((
x & 0x0F) << 4);
934 return (
reverse_bits(
static_cast<uint16_t
>(
x & 0xFFFF)) << 16) |
940#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
949#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
971bool str_startswith(
const std::string &str,
const std::string &start);
989constexpr char to_snake_case_char(
char c) {
return (c ==
' ') ?
'_' : (c >=
'A' && c <=
'Z') ? c + (
'a' -
'A') : c; }
994 return (c ==
'-' || c ==
'_' || (c >=
'0' && c <=
'9') || (c >=
'a' && c <=
'z') || (c >=
'A' && c <=
'Z')) ? c :
'_';
1006char *
str_sanitize_to(
char *buffer,
size_t buffer_size,
const char *str);
1021 for (
size_t i = 0; i <
len; i++) {
1053#define buf_append_printf(buf, size, pos, fmt, ...) buf_append_printf_p(buf, size, pos, PSTR(fmt), ##__VA_ARGS__)
1092 size_t remaining =
size -
pos - 1;
1093 size_t len = strnlen_P(str, remaining);
1094 memcpy_P(buf +
pos, str,
len);
1102#define buf_append_str(buf, size, pos, str) buf_append_str_p(buf, size, pos, PSTR(str))
1115 size_t remaining =
size -
pos - 1;
1117 while (
len < remaining && str[
len] !=
'\0') {
1120 memcpy(buf +
pos, str,
len);
1135std::string
make_name_with_suffix(
const std::string &name,
char sep,
const char *suffix_ptr,
size_t suffix_len);
1145std::string
make_name_with_suffix(
const char *name,
size_t name_len,
char sep,
const char *suffix_ptr,
1158 const char *suffix_ptr,
size_t suffix_len);
1166template<
typename T, enable_if_t<(std::is_
integral<T>::value && std::is_
unsigned<T>::value),
int> = 0>
1168 char *
end =
nullptr;
1169 unsigned long value = ::strtoul(str, &
end, 10);
1170 if (
end == str || *
end !=
'\0' || value > std::numeric_limits<T>::max())
1175template<
typename T, enable_if_t<(std::is_
integral<T>::value && std::is_
unsigned<T>::value),
int> = 0>
1180template<
typename T, enable_if_t<(std::is_
integral<T>::value && std::is_
signed<T>::value),
int> = 0>
1182 char *
end =
nullptr;
1183 signed long value = ::strtol(str, &
end, 10);
1184 if (
end == str || *
end !=
'\0' || value < std::numeric_limits<T>::min() || value > std::numeric_limits<T>::max())
1189template<
typename T, enable_if_t<(std::is_
integral<T>::value && std::is_
signed<T>::value),
int> = 0>
1194template<
typename T, enable_if_t<(std::is_same<T,
float>::value),
int> = 0> optional<T>
parse_number(
const char *str) {
1195 char *
end =
nullptr;
1196 float value = ::strtof(str, &
end);
1197 if (
end == str || *
end !=
'\0' || value == HUGE_VALF)
1202template<
typename T, enable_if_t<(std::is_same<T,
float>::value),
int> = 0>
1218size_t parse_hex(
const char *str,
size_t len, uint8_t *data,
size_t count);
1220inline bool parse_hex(
const char *str, uint8_t *data,
size_t count) {
1221 return parse_hex(str, strlen(str), data, count) == 2 * count;
1224inline bool parse_hex(
const std::string &str, uint8_t *data,
size_t count) {
1225 return parse_hex(str.c_str(), str.length(), data, count) == 2 * count;
1228inline bool parse_hex(
const char *str, std::vector<uint8_t> &data,
size_t count) {
1230 return parse_hex(str, strlen(str), data.data(), count) == 2 * count;
1233inline bool parse_hex(
const std::string &str, std::vector<uint8_t> &data,
size_t count) {
1235 return parse_hex(str.c_str(), str.length(), data.data(), count) == 2 * count;
1242template<typename T, enable_if_t<std::is_unsigned<T>::value,
int> = 0>
1245 if (
len > 2 *
sizeof(T) ||
parse_hex(str,
len,
reinterpret_cast<uint8_t *
>(&
val),
sizeof(T)) == 0)
1250template<typename T, enable_if_t<std::is_unsigned<T>::value,
int> = 0> optional<T>
parse_hex(
const char *str) {
1254template<typename T, enable_if_t<std::is_unsigned<T>::value,
int> = 0> optional<T>
parse_hex(
const std::string &str) {
1260static constexpr uint8_t INVALID_HEX_CHAR = 255;
1263 if (c >=
'0' && c <=
'9')
1265 if (c >=
'A' && c <=
'F')
1266 return c -
'A' + 10;
1267 if (c >=
'a' && c <=
'f')
1268 return c -
'a' + 10;
1269 return INVALID_HEX_CHAR;
1273ESPHOME_ALWAYS_INLINE
inline char format_hex_char(uint8_t v,
char base) {
return v >= 10 ? base + (v - 10) :
'0' + v; }
1282static constexpr size_t JSON_ESCAPE_MAX_EXPANSION = 6;
1309 int32_t tens = v / 10;
1310 *buf++ =
'0' + tens;
1312 }
else if (v >= 10) {
1313 int32_t tens = v / 10;
1314 *buf++ =
'0' + tens;
1325inline char *
buf_append_sep_str(
char *buf,
size_t remaining,
char separator,
const char *str,
size_t str_len) {
1326 if (remaining < 2) {
1327 if (remaining >= 1) {
1334 size_t copy_len = std::min(str_len, remaining - 1);
1335 memcpy(buf, str, copy_len);
1345static constexpr size_t UINT32_MAX_STR_SIZE = 11;
1356 return static_cast<size_t>(
end - buf.data());
1363 while (divisor > 0) {
1364 *buf++ =
'0' +
static_cast<char>(frac / divisor);
1377 static_assert(N >= 3,
"Buffer must hold at least one hex byte (3 chars)");
1382template<size_t N, typename T, enable_if_t<std::is_unsigned<T>::value,
int> = 0>
1384 static_assert(N >=
sizeof(T) * 2 + 1,
"Buffer too small for type");
1386 return format_hex_to(buffer,
reinterpret_cast<const uint8_t *
>(&
val),
sizeof(T));
1390template<
size_t N>
inline char *
format_hex_to(
char (&buffer)[N],
const std::vector<uint8_t> &data) {
1395template<
size_t N,
size_t M>
inline char *
format_hex_to(
char (&buffer)[N],
const std::array<uint8_t, M> &data) {
1406template<size_t N, typename T, enable_if_t<std::is_unsigned<T>::value,
int> = 0>
1408 static_assert(N >=
sizeof(T) * 2 + 3,
"Buffer too small for prefixed hex");
1412 format_hex_to(buffer + 2, N - 2,
reinterpret_cast<const uint8_t *
>(&
val),
sizeof(T));
1418 static_assert(N >= 5,
"Buffer must hold at least '0x' + one hex byte + null");
1444 static_assert(N >= 3,
"Buffer must hold at least one hex byte");
1455template<
size_t N,
size_t M>
1481 static_assert(N >= 5,
"Buffer must hold at least one hex uint16_t");
1486static constexpr size_t MAC_ADDRESS_SIZE = 6;
1490static constexpr size_t MAC_ADDRESS_BUFFER_SIZE = MAC_ADDRESS_SIZE * 2 + 1;
1494 return format_hex_pretty_to(output, MAC_ADDRESS_PRETTY_BUFFER_SIZE, mac, MAC_ADDRESS_SIZE,
':');
1499 format_hex_to(output, MAC_ADDRESS_BUFFER_SIZE, mac, MAC_ADDRESS_SIZE);
1507template<typename T, enable_if_t<std::is_unsigned<T>::value,
int> = 0> std::string
format_hex(T
val) {
1509 return format_hex(
reinterpret_cast<uint8_t *
>(&
val),
sizeof(T));
1513template<std::
size_t N> std::string
format_hex(
const std::array<uint8_t, N> &data) {
1522template<typename T, enable_if_t<std::is_unsigned<T>::value,
int> = 0>
1525 return format_hex_pretty(
reinterpret_cast<uint8_t *
>(&
val),
sizeof(T), separator, show_length);
1554 static_assert(N >= 9,
"Buffer must hold at least one binary byte (9 chars)");
1574template<size_t N, typename T, enable_if_t<std::is_unsigned<T>::value,
int> = 0>
1576 static_assert(N >=
sizeof(T) * 8 + 1,
"Buffer too small for type");
1578 return format_bin_to(buffer,
reinterpret_cast<const uint8_t *
>(&
val),
sizeof(T));
1585template<typename T, enable_if_t<std::is_unsigned<T>::value,
int> = 0> std::string
format_bin(T
val) {
1587 return format_bin(
reinterpret_cast<uint8_t *
>(&
val),
sizeof(T));
1603static constexpr size_t VALUE_ACCURACY_MAX_LEN = 64;
1606size_t value_accuracy_to_buf(std::span<char, VALUE_ACCURACY_MAX_LEN> buf,
float value, int8_t accuracy_decimals);
1609 int8_t accuracy_decimals, StringRef unit_of_measurement);
1616size_t base64_decode(std::string
const &encoded_string, uint8_t *buf,
size_t buf_len);
1617size_t base64_decode(
const uint8_t *encoded_data,
size_t encoded_len, uint8_t *buf,
size_t buf_len);
1632ESPDEPRECATED(
"Use LightState::gamma_correct_lut() instead. Removed in 2026.9.0.",
"2026.3.0")
1636ESPDEPRECATED("Use LightState::gamma_uncorrect_lut() instead. Removed in 2026.9.0.", "2026.3.0")
1640void rgb_to_hsv(
float red,
float green,
float blue,
int &hue,
float &saturation,
float &value);
1642void hsv_to_rgb(
int hue,
float saturation,
float value,
float &red,
float &green,
float &blue);
1676 static_assert(
sizeof(
void *) ==
sizeof(std::uintptr_t),
"void* must be the same size as uintptr_t");
1678 void (*fn_)(
void *, Ts...){
nullptr};
1679 void *ctx_{
nullptr};
1682 void call(Ts...
args)
const { this->fn_(this->ctx_, std::forward<Ts>(
args)...); }
1687 using DecayF = std::decay_t<F>;
1688 if constexpr (
sizeof(DecayF) <=
sizeof(
void *) && std::is_trivially_copyable_v<DecayF>) {
1695 DecayF decayed = std::forward<F>(callable);
1696 __builtin_memcpy(&cb.ctx_, &decayed,
sizeof(DecayF));
1697 cb.fn_ = [](
void *c, Ts...
args) {
1698 alignas(DecayF)
char buf[
sizeof(DecayF)];
1699 __builtin_memcpy(buf, &c,
sizeof(DecayF));
1700 (*std::launder(
reinterpret_cast<DecayF *
>(buf)))(
args...);
1707 auto *stored =
new DecayF(std::forward<F>(callable));
1708 return {[](
void *c, Ts...
args) { (*
static_cast<DecayF *
>(c))(
args...); },
static_cast<void *
>(stored)};
1731 static_assert(std::is_trivially_copyable_v<CbType>,
"Callback must be trivially copyable");
1741 : data_(other.data_), size_(other.size_), capacity_(other.capacity_) {
1742 other.data_ =
nullptr;
1744 other.capacity_ = 0;
1747 std::swap(this->data_, other.data_);
1748 std::swap(this->size_, other.size_);
1749 std::swap(this->capacity_, other.capacity_);
1755 template<
typename F>
void add(F &&callback) { this->add_(CbType::create(std::forward<F>(callback))); }
1758 inline void ESPHOME_ALWAYS_INLINE
call(
const Ts &...
args) {
1759 if (this->size_ != 0) {
1760 for (
auto *it = this->data_, *
end = it + this->size_; it !=
end; ++it) {
1765 uint16_t
size()
const {
return this->size_; }
1775 if (this->size_ == this->capacity_) {
1779 this->data_[this->size_++] = cb;
1783 uint16_t capacity_{0};
1800 template<
typename F>
void add(F &&callback) { this->add_(
Callback<
void(Ts...)>::create(std::forward<F>(callback))); }
1804 for (
auto &cb : this->callbacks_)
1807 size_t size()
const {
return this->callbacks_.size(); }
1849 template<
typename F>
void add(F &&callback) { this->add_(
Callback<
void(Ts...)>::create(std::forward<F>(callback))); }
1853 if (this->callbacks_) {
1854 this->callbacks_->call(
args...);
1859 size_t size()
const {
return this->callbacks_ ? this->callbacks_->size() : 0; }
1862 bool empty()
const {
return !this->callbacks_ || this->callbacks_->size() == 0; }
1870 if (!this->callbacks_) {
1873 this->callbacks_->add_(cb);
1935#if defined(USE_ESP8266) || defined(USE_RP2)
1942#elif defined(USE_ESP32) || defined(USE_LIBRETINY)
1944 Mutex() { handle_ = xSemaphoreCreateMutex(); }
1946 void lock() { xSemaphoreTake(this->handle_, portMAX_DELAY); }
1947 bool try_lock() {
return xSemaphoreTake(this->handle_, 0) == pdTRUE; }
1948 void unlock() { xSemaphoreGive(this->handle_); }
1951 SemaphoreHandle_t handle_;
2004#if defined(USE_ESP8266) || defined(USE_RP2) || defined(USE_ZEPHYR)
2022#if defined(USE_ESP32) || defined(USE_RP2)
2118 if (alloc_bits != 0) {
2119 this->flags_ = alloc_bits;
2129 size_t size = n * manual_size;
2132 const auto caps = this->get_caps_();
2133 ptr =
static_cast<T *
>(heap_caps_malloc_prefer(
size, 2, caps[0], caps[1]));
2136 ptr =
static_cast<T *
>(malloc(
size));
2144 size_t size = n * manual_size;
2147 const auto caps = this->get_caps_();
2148 ptr =
static_cast<T *
>(heap_caps_realloc_prefer(p,
size, 2, caps[0], caps[1]));
2151 ptr =
static_cast<T *
>(realloc(p,
size));
2165 return ESP.getFreeHeap();
2166#elif defined(USE_ESP32)
2168 this->flags_ &
ALLOC_INTERNAL ? heap_caps_get_free_size(MALLOC_CAP_8BIT | MALLOC_CAP_INTERNAL) : 0;
2170 this->flags_ &
ALLOC_EXTERNAL ? heap_caps_get_free_size(MALLOC_CAP_8BIT | MALLOC_CAP_SPIRAM) : 0;
2171 return max_internal + max_external;
2172#elif defined(USE_RP2)
2173 return ::rp2040.getFreeHeap();
2174#elif defined(USE_LIBRETINY)
2175 return lt_heap_get_free();
2186 return ESP.getMaxFreeBlockSize();
2187#elif defined(USE_ESP32)
2189 this->flags_ &
ALLOC_INTERNAL ? heap_caps_get_largest_free_block(MALLOC_CAP_8BIT | MALLOC_CAP_INTERNAL) : 0;
2191 this->flags_ &
ALLOC_EXTERNAL ? heap_caps_get_largest_free_block(MALLOC_CAP_8BIT | MALLOC_CAP_SPIRAM) : 0;
2192 return std::max(max_internal, max_external);
2205 std::array<uint32_t, 2> get_caps_()
const {
2206 constexpr uint32_t external_caps = MALLOC_CAP_SPIRAM | MALLOC_CAP_8BIT;
2207 constexpr uint32_t internal_caps = MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT;
2209 return {internal_caps, external_caps};
2213 return {primary, fallback};
2226template<
typename T,
typename U>
2228 { a > b } -> std::convertible_to<bool>;
2229 { a < b } -> std::convertible_to<bool>;
2232template<std::totally_ordered T, comparable_with<T> U> T
clamp_at_least(T value, U min) {
2237template<std::totally_ordered T, comparable_with<T> U> T
clamp_at_most(T value, U max) {
2250template<typename T, enable_if_t<!std::is_pointer<T>::value,
int> = 0> T
id(T value) {
return value; }
2255template<typename T, enable_if_t<std::is_pointer<T *>::value,
int> = 0> T &
id(T *value) {
return *value; }
Heap-allocating helper functions.
void ESPHOME_ALWAYS_INLINE call(const Ts &...args)
Call all callbacks in this manager.
CallbackManager & operator=(const CallbackManager &)=delete
void operator()(const Ts &...args)
Call all callbacks in this manager.
CallbackManager & operator=(CallbackManager &&other) noexcept
friend class LazyCallbackManager
CallbackManager()=default
void add(F &&callback)
Add any callable.
CallbackManager(CallbackManager &&other) noexcept
void add_(CbType cb)
Non-template core to avoid code duplication per lambda type.
CallbackManager(const CallbackManager &)=delete
Lightweight read-only view over a const array stored in RODATA (will typically be in flash memory) Av...
const constexpr T & operator[](size_t i) const
constexpr bool empty() const
constexpr ConstVector(const T *data, size_t size)
constexpr size_t size() const
Helper class to deduplicate items in a series of values.
bool next(T value)
Feeds the next item in the series to the deduplicator and returns false if this is a duplicate.
bool has_value() const
Returns true if this deduplicator has processed any items.
bool next_unknown()
Returns true if the deduplicator's value was previously known.
const T & operator*() const
bool operator!=(const ConstIterator &other) const
ConstIterator & operator++()
ConstIterator(const FixedRingBuffer *buf, index_type pos)
bool operator!=(const Iterator &other) const
Iterator(FixedRingBuffer *buf, index_type pos)
Fixed-capacity circular buffer - allocates once at runtime, never reallocates.
FixedRingBuffer & operator=(const FixedRingBuffer &)=delete
ConstIterator begin() const
bool push(const T &value)
Push a value. Returns false if full.
index_type capacity() const
void push_overwrite(const T &value)
Push a value, overwriting the oldest if full.
void init(index_type capacity)
Allocate capacity - can only be called once.
void pop()
Remove the oldest element.
void clear()
Clear all elements (reset to empty, keep capacity)
FixedRingBuffer()=default
FixedRingBuffer(const FixedRingBuffer &)=delete
ConstIterator end() const
Fixed-capacity vector - allocates once at runtime, never reallocates This avoids std::vector template...
const T & at(size_t i) const
FixedVector(FixedVector &&other) noexcept
FixedVector(std::initializer_list< T > init_list)
Constructor from initializer list - allocates exact size needed This enables brace initialization: Fi...
FixedVector & operator=(std::initializer_list< T > init_list)
Assignment from initializer list - avoids temporary and move overhead This enables: FixedVector<int> ...
T & front()
Access first element (no bounds checking - matches std::vector behavior) Caller must ensure vector is...
const T & operator[](size_t i) const
T & operator[](size_t i)
Access element without bounds checking (matches std::vector behavior) Caller must ensure index is val...
T & back()
Access last element (no bounds checking - matches std::vector behavior) Caller must ensure vector is ...
FixedVector & operator=(const FixedVector &)=delete
FixedVector(const FixedVector &)=delete
void push_back(T &&value)
Add element by move without bounds checking Caller must ensure sufficient capacity was allocated via ...
void pop_back()
Remove the last element in place (no reallocation, keeps capacity) Caller must ensure vector is not e...
T & emplace_back(Args &&...args)
Emplace element without bounds checking - constructs in-place with arguments Caller must ensure suffi...
FixedVector & operator=(FixedVector &&other) noexcept
T & at(size_t i)
Access element with bounds checking (matches std::vector behavior) Note: No exception thrown on out o...
void push_back(const T &value)
Add element without bounds checking Caller must ensure sufficient capacity was allocated via init() S...
Helper class to request loop() to be called as fast as possible.
static bool is_high_frequency()
Check whether the loop is running continuously.
void stop()
Stop running the loop continuously.
static uint8_t num_requests
void start()
Start running the loop continuously.
Helper class to disable interrupts.
LazyCallbackManager & operator=(const LazyCallbackManager &)=delete
LazyCallbackManager(const LazyCallbackManager &)=delete
size_t size() const
Return the number of registered callbacks.
LazyCallbackManager()=default
void add_(Callback< void(Ts...)> cb)
Non-template core to avoid code duplication per lambda type.
void add(F &&callback)
Add any callable. Allocates the underlying CallbackManager on first use.
void operator()(Ts... args)
Call all callbacks in this manager.
LazyCallbackManager & operator=(LazyCallbackManager &&)=delete
~LazyCallbackManager()
Destructor - clean up allocated CallbackManager if any.
void call(Ts... args)
Call all callbacks in this manager. No-op if no callbacks registered.
bool empty() const
Check if any callbacks are registered.
LazyCallbackManager(LazyCallbackManager &&)=delete
Helper class that wraps a mutex with a RAII-style API.
Helper class to lock the lwIP TCPIP core when making lwIP API calls from non-TCPIP threads.
LwIPLock(const LwIPLock &)=delete
LwIPLock & operator=(const LwIPLock &)=delete
Mutex implementation, with API based on the unavailable std::mutex.
Mutex(const Mutex &)=delete
Mutex & operator=(const Mutex &)=delete
Helper class to easily give an object a parent of type T.
T * get_parent() const
Get the parent of this object.
void set_parent(T *parent)
Set the parent of this object.
An STL allocator that uses SPI or internal RAM.
constexpr RAMAllocator(uint8_t flags)
T * reallocate(T *p, size_t n, size_t manual_size)
size_t get_free_heap_size() const
Return the total heap space available via this allocator.
T * reallocate(T *p, size_t n)
void deallocate(T *p, size_t n)
size_t get_max_free_block_size() const
Return the maximum size block this allocator could allocate.
constexpr RAMAllocator(const RAMAllocator< U > &other)
T * allocate(size_t n, size_t manual_size)
constexpr RAMAllocator()=default
Helper class for efficient buffer allocation - uses stack for small sizes, heap for large This is use...
SmallBufferWithHeapFallback(const SmallBufferWithHeapFallback &)=delete
SmallBufferWithHeapFallback & operator=(SmallBufferWithHeapFallback &&)=delete
~SmallBufferWithHeapFallback()
SmallBufferWithHeapFallback & operator=(const SmallBufferWithHeapFallback &)=delete
SmallBufferWithHeapFallback(size_t size)
SmallBufferWithHeapFallback(SmallBufferWithHeapFallback &&)=delete
Small buffer optimization - stores data inline when small, heap-allocates for large data This avoids ...
SmallInlineBuffer()=default
SmallInlineBuffer(const SmallInlineBuffer &)=delete
uint8_t * init(size_t size)
Resize to size bytes of (uninitialized) storage and return a writable pointer to fill.
void set(const uint8_t *src, size_t size)
Set buffer contents, allocating heap if needed.
SmallInlineBuffer & operator=(const SmallInlineBuffer &)=delete
uint8_t inline_[InlineSize]
SmallInlineBuffer & operator=(SmallInlineBuffer &&other) noexcept
const uint8_t * data() const
SmallInlineBuffer(SmallInlineBuffer &&other) noexcept
void add(F &&callback)
Add any callable.
void call(Ts... args)
Call all callbacks in this manager.
void add_(Callback< void(Ts...)> cb)
Non-template core to avoid code duplication per lambda type.
StaticVector< Callback< void(Ts...)>, N > callbacks_
void operator()(Ts... args)
Call all callbacks in this manager.
CallbackManager backed by StaticVector for compile-time-known callback counts.
const T & operator*() const
ConstIterator(const StaticRingBuffer *buf, index_type pos)
ConstIterator & operator++()
bool operator!=(const ConstIterator &other) const
bool operator!=(const Iterator &other) const
Iterator(StaticRingBuffer *buf, index_type pos)
Fixed-size circular buffer with FIFO semantics and iteration support.
bool push(const T &value)
ConstIterator begin() const
ConstIterator end() const
void clear()
Clear all elements (reset to empty)
Minimal static vector - saves memory by avoiding std::vector overhead.
const_reverse_iterator rend() const
reverse_iterator rbegin()
const T & operator[](size_t i) const
void push_back(const T &value)
void assign(InputIt first, InputIt last)
const_reverse_iterator rbegin() const
std::reverse_iterator< const_iterator > const_reverse_iterator
typename std::array< T, N >::iterator iterator
typename std::array< T, N >::const_iterator const_iterator
std::reverse_iterator< iterator > reverse_iterator
const_iterator end() const
StaticVector(InputIt first, InputIt last)
StaticVector(const StaticVector< T, M > &other)
StaticVector(std::initializer_list< T > init)
const_iterator begin() const
struct @66::@67 __attribute__
Wake the main loop task from an ISR. ISR-safe.
Functions to constrain the range of arithmetic values.
size_t buf_append_str_p(char *buf, size_t size, size_t pos, PGM_P str)
Safely append a PROGMEM string to buffer, returning new position (capped at size).
T clamp_at_most(T value, U max)
bool random_bytes(uint8_t *data, size_t len)
Generate len random bytes using the platform's secure RNG (hardware RNG or OS CSPRNG).
size_t buf_append_str(char *buf, size_t size, size_t pos, const char *str)
Safely append a string to buffer, returning new position (capped at size).
constexpr uint32_t fnv1a_hash_extend(uint32_t hash, const char *str)
Extend a FNV-1a hash with additional string data.
ESPDEPRECATED("Use LightState::gamma_correct_lut() instead. Removed in 2026.9.0.", "2026.3.0") float gamma_correct(float value
Applies gamma correction of gamma to value.
float random_float()
Return a random float between 0 and 1.
const char int const __FlashStringHelper * format
ESPHOME_ALWAYS_INLINE char format_hex_char(uint8_t v, char base)
Convert a nibble (0-15) to hex char with specified base ('a' for lowercase, 'A' for uppercase)
float gamma_uncorrect(float value, float gamma)
uint16_t crc16(const uint8_t *data, uint16_t len, uint16_t crc, uint16_t reverse_poly, bool refin, bool refout)
Calculate a CRC-16 checksum of data with size len.
size_t make_name_with_suffix_to(char *buffer, size_t buffer_size, const char *name, size_t name_len, char sep, const char *suffix_ptr, size_t suffix_len)
Zero-allocation version: format name + separator + suffix directly into buffer.
constexpr T convert_big_endian(T val)
Convert a value between host byte order and big endian (most significant byte first) order.
float gamma_correct(float value, float gamma)
constexpr char to_sanitized_char(char c)
Sanitize a single char: keep alphanumerics, dashes, underscores; replace others with underscore.
bool mac_address_is_valid(const uint8_t *mac)
Check if the MAC address is not all zeros or all ones.
ESPHOME_ALWAYS_INLINE char format_hex_pretty_char(uint8_t v)
Convert a nibble (0-15) to uppercase hex char (used for pretty printing)
void format_mac_addr_lower_no_sep(const uint8_t *mac, char *output)
Format MAC address as xxxxxxxxxxxxxx (lowercase, no separators)
constexpr uint32_t FNV1_OFFSET_BASIS
FNV-1 32-bit offset basis.
void rgb_to_hsv(float red, float green, float blue, int &hue, float &saturation, float &value)
Convert red, green and blue (all 0-1) values to hue (0-360), saturation (0-1) and value (0-1).
std::string format_hex(const uint8_t *data, size_t length)
Format the byte array data of length len in lowercased hex.
uint16_t uint16_t size_t elem_size
size_t value_accuracy_to_buf(std::span< char, VALUE_ACCURACY_MAX_LEN > buf, float value, int8_t accuracy_decimals)
Format value with accuracy to buffer, returns chars written (excluding null)
size_t buf_append_printf_p(char *buf, size_t size, size_t pos, PGM_P fmt,...)
Safely append formatted string to buffer, returning new position (capped at size).
ParseOnOffState parse_on_off(const char *str, const char *on, const char *off)
Parse a string that contains either on, off or toggle.
const char int const __FlashStringHelper va_list args
std::string format_bin(const uint8_t *data, size_t length)
Format the byte array data of length len in binary.
constexpr T convert_little_endian(T val)
Convert a value between host byte order and little endian (least significant byte first) order.
constexpr uint32_t fnv1_hash_extend(uint32_t hash, T value)
Extend a FNV-1 hash with an integer (hashes each byte).
bool base64_decode_int32_vector(const std::string &base64, std::vector< int32_t > &out)
Decode base64/base64url string directly into vector of little-endian int32 values.
constexpr size_t format_hex_prefixed_size(size_t byte_count)
Calculate buffer size needed for format_hex_prefixed_to: "0xXXXXXXXX...\0" = bytes * 2 + 3.
constexpr uint32_t encode_uint24(uint8_t byte1, uint8_t byte2, uint8_t byte3)
Encode a 24-bit value given three bytes in most to least significant byte order.
uint32_t small_pow10(int8_t n)
Return 10^n for small non-negative n (0-3) as uint32_t, avoiding float.
std::vector< uint8_t > base64_decode(const std::string &encoded_string)
Decode a base64 string to a byte vector.
char * format_hex_prefixed_to(char(&buffer)[N], T val)
Format an unsigned integer as "0x" prefixed lowercase hex to buffer.
bool has_custom_mac_address()
Check if a custom MAC address is set (ESP32 & variants)
size_t parse_hex(const char *str, size_t length, uint8_t *data, size_t count)
Parse bytes from a hex-encoded string into a byte array.
char * format_hex_pretty_to(char *buffer, size_t buffer_size, const uint8_t *data, size_t length, char separator)
Format byte array as uppercase hex to buffer (base implementation).
size_t uint32_to_str(std::span< char, UINT32_MAX_STR_SIZE > buf, uint32_t val)
Write unsigned 32-bit integer to buffer with compile-time size check.
int8_t ilog10(float value)
Compute floor(log10(fabs(value))) using iterative comparison.
uint32_t fnv1_hash_object_id(const char *str, size_t len)
Calculate FNV-1 hash of a string while applying snake_case + sanitize transformations.
uint32_t fnv1_hash(const char *str)
Calculate a FNV-1 hash of str.
T clamp_at_least(T value, U min)
optional< T > parse_number(const char *str)
Parse an unsigned decimal number from a null-terminated string.
char * frac_to_str_unchecked(char *buf, uint32_t frac, uint32_t divisor)
Write fractional digits with leading zeros to buffer (internal, no size check).
void set_mac_address(uint8_t *mac)
Set the MAC address to use from the provided byte array (6 bytes).
int8_t step_to_accuracy_decimals(float step)
Derive accuracy in decimals from an increment step.
uint32_t random_uint32()
Return a random 32-bit unsigned integer.
const char * get_mac_address_pretty_into_buffer(std::span< char, MAC_ADDRESS_PRETTY_BUFFER_SIZE > buf)
Get the device MAC address into the given buffer, in colon-separated uppercase hex notation.
char * buf_append_sep_str(char *buf, size_t remaining, char separator, const char *str, size_t str_len)
Append a separator char and a string to a buffer, respecting remaining space.
void delay_microseconds_safe(uint32_t us)
Delay for the given amount of microseconds, possibly yielding to other processes during the wait.
std::string format_hex_pretty(const uint8_t *data, size_t length, char separator, bool show_length)
Format a byte array in pretty-printed, human-readable hex format.
constexpr size_t format_hex_size(size_t byte_count)
Calculate buffer size needed for format_hex_to: "XXXXXXXX...\0" = bytes * 2 + 1.
bool str_equals_case_insensitive(const std::string &a, const std::string &b)
Compare strings for equality in case-insensitive manner.
bool str_endswith_ignore_case(const char *str, size_t str_len, const char *suffix, size_t suffix_len)
Case-insensitive check if string ends with suffix (no heap allocation).
char * str_sanitize_to(char *buffer, size_t buffer_size, const char *str)
Sanitize a string to buffer, keeping only alphanumerics, dashes, and underscores.
void init_array_from(std::array< T, N > &dest, std::initializer_list< T > src)
Initialize a std::array from an initializer_list.
char * int8_to_str(char *buf, int8_t val)
Write int8 value to buffer without modulo operations.
size_t value_accuracy_with_uom_to_buf(std::span< char, VALUE_ACCURACY_MAX_LEN > buf, float value, int8_t accuracy_decimals, StringRef unit_of_measurement)
Format value with accuracy and UOM to buffer, returns chars written (excluding null)
const char * json_escape_into_buffer(std::span< char > buf, StringRef value, bool short_control_escapes)
Copy value into buf, escaping the characters that cannot appear raw inside a JSON string literal.
char * uint32_to_str_unchecked(char *buf, uint32_t val)
Write unsigned 32-bit integer to buffer (internal, no size check).
constexpr size_t format_hex_pretty_size(size_t byte_count)
Calculate buffer size needed for format_hex_pretty_to with separator: "XX:XX:...:XX\0".
constexpr uint32_t FNV1_PRIME
FNV-1 32-bit prime.
constexpr T encode_value(const uint8_t *bytes)
Encode a value from its constituent bytes (from most to least significant) in an array with length si...
void hsv_to_rgb(int hue, float saturation, float value, float &red, float &green, float &blue)
Convert hue (0-360), saturation (0-1) and value (0-1) to red, green and blue (all 0-1).
void get_mac_address_into_buffer(std::span< char, MAC_ADDRESS_BUFFER_SIZE > buf)
Get the device MAC address into the given buffer, in lowercase hex notation.
uint16_t crc16be(const uint8_t *data, uint16_t len, uint16_t crc, uint16_t poly, bool refin, bool refout)
constexpr uint32_t encode_uint32(uint8_t byte1, uint8_t byte2, uint8_t byte3, uint8_t byte4)
Encode a 32-bit value given four bytes in most to least significant byte order.
uint8_t crc8(const uint8_t *data, uint8_t len, uint8_t crc, uint8_t poly, bool msb_first)
Calculate a CRC-8 checksum of data with size len.
constexpr float celsius_to_fahrenheit(float value)
Convert degrees Celsius to degrees Fahrenheit.
size_t size_t const char va_start(args, fmt)
constexpr uint16_t encode_uint16(uint8_t msb, uint8_t lsb)
Encode a 16-bit value given the most and least significant byte.
void get_mac_address_raw(uint8_t *mac)
Get the device MAC address as raw bytes, written into the provided byte array (6 bytes).
size_t size_t const char * fmt
constexpr uint8_t parse_hex_char(char c)
bool str_startswith(const std::string &str, const std::string &start)
Check whether a string starts with a value.
constexpr std::array< uint8_t, sizeof(T)> decode_value(T val)
Decode a value into its constituent bytes (from most to least significant).
constexpr size_t format_bin_size(size_t byte_count)
Calculate buffer size needed for format_bin_to: "01234567...\0" = bytes * 8 + 1.
To bit_cast(const From &src)
Convert data between types, without aliasing issues or undefined behaviour.
constexpr char to_snake_case_char(char c)
Convert a single char to snake_case: lowercase and space to underscore.
constexpr float fahrenheit_to_celsius(float value)
Convert degrees Fahrenheit to degrees Celsius.
uint8_t reverse_bits(uint8_t x)
Reverse the order of 8 bits.
char * format_hex_to(char *buffer, size_t buffer_size, const uint8_t *data, size_t length)
Format byte array as lowercase hex to buffer (base implementation).
float lerp(float completion, float start, float end)=delete
constexpr size_t format_hex_pretty_uint16_size(size_t count)
Calculate buffer size needed for format_hex_pretty_to with uint16_t data: "XXXX:XXXX:....
T remap(U value, U min, U max, T min_out, T max_out)
Remap value from the range (min, max) to (min_out, max_out).
void * callback_manager_grow(void *data, uint16_t size, uint16_t &capacity, size_t elem_size)
Grow a CallbackManager's backing array to exactly size+1. Defined in helpers.cpp.
bool str_endswith(const std::string &str, const std::string &end)
Check whether a string ends with a value.
constexpr uint32_t fnv1a_hash(const char *str)
Calculate a FNV-1a hash of str.
uint16_t uint16_t & capacity
ParseOnOffState
Return values for parse_on_off().
float pow10_int(int8_t exp)
Compute 10^exp using iterative multiplication/division.
std::string make_name_with_suffix(const char *name, size_t name_len, char sep, const char *suffix_ptr, size_t suffix_len)
Optimized string concatenation: name + separator + suffix (const char* overload) Uses a fixed stack b...
char * format_bin_to(char *buffer, size_t buffer_size, const uint8_t *data, size_t length)
Format byte array as binary string to buffer.
char * format_mac_addr_upper(const uint8_t *mac, char *output)
Format MAC address as XX:XX:XX:XX:XX:XX (uppercase, colon separators)
static Callback create(F &&callable)
Create from any callable.
void call(Ts... args) const
Invoke the callback. Only valid on Callbacks created via create(), never on default-constructed insta...
Lightweight type-erased callback (8 bytes on 32-bit) that avoids std::function overhead.