ESPHome: esphome/core/alloc_helpers.h Source File

#pragma once


#include <cstdarg>

#include <cstdint>

#include <cstdio>

#include <string>

#include <vector>


namespace esphome {


// --- String helpers (allocating) ---


std::string str_truncate(const std::string &str, size_t length);


std::string str_until(const char *str, char ch);

std::string str_until(const std::string &str, char ch);


std::string str_lower_case(const std::string &str);


std::string str_upper_case(const std::string &str);


std::string str_snake_case(const std::string &str);


std::string str_sanitize(const std::string &str);


std::string __attribute__((format(printf, 1, 3))) str_snprintf(const char *fmt, size_t len, ...);


std::string __attribute__((format(printf, 1, 2))) str_sprintf(const char *fmt, ...);


// --- Hex/binary formatting helpers (allocating) ---


std::string format_mac_address_pretty(const uint8_t mac[6]);


std::string format_hex(const uint8_t *data, size_t length);


std::string format_hex(const std::vector<uint8_t> &data);


std::string format_hex_pretty(const uint8_t *data, size_t length, char separator = '.', bool show_length = true);


std::string format_hex_pretty(const uint16_t *data, size_t length, char separator = '.', bool show_length = true);


std::string format_hex_pretty(const std::vector<uint8_t> &data, char separator = '.', bool show_length = true);


std::string format_hex_pretty(const std::vector<uint16_t> &data, char separator = '.', bool show_length = true);


std::string format_hex_pretty(const std::string &data, char separator = '.', bool show_length = true);


std::string format_bin(const uint8_t *data, size_t length);


// --- Value formatting helpers (allocating) ---


__attribute__((deprecated("Allocates heap memory. Use value_accuracy_to_buf() instead. Removed in 2026.7.0.")))

std::string

value_accuracy_to_string(float value, int8_t accuracy_decimals);


// --- Base64 helpers (allocating) ---


std::string base64_encode(const uint8_t *buf, size_t buf_len);

std::string base64_encode(const std::vector<uint8_t> &buf);


std::vector<uint8_t> base64_decode(const std::string &encoded_string);


// --- MAC address helpers (allocating) ---


std::string get_mac_address();


std::string get_mac_address_pretty();


}  // namespace esphome

__attribute__
struct @65::@66 __attribute__
Wake the main loop task from an ISR. ISR-safe.
Definition main_task.h:32

esphome
Definition a01nyub.cpp:7

esphome::format
const char int const __FlashStringHelper * format
Definition log.h:74

esphome::value_accuracy_to_string
std::string value_accuracy_to_string(float value, int8_t accuracy_decimals)
Definition alloc_helpers.cpp:91

esphome::format_hex
std::string format_hex(const uint8_t *data, size_t length)
Format the byte array data of length len in lowercased hex.
Definition alloc_helpers.cpp:160

esphome::value_accuracy_to_buf
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)
Definition helpers.cpp:474

esphome::str_lower_case
std::string str_lower_case(const std::string &str)
Convert the string to lower case.
Definition alloc_helpers.cpp:34

esphome::format_bin
std::string format_bin(const uint8_t *data, size_t length)
Format the byte array data of length len in binary.
Definition alloc_helpers.cpp:207

esphome::str_sanitize
std::string str_sanitize(const std::string &str)
Sanitizes the input string by removing all characters but alphanumerics, dashes and underscores.
Definition alloc_helpers.cpp:51

esphome::len
std::string size_t len
Definition alloc_helpers.h:53

esphome::base64_decode
std::vector< uint8_t > base64_decode(const std::string &encoded_string)
Decode a base64 string to a byte vector.
Definition alloc_helpers.cpp:143

esphome::get_mac_address_pretty
std::string get_mac_address_pretty()
Get the device MAC address as a string, in colon-separated uppercase hex notation.
Definition alloc_helpers.cpp:224

esphome::str_snprintf
std::string str_snprintf(const char *fmt, size_t len,...)
Definition alloc_helpers.cpp:58

esphome::str_upper_case
std::string str_upper_case(const std::string &str)
Convert the string to upper case.
Definition alloc_helpers.cpp:36

esphome::format_hex_pretty
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.
Definition alloc_helpers.cpp:182

esphome::str_until
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 alloc_helpers.cpp:20

esphome::format_mac_address_pretty
std::string format_mac_address_pretty(const uint8_t *mac)
Definition alloc_helpers.cpp:154

esphome::base64_encode
std::string base64_encode(const std::vector< uint8_t > &buf)
Encode a byte vector to base64 string.
Definition alloc_helpers.cpp:115

esphome::str_sprintf
std::string str_sprintf(const char *fmt,...)
Definition alloc_helpers.cpp:73

esphome::fmt
size_t size_t const char * fmt
Definition helpers.h:1039

esphome::get_mac_address
std::string get_mac_address()
Get the device MAC address as a string, in lowercase hex notation.
Definition alloc_helpers.cpp:216

esphome::str_snake_case
std::string str_snake_case(const std::string &str)
Convert the string to snake case (lowercase with underscores).
Definition alloc_helpers.cpp:43

esphome::str_truncate
std::string str_truncate(const std::string &str, size_t length)
Truncate a string to a specific length.
Definition alloc_helpers.cpp:16

length
uint16_t length
Definition tt21100.cpp:0