ESPHome 2026.2.1
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes
esphome::network::IPAddress Struct Reference

#include <ip_address.h>

Public Member Functions

 IPAddress ()
 
 IPAddress (uint8_t first, uint8_t second, uint8_t third, uint8_t fourth)
 
 IPAddress (const std::string &in_address)
 
 IPAddress (const ip_addr_t *other_ip)
 
 ESPDEPRECATED ("Use str_to() instead. Removed in 2026.8.0", "2026.2.0") std
 
 IPAddress (uint8_t first, uint8_t second, uint8_t third, uint8_t fourth)
 
 IPAddress (const ip_addr_t *other_ip)
 
 IPAddress (const char *in_address)
 
 IPAddress (const std::string &in_address)
 
 IPAddress (ip4_addr_t *other_ip)
 
 IPAddress (const arduino_ns::IPAddress &other_ip)
 
 IPAddress (ip6_addr_t *other_ip)
 
 IPAddress (esp_ip6_addr_t *other_ip)
 
 IPAddress (esp_ip4_addr_t *other_ip)
 
 IPAddress (esp_ip_addr_t *other_ip)
 
 operator esp_ip_addr_t () const
 
 operator esp_ip4_addr_t () const
 
 operator ip_addr_t () const
 
 operator ip4_addr_t () const
 
 operator arduino_ns::IPAddress () const
 
bool is_set () const
 
bool is_ip4 () const
 
bool is_ip6 () const
 
bool is_multicast () const
 
 ESPDEPRECATED ("Use str_to() instead. Removed in 2026.8.0", "2026.2.0") std
 Write IP address to buffer.
 

Protected Attributes

ip_addr_t ip_addr_
 

Detailed Description

Definition at line 54 of file ip_address.h.

Constructor & Destructor Documentation

◆ IPAddress() [1/14]

esphome::network::IPAddress::IPAddress ( )
inline

Definition at line 57 of file ip_address.h.

◆ IPAddress() [2/14]

esphome::network::IPAddress::IPAddress ( uint8_t first,
uint8_t second,
uint8_t third,
uint8_t fourth )
inline

Definition at line 58 of file ip_address.h.

◆ IPAddress() [3/14]

esphome::network::IPAddress::IPAddress ( const std::string & in_address)
inline

Definition at line 61 of file ip_address.h.

◆ IPAddress() [4/14]

esphome::network::IPAddress::IPAddress ( const ip_addr_t * other_ip)
inline

Definition at line 62 of file ip_address.h.

◆ IPAddress() [5/14]

esphome::network::IPAddress::IPAddress ( uint8_t first,
uint8_t second,
uint8_t third,
uint8_t fourth )
inline

Definition at line 77 of file ip_address.h.

◆ IPAddress() [6/14]

esphome::network::IPAddress::IPAddress ( const ip_addr_t * other_ip)
inline

Definition at line 80 of file ip_address.h.

◆ IPAddress() [7/14]

esphome::network::IPAddress::IPAddress ( const char * in_address)
inline

Definition at line 81 of file ip_address.h.

◆ IPAddress() [8/14]

esphome::network::IPAddress::IPAddress ( const std::string & in_address)
inline

Definition at line 82 of file ip_address.h.

◆ IPAddress() [9/14]

esphome::network::IPAddress::IPAddress ( ip4_addr_t * other_ip)
inline

Definition at line 83 of file ip_address.h.

◆ IPAddress() [10/14]

esphome::network::IPAddress::IPAddress ( const arduino_ns::IPAddress & other_ip)
inline

Definition at line 90 of file ip_address.h.

◆ IPAddress() [11/14]

esphome::network::IPAddress::IPAddress ( ip6_addr_t * other_ip)
inline

Definition at line 93 of file ip_address.h.

◆ IPAddress() [12/14]

esphome::network::IPAddress::IPAddress ( esp_ip6_addr_t * other_ip)
inline

Definition at line 101 of file ip_address.h.

◆ IPAddress() [13/14]

esphome::network::IPAddress::IPAddress ( esp_ip4_addr_t * other_ip)
inline

Definition at line 106 of file ip_address.h.

◆ IPAddress() [14/14]

esphome::network::IPAddress::IPAddress ( esp_ip_addr_t * other_ip)
inline

Definition at line 112 of file ip_address.h.

Member Function Documentation

◆ ESPDEPRECATED() [1/2]

esphome::network::IPAddress::ESPDEPRECATED ( "Use str_to() instead. Removed in 2026.8.0" ,
"2026.2.0"  )
inline

Definition at line 64 of file ip_address.h.

◆ ESPDEPRECATED() [2/2]

esphome::network::IPAddress::ESPDEPRECATED ( "Use str_to() instead. Removed in 2026.8.0" ,
"2026.2.0"  )
inline

Write IP address to buffer.

Buffer must be at least IP_ADDRESS_BUFFER_SIZE bytes. Output is lowercased per RFC 5952 (IPv6 hex digits a-f).

Definition at line 153 of file ip_address.h.

◆ is_ip4()

bool esphome::network::IPAddress::is_ip4 ( ) const
inline

Definition at line 149 of file ip_address.h.

◆ is_ip6()

bool esphome::network::IPAddress::is_ip6 ( ) const
inline

Definition at line 150 of file ip_address.h.

◆ is_multicast()

bool esphome::network::IPAddress::is_multicast ( ) const
inline

Definition at line 151 of file ip_address.h.

◆ is_set()

bool esphome::network::IPAddress::is_set ( ) const
inline

Definition at line 148 of file ip_address.h.

◆ operator arduino_ns::IPAddress()

esphome::network::IPAddress::operator arduino_ns::IPAddress ( ) const
inline

Definition at line 145 of file ip_address.h.

◆ operator esp_ip4_addr_t()

esphome::network::IPAddress::operator esp_ip4_addr_t ( ) const
inline

Definition at line 128 of file ip_address.h.

◆ operator esp_ip_addr_t()

esphome::network::IPAddress::operator esp_ip_addr_t ( ) const
inline

Definition at line 119 of file ip_address.h.

◆ operator ip4_addr_t()

esphome::network::IPAddress::operator ip4_addr_t ( ) const
inline

Definition at line 141 of file ip_address.h.

◆ operator ip_addr_t()

esphome::network::IPAddress::operator ip_addr_t ( ) const
inline

Definition at line 139 of file ip_address.h.

Field Documentation

◆ ip_addr_

ip_addr_t esphome::network::IPAddress::ip_addr_
protected

Definition at line 181 of file ip_address.h.

The documentation for this struct was generated from the following file:
Generated by doxygen 1.12.0