ESPHome  2022.11.3
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 #define HOT __attribute__((hot))
18 #define ESPDEPRECATED(msg, when) __attribute__((deprecated(msg)))
19 #define ALWAYS_INLINE __attribute__((always_inline))
20 #define PACKED __attribute__((packed))
21 
22 // Various functions can be constexpr in C++14, but not in C++11 (because their body isn't just a return statement).
23 // Define a substitute constexpr keyword for those functions, until we can drop C++11 support.
24 #if __cplusplus >= 201402L
25 #define constexpr14 constexpr
26 #else
27 #define constexpr14 inline // constexpr implies inline
28 #endif
29 
30 namespace esphome {
31 
34 
35 // Backports for various STL features we like to use. Pull in the STL implementation wherever available, to avoid
36 // ambiguity and to provide a uniform API.
37 
38 // std::to_string() from C++11, available from libstdc++/g++ 8
39 // See https://github.com/espressif/esp-idf/issues/1445
40 #if _GLIBCXX_RELEASE >= 8
41 using std::to_string;
42 #else
43 std::string to_string(int value); // NOLINT
44 std::string to_string(long value); // NOLINT
45 std::string to_string(long long value); // NOLINT
46 std::string to_string(unsigned value); // NOLINT
47 std::string to_string(unsigned long value); // NOLINT
48 std::string to_string(unsigned long long value); // NOLINT
49 std::string to_string(float value);
50 std::string to_string(double value);
51 std::string to_string(long double value);
52 #endif
53 
54 // std::is_trivially_copyable from C++11, implemented in libstdc++/g++ 5.1 (but minor releases can't be detected)
55 #if _GLIBCXX_RELEASE >= 6
56 using std::is_trivially_copyable;
57 #else
58 // Implementing this is impossible without compiler intrinsics, so don't bother. Invalid usage will be detected on
59 // other variants that use a newer compiler anyway.
60 // NOLINTNEXTLINE(readability-identifier-naming)
61 template<typename T> struct is_trivially_copyable : public std::integral_constant<bool, true> {};
62 #endif
63 
64 // std::make_unique() from C++14
65 #if __cpp_lib_make_unique >= 201304
66 using std::make_unique;
67 #else
68 template<typename T, typename... Args> std::unique_ptr<T> make_unique(Args &&...args) {
69  return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
70 }
71 #endif
72 
73 // std::enable_if_t from C++14
74 #if __cplusplus >= 201402L
75 using std::enable_if_t;
76 #else
77 template<bool B, class T = void> using enable_if_t = typename std::enable_if<B, T>::type;
78 #endif
79 
80 // std::clamp from C++17
81 #if __cpp_lib_clamp >= 201603
82 using std::clamp;
83 #else
84 template<typename T, typename Compare> constexpr const T &clamp(const T &v, const T &lo, const T &hi, Compare comp) {
85  return comp(v, lo) ? lo : comp(hi, v) ? hi : v;
86 }
87 template<typename T> constexpr const T &clamp(const T &v, const T &lo, const T &hi) {
88  return clamp(v, lo, hi, std::less<T>{});
89 }
90 #endif
91 
92 // std::is_invocable from C++17
93 #if __cpp_lib_is_invocable >= 201703
94 using std::is_invocable;
95 #else
96 // https://stackoverflow.com/a/37161919/8924614
97 template<class T, class... Args> struct is_invocable { // NOLINT(readability-identifier-naming)
98  template<class U> static auto test(U *p) -> decltype((*p)(std::declval<Args>()...), void(), std::true_type());
99  template<class U> static auto test(...) -> decltype(std::false_type());
100  static constexpr auto value = decltype(test<T>(nullptr))::value; // NOLINT
101 };
102 #endif
103 
104 // std::bit_cast from C++20
105 #if __cpp_lib_bit_cast >= 201806
106 using std::bit_cast;
107 #else
108 template<
110  typename To, typename From,
112  int> = 0>
113 To bit_cast(const From &src) {
114  To dst;
115  memcpy(&dst, &src, sizeof(To));
116  return dst;
117 }
118 #endif
119 
120 // std::byteswap from C++23
121 template<typename T> constexpr14 T byteswap(T n) {
122  T m;
123  for (size_t i = 0; i < sizeof(T); i++)
124  reinterpret_cast<uint8_t *>(&m)[i] = reinterpret_cast<uint8_t *>(&n)[sizeof(T) - 1 - i];
125  return m;
126 }
127 template<> constexpr14 uint8_t byteswap(uint8_t n) { return n; }
128 template<> constexpr14 uint16_t byteswap(uint16_t n) { return __builtin_bswap16(n); }
129 template<> constexpr14 uint32_t byteswap(uint32_t n) { return __builtin_bswap32(n); }
130 template<> constexpr14 uint64_t byteswap(uint64_t n) { return __builtin_bswap64(n); }
131 template<> constexpr14 int8_t byteswap(int8_t n) { return n; }
132 template<> constexpr14 int16_t byteswap(int16_t n) { return __builtin_bswap16(n); }
133 template<> constexpr14 int32_t byteswap(int32_t n) { return __builtin_bswap32(n); }
134 template<> constexpr14 int64_t byteswap(int64_t n) { return __builtin_bswap64(n); }
135 
137 
140 
142 float lerp(float completion, float start, float end);
143 
145 template<typename T, typename U> T remap(U value, U min, U max, T min_out, T max_out) {
146  return (value - min) * (max_out - min_out) / (max - min) + min_out;
147 }
148 
150 uint8_t crc8(uint8_t *data, uint8_t len);
151 
153 uint16_t crc16(const uint8_t *data, uint8_t len);
154 
156 uint32_t fnv1_hash(const std::string &str);
157 
159 uint32_t random_uint32();
161 float random_float();
163 bool random_bytes(uint8_t *data, size_t len);
164 
166 
169 
171 constexpr uint16_t encode_uint16(uint8_t msb, uint8_t lsb) {
172  return (static_cast<uint16_t>(msb) << 8) | (static_cast<uint16_t>(lsb));
173 }
175 constexpr uint32_t encode_uint32(uint8_t byte1, uint8_t byte2, uint8_t byte3, uint8_t byte4) {
176  return (static_cast<uint32_t>(byte1) << 24) | (static_cast<uint32_t>(byte2) << 16) |
177  (static_cast<uint32_t>(byte3) << 8) | (static_cast<uint32_t>(byte4));
178 }
180 constexpr uint32_t encode_uint24(uint8_t byte1, uint8_t byte2, uint8_t byte3) {
181  return ((static_cast<uint32_t>(byte1) << 16) | (static_cast<uint32_t>(byte2) << 8) | (static_cast<uint32_t>(byte3)));
182 }
183 
185 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0>
186 constexpr14 T encode_value(const uint8_t *bytes) {
187  T val = 0;
188  for (size_t i = 0; i < sizeof(T); i++) {
189  val <<= 8;
190  val |= bytes[i];
191  }
192  return val;
193 }
195 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0>
196 constexpr14 T encode_value(const std::array<uint8_t, sizeof(T)> bytes) {
197  return encode_value<T>(bytes.data());
198 }
200 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0>
201 constexpr14 std::array<uint8_t, sizeof(T)> decode_value(T val) {
202  std::array<uint8_t, sizeof(T)> ret{};
203  for (size_t i = sizeof(T); i > 0; i--) {
204  ret[i - 1] = val & 0xFF;
205  val >>= 8;
206  }
207  return ret;
208 }
209 
211 inline uint8_t reverse_bits(uint8_t x) {
212  x = ((x & 0xAA) >> 1) | ((x & 0x55) << 1);
213  x = ((x & 0xCC) >> 2) | ((x & 0x33) << 2);
214  x = ((x & 0xF0) >> 4) | ((x & 0x0F) << 4);
215  return x;
216 }
218 inline uint16_t reverse_bits(uint16_t x) {
219  return (reverse_bits(static_cast<uint8_t>(x & 0xFF)) << 8) | reverse_bits(static_cast<uint8_t>((x >> 8) & 0xFF));
220 }
222 inline uint32_t reverse_bits(uint32_t x) {
223  return (reverse_bits(static_cast<uint16_t>(x & 0xFFFF)) << 16) |
224  reverse_bits(static_cast<uint16_t>((x >> 16) & 0xFFFF));
225 }
226 
228 template<typename T> constexpr14 T convert_big_endian(T val) {
229 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
230  return byteswap(val);
231 #else
232  return val;
233 #endif
234 }
235 
237 template<typename T> constexpr14 T convert_little_endian(T val) {
238 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
239  return val;
240 #else
241  return byteswap(val);
242 #endif
243 }
244 
246 
249 
251 bool str_equals_case_insensitive(const std::string &a, const std::string &b);
252 
254 bool str_startswith(const std::string &str, const std::string &start);
256 bool str_endswith(const std::string &str, const std::string &end);
257 
259 inline std::string to_string(const std::string &val) { return val; }
260 
262 std::string str_truncate(const std::string &str, size_t length);
263 
266 std::string str_until(const char *str, char ch);
268 std::string str_until(const std::string &str, char ch);
269 
271 std::string str_lower_case(const std::string &str);
273 std::string str_upper_case(const std::string &str);
275 std::string str_snake_case(const std::string &str);
276 
278 std::string str_sanitize(const std::string &str);
279 
281 std::string __attribute__((format(printf, 1, 3))) str_snprintf(const char *fmt, size_t len, ...);
282 
284 std::string __attribute__((format(printf, 1, 2))) str_sprintf(const char *fmt, ...);
285 
287 
290 
292 template<typename T, enable_if_t<(std::is_integral<T>::value && std::is_unsigned<T>::value), int> = 0>
293 optional<T> parse_number(const char *str) {
294  char *end = nullptr;
295  unsigned long value = ::strtoul(str, &end, 10); // NOLINT(google-runtime-int)
296  if (end == str || *end != '\0' || value > std::numeric_limits<T>::max())
297  return {};
298  return value;
299 }
301 template<typename T, enable_if_t<(std::is_integral<T>::value && std::is_unsigned<T>::value), int> = 0>
302 optional<T> parse_number(const std::string &str) {
303  return parse_number<T>(str.c_str());
304 }
306 template<typename T, enable_if_t<(std::is_integral<T>::value && std::is_signed<T>::value), int> = 0>
307 optional<T> parse_number(const char *str) {
308  char *end = nullptr;
309  signed long value = ::strtol(str, &end, 10); // NOLINT(google-runtime-int)
310  if (end == str || *end != '\0' || value < std::numeric_limits<T>::min() || value > std::numeric_limits<T>::max())
311  return {};
312  return value;
313 }
315 template<typename T, enable_if_t<(std::is_integral<T>::value && std::is_signed<T>::value), int> = 0>
316 optional<T> parse_number(const std::string &str) {
317  return parse_number<T>(str.c_str());
318 }
320 template<typename T, enable_if_t<(std::is_same<T, float>::value), int> = 0> optional<T> parse_number(const char *str) {
321  char *end = nullptr;
322  float value = ::strtof(str, &end);
323  if (end == str || *end != '\0' || value == HUGE_VALF)
324  return {};
325  return value;
326 }
328 template<typename T, enable_if_t<(std::is_same<T, float>::value), int> = 0>
329 optional<T> parse_number(const std::string &str) {
330  return parse_number<T>(str.c_str());
331 }
332 
344 size_t parse_hex(const char *str, size_t len, uint8_t *data, size_t count);
346 inline bool parse_hex(const char *str, uint8_t *data, size_t count) {
347  return parse_hex(str, strlen(str), data, count) == 2 * count;
348 }
350 inline bool parse_hex(const std::string &str, uint8_t *data, size_t count) {
351  return parse_hex(str.c_str(), str.length(), data, count) == 2 * count;
352 }
354 inline bool parse_hex(const char *str, std::vector<uint8_t> &data, size_t count) {
355  data.resize(count);
356  return parse_hex(str, strlen(str), data.data(), count) == 2 * count;
357 }
359 inline bool parse_hex(const std::string &str, std::vector<uint8_t> &data, size_t count) {
360  data.resize(count);
361  return parse_hex(str.c_str(), str.length(), data.data(), count) == 2 * count;
362 }
368 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0>
369 optional<T> parse_hex(const char *str, size_t len) {
370  T val = 0;
371  if (len > 2 * sizeof(T) || parse_hex(str, len, reinterpret_cast<uint8_t *>(&val), sizeof(T)) == 0)
372  return {};
373  return convert_big_endian(val);
374 }
376 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0> optional<T> parse_hex(const char *str) {
377  return parse_hex<T>(str, strlen(str));
378 }
380 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0> optional<T> parse_hex(const std::string &str) {
381  return parse_hex<T>(str.c_str(), str.length());
382 }
383 
385 std::string format_hex(const uint8_t *data, size_t length);
387 std::string format_hex(const std::vector<uint8_t> &data);
389 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0> std::string format_hex(T val) {
390  val = convert_big_endian(val);
391  return format_hex(reinterpret_cast<uint8_t *>(&val), sizeof(T));
392 }
393 
395 std::string format_hex_pretty(const uint8_t *data, size_t length);
397 std::string format_hex_pretty(const uint16_t *data, size_t length);
399 std::string format_hex_pretty(const std::vector<uint8_t> &data);
401 std::string format_hex_pretty(const std::vector<uint16_t> &data);
403 template<typename T, enable_if_t<std::is_unsigned<T>::value, int> = 0> std::string format_hex_pretty(T val) {
404  val = convert_big_endian(val);
405  return format_hex_pretty(reinterpret_cast<uint8_t *>(&val), sizeof(T));
406 }
407 
414 };
416 ParseOnOffState parse_on_off(const char *str, const char *on = nullptr, const char *off = nullptr);
417 
419 std::string value_accuracy_to_string(float value, int8_t accuracy_decimals);
420 
422 int8_t step_to_accuracy_decimals(float step);
423 
425 
428 
430 float gamma_correct(float value, float gamma);
432 float gamma_uncorrect(float value, float gamma);
433 
435 void rgb_to_hsv(float red, float green, float blue, int &hue, float &saturation, float &value);
437 void hsv_to_rgb(int hue, float saturation, float value, float &red, float &green, float &blue);
438 
440 
443 
445 constexpr float celsius_to_fahrenheit(float value) { return value * 1.8f + 32.0f; }
447 constexpr float fahrenheit_to_celsius(float value) { return (value - 32.0f) / 1.8f; }
448 
450 
453 
454 template<typename... X> class CallbackManager;
455 
460 template<typename... Ts> class CallbackManager<void(Ts...)> {
461  public:
463  void add(std::function<void(Ts...)> &&callback) { this->callbacks_.push_back(std::move(callback)); }
464 
466  void call(Ts... args) {
467  for (auto &cb : this->callbacks_)
468  cb(args...);
469  }
470 
472  void operator()(Ts... args) { call(args...); }
473 
474  protected:
475  std::vector<std::function<void(Ts...)>> callbacks_;
476 };
477 
479 template<typename T> class Deduplicator {
480  public:
482  bool next(T value) {
483  if (this->has_value_) {
484  if (this->last_value_ == value)
485  return false;
486  }
487  this->has_value_ = true;
488  this->last_value_ = value;
489  return true;
490  }
492  bool has_value() const { return this->has_value_; }
493 
494  protected:
495  bool has_value_{false};
496  T last_value_{};
497 };
498 
500 template<typename T> class Parented {
501  public:
502  Parented() {}
503  Parented(T *parent) : parent_(parent) {}
504 
506  T *get_parent() const { return parent_; }
508  void set_parent(T *parent) { parent_ = parent; }
509 
510  protected:
511  T *parent_{nullptr};
512 };
513 
515 
518 
540  public:
541  InterruptLock();
542  ~InterruptLock();
543 
544  protected:
545 #if defined(USE_ESP8266) || defined(USE_RP2040)
546  uint32_t state_;
547 #endif
548 };
549 
556  public:
558  void start();
560  void stop();
561 
563  static bool is_high_frequency();
564 
565  protected:
566  bool started_{false};
567  static uint8_t num_requests; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
568 };
569 
571 void get_mac_address_raw(uint8_t *mac);
572 
574 std::string get_mac_address();
575 
577 std::string get_mac_address_pretty();
578 
579 #ifdef USE_ESP32
580 void set_mac_address(uint8_t *mac);
582 #endif
583 
585 void delay_microseconds_safe(uint32_t us);
586 
588 
591 
597 template<class T> class ExternalRAMAllocator {
598  public:
599  using value_type = T;
600 
601  enum Flags {
602  NONE = 0,
603  REFUSE_INTERNAL = 1 << 0,
604  ALLOW_FAILURE = 1 << 1,
605  };
606 
607  ExternalRAMAllocator() = default;
608  ExternalRAMAllocator(Flags flags) : flags_{flags} {}
609  template<class U> constexpr ExternalRAMAllocator(const ExternalRAMAllocator<U> &other) : flags_{other.flags_} {}
610 
611  T *allocate(size_t n) {
612  size_t size = n * sizeof(T);
613  T *ptr = nullptr;
614 #ifdef USE_ESP32
615  ptr = static_cast<T *>(heap_caps_malloc(size, MALLOC_CAP_SPIRAM));
616 #endif
617  if (ptr == nullptr && (this->flags_ & Flags::REFUSE_INTERNAL) == 0)
618  ptr = static_cast<T *>(malloc(size)); // NOLINT(cppcoreguidelines-owning-memory,cppcoreguidelines-no-malloc)
619  if (ptr == nullptr && (this->flags_ & Flags::ALLOW_FAILURE) == 0)
620  abort();
621  return ptr;
622  }
623 
624  void deallocate(T *p, size_t n) {
625  free(p); // NOLINT(cppcoreguidelines-owning-memory,cppcoreguidelines-no-malloc)
626  }
627 
628  private:
629  Flags flags_{Flags::NONE};
630 };
631 
633 
636 
641 template<typename T, enable_if_t<!std::is_pointer<T>::value, int> = 0> T id(T value) { return value; }
646 template<typename T, enable_if_t<std::is_pointer<T *>::value, int> = 0> T &id(T *value) { return *value; }
647 
649 
652 
653 ESPDEPRECATED("hexencode() is deprecated, use format_hex_pretty() instead.", "2022.1")
654 inline std::string hexencode(const uint8_t *data, uint32_t len) { return format_hex_pretty(data, len); }
655 
656 template<typename T>
657 ESPDEPRECATED("hexencode() is deprecated, use format_hex_pretty() instead.", "2022.1")
658 std::string hexencode(const T &data) {
659  return hexencode(data.data(), data.size());
660 }
661 
663 
664 } // 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:354
std::string str_snake_case(const std::string &str)
Convert the string to snake case (lowercase with underscores).
Definition: helpers.cpp:160
std::string str_truncate(const std::string &str, size_t length)
Truncate a string to a specific length.
Definition: helpers.cpp:142
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:288
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:237
std::string str_upper_case(const std::string &str)
Convert the string to upper case.
Definition: helpers.cpp:159
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:225
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:206
bool next(T value)
Feeds the next item in the series to the deduplicator and returns whether this is a duplicate...
Definition: helpers.h:482
uint32_t random_uint32()
Return a random 32-bit unsigned integer.
Definition: helpers.cpp:95
constexpr ExternalRAMAllocator(const ExternalRAMAllocator< U > &other)
Definition: helpers.h:609
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:145
uint8_t crc8(uint8_t *data, uint8_t len)
Calculate a CRC-8 checksum of data with size len.
Definition: helpers.cpp:56
Helper class to request loop() to be called as fast as possible.
Definition: helpers.h:555
typename std::enable_if< B, T >::type enable_if_t
Definition: helpers.h:77
An STL allocator that uses SPI RAM.
Definition: helpers.h:597
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:175
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:259
void deallocate(T *p, size_t n)
Definition: helpers.h:624
STL namespace.
T id(T value)
Helper function to make id(var) known from lambdas work in custom components.
Definition: helpers.h:641
std::vector< std::function< void(Ts...)> > callbacks_
Definition: helpers.h:475
float lerp(float completion, float start, float end)
Linearly interpolate between start and end by completion (between 0 and 1).
Definition: helpers.cpp:55
void set_parent(T *parent)
Set the parent of this object.
Definition: helpers.h:508
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:456
bool random_bytes(uint8_t *data, size_t len)
Generate len number of random bytes.
Definition: helpers.cpp:112
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:186
constexpr const T & clamp(const T &v, const T &lo, const T &hi, Compare comp)
Definition: helpers.h:84
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:273
void call(Ts... args)
Call all callbacks in this manager.
Definition: helpers.h:466
uint8_t reverse_bits(uint8_t x)
Reverse the order of 8 bits.
Definition: helpers.h:211
uint8_t m
Definition: bl0939.h:20
uint16_t crc16(const uint8_t *data, uint8_t len)
Calculate a CRC-16 checksum of data with size len.
Definition: helpers.cpp:71
ParseOnOffState
Return values for parse_on_off().
Definition: helpers.h:409
float gamma_correct(float value, float gamma)
Applies gamma correction of gamma to value.
Definition: helpers.cpp:314
bool str_startswith(const std::string &str, const std::string &start)
Check whether a string starts with a value.
Definition: helpers.cpp:138
constexpr float celsius_to_fahrenheit(float value)
Convert degrees Celsius to degrees Fahrenheit.
Definition: helpers.h:445
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:293
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:331
std::string str_lower_case(const std::string &str)
Convert the string to lower case.
Definition: helpers.cpp:158
std::string str_sprintf(const char *fmt,...)
Definition: helpers.cpp:188
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:201
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:228
std::string get_mac_address()
Get the device MAC address as a string, in lowercase hex notation.
Definition: helpers.cpp:442
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:180
uint8_t type
ExternalRAMAllocator(Flags flags)
Definition: helpers.h:608
bool has_value() const
Returns whether this deduplicator has processed any items so far.
Definition: helpers.h:492
bool str_endswith(const std::string &str, const std::string &end)
Check whether a string ends with a value.
Definition: helpers.cpp:139
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:171
void set_mac_address(uint8_t *mac)
Set the MAC address to use from the provided byte array (6 bytes).
Definition: helpers.cpp:453
int8_t step_to_accuracy_decimals(float step)
Derive accuracy in decimals from an increment step.
Definition: helpers.cpp:299
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:145
const uint32_t flags
Definition: stm32flash.h:85
Parented(T *parent)
Definition: helpers.h:503
T * get_parent() const
Get the parent of this object.
Definition: helpers.h:506
Helper class to disable interrupts.
Definition: helpers.h:539
std::string str_sanitize(const std::string &str)
Sanitizes the input string by removing all characters but alphanumerics, dashes and underscores...
Definition: helpers.cpp:167
std::string to_string(int value)
Definition: helpers.cpp:42
std::string size_t len
Definition: helpers.h:281
uint32_t fnv1_hash(const std::string &str)
Calculate a FNV-1 hash of str.
Definition: helpers.cpp:86
constexpr14 T byteswap(T n)
Definition: helpers.h:121
To bit_cast(const From &src)
Convert data between types, without aliasing issues or undefined behaviour.
Definition: helpers.h:113
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:237
Helper class to deduplicate items in a series of values.
Definition: helpers.h:479
Definition: a4988.cpp:4
void operator()(Ts... args)
Call all callbacks in this manager.
Definition: helpers.h:472
num_t cb(num_t x)
Definition: sun.cpp:31
std::vector< uint8_t > bytes
Definition: sml_parser.h:12
uint32_t val
Definition: datatypes.h:85
std::unique_ptr< T > make_unique(Args &&...args)
Definition: helpers.h:68
std::string get_mac_address_pretty()
Get the device MAC address as a string, in colon-separated uppercase hex notation.
Definition: helpers.cpp:447
void add(std::function< void(Ts...)> &&callback)
Add a callback to the list.
Definition: helpers.h:463
constexpr float fahrenheit_to_celsius(float value)
Convert degrees Fahrenheit to degrees Celsius.
Definition: helpers.h:447
std::string str_snprintf(const char *fmt, size_t len,...)
Definition: helpers.cpp:174
float random_float()
Return a random float between 0 and 1.
Definition: helpers.cpp:111
Helper class to easily give an object a parent of type T.
Definition: helpers.h:500
bool str_equals_case_insensitive(const std::string &a, const std::string &b)
Compare strings for equality in case-insensitive manner.
Definition: helpers.cpp:135
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:425
constexpr const T & clamp(const T &v, const T &lo, const T &hi)
Definition: helpers.h:87
float gamma_uncorrect(float value, float gamma)
Reverts gamma correction of gamma to value.
Definition: helpers.cpp:322