ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
wifi_info_text_sensor.cpp
Go to the documentation of this file.
2#ifdef USE_WIFI
4#include "esphome/core/log.h"
5
6#ifdef USE_ESP8266
7#include <pgmspace.h>
8#endif
9
11
12ESPHOME_LOG_TAG(TAG, "wifi_info");
13
14#ifdef USE_WIFI_IP_STATE_LISTENERS
15
16/********************
17 * IPAddressWiFiInfo
18 *******************/
19
21
22void IPAddressWiFiInfo::dump_config() { LOG_TEXT_SENSOR("", "IP Address", this); }
23
25 const network::IPAddress &dns2) {
26 char buf[network::IP_ADDRESS_BUFFER_SIZE];
27 ips[0].str_to(buf);
28 this->publish_state(buf);
29#ifdef WIFI_INFO_IP_SENSOR_COUNT
30 uint8_t sensor = 0;
31 for (const auto &ip : ips) {
32 if (!ip.is_set())
33 continue;
34 if (sensor == WIFI_INFO_IP_SENSOR_COUNT)
35 break;
36 if (this->ip_sensors_[sensor] != nullptr) {
37 ip.str_to(buf);
38 this->ip_sensors_[sensor]->publish_state(buf);
39 }
40 sensor++;
41 }
42#endif
43}
44
45/*********************
46 * DNSAddressWifiInfo
47 ********************/
48
50
51void DNSAddressWifiInfo::dump_config() { LOG_TEXT_SENSOR("", "DNS Address", this); }
52
54 const network::IPAddress &dns2) {
55 // IP_ADDRESS_BUFFER_SIZE (40) = max IP (39) + null; space reuses first null's slot
56 char buf[network::IP_ADDRESS_BUFFER_SIZE * 2];
57 dns1.str_to(buf);
58 size_t len1 = strlen(buf);
59 buf[len1] = ' ';
60 dns2.str_to(buf + len1 + 1);
61 this->publish_state(buf);
62}
63
64#endif // USE_WIFI_IP_STATE_LISTENERS
65
66#ifdef USE_WIFI_SCAN_RESULTS_LISTENERS
67
68/**********************
69 * ScanResultsWiFiInfo
70 *********************/
71
73
74void ScanResultsWiFiInfo::dump_config() { LOG_TEXT_SENSOR("", "Scan Results", this); }
75
76// Format: "SSID: -XXdB\n" - caller must ensure ssid_len + 9 bytes available in buffer
77static char *format_scan_entry(char *buf, const char *ssid, size_t ssid_len, int8_t rssi) {
78 memcpy(buf, ssid, ssid_len);
79 buf += ssid_len;
80 *buf++ = ':';
81 *buf++ = ' ';
82 buf = int8_to_str(buf, rssi);
83 *buf++ = 'd';
84 *buf++ = 'B';
85 *buf++ = '\n';
86 return buf;
87}
88
90 char buf[MAX_STATE_LEN + 1];
91 char *ptr = buf;
92 const char *end = buf + MAX_STATE_LEN;
93
94 for (const auto &scan : results) {
95 if (scan.get_is_hidden())
96 continue;
97 const auto &ssid = scan.get_ssid();
98 // Max space: ssid + ": " (2) + "-128" (4) + "dB\n" (3) = ssid + 9
99 if (ptr + ssid.size() + 9 > end)
100 break;
101 ptr = format_scan_entry(ptr, ssid.c_str(), ssid.size(), scan.get_rssi());
102 }
103
104 *ptr = '\0';
105 this->publish_state(buf);
106}
107
108#endif // USE_WIFI_SCAN_RESULTS_LISTENERS
109
110#ifdef USE_WIFI_CONNECT_STATE_LISTENERS
111
112/***************
113 * SSIDWiFiInfo
114 **************/
115
117
118void SSIDWiFiInfo::dump_config() { LOG_TEXT_SENSOR("", "SSID", this); }
119
120void SSIDWiFiInfo::on_wifi_connect_state(StringRef ssid, std::span<const uint8_t, 6> bssid) {
121 this->publish_state(ssid.c_str(), ssid.size());
122}
123
124/****************
125 * BSSIDWiFiInfo
126 ***************/
127
129
130void BSSIDWiFiInfo::dump_config() { LOG_TEXT_SENSOR("", "BSSID", this); }
131
132void BSSIDWiFiInfo::on_wifi_connect_state(StringRef ssid, std::span<const uint8_t, 6> bssid) {
133 char buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE] = "unknown";
134 if (mac_address_is_valid(bssid.data())) {
135 format_mac_addr_upper(bssid.data(), buf);
136 }
137 this->publish_state(buf);
138}
139
140#endif // USE_WIFI_CONNECT_STATE_LISTENERS
141
142#ifdef USE_WIFI_POWER_SAVE_LISTENERS
143
144/************************
145 * PowerSaveModeWiFiInfo
146 ***********************/
147
149
150void PowerSaveModeWiFiInfo::dump_config() { LOG_TEXT_SENSOR("", "WiFi Power Save Mode", this); }
151
153#ifdef USE_ESP8266
154#define MODE_STR(s) static const char MODE_##s[] PROGMEM = #s
155 MODE_STR(NONE);
156 MODE_STR(LIGHT);
157 MODE_STR(HIGH);
158 MODE_STR(UNKNOWN);
159
160 const char *mode_str_p;
161 switch (mode) {
163 mode_str_p = MODE_NONE;
164 break;
166 mode_str_p = MODE_LIGHT;
167 break;
169 mode_str_p = MODE_HIGH;
170 break;
171 default:
172 mode_str_p = MODE_UNKNOWN;
173 break;
174 }
175
176 char mode_str[8];
177 strncpy_P(mode_str, mode_str_p, sizeof(mode_str));
178 mode_str[sizeof(mode_str) - 1] = '\0';
179#undef MODE_STR
180#else
181 const char *mode_str;
182 switch (mode) {
184 mode_str = "NONE";
185 break;
187 mode_str = "LIGHT";
188 break;
190 mode_str = "HIGH";
191 break;
192 default:
193 mode_str = "UNKNOWN";
194 break;
195 }
196#endif
197 this->publish_state(mode_str);
198}
199
200#endif // USE_WIFI_POWER_SAVE_LISTENERS
201
202/*********************
203 * MacAddressWifiInfo
204 ********************/
205
206void MacAddressWifiInfo::dump_config() { LOG_TEXT_SENSOR("", "MAC Address", this); }
207
208} // namespace esphome::wifi_info
209#endif
BedjetMode mode
BedJet operating mode.
StringRef is a reference to a string owned by something else.
Definition string_ref.h:31
constexpr const char * c_str() const
Definition string_ref.h:78
constexpr size_type size() const
Definition string_ref.h:79
void publish_state(const std::string &state)
Definition text_sensor.h:42
void add_connect_state_listener(WiFiConnectStateListener *listener)
Add a listener for WiFi connection state changes.
void add_power_save_listener(WiFiPowerSaveListener *listener)
Add a listener for WiFi power save mode changes.
void add_ip_state_listener(WiFiIPStateListener *listener)
Add a listener for IP state changes.
void add_scan_results_listener(WiFiScanResultsListener *listener)
Add a listener for WiFi scan results.
void on_wifi_connect_state(StringRef ssid, std::span< const uint8_t, 6 > bssid) override
void on_ip_state(const network::IPAddresses &ips, const network::IPAddress &dns1, const network::IPAddress &dns2) override
void on_ip_state(const network::IPAddresses &ips, const network::IPAddress &dns1, const network::IPAddress &dns2) override
std::array< text_sensor::TextSensor *, WIFI_INFO_IP_SENSOR_COUNT > ip_sensors_
void on_wifi_power_save(wifi::WiFiPowerSaveMode mode) override
void on_wifi_connect_state(StringRef ssid, std::span< const uint8_t, 6 > bssid) override
void on_wifi_scan_results(const wifi::wifi_scan_vector_t< wifi::WiFiScanResult > &results) override
std::array< IPAddress, 5 > IPAddresses
Definition ip_address.h:368
ESPHOME_LOG_TAG(TAG, "wifi_info")
std::vector< T > wifi_scan_vector_t
WiFiComponent * global_wifi_component
bool mac_address_is_valid(const uint8_t *mac)
Check if the MAC address is not all zeros or all ones.
Definition helpers.cpp:865
char * int8_to_str(char *buf, int8_t val)
Write int8 value to buffer without modulo operations.
Definition helpers.h:1560
char * format_mac_addr_upper(const uint8_t *mac, char *output)
Format MAC address as XX:XX:XX:XX:XX:XX (uppercase, colon separators)
Definition helpers.h:1754
char * str_to(char *buf) const
Definition ip_address.h:152
uint8_t end[39]
Definition sun_gtil2.cpp:17