ESPHome  2024.5.4
helpers.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <cmath>
4 #include <cstring>
5 #include <functional>
6 #include <memory>
7 #include <string>
8 #include <type_traits>
9 #include <vector>
10 
11 #include "esphome/core/optional.h"
12 
13 #ifdef USE_ESP32
14 #include <esp_heap_caps.h>
15 #endif
16 
17 #if defined(USE_ESP32)
18 #include <freertos/FreeRTOS.h>
19 #include <freertos/semphr.h>
20 #elif defined(USE_LIBRETINY)
21 #include <FreeRTOS.h>
22 #include <semphr.h>
23 #endif
24 
25 #define HOT __attribute__((hot))
26 #define ESPDEPRECATED(msg, when) __attribute__((deprecated(msg)))
27 #define ESPHOME_ALWAYS_INLINE __attribute__((always_inline))
28 #define PACKED __attribute__((packed))
29 
30 // Various functions can be constexpr in C++14, but not in C++11 (because their body isn't just a return statement).
31 // Define a substitute constexpr keyword for those functions, until we can drop C++11 support.
32 #if __cplusplus >= 201402L
33 #define constexpr14 constexpr
34 #else
35 #define constexpr14 inline // constexpr implies inline
36 #endif
37 
38 namespace esphome {
39 
42 
43 // Backports for various STL features we like to use. Pull in the STL implementation wherever available, to avoid
44 // ambiguity and to provide a uniform API.
45 
46 // std::to_string() from C++11, available from libstdc++/g++ 8
47 // See https://github.com/espressif/esp-idf/issues/1445
48 #if _GLIBCXX_RELEASE >= 8
49 using std::to_string;
50 #else
51 std::string to_string(int value); // NOLINT
52 std::string to_string(long value); // NOLINT
53 std::string to_string(long long value); // NOLINT
54 std::string to_string(unsigned value); // NOLINT
55 std::string to_string(unsigned long value); // NOLINT
56 std::string to_string(unsigned long long value); // NOLINT
57 std::string to_string(float value);
58 std::string to_string(double value);
59 std::string to_string(long double value);
60 #endif
61 
62 // std::is_trivially_copyable from C++11, implemented in libstdc++/g++ 5.1 (but minor releases can't be detected)
63 #if _GLIBCXX_RELEASE >= 6
64 using std::is_trivially_copyable;
65 #else
66 // Implementing this is impossible without compiler intrinsics, so don't bother. Invalid usage will be detected on
67 // other variants that use a newer compiler anyway.
68 // NOLINTNEXTLINE(readability-identifier-naming)
69 template<typename T> struct is_trivially_copyable : public std::integral_constant<bool, true> {};
70 #endif
71 
72 // std::make_unique() from C++14
73 #if __cpp_lib_make_unique >= 201304
74 using std::make_unique;
75 #else
76 template<typename T, typename... Args> std::unique_ptr<T> make_unique(Args &&...args) {
77  return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
78 }
79 #endif
80 
81 // std::enable_if_t from C++14
82 #if __cplusplus >= 201402L
83 using std::enable_if_t;
84 #else
85 template<bool B, class T = void> using enable_if_t = typename std::enable_if<B, T>::type;
86 #endif
87 
88 // std::clamp from C++17
89 #if __cpp_lib_clamp >= 201603
90 using std::clamp;
91 #else
92 template<typename T, typename Compare> constexpr const T &clamp(const T &v, const T &lo, const T &hi, Compare comp) {
93  return comp(v, lo) ? lo : comp(hi, v) ? hi : v;
94 }
95 template<typename T> constexpr const T &clamp(const T &v, const T &lo, const T &hi) {
96  return clamp(v, lo, hi, std::less<T>{});
97 }
98 #endif
99 
100 // std::is_invocable from C++17
101 #if __cpp_lib_is_invocable >= 201703
102 using std::is_invocable;
103 #else
104 // https://stackoverflow.com/a/37161919/8924614
105 template<class T, class... Args> struct is_invocable { // NOLINT(readability-identifier-naming)
106  template<class U> static auto test(U *p) -> decltype((*p)(std::declval<Args>()...), void(), std::true_type());
107  template<class U> static auto test(...) -> decltype(std::false_type());
108  static constexpr auto value = decltype(test<T>(nullptr))::value; // NOLINT
109 };
110 #endif
111 
112 // std::bit_cast from C++20
113 #if __cpp_lib_bit_cast >= 201806
114 using std::bit_cast;
115 #else
116 template<
118  typename To, typename From,
120  int> = 0>
121 To bit_cast(const From &src) {
122  To dst;
123  memcpy(&dst, &src, sizeof(To));
124  return dst;
125 }
126 #endif
127 
128 // std::byteswap from C++23
129 template<typename T> constexpr14 T byteswap(T n) {
130  T m;
131  for (size_t i = 0; i < sizeof(T); i++)
132  reinterpret_cast<uint8_t *>(&m)[i] = reinterpret_cast<uint8_t *>(&n)[sizeof(T) - 1 - i];
133  return m;
134 }
135 template<> constexpr14 uint8_t byteswap(uint8_t n) { return n; }
136 template<> constexpr14 uint16_t byteswap(uint16_t n) { return __builtin_bswap16(n); }
137 template<> constexpr14 uint32_t byteswap(uint32_t n) { return __builtin_bswap32(n); }
138 template<> constexpr14 uint64_t byteswap(uint64_t n) { return __builtin_bswap64(n); }
139 template<> constexpr14 int8_t byteswap(int8_t n) { return n; }
140 template<> constexpr14 int16_t byteswap(int16_t n) { return __builtin_bswap16(n); }
141 template<> constexpr14 int32_t byteswap(int32_t n) { return __builtin_bswap32(n); }
142 template<> constexpr14 int64_t byteswap(int64_t n) { return __builtin_bswap64(n); }
143 
145 
148 
150 float lerp(float completion, float start, float end);
151 
153 template<typename T, typename U> T remap(U value, U min, U max, T min_out, T max_out) {
154  return (value - min) * (max_out - min_out) / (max - min) + min_out;
155 }
156 
158 uint8_t crc8(uint8_t *data, uint8_t len);
159 
161 uint16_t crc16(const uint8_t *data, uint16_t len, uint16_t crc = 0xffff, uint16_t reverse_poly = 0xa001,
162  bool refin = false, bool refout = false);
163 uint16_t crc16be(const uint8_t *data, uint16_t len, uint16_t crc = 0, uint16_t poly = 0x1021, bool refin = false,
164  bool refout = false);
165 
167 uint32_t fnv1_hash(const std::string &str);
168 
170 uint32_t random_uint32();
172 float random_float();
174 bool random_bytes(uint8_t *data, size_t len);
175 
177 
180 
182 constexpr uint16_t encode_uint16(uint8_t msb, uint8_t lsb) {
183  return (static_cast<uint16_t>(msb) << 8) | (static_cast<uint16_t>(lsb));
184 }
186 constexpr uint32_t encode_uint32(uint8_t byte1, uint8_t byte2, uint8_t byte3, uint8_t byte4) {
187  return (static_cast<uint32_t>(byte1) << 24) | (static_cast<uint32_t>(byte2) << 16) |
188  (static_cast<uint32_t>(byte3) << 8) | (static_cast<uint32_t>(byte4));
189 }
191 constexpr uint32_t encode_uint24(uint8_t byte1, uint8_t byte2, uint8_t byte3) {
192  return ((static_cast<uint32_t>(byte1) << 16) | (static_cast<uint32_t>(byte2) << 8) | (static_cast<uint32_t>(byte3)));
193 }
194 
196 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0>
197 constexpr14 T encode_value(const uint8_t *bytes) {
198  T val = 0;
199  for (size_t i = 0; i < sizeof(T); i++) {
200  val <<= 8;
201  val |= bytes[i];
202  }
203  return val;
204 }
206 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0>
207 constexpr14 T encode_value(const std::array<uint8_t, sizeof(T)> bytes) {
208  return encode_value<T>(bytes.data());
209 }
211 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0>
212 constexpr14 std::array<uint8_t, sizeof(T)> decode_value(T val) {
213  std::array<uint8_t, sizeof(T)> ret{};
214  for (size_t i = sizeof(T); i > 0; i--) {
215  ret[i - 1] = val & 0xFF;
216  val >>= 8;
217  }
218  return ret;
219 }
220 
222 inline uint8_t reverse_bits(uint8_t x) {
223  x = ((x & 0xAA) >> 1) | ((x & 0x55) << 1);
224  x = ((x & 0xCC) >> 2) | ((x & 0x33) << 2);
225  x = ((x & 0xF0) >> 4) | ((x & 0x0F) << 4);
226  return x;
227 }
229 inline uint16_t reverse_bits(uint16_t x) {
230  return (reverse_bits(static_cast<uint8_t>(x & 0xFF)) << 8) | reverse_bits(static_cast<uint8_t>((x >> 8) & 0xFF));
231 }
233 inline uint32_t reverse_bits(uint32_t x) {
234  return (reverse_bits(static_cast<uint16_t>(x & 0xFFFF)) << 16) |
235  reverse_bits(static_cast<uint16_t>((x >> 16) & 0xFFFF));
236 }
237 
239 template<typename T> constexpr14 T convert_big_endian(T val) {
240 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
241  return byteswap(val);
242 #else
243  return val;
244 #endif
245 }
246 
248 template<typename T> constexpr14 T convert_little_endian(T val) {
249 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
250  return val;
251 #else
252  return byteswap(val);
253 #endif
254 }
255 
257 
260 
262 bool str_equals_case_insensitive(const std::string &a, const std::string &b);
263 
265 bool str_startswith(const std::string &str, const std::string &start);
267 bool str_endswith(const std::string &str, const std::string &end);
268 
270 inline std::string to_string(const std::string &val) { return val; }
271 
273 std::string str_truncate(const std::string &str, size_t length);
274 
277 std::string str_until(const char *str, char ch);
279 std::string str_until(const std::string &str, char ch);
280 
282 std::string str_lower_case(const std::string &str);
284 std::string str_upper_case(const std::string &str);
286 std::string str_snake_case(const std::string &str);
287 
289 std::string str_sanitize(const std::string &str);
290 
292 std::string __attribute__((format(printf, 1, 3))) str_snprintf(const char *fmt, size_t len, ...);
293 
295 std::string __attribute__((format(printf, 1, 2))) str_sprintf(const char *fmt, ...);
296 
298 
301 
303 template<typename T, enable_if_t<(std::is_integral<T>::value && std::is_unsigned<T>::value), int> = 0>
304 optional<T> parse_number(const char *str) {
305  char *end = nullptr;
306  unsigned long value = ::strtoul(str, &end, 10); // NOLINT(google-runtime-int)
307  if (end == str || *end != '\0' || value > std::numeric_limits<T>::max())
308  return {};
309  return value;
310 }
312 template<typename T, enable_if_t<(std::is_integral<T>::value && std::is_unsigned<T>::value), int> = 0>
313 optional<T> parse_number(const std::string &str) {
314  return parse_number<T>(str.c_str());
315 }
317 template<typename T, enable_if_t<(std::is_integral<T>::value && std::is_signed<T>::value), int> = 0>
318 optional<T> parse_number(const char *str) {
319  char *end = nullptr;
320  signed long value = ::strtol(str, &end, 10); // NOLINT(google-runtime-int)
321  if (end == str || *end != '\0' || value < std::numeric_limits<T>::min() || value > std::numeric_limits<T>::max())
322  return {};
323  return value;
324 }
326 template<typename T, enable_if_t<(std::is_integral<T>::value && std::is_signed<T>::value), int> = 0>
327 optional<T> parse_number(const std::string &str) {
328  return parse_number<T>(str.c_str());
329 }
331 template<typename T, enable_if_t<(std::is_same<T, float>::value), int> = 0> optional<T> parse_number(const char *str) {
332  char *end = nullptr;
333  float value = ::strtof(str, &end);
334  if (end == str || *end != '\0' || value == HUGE_VALF)
335  return {};
336  return value;
337 }
339 template<typename T, enable_if_t<(std::is_same<T, float>::value), int> = 0>
340 optional<T> parse_number(const std::string &str) {
341  return parse_number<T>(str.c_str());
342 }
343 
355 size_t parse_hex(const char *str, size_t len, uint8_t *data, size_t count);
357 inline bool parse_hex(const char *str, uint8_t *data, size_t count) {
358  return parse_hex(str, strlen(str), data, count) == 2 * count;
359 }
361 inline bool parse_hex(const std::string &str, uint8_t *data, size_t count) {
362  return parse_hex(str.c_str(), str.length(), data, count) == 2 * count;
363 }
365 inline bool parse_hex(const char *str, std::vector<uint8_t> &data, size_t count) {
366  data.resize(count);
367  return parse_hex(str, strlen(str), data.data(), count) == 2 * count;
368 }
370 inline bool parse_hex(const std::string &str, std::vector<uint8_t> &data, size_t count) {
371  data.resize(count);
372  return parse_hex(str.c_str(), str.length(), data.data(), count) == 2 * count;
373 }
379 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0>
380 optional<T> parse_hex(const char *str, size_t len) {
381  T val = 0;
382  if (len > 2 * sizeof(T) || parse_hex(str, len, reinterpret_cast<uint8_t *>(&val), sizeof(T)) == 0)
383  return {};
384  return convert_big_endian(val);
385 }
387 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0> optional<T> parse_hex(const char *str) {
388  return parse_hex<T>(str, strlen(str));
389 }
391 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0> optional<T> parse_hex(const std::string &str) {
392  return parse_hex<T>(str.c_str(), str.length());
393 }
394 
396 std::string format_hex(const uint8_t *data, size_t length);
398 std::string format_hex(const std::vector<uint8_t> &data);
400 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0> std::string format_hex(T val) {
401  val = convert_big_endian(val);
402  return format_hex(reinterpret_cast<uint8_t *>(&val), sizeof(T));
403 }
404 template<std::size_t N> std::string format_hex(const std::array<uint8_t, N> &data) {
405  return format_hex(data.data(), data.size());
406 }
407 
409 std::string format_hex_pretty(const uint8_t *data, size_t length);
411 std::string format_hex_pretty(const uint16_t *data, size_t length);
413 std::string format_hex_pretty(const std::vector<uint8_t> &data);
415 std::string format_hex_pretty(const std::vector<uint16_t> &data);
417 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0> std::string format_hex_pretty(T val) {
418  val = convert_big_endian(val);
419  return format_hex_pretty(reinterpret_cast<uint8_t *>(&val), sizeof(T));
420 }
421 
428 };
430 ParseOnOffState parse_on_off(const char *str, const char *on = nullptr, const char *off = nullptr);
431 
433 std::string value_accuracy_to_string(float value, int8_t accuracy_decimals);
434 
436 int8_t step_to_accuracy_decimals(float step);
437 
438 std::string base64_encode(const uint8_t *buf, size_t buf_len);
439 std::string base64_encode(const std::vector<uint8_t> &buf);
440 
441 std::vector<uint8_t> base64_decode(const std::string &encoded_string);
442 size_t base64_decode(std::string const &encoded_string, uint8_t *buf, size_t buf_len);
443 
445 
448 
450 float gamma_correct(float value, float gamma);
452 float gamma_uncorrect(float value, float gamma);
453 
455 void rgb_to_hsv(float red, float green, float blue, int &hue, float &saturation, float &value);
457 void hsv_to_rgb(int hue, float saturation, float value, float &red, float &green, float &blue);
458 
460 
463 
465 constexpr float celsius_to_fahrenheit(float value) { return value * 1.8f + 32.0f; }
467 constexpr float fahrenheit_to_celsius(float value) { return (value - 32.0f) / 1.8f; }
468 
470 
473 
474 template<typename... X> class CallbackManager;
475 
480 template<typename... Ts> class CallbackManager<void(Ts...)> {
481  public:
483  void add(std::function<void(Ts...)> &&callback) { this->callbacks_.push_back(std::move(callback)); }
484 
486  void call(Ts... args) {
487  for (auto &cb : this->callbacks_)
488  cb(args...);
489  }
490  size_t size() const { return this->callbacks_.size(); }
491 
493  void operator()(Ts... args) { call(args...); }
494 
495  protected:
496  std::vector<std::function<void(Ts...)>> callbacks_;
497 };
498 
500 template<typename T> class Deduplicator {
501  public:
503  bool next(T value) {
504  if (this->has_value_) {
505  if (this->last_value_ == value)
506  return false;
507  }
508  this->has_value_ = true;
509  this->last_value_ = value;
510  return true;
511  }
513  bool has_value() const { return this->has_value_; }
514 
515  protected:
516  bool has_value_{false};
517  T last_value_{};
518 };
519 
521 template<typename T> class Parented {
522  public:
523  Parented() {}
524  Parented(T *parent) : parent_(parent) {}
525 
527  T *get_parent() const { return parent_; }
529  void set_parent(T *parent) { parent_ = parent; }
530 
531  protected:
532  T *parent_{nullptr};
533 };
534 
536 
539 
544 class Mutex {
545  public:
546  Mutex();
547  Mutex(const Mutex &) = delete;
548  void lock();
549  bool try_lock();
550  void unlock();
551 
552  Mutex &operator=(const Mutex &) = delete;
553 
554  private:
555 #if defined(USE_ESP32) || defined(USE_LIBRETINY)
556  SemaphoreHandle_t handle_;
557 #endif
558 };
559 
564 class LockGuard {
565  public:
566  LockGuard(Mutex &mutex) : mutex_(mutex) { mutex_.lock(); }
567  ~LockGuard() { mutex_.unlock(); }
568 
569  private:
570  Mutex &mutex_;
571 };
572 
594  public:
595  InterruptLock();
596  ~InterruptLock();
597 
598  protected:
599 #if defined(USE_ESP8266) || defined(USE_RP2040)
600  uint32_t state_;
601 #endif
602 };
603 
610  public:
612  void start();
614  void stop();
615 
617  static bool is_high_frequency();
618 
619  protected:
620  bool started_{false};
621  static uint8_t num_requests; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
622 };
623 
625 void get_mac_address_raw(uint8_t *mac); // NOLINT(readability-non-const-parameter)
626 
628 std::string get_mac_address();
629 
631 std::string get_mac_address_pretty();
632 
633 #ifdef USE_ESP32
634 void set_mac_address(uint8_t *mac);
636 #endif
637 
639 void delay_microseconds_safe(uint32_t us);
640 
642 
645 
651 template<class T> class ExternalRAMAllocator {
652  public:
653  using value_type = T;
654 
655  enum Flags {
656  NONE = 0,
657  REFUSE_INTERNAL = 1 << 0,
658  ALLOW_FAILURE = 1 << 1,
659  };
660 
661  ExternalRAMAllocator() = default;
662  ExternalRAMAllocator(Flags flags) : flags_{flags} {}
663  template<class U> constexpr ExternalRAMAllocator(const ExternalRAMAllocator<U> &other) : flags_{other.flags_} {}
664 
665  T *allocate(size_t n) {
666  size_t size = n * sizeof(T);
667  T *ptr = nullptr;
668 #ifdef USE_ESP32
669  ptr = static_cast<T *>(heap_caps_malloc(size, MALLOC_CAP_SPIRAM | MALLOC_CAP_8BIT));
670 #endif
671  if (ptr == nullptr && (this->flags_ & Flags::REFUSE_INTERNAL) == 0)
672  ptr = static_cast<T *>(malloc(size)); // NOLINT(cppcoreguidelines-owning-memory,cppcoreguidelines-no-malloc)
673  if (ptr == nullptr && (this->flags_ & Flags::ALLOW_FAILURE) == 0)
674  abort();
675  return ptr;
676  }
677 
678  void deallocate(T *p, size_t n) {
679  free(p); // NOLINT(cppcoreguidelines-owning-memory,cppcoreguidelines-no-malloc)
680  }
681 
682  private:
683  Flags flags_{Flags::NONE};
684 };
685 
687 
690 
695 template<typename T, enable_if_t<!std::is_pointer<T>::value, int> = 0> T id(T value) { return value; }
700 template<typename T, enable_if_t<std::is_pointer<T *>::value, int> = 0> T &id(T *value) { return *value; }
701 
703 
706 
707 ESPDEPRECATED("hexencode() is deprecated, use format_hex_pretty() instead.", "2022.1")
708 inline std::string hexencode(const uint8_t *data, uint32_t len) { return format_hex_pretty(data, len); }
709 
710 template<typename T>
711 ESPDEPRECATED("hexencode() is deprecated, use format_hex_pretty() instead.", "2022.1")
712 std::string hexencode(const T &data) {
713  return hexencode(data.data(), data.size());
714 }
715 
717 
718 } // namespace esphome
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)...
Definition: helpers.cpp:579
std::string str_snake_case(const std::string &str)
Convert the string to snake case (lowercase with underscores).
Definition: helpers.cpp:281
std::string str_truncate(const std::string &str, size_t length)
Truncate a string to a specific length.
Definition: helpers.cpp:263
uint16_t crc16be(const uint8_t *data, uint16_t len, uint16_t crc, uint16_t poly, bool refin, bool refout)
Definition: helpers.cpp:150
std::string value_accuracy_to_string(float value, int8_t accuracy_decimals)
Create a string from a value and an accuracy in decimals.
Definition: helpers.cpp:412
std::string format_hex_pretty(const uint8_t *data, size_t length)
Format the byte array data of length len in pretty-printed, human-readable hex.
Definition: helpers.cpp:361
std::string str_upper_case(const std::string &str)
Convert the string to upper case.
Definition: helpers.cpp:280
std::string format_hex(const uint8_t *data, size_t length)
Format the byte array data of length len in lowercased hex.
Definition: helpers.cpp:349
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.
Definition: helpers.cpp:330
bool next(T value)
Feeds the next item in the series to the deduplicator and returns whether this is a duplicate...
Definition: helpers.h:503
uint32_t random_uint32()
Return a random 32-bit unsigned integer.
Definition: helpers.cpp:193
constexpr ExternalRAMAllocator(const ExternalRAMAllocator< U > &other)
Definition: helpers.h:663
uint16_t x
Definition: tt21100.cpp:17
std::string str_until(const char *str, char ch)
Extract the part of the string until either the first occurrence of the specified character...
Definition: helpers.cpp:266
uint8_t crc8(uint8_t *data, uint8_t len)
Calculate a CRC-8 checksum of data with size len.
Definition: helpers.cpp:96
Helper class to request loop() to be called as fast as possible.
Definition: helpers.h:609
typename std::enable_if< B, T >::type enable_if_t
Definition: helpers.h:85
An STL allocator that uses SPI RAM.
Definition: helpers.h:651
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.
Definition: helpers.h:186
size_t base64_decode(const std::string &encoded_string, uint8_t *buf, size_t buf_len)
Definition: helpers.cpp:484
std::string to_string(const std::string &val)
Convert the value to a string (added as extra overload so that to_string() can be used on all stringi...
Definition: helpers.h:270
void deallocate(T *p, size_t n)
Definition: helpers.h:678
STL namespace.
T id(T value)
Helper function to make id(var) known from lambdas work in custom components.
Definition: helpers.h:695
std::vector< std::function< void(Ts...)> > callbacks_
Definition: helpers.h:496
float lerp(float completion, float start, float end)
Linearly interpolate between start and end by completion (between 0 and 1).
Definition: helpers.cpp:95
mopeka_std_values val[4]
void set_parent(T *parent)
Set the parent of this object.
Definition: helpers.h:529
void delay_microseconds_safe(uint32_t us)
Delay for the given amount of microseconds, possibly yielding to other processes during the wait...
Definition: helpers.cpp:702
bool random_bytes(uint8_t *data, size_t len)
Generate len number of random bytes.
Definition: helpers.cpp:217
constexpr14 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...
Definition: helpers.h:197
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.
Definition: helpers.cpp:112
constexpr const T & clamp(const T &v, const T &lo, const T &hi, Compare comp)
Definition: helpers.h:92
ParseOnOffState parse_on_off(const char *str, const char *on, const char *off)
Parse a string that contains either on, off or toggle.
Definition: helpers.cpp:397
void call(Ts... args)
Call all callbacks in this manager.
Definition: helpers.h:486
uint8_t reverse_bits(uint8_t x)
Reverse the order of 8 bits.
Definition: helpers.h:222
uint8_t m
Definition: bl0939.h:20
ParseOnOffState
Return values for parse_on_off().
Definition: helpers.h:423
float gamma_correct(float value, float gamma)
Applies gamma correction of gamma to value.
Definition: helpers.cpp:539
bool str_startswith(const std::string &str, const std::string &start)
Check whether a string starts with a value.
Definition: helpers.cpp:259
constexpr float celsius_to_fahrenheit(float value)
Convert degrees Celsius to degrees Fahrenheit.
Definition: helpers.h:465
std::string base64_encode(const std::vector< uint8_t > &buf)
Definition: helpers.cpp:442
ESPDEPRECATED("Use Color::BLACK instead of COLOR_BLACK", "v1.21") extern const Color COLOR_BLACK
optional< T > parse_number(const char *str)
Parse an unsigned decimal number from a null-terminated string.
Definition: helpers.h:304
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)...
Definition: helpers.cpp:556
std::string str_lower_case(const std::string &str)
Convert the string to lower case.
Definition: helpers.cpp:279
std::string str_sprintf(const char *fmt,...)
Definition: helpers.cpp:312
constexpr14 std::array< uint8_t, sizeof(T)> decode_value(T val)
Decode a value into its constituent bytes (from most to least significant).
Definition: helpers.h:212
constexpr14 T convert_big_endian(T val)
Convert a value between host byte order and big endian (most significant byte first) order...
Definition: helpers.h:239
std::string get_mac_address()
Get the device MAC address as a string, in lowercase hex notation.
Definition: helpers.cpp:688
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.
Definition: helpers.h:191
uint8_t type
ExternalRAMAllocator(Flags flags)
Definition: helpers.h:662
bool has_value() const
Returns whether this deduplicator has processed any items so far.
Definition: helpers.h:513
bool str_endswith(const std::string &str, const std::string &end)
Check whether a string ends with a value.
Definition: helpers.cpp:260
constexpr uint16_t encode_uint16(uint8_t msb, uint8_t lsb)
Encode a 16-bit value given the most and least significant byte.
Definition: helpers.h:182
void set_mac_address(uint8_t *mac)
Set the MAC address to use from the provided byte array (6 bytes).
Definition: helpers.cpp:699
int8_t step_to_accuracy_decimals(float step)
Derive accuracy in decimals from an increment step.
Definition: helpers.cpp:423
enum esphome::EntityCategory __attribute__
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).
Definition: helpers.h:153
const uint32_t flags
Definition: stm32flash.h:85
Parented(T *parent)
Definition: helpers.h:524
LockGuard(Mutex &mutex)
Definition: helpers.h:566
T * get_parent() const
Get the parent of this object.
Definition: helpers.h:527
Helper class to disable interrupts.
Definition: helpers.h:593
std::string str_sanitize(const std::string &str)
Sanitizes the input string by removing all characters but alphanumerics, dashes and underscores...
Definition: helpers.cpp:288
std::string to_string(int value)
Definition: helpers.cpp:82
std::string size_t len
Definition: helpers.h:292
uint32_t fnv1_hash(const std::string &str)
Calculate a FNV-1 hash of str.
Definition: helpers.cpp:184
constexpr14 T byteswap(T n)
Definition: helpers.h:129
To bit_cast(const From &src)
Convert data between types, without aliasing issues or undefined behaviour.
Definition: helpers.h:121
constexpr14 T convert_little_endian(T val)
Convert a value between host byte order and little endian (least significant byte first) order...
Definition: helpers.h:248
uint16_t length
Definition: tt21100.cpp:12
Helper class to deduplicate items in a series of values.
Definition: helpers.h:500
This is a workaround until we can figure out a way to get the tflite-micro idf component code availab...
Definition: a01nyub.cpp:7
void operator()(Ts... args)
Call all callbacks in this manager.
Definition: helpers.h:493
num_t cb(num_t x)
Definition: sun.cpp:31
std::vector< uint8_t > bytes
Definition: sml_parser.h:12
uint8_t end[39]
Definition: sun_gtil2.cpp:31
std::unique_ptr< T > make_unique(Args &&...args)
Definition: helpers.h:76
std::string get_mac_address_pretty()
Get the device MAC address as a string, in colon-separated uppercase hex notation.
Definition: helpers.cpp:693
void add(std::function< void(Ts...)> &&callback)
Add a callback to the list.
Definition: helpers.h:483
constexpr float fahrenheit_to_celsius(float value)
Convert degrees Fahrenheit to degrees Celsius.
Definition: helpers.h:467
std::string str_snprintf(const char *fmt, size_t len,...)
Definition: helpers.cpp:298
float random_float()
Return a random float between 0 and 1.
Definition: helpers.cpp:216
Helper class to easily give an object a parent of type T.
Definition: helpers.h:521
Helper class that wraps a mutex with a RAII-style API.
Definition: helpers.h:564
Mutex implementation, with API based on the unavailable std::mutex.
Definition: helpers.h:544
bool str_equals_case_insensitive(const std::string &a, const std::string &b)
Compare strings for equality in case-insensitive manner.
Definition: helpers.cpp:256
void get_mac_address_raw(uint8_t *mac)
Get the device MAC address as raw bytes, written into the provided byte array (6 bytes).
Definition: helpers.cpp:662
constexpr const T & clamp(const T &v, const T &lo, const T &hi)
Definition: helpers.h:95
float gamma_uncorrect(float value, float gamma)
Reverts gamma correction of gamma to value.
Definition: helpers.cpp:547