ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
prometheus_handler.cpp
Go to the documentation of this file.
2#include <cinttypes>
3#if defined(USE_NETWORK) && !defined(USE_HOST)
5
7
8void PrometheusHandler::handleRequest(AsyncWebServerRequest *req) {
9 AsyncResponseStream *stream = req->beginResponseStream("text/plain; version=0.0.4; charset=utf-8");
10 std::string area = App.get_area();
11 std::string node = App.get_name();
12 std::string friendly_name = App.get_friendly_name();
13
14#ifdef USE_SENSOR
15 this->sensor_type_(stream);
16 for (auto *obj : App.get_sensors())
17 this->sensor_row_(stream, obj, area, node, friendly_name);
18#endif
19
20#ifdef USE_BINARY_SENSOR
21 this->binary_sensor_type_(stream);
22 for (auto *obj : App.get_binary_sensors())
23 this->binary_sensor_row_(stream, obj, area, node, friendly_name);
24#endif
25
26#ifdef USE_FAN
27 this->fan_type_(stream);
28 for (auto *obj : App.get_fans())
29 this->fan_row_(stream, obj, area, node, friendly_name);
30#endif
31
32#ifdef USE_LIGHT
33 this->light_type_(stream);
34 for (auto *obj : App.get_lights())
35 this->light_row_(stream, obj, area, node, friendly_name);
36#endif
37
38#ifdef USE_COVER
39 this->cover_type_(stream);
40 for (auto *obj : App.get_covers())
41 this->cover_row_(stream, obj, area, node, friendly_name);
42#endif
43
44#ifdef USE_SWITCH
45 this->switch_type_(stream);
46 for (auto *obj : App.get_switches())
47 this->switch_row_(stream, obj, area, node, friendly_name);
48#endif
49
50#ifdef USE_LOCK
51 this->lock_type_(stream);
52 for (auto *obj : App.get_locks())
53 this->lock_row_(stream, obj, area, node, friendly_name);
54#endif
55
56#ifdef USE_EVENT
57 this->event_type_(stream);
58 for (auto *obj : App.get_events())
59 this->event_row_(stream, obj, area, node, friendly_name);
60#endif
61
62#ifdef USE_TEXT
63 this->text_type_(stream);
64 for (auto *obj : App.get_texts())
65 this->text_row_(stream, obj, area, node, friendly_name);
66#endif
67
68#ifdef USE_TEXT_SENSOR
69 this->text_sensor_type_(stream);
70 for (auto *obj : App.get_text_sensors())
71 this->text_sensor_row_(stream, obj, area, node, friendly_name);
72#endif
73
74#ifdef USE_NUMBER
75 this->number_type_(stream);
76 for (auto *obj : App.get_numbers())
77 this->number_row_(stream, obj, area, node, friendly_name);
78#endif
79
80#ifdef USE_SELECT
81 this->select_type_(stream);
82 for (auto *obj : App.get_selects())
83 this->select_row_(stream, obj, area, node, friendly_name);
84#endif
85
86#ifdef USE_MEDIA_PLAYER
87 this->media_player_type_(stream);
88 for (auto *obj : App.get_media_players())
89 this->media_player_row_(stream, obj, area, node, friendly_name);
90#endif
91
92#ifdef USE_UPDATE
93 this->update_entity_type_(stream);
94 for (auto *obj : App.get_updates())
95 this->update_entity_row_(stream, obj, area, node, friendly_name);
96#endif
97
98#ifdef USE_VALVE
99 this->valve_type_(stream);
100 for (auto *obj : App.get_valves())
101 this->valve_row_(stream, obj, area, node, friendly_name);
102#endif
103
104#ifdef USE_DATETIME_DATE
105 this->date_type_(stream);
106 for (auto *obj : App.get_dates())
107 this->date_row_(stream, obj, area, node, friendly_name);
108#endif
109
110#ifdef USE_DATETIME_TIME
111 this->time_type_(stream);
112 for (auto *obj : App.get_times())
113 this->time_row_(stream, obj, area, node, friendly_name);
114#endif
115
116#ifdef USE_DATETIME_DATETIME
117 this->datetime_type_(stream);
118 for (auto *obj : App.get_datetimes())
119 this->datetime_row_(stream, obj, area, node, friendly_name);
120#endif
121
122#ifdef USE_CLIMATE
123 this->climate_type_(stream);
124 for (auto *obj : App.get_climates())
125 this->climate_row_(stream, obj, area, node, friendly_name);
126#endif
127
128 req->send(stream);
129}
130
131void PrometheusHandler::print_relabel_id_(AsyncResponseStream *stream, EntityBase *obj) {
132 auto item = relabel_map_id_.find(obj);
133 if (item != relabel_map_id_.end()) {
134 stream->print(item->second.c_str());
135 return;
136 }
137 char object_id_buf[OBJECT_ID_MAX_LEN];
138 stream->print(obj->get_object_id_to(object_id_buf).c_str());
139}
140
141void PrometheusHandler::print_relabel_name_(AsyncResponseStream *stream, EntityBase *obj) {
142 auto item = relabel_map_name_.find(obj);
143 if (item != relabel_map_name_.end()) {
144 stream->print(item->second.c_str());
145 return;
146 }
147 stream->print(reinterpret_cast<ProgmemStr>(obj->get_name_progmem().progmem_ptr()));
148}
149
150void PrometheusHandler::add_area_label_(AsyncResponseStream *stream, std::string &area) {
151 if (!area.empty()) {
152 stream->print(ESPHOME_F("\",area=\""));
153 stream->print(area.c_str());
154 }
155}
156
157void PrometheusHandler::add_node_label_(AsyncResponseStream *stream, std::string &node) {
158 if (!node.empty()) {
159 stream->print(ESPHOME_F("\",node=\""));
160 stream->print(node.c_str());
161 }
162}
163
164void PrometheusHandler::add_friendly_name_label_(AsyncResponseStream *stream, std::string &friendly_name) {
165 if (!friendly_name.empty()) {
166 stream->print(ESPHOME_F("\",friendly_name=\""));
167 stream->print(friendly_name.c_str());
168 }
169}
170
171void PrometheusHandler::print_metric_labels_(AsyncResponseStream *stream, ProgmemStr metric_name, EntityBase *obj,
172 std::string &area, std::string &node, std::string &friendly_name) {
173 stream->print(metric_name);
174 stream->print(ESPHOME_F("{id=\""));
175 this->print_relabel_id_(stream, obj);
176 add_area_label_(stream, area);
177 add_node_label_(stream, node);
178 add_friendly_name_label_(stream, friendly_name);
179 stream->print(ESPHOME_F("\",name=\""));
180 this->print_relabel_name_(stream, obj);
181}
182
183// Type-specific implementation
184#ifdef USE_SENSOR
185void PrometheusHandler::sensor_type_(AsyncResponseStream *stream) {
186 stream->print(ESPHOME_F("#TYPE esphome_sensor_value gauge\n"));
187 stream->print(ESPHOME_F("#TYPE esphome_sensor_failed gauge\n"));
188}
189void PrometheusHandler::sensor_row_(AsyncResponseStream *stream, sensor::Sensor *obj, std::string &area,
190 std::string &node, std::string &friendly_name) {
191 if (obj->is_internal() && !this->include_internal_)
192 return;
193 if (!std::isnan(obj->state)) {
194 // We have a valid value, output this value
195 stream->print(ESPHOME_F("esphome_sensor_failed{id=\""));
196 this->print_relabel_id_(stream, obj);
197 add_area_label_(stream, area);
198 add_node_label_(stream, node);
199 add_friendly_name_label_(stream, friendly_name);
200 stream->print(ESPHOME_F("\",name=\""));
201 this->print_relabel_name_(stream, obj);
202 stream->print(ESPHOME_F("\"} 0\n"));
203 // Data itself
204 stream->print(ESPHOME_F("esphome_sensor_value{id=\""));
205 this->print_relabel_id_(stream, obj);
206 add_area_label_(stream, area);
207 add_node_label_(stream, node);
208 add_friendly_name_label_(stream, friendly_name);
209 stream->print(ESPHOME_F("\",name=\""));
210 this->print_relabel_name_(stream, obj);
211 stream->print(ESPHOME_F("\",unit=\""));
212 stream->print(obj->get_unit_of_measurement_ref().c_str());
213 stream->print(ESPHOME_F("\"} "));
214 char value_buf[VALUE_ACCURACY_MAX_LEN];
215 value_accuracy_to_buf(value_buf, obj->state, obj->get_accuracy_decimals());
216 stream->print(value_buf);
217 stream->print(ESPHOME_F("\n"));
218 } else {
219 // Invalid state
220 stream->print(ESPHOME_F("esphome_sensor_failed{id=\""));
221 this->print_relabel_id_(stream, obj);
222 add_area_label_(stream, area);
223 add_node_label_(stream, node);
224 add_friendly_name_label_(stream, friendly_name);
225 stream->print(ESPHOME_F("\",name=\""));
226 this->print_relabel_name_(stream, obj);
227 stream->print(ESPHOME_F("\"} 1\n"));
228 }
229}
230#endif
231
232// Type-specific implementation
233#ifdef USE_BINARY_SENSOR
234void PrometheusHandler::binary_sensor_type_(AsyncResponseStream *stream) {
235 stream->print(ESPHOME_F("#TYPE esphome_binary_sensor_value gauge\n"));
236 stream->print(ESPHOME_F("#TYPE esphome_binary_sensor_failed gauge\n"));
237}
239 std::string &area, std::string &node, std::string &friendly_name) {
240 if (obj->is_internal() && !this->include_internal_)
241 return;
242 if (obj->has_state()) {
243 // We have a valid value, output this value
244 stream->print(ESPHOME_F("esphome_binary_sensor_failed{id=\""));
245 this->print_relabel_id_(stream, obj);
246 add_area_label_(stream, area);
247 add_node_label_(stream, node);
248 add_friendly_name_label_(stream, friendly_name);
249 stream->print(ESPHOME_F("\",name=\""));
250 this->print_relabel_name_(stream, obj);
251 stream->print(ESPHOME_F("\"} 0\n"));
252 // Data itself
253 stream->print(ESPHOME_F("esphome_binary_sensor_value{id=\""));
254 this->print_relabel_id_(stream, obj);
255 add_area_label_(stream, area);
256 add_node_label_(stream, node);
257 add_friendly_name_label_(stream, friendly_name);
258 stream->print(ESPHOME_F("\",name=\""));
259 this->print_relabel_name_(stream, obj);
260 stream->print(ESPHOME_F("\"} "));
261 stream->print(obj->state);
262 stream->print(ESPHOME_F("\n"));
263 } else {
264 // Invalid state
265 stream->print(ESPHOME_F("esphome_binary_sensor_failed{id=\""));
266 this->print_relabel_id_(stream, obj);
267 add_area_label_(stream, area);
268 add_node_label_(stream, node);
269 add_friendly_name_label_(stream, friendly_name);
270 stream->print(ESPHOME_F("\",name=\""));
271 this->print_relabel_name_(stream, obj);
272 stream->print(ESPHOME_F("\"} 1\n"));
273 }
274}
275#endif
276
277#ifdef USE_FAN
278void PrometheusHandler::fan_type_(AsyncResponseStream *stream) {
279 stream->print(ESPHOME_F("#TYPE esphome_fan_value gauge\n"));
280 stream->print(ESPHOME_F("#TYPE esphome_fan_failed gauge\n"));
281 stream->print(ESPHOME_F("#TYPE esphome_fan_speed gauge\n"));
282 stream->print(ESPHOME_F("#TYPE esphome_fan_oscillation gauge\n"));
283}
284void PrometheusHandler::fan_row_(AsyncResponseStream *stream, fan::Fan *obj, std::string &area, std::string &node,
285 std::string &friendly_name) {
286 if (obj->is_internal() && !this->include_internal_)
287 return;
288 stream->print(ESPHOME_F("esphome_fan_failed{id=\""));
289 this->print_relabel_id_(stream, obj);
290 add_area_label_(stream, area);
291 add_node_label_(stream, node);
292 add_friendly_name_label_(stream, friendly_name);
293 stream->print(ESPHOME_F("\",name=\""));
294 this->print_relabel_name_(stream, obj);
295 stream->print(ESPHOME_F("\"} 0\n"));
296 // Data itself
297 stream->print(ESPHOME_F("esphome_fan_value{id=\""));
298 this->print_relabel_id_(stream, obj);
299 add_area_label_(stream, area);
300 add_node_label_(stream, node);
301 add_friendly_name_label_(stream, friendly_name);
302 stream->print(ESPHOME_F("\",name=\""));
303 this->print_relabel_name_(stream, obj);
304 stream->print(ESPHOME_F("\"} "));
305 stream->print(obj->state);
306 stream->print(ESPHOME_F("\n"));
307 // Speed if available
308 if (obj->get_traits().supports_speed()) {
309 stream->print(ESPHOME_F("esphome_fan_speed{id=\""));
310 this->print_relabel_id_(stream, obj);
311 add_area_label_(stream, area);
312 add_node_label_(stream, node);
313 add_friendly_name_label_(stream, friendly_name);
314 stream->print(ESPHOME_F("\",name=\""));
315 this->print_relabel_name_(stream, obj);
316 stream->print(ESPHOME_F("\"} "));
317 stream->print(obj->speed);
318 stream->print(ESPHOME_F("\n"));
319 }
320 // Oscillation if available
321 if (obj->get_traits().supports_oscillation()) {
322 stream->print(ESPHOME_F("esphome_fan_oscillation{id=\""));
323 this->print_relabel_id_(stream, obj);
324 add_area_label_(stream, area);
325 add_node_label_(stream, node);
326 add_friendly_name_label_(stream, friendly_name);
327 stream->print(ESPHOME_F("\",name=\""));
328 this->print_relabel_name_(stream, obj);
329 stream->print(ESPHOME_F("\"} "));
330 stream->print(obj->oscillating);
331 stream->print(ESPHOME_F("\n"));
332 }
333}
334#endif
335
336#ifdef USE_LIGHT
337void PrometheusHandler::light_type_(AsyncResponseStream *stream) {
338 stream->print(ESPHOME_F("#TYPE esphome_light_state gauge\n"));
339 stream->print(ESPHOME_F("#TYPE esphome_light_color gauge\n"));
340 stream->print(ESPHOME_F("#TYPE esphome_light_effect_active gauge\n"));
341}
342void PrometheusHandler::light_row_(AsyncResponseStream *stream, light::LightState *obj, std::string &area,
343 std::string &node, std::string &friendly_name) {
344 if (obj->is_internal() && !this->include_internal_)
345 return;
346 // State
347 print_metric_labels_(stream, ESPHOME_F("esphome_light_state"), obj, area, node, friendly_name);
348 stream->print(ESPHOME_F("\"} "));
349 stream->print(obj->get_reported_values().is_on());
350 stream->print(ESPHOME_F("\n"));
351 // Brightness and RGBW
353 float brightness, r, g, b, w;
354 color.as_brightness(&brightness);
355 color.as_rgbw(&r, &g, &b, &w);
357 print_metric_labels_(stream, ESPHOME_F("esphome_light_color"), obj, area, node, friendly_name);
358 stream->print(ESPHOME_F("\",channel=\"brightness\"} "));
359 stream->print(brightness);
360 stream->print(ESPHOME_F("\n"));
361 }
363 print_metric_labels_(stream, ESPHOME_F("esphome_light_color"), obj, area, node, friendly_name);
364 stream->print(ESPHOME_F("\",channel=\"r\"} "));
365 stream->print(r);
366 stream->print(ESPHOME_F("\n"));
367 print_metric_labels_(stream, ESPHOME_F("esphome_light_color"), obj, area, node, friendly_name);
368 stream->print(ESPHOME_F("\",channel=\"g\"} "));
369 stream->print(g);
370 stream->print(ESPHOME_F("\n"));
371 print_metric_labels_(stream, ESPHOME_F("esphome_light_color"), obj, area, node, friendly_name);
372 stream->print(ESPHOME_F("\",channel=\"b\"} "));
373 stream->print(b);
374 stream->print(ESPHOME_F("\n"));
375 }
377 print_metric_labels_(stream, ESPHOME_F("esphome_light_color"), obj, area, node, friendly_name);
378 stream->print(ESPHOME_F("\",channel=\"w\"} "));
379 stream->print(w);
380 stream->print(ESPHOME_F("\n"));
381 }
382 // Skip effect metrics if light has no effects
383 if (!obj->get_effects().empty()) {
384 // Effect
385 StringRef effect = obj->get_effect_name();
386 print_metric_labels_(stream, ESPHOME_F("esphome_light_effect_active"), obj, area, node, friendly_name);
387 stream->print(ESPHOME_F("\",effect=\""));
388 // Only vary based on effect
389 if (effect == "None") {
390 stream->print(ESPHOME_F("None\"} 0\n"));
391 } else {
392 // c_str() is safe as effect names are null-terminated strings from codegen
393 stream->print(effect.c_str());
394 stream->print(ESPHOME_F("\"} 1\n"));
395 }
396 }
397}
398#endif
399
400#ifdef USE_COVER
401void PrometheusHandler::cover_type_(AsyncResponseStream *stream) {
402 stream->print(ESPHOME_F("#TYPE esphome_cover_value gauge\n"));
403 stream->print(ESPHOME_F("#TYPE esphome_cover_failed gauge\n"));
404}
405void PrometheusHandler::cover_row_(AsyncResponseStream *stream, cover::Cover *obj, std::string &area, std::string &node,
406 std::string &friendly_name) {
407 if (obj->is_internal() && !this->include_internal_)
408 return;
409 if (!std::isnan(obj->position)) {
410 // We have a valid value, output this value
411 stream->print(ESPHOME_F("esphome_cover_failed{id=\""));
412 this->print_relabel_id_(stream, obj);
413 add_area_label_(stream, area);
414 add_node_label_(stream, node);
415 add_friendly_name_label_(stream, friendly_name);
416 stream->print(ESPHOME_F("\",name=\""));
417 this->print_relabel_name_(stream, obj);
418 stream->print(ESPHOME_F("\"} 0\n"));
419 // Data itself
420 stream->print(ESPHOME_F("esphome_cover_value{id=\""));
421 this->print_relabel_id_(stream, obj);
422 add_area_label_(stream, area);
423 add_node_label_(stream, node);
424 add_friendly_name_label_(stream, friendly_name);
425 stream->print(ESPHOME_F("\",name=\""));
426 this->print_relabel_name_(stream, obj);
427 stream->print(ESPHOME_F("\"} "));
428 stream->print(obj->position);
429 stream->print(ESPHOME_F("\n"));
430 if (obj->get_traits().get_supports_tilt()) {
431 stream->print(ESPHOME_F("esphome_cover_tilt{id=\""));
432 this->print_relabel_id_(stream, obj);
433 add_area_label_(stream, area);
434 add_node_label_(stream, node);
435 add_friendly_name_label_(stream, friendly_name);
436 stream->print(ESPHOME_F("\",name=\""));
437 this->print_relabel_name_(stream, obj);
438 stream->print(ESPHOME_F("\"} "));
439 stream->print(obj->tilt);
440 stream->print(ESPHOME_F("\n"));
441 }
442 } else {
443 // Invalid state
444 stream->print(ESPHOME_F("esphome_cover_failed{id=\""));
445 this->print_relabel_id_(stream, obj);
446 add_area_label_(stream, area);
447 add_node_label_(stream, node);
448 add_friendly_name_label_(stream, friendly_name);
449 stream->print(ESPHOME_F("\",name=\""));
450 this->print_relabel_name_(stream, obj);
451 stream->print(ESPHOME_F("\"} 1\n"));
452 }
453}
454#endif
455
456#ifdef USE_SWITCH
457void PrometheusHandler::switch_type_(AsyncResponseStream *stream) {
458 stream->print(ESPHOME_F("#TYPE esphome_switch_value gauge\n"));
459 stream->print(ESPHOME_F("#TYPE esphome_switch_failed gauge\n"));
460}
461void PrometheusHandler::switch_row_(AsyncResponseStream *stream, switch_::Switch *obj, std::string &area,
462 std::string &node, std::string &friendly_name) {
463 if (obj->is_internal() && !this->include_internal_)
464 return;
465 stream->print(ESPHOME_F("esphome_switch_failed{id=\""));
466 this->print_relabel_id_(stream, obj);
467 add_area_label_(stream, area);
468 add_node_label_(stream, node);
469 add_friendly_name_label_(stream, friendly_name);
470 stream->print(ESPHOME_F("\",name=\""));
471 this->print_relabel_name_(stream, obj);
472 stream->print(ESPHOME_F("\"} 0\n"));
473 // Data itself
474 stream->print(ESPHOME_F("esphome_switch_value{id=\""));
475 this->print_relabel_id_(stream, obj);
476 add_area_label_(stream, area);
477 add_node_label_(stream, node);
478 add_friendly_name_label_(stream, friendly_name);
479 stream->print(ESPHOME_F("\",name=\""));
480 this->print_relabel_name_(stream, obj);
481 stream->print(ESPHOME_F("\"} "));
482 stream->print(obj->state);
483 stream->print(ESPHOME_F("\n"));
484}
485#endif
486
487#ifdef USE_LOCK
488void PrometheusHandler::lock_type_(AsyncResponseStream *stream) {
489 stream->print(ESPHOME_F("#TYPE esphome_lock_value gauge\n"));
490 stream->print(ESPHOME_F("#TYPE esphome_lock_failed gauge\n"));
491}
492void PrometheusHandler::lock_row_(AsyncResponseStream *stream, lock::Lock *obj, std::string &area, std::string &node,
493 std::string &friendly_name) {
494 if (obj->is_internal() && !this->include_internal_)
495 return;
496 stream->print(ESPHOME_F("esphome_lock_failed{id=\""));
497 this->print_relabel_id_(stream, obj);
498 add_area_label_(stream, area);
499 add_node_label_(stream, node);
500 add_friendly_name_label_(stream, friendly_name);
501 stream->print(ESPHOME_F("\",name=\""));
502 this->print_relabel_name_(stream, obj);
503 stream->print(ESPHOME_F("\"} 0\n"));
504 // Data itself
505 stream->print(ESPHOME_F("esphome_lock_value{id=\""));
506 this->print_relabel_id_(stream, obj);
507 add_area_label_(stream, area);
508 add_node_label_(stream, node);
509 add_friendly_name_label_(stream, friendly_name);
510 stream->print(ESPHOME_F("\",name=\""));
511 this->print_relabel_name_(stream, obj);
512 stream->print(ESPHOME_F("\"} "));
513 stream->print(obj->state);
514 stream->print(ESPHOME_F("\n"));
515}
516#endif
517
518// Type-specific implementation
519#ifdef USE_TEXT_SENSOR
520void PrometheusHandler::text_sensor_type_(AsyncResponseStream *stream) {
521 stream->print(ESPHOME_F("#TYPE esphome_text_sensor_value gauge\n"));
522 stream->print(ESPHOME_F("#TYPE esphome_text_sensor_failed gauge\n"));
523}
524void PrometheusHandler::text_sensor_row_(AsyncResponseStream *stream, text_sensor::TextSensor *obj, std::string &area,
525 std::string &node, std::string &friendly_name) {
526 if (obj->is_internal() && !this->include_internal_)
527 return;
528 if (obj->has_state()) {
529 // We have a valid value, output this value
530 stream->print(ESPHOME_F("esphome_text_sensor_failed{id=\""));
531 this->print_relabel_id_(stream, obj);
532 add_area_label_(stream, area);
533 add_node_label_(stream, node);
534 add_friendly_name_label_(stream, friendly_name);
535 stream->print(ESPHOME_F("\",name=\""));
536 this->print_relabel_name_(stream, obj);
537 stream->print(ESPHOME_F("\"} 0\n"));
538 // Data itself
539 stream->print(ESPHOME_F("esphome_text_sensor_value{id=\""));
540 this->print_relabel_id_(stream, obj);
541 add_area_label_(stream, area);
542 add_node_label_(stream, node);
543 add_friendly_name_label_(stream, friendly_name);
544 stream->print(ESPHOME_F("\",name=\""));
545 this->print_relabel_name_(stream, obj);
546 stream->print(ESPHOME_F("\",value=\""));
547 stream->print(obj->state.c_str());
548 stream->print(ESPHOME_F("\"} "));
549 stream->print(ESPHOME_F("1.0"));
550 stream->print(ESPHOME_F("\n"));
551 } else {
552 // Invalid state
553 stream->print(ESPHOME_F("esphome_text_sensor_failed{id=\""));
554 this->print_relabel_id_(stream, obj);
555 add_area_label_(stream, area);
556 add_node_label_(stream, node);
557 add_friendly_name_label_(stream, friendly_name);
558 stream->print(ESPHOME_F("\",name=\""));
559 this->print_relabel_name_(stream, obj);
560 stream->print(ESPHOME_F("\"} 1\n"));
561 }
562}
563#endif
564
565// Type-specific implementation
566#ifdef USE_TEXT
567void PrometheusHandler::text_type_(AsyncResponseStream *stream) {
568 stream->print(ESPHOME_F("#TYPE esphome_text_value gauge\n"));
569 stream->print(ESPHOME_F("#TYPE esphome_text_failed gauge\n"));
570}
571void PrometheusHandler::text_row_(AsyncResponseStream *stream, text::Text *obj, std::string &area, std::string &node,
572 std::string &friendly_name) {
573 if (obj->is_internal() && !this->include_internal_)
574 return;
575 if (obj->has_state()) {
576 // We have a valid value, output this value
577 stream->print(ESPHOME_F("esphome_text_failed{id=\""));
578 this->print_relabel_id_(stream, obj);
579 add_area_label_(stream, area);
580 add_node_label_(stream, node);
581 add_friendly_name_label_(stream, friendly_name);
582 stream->print(ESPHOME_F("\",name=\""));
583 this->print_relabel_name_(stream, obj);
584 stream->print(ESPHOME_F("\"} 0\n"));
585 // Data itself
586 stream->print(ESPHOME_F("esphome_text_value{id=\""));
587 this->print_relabel_id_(stream, obj);
588 add_area_label_(stream, area);
589 add_node_label_(stream, node);
590 add_friendly_name_label_(stream, friendly_name);
591 stream->print(ESPHOME_F("\",name=\""));
592 this->print_relabel_name_(stream, obj);
593 stream->print(ESPHOME_F("\",value=\""));
594 stream->print(obj->state.c_str());
595 stream->print(ESPHOME_F("\"} "));
596 stream->print(ESPHOME_F("1.0"));
597 stream->print(ESPHOME_F("\n"));
598 } else {
599 // Invalid state
600 stream->print(ESPHOME_F("esphome_text_failed{id=\""));
601 this->print_relabel_id_(stream, obj);
602 add_area_label_(stream, area);
603 add_node_label_(stream, node);
604 add_friendly_name_label_(stream, friendly_name);
605 stream->print(ESPHOME_F("\",name=\""));
606 this->print_relabel_name_(stream, obj);
607 stream->print(ESPHOME_F("\"} 1\n"));
608 }
609}
610#endif
611
612// Type-specific implementation
613#ifdef USE_EVENT
614void PrometheusHandler::event_type_(AsyncResponseStream *stream) {
615 stream->print(ESPHOME_F("#TYPE esphome_event_value gauge\n"));
616 stream->print(ESPHOME_F("#TYPE esphome_event_failed gauge\n"));
617}
618void PrometheusHandler::event_row_(AsyncResponseStream *stream, event::Event *obj, std::string &area, std::string &node,
619 std::string &friendly_name) {
620 if (obj->is_internal() && !this->include_internal_)
621 return;
622 if (obj->has_event()) {
623 // We have a valid event type, output this value
624 stream->print(ESPHOME_F("esphome_event_failed{id=\""));
625 this->print_relabel_id_(stream, obj);
626 add_area_label_(stream, area);
627 add_node_label_(stream, node);
628 add_friendly_name_label_(stream, friendly_name);
629 stream->print(ESPHOME_F("\",name=\""));
630 this->print_relabel_name_(stream, obj);
631 stream->print(ESPHOME_F("\"} 0\n"));
632 // Data itself
633 stream->print(ESPHOME_F("esphome_event_value{id=\""));
634 this->print_relabel_id_(stream, obj);
635 add_area_label_(stream, area);
636 add_node_label_(stream, node);
637 add_friendly_name_label_(stream, friendly_name);
638 stream->print(ESPHOME_F("\",name=\""));
639 this->print_relabel_name_(stream, obj);
640 stream->print(ESPHOME_F("\",last_event_type=\""));
641 // get_last_event_type() returns StringRef (null-terminated)
642 stream->print(obj->get_last_event_type().c_str());
643 stream->print(ESPHOME_F("\"} "));
644 stream->print(ESPHOME_F("1.0"));
645 stream->print(ESPHOME_F("\n"));
646 } else {
647 // No event triggered yet
648 stream->print(ESPHOME_F("esphome_event_failed{id=\""));
649 this->print_relabel_id_(stream, obj);
650 add_area_label_(stream, area);
651 add_node_label_(stream, node);
652 add_friendly_name_label_(stream, friendly_name);
653 stream->print(ESPHOME_F("\",name=\""));
654 this->print_relabel_name_(stream, obj);
655 stream->print(ESPHOME_F("\"} 1\n"));
656 }
657}
658#endif
659
660// Type-specific implementation
661#ifdef USE_NUMBER
662void PrometheusHandler::number_type_(AsyncResponseStream *stream) {
663 stream->print(ESPHOME_F("#TYPE esphome_number_value gauge\n"));
664 stream->print(ESPHOME_F("#TYPE esphome_number_failed gauge\n"));
665}
666void PrometheusHandler::number_row_(AsyncResponseStream *stream, number::Number *obj, std::string &area,
667 std::string &node, std::string &friendly_name) {
668 if (obj->is_internal() && !this->include_internal_)
669 return;
670 if (!std::isnan(obj->state)) {
671 // We have a valid value, output this value
672 stream->print(ESPHOME_F("esphome_number_failed{id=\""));
673 this->print_relabel_id_(stream, obj);
674 add_area_label_(stream, area);
675 add_node_label_(stream, node);
676 add_friendly_name_label_(stream, friendly_name);
677 stream->print(ESPHOME_F("\",name=\""));
678 this->print_relabel_name_(stream, obj);
679 stream->print(ESPHOME_F("\"} 0\n"));
680 // Data itself
681 stream->print(ESPHOME_F("esphome_number_value{id=\""));
682 this->print_relabel_id_(stream, obj);
683 add_area_label_(stream, area);
684 add_node_label_(stream, node);
685 add_friendly_name_label_(stream, friendly_name);
686 stream->print(ESPHOME_F("\",name=\""));
687 this->print_relabel_name_(stream, obj);
688 stream->print(ESPHOME_F("\"} "));
689 stream->print(obj->state);
690 stream->print(ESPHOME_F("\n"));
691 } else {
692 // Invalid state
693 stream->print(ESPHOME_F("esphome_number_failed{id=\""));
694 this->print_relabel_id_(stream, obj);
695 add_area_label_(stream, area);
696 add_node_label_(stream, node);
697 add_friendly_name_label_(stream, friendly_name);
698 stream->print(ESPHOME_F("\",name=\""));
699 this->print_relabel_name_(stream, obj);
700 stream->print(ESPHOME_F("\"} 1\n"));
701 }
702}
703#endif
704
705#ifdef USE_SELECT
706void PrometheusHandler::select_type_(AsyncResponseStream *stream) {
707 stream->print(ESPHOME_F("#TYPE esphome_select_value gauge\n"));
708 stream->print(ESPHOME_F("#TYPE esphome_select_failed gauge\n"));
709}
710void PrometheusHandler::select_row_(AsyncResponseStream *stream, select::Select *obj, std::string &area,
711 std::string &node, std::string &friendly_name) {
712 if (obj->is_internal() && !this->include_internal_)
713 return;
714 if (obj->has_state()) {
715 // We have a valid value, output this value
716 stream->print(ESPHOME_F("esphome_select_failed{id=\""));
717 this->print_relabel_id_(stream, obj);
718 add_area_label_(stream, area);
719 add_node_label_(stream, node);
720 add_friendly_name_label_(stream, friendly_name);
721 stream->print(ESPHOME_F("\",name=\""));
722 this->print_relabel_name_(stream, obj);
723 stream->print(ESPHOME_F("\"} 0\n"));
724 // Data itself
725 stream->print(ESPHOME_F("esphome_select_value{id=\""));
726 this->print_relabel_id_(stream, obj);
727 add_area_label_(stream, area);
728 add_node_label_(stream, node);
729 add_friendly_name_label_(stream, friendly_name);
730 stream->print(ESPHOME_F("\",name=\""));
731 this->print_relabel_name_(stream, obj);
732 stream->print(ESPHOME_F("\",value=\""));
733 // c_str() is safe as option values are null-terminated strings from codegen
734 stream->print(obj->current_option().c_str());
735 stream->print(ESPHOME_F("\"} "));
736 stream->print(ESPHOME_F("1.0"));
737 stream->print(ESPHOME_F("\n"));
738 } else {
739 // Invalid state
740 stream->print(ESPHOME_F("esphome_select_failed{id=\""));
741 this->print_relabel_id_(stream, obj);
742 add_area_label_(stream, area);
743 add_node_label_(stream, node);
744 add_friendly_name_label_(stream, friendly_name);
745 stream->print(ESPHOME_F("\",name=\""));
746 this->print_relabel_name_(stream, obj);
747 stream->print(ESPHOME_F("\"} 1\n"));
748 }
749}
750#endif
751
752#ifdef USE_MEDIA_PLAYER
753void PrometheusHandler::media_player_type_(AsyncResponseStream *stream) {
754 stream->print(ESPHOME_F("#TYPE esphome_media_player_state_value gauge\n"));
755 stream->print(ESPHOME_F("#TYPE esphome_media_player_volume gauge\n"));
756 stream->print(ESPHOME_F("#TYPE esphome_media_player_is_muted gauge\n"));
757 stream->print(ESPHOME_F("#TYPE esphome_media_player_failed gauge\n"));
758}
760 std::string &area, std::string &node, std::string &friendly_name) {
761 if (obj->is_internal() && !this->include_internal_)
762 return;
763 stream->print(ESPHOME_F("esphome_media_player_failed{id=\""));
764 this->print_relabel_id_(stream, obj);
765 add_area_label_(stream, area);
766 add_node_label_(stream, node);
767 add_friendly_name_label_(stream, friendly_name);
768 stream->print(ESPHOME_F("\",name=\""));
769 this->print_relabel_name_(stream, obj);
770 stream->print(ESPHOME_F("\"} 0\n"));
771 // Data itself
772 stream->print(ESPHOME_F("esphome_media_player_state_value{id=\""));
773 this->print_relabel_id_(stream, obj);
774 add_area_label_(stream, area);
775 add_node_label_(stream, node);
776 add_friendly_name_label_(stream, friendly_name);
777 stream->print(ESPHOME_F("\",name=\""));
778 this->print_relabel_name_(stream, obj);
779 stream->print(ESPHOME_F("\",value=\""));
781 stream->print(ESPHOME_F("\"} "));
782 stream->print(ESPHOME_F("1.0"));
783 stream->print(ESPHOME_F("\n"));
784 stream->print(ESPHOME_F("esphome_media_player_volume{id=\""));
785 this->print_relabel_id_(stream, obj);
786 add_area_label_(stream, area);
787 add_node_label_(stream, node);
788 add_friendly_name_label_(stream, friendly_name);
789 stream->print(ESPHOME_F("\",name=\""));
790 this->print_relabel_name_(stream, obj);
791 stream->print(ESPHOME_F("\"} "));
792 stream->print(obj->volume);
793 stream->print(ESPHOME_F("\n"));
794 stream->print(ESPHOME_F("esphome_media_player_is_muted{id=\""));
795 this->print_relabel_id_(stream, obj);
796 add_area_label_(stream, area);
797 add_node_label_(stream, node);
798 add_friendly_name_label_(stream, friendly_name);
799 stream->print(ESPHOME_F("\",name=\""));
800 this->print_relabel_name_(stream, obj);
801 stream->print(ESPHOME_F("\"} "));
802 if (obj->is_muted()) {
803 stream->print(ESPHOME_F("1.0"));
804 } else {
805 stream->print(ESPHOME_F("0.0"));
806 }
807 stream->print(ESPHOME_F("\n"));
808}
809#endif
810
811#ifdef USE_UPDATE
812void PrometheusHandler::update_entity_type_(AsyncResponseStream *stream) {
813 stream->print(ESPHOME_F("#TYPE esphome_update_entity_state gauge\n"));
814 stream->print(ESPHOME_F("#TYPE esphome_update_entity_info gauge\n"));
815 stream->print(ESPHOME_F("#TYPE esphome_update_entity_failed gauge\n"));
816}
817
819 switch (state) {
821 stream->print("unknown");
822 break;
824 stream->print("none");
825 break;
827 stream->print("available");
828 break;
830 stream->print("installing");
831 break;
832 default:
833 stream->print("invalid");
834 break;
835 }
836}
837
838void PrometheusHandler::update_entity_row_(AsyncResponseStream *stream, update::UpdateEntity *obj, std::string &area,
839 std::string &node, std::string &friendly_name) {
840 if (obj->is_internal() && !this->include_internal_)
841 return;
842 if (obj->has_state()) {
843 // We have a valid value, output this value
844 stream->print(ESPHOME_F("esphome_update_entity_failed{id=\""));
845 this->print_relabel_id_(stream, obj);
846 add_area_label_(stream, area);
847 add_node_label_(stream, node);
848 add_friendly_name_label_(stream, friendly_name);
849 stream->print(ESPHOME_F("\",name=\""));
850 this->print_relabel_name_(stream, obj);
851 stream->print(ESPHOME_F("\"} 0\n"));
852 // First update state
853 stream->print(ESPHOME_F("esphome_update_entity_state{id=\""));
854 this->print_relabel_id_(stream, obj);
855 add_area_label_(stream, area);
856 add_node_label_(stream, node);
857 add_friendly_name_label_(stream, friendly_name);
858 stream->print(ESPHOME_F("\",name=\""));
859 this->print_relabel_name_(stream, obj);
860 stream->print(ESPHOME_F("\",value=\""));
861 handle_update_state_(stream, obj->state);
862 stream->print(ESPHOME_F("\"} "));
863 stream->print(ESPHOME_F("1.0"));
864 stream->print(ESPHOME_F("\n"));
865 // Next update info
866 stream->print(ESPHOME_F("esphome_update_entity_info{id=\""));
867 this->print_relabel_id_(stream, obj);
868 add_area_label_(stream, area);
869 add_node_label_(stream, node);
870 add_friendly_name_label_(stream, friendly_name);
871 stream->print(ESPHOME_F("\",name=\""));
872 this->print_relabel_name_(stream, obj);
873 stream->print(ESPHOME_F("\",current_version=\""));
874 stream->print(obj->update_info.current_version.c_str());
875 stream->print(ESPHOME_F("\",latest_version=\""));
876 stream->print(obj->update_info.latest_version.c_str());
877 stream->print(ESPHOME_F("\",title=\""));
878 stream->print(obj->update_info.title.c_str());
879 stream->print(ESPHOME_F("\"} "));
880 stream->print(ESPHOME_F("1.0"));
881 stream->print(ESPHOME_F("\n"));
882 } else {
883 // Invalid state
884 stream->print(ESPHOME_F("esphome_update_entity_failed{id=\""));
885 this->print_relabel_id_(stream, obj);
886 add_area_label_(stream, area);
887 add_node_label_(stream, node);
888 add_friendly_name_label_(stream, friendly_name);
889 stream->print(ESPHOME_F("\",name=\""));
890 this->print_relabel_name_(stream, obj);
891 stream->print(ESPHOME_F("\"} 1\n"));
892 }
893}
894#endif
895
896#ifdef USE_VALVE
897void PrometheusHandler::valve_type_(AsyncResponseStream *stream) {
898 stream->print(ESPHOME_F("#TYPE esphome_valve_operation gauge\n"));
899 stream->print(ESPHOME_F("#TYPE esphome_valve_failed gauge\n"));
900 stream->print(ESPHOME_F("#TYPE esphome_valve_position gauge\n"));
901}
902
903void PrometheusHandler::valve_row_(AsyncResponseStream *stream, valve::Valve *obj, std::string &area, std::string &node,
904 std::string &friendly_name) {
905 if (obj->is_internal() && !this->include_internal_)
906 return;
907 stream->print(ESPHOME_F("esphome_valve_failed{id=\""));
908 this->print_relabel_id_(stream, obj);
909 add_area_label_(stream, area);
910 add_node_label_(stream, node);
911 add_friendly_name_label_(stream, friendly_name);
912 stream->print(ESPHOME_F("\",name=\""));
913 this->print_relabel_name_(stream, obj);
914 stream->print(ESPHOME_F("\"} 0\n"));
915 // Data itself
916 stream->print(ESPHOME_F("esphome_valve_operation{id=\""));
917 this->print_relabel_id_(stream, obj);
918 add_area_label_(stream, area);
919 add_node_label_(stream, node);
920 add_friendly_name_label_(stream, friendly_name);
921 stream->print(ESPHOME_F("\",name=\""));
922 this->print_relabel_name_(stream, obj);
923 stream->print(ESPHOME_F("\",operation=\""));
924 stream->print(reinterpret_cast<ProgmemStr>(valve::valve_operation_to_str(obj->current_operation)));
925 stream->print(ESPHOME_F("\"} "));
926 stream->print(ESPHOME_F("1.0"));
927 stream->print(ESPHOME_F("\n"));
928 // Now see if position is supported
929 if (obj->get_traits().get_supports_position()) {
930 stream->print(ESPHOME_F("esphome_valve_position{id=\""));
931 this->print_relabel_id_(stream, obj);
932 add_area_label_(stream, area);
933 add_node_label_(stream, node);
934 add_friendly_name_label_(stream, friendly_name);
935 stream->print(ESPHOME_F("\",name=\""));
936 this->print_relabel_name_(stream, obj);
937 stream->print(ESPHOME_F("\"} "));
938 stream->print(obj->position);
939 stream->print(ESPHOME_F("\n"));
940 }
941}
942#endif
943
944#ifdef USE_CLIMATE
945void PrometheusHandler::climate_type_(AsyncResponseStream *stream) {
946 stream->print(ESPHOME_F("#TYPE esphome_climate_setting gauge\n"));
947 stream->print(ESPHOME_F("#TYPE esphome_climate_value gauge\n"));
948 stream->print(ESPHOME_F("#TYPE esphome_climate_failed gauge\n"));
949}
950
951void PrometheusHandler::climate_setting_row_(AsyncResponseStream *stream, climate::Climate *obj, std::string &area,
952 std::string &node, std::string &friendly_name, std::string &setting,
953 const LogString *setting_value) {
954 stream->print(ESPHOME_F("esphome_climate_setting{id=\""));
955 this->print_relabel_id_(stream, obj);
956 add_area_label_(stream, area);
957 add_node_label_(stream, node);
958 add_friendly_name_label_(stream, friendly_name);
959 stream->print(ESPHOME_F("\",name=\""));
960 this->print_relabel_name_(stream, obj);
961 stream->print(ESPHOME_F("\",category=\""));
962 stream->print(setting.c_str());
963 stream->print(ESPHOME_F("\",setting_value=\""));
964#ifdef USE_ESP8266
965 stream->print((const __FlashStringHelper *) setting_value);
966#else
967 stream->print(LOG_STR_ARG(setting_value));
968#endif
969 stream->print(ESPHOME_F("\"} "));
970 stream->print(ESPHOME_F("1.0"));
971 stream->print(ESPHOME_F("\n"));
972}
973
974void PrometheusHandler::climate_value_row_(AsyncResponseStream *stream, climate::Climate *obj, std::string &area,
975 std::string &node, std::string &friendly_name, std::string &category,
976 const char *climate_value) {
977 stream->print(ESPHOME_F("esphome_climate_value{id=\""));
978 this->print_relabel_id_(stream, obj);
979 add_area_label_(stream, area);
980 add_node_label_(stream, node);
981 add_friendly_name_label_(stream, friendly_name);
982 stream->print(ESPHOME_F("\",name=\""));
983 this->print_relabel_name_(stream, obj);
984 stream->print(ESPHOME_F("\",category=\""));
985 stream->print(category.c_str());
986 stream->print(ESPHOME_F("\"} "));
987 stream->print(climate_value);
988 stream->print(ESPHOME_F("\n"));
989}
990
991void PrometheusHandler::climate_failed_row_(AsyncResponseStream *stream, climate::Climate *obj, std::string &area,
992 std::string &node, std::string &friendly_name, std::string &category,
993 bool is_failed_value) {
994 stream->print(ESPHOME_F("esphome_climate_failed{id=\""));
995 this->print_relabel_id_(stream, obj);
996 add_area_label_(stream, area);
997 add_node_label_(stream, node);
998 add_friendly_name_label_(stream, friendly_name);
999 stream->print(ESPHOME_F("\",name=\""));
1000 this->print_relabel_name_(stream, obj);
1001 stream->print(ESPHOME_F("\",category=\""));
1002 stream->print(category.c_str());
1003 stream->print(ESPHOME_F("\"} "));
1004 if (is_failed_value) {
1005 stream->print(ESPHOME_F("1.0"));
1006 } else {
1007 stream->print(ESPHOME_F("0.0"));
1008 }
1009 stream->print(ESPHOME_F("\n"));
1010}
1011
1012void PrometheusHandler::climate_row_(AsyncResponseStream *stream, climate::Climate *obj, std::string &area,
1013 std::string &node, std::string &friendly_name) {
1014 if (obj->is_internal() && !this->include_internal_)
1015 return;
1016 // Data itself
1017 bool any_failures = false;
1018 std::string climate_mode_category = "mode";
1019 const auto *climate_mode_value = climate::climate_mode_to_string(obj->mode);
1020 climate_setting_row_(stream, obj, area, node, friendly_name, climate_mode_category, climate_mode_value);
1021 const auto traits = obj->get_traits();
1022 // Now see if traits is supported
1023 int8_t target_accuracy = traits.get_target_temperature_accuracy_decimals();
1024 int8_t current_accuracy = traits.get_current_temperature_accuracy_decimals();
1025 char value_buf[VALUE_ACCURACY_MAX_LEN];
1026 // max temp
1027 std::string max_temp = "maximum_temperature";
1028 value_accuracy_to_buf(value_buf, traits.get_visual_max_temperature(), target_accuracy);
1029 climate_value_row_(stream, obj, area, node, friendly_name, max_temp, value_buf);
1030 // min temp
1031 std::string min_temp = "minimum_temperature";
1032 value_accuracy_to_buf(value_buf, traits.get_visual_min_temperature(), target_accuracy);
1033 climate_value_row_(stream, obj, area, node, friendly_name, min_temp, value_buf);
1034 // now check optional traits
1035 if (traits.has_feature_flags(climate::CLIMATE_SUPPORTS_CURRENT_TEMPERATURE)) {
1036 std::string current_temp = "current_temperature";
1037 if (std::isnan(obj->current_temperature)) {
1038 climate_failed_row_(stream, obj, area, node, friendly_name, current_temp, true);
1039 any_failures = true;
1040 } else {
1041 value_accuracy_to_buf(value_buf, obj->current_temperature, current_accuracy);
1042 climate_value_row_(stream, obj, area, node, friendly_name, current_temp, value_buf);
1043 climate_failed_row_(stream, obj, area, node, friendly_name, current_temp, false);
1044 }
1045 }
1046 if (traits.has_feature_flags(climate::CLIMATE_SUPPORTS_CURRENT_HUMIDITY)) {
1047 std::string current_humidity = "current_humidity";
1048 if (std::isnan(obj->current_humidity)) {
1049 climate_failed_row_(stream, obj, area, node, friendly_name, current_humidity, true);
1050 any_failures = true;
1051 } else {
1052 value_accuracy_to_buf(value_buf, obj->current_humidity, 0);
1053 climate_value_row_(stream, obj, area, node, friendly_name, current_humidity, value_buf);
1054 climate_failed_row_(stream, obj, area, node, friendly_name, current_humidity, false);
1055 }
1056 }
1057 if (traits.has_feature_flags(climate::CLIMATE_SUPPORTS_TARGET_HUMIDITY)) {
1058 std::string target_humidity = "target_humidity";
1059 if (std::isnan(obj->target_humidity)) {
1060 climate_failed_row_(stream, obj, area, node, friendly_name, target_humidity, true);
1061 any_failures = true;
1062 } else {
1063 value_accuracy_to_buf(value_buf, obj->target_humidity, 0);
1064 climate_value_row_(stream, obj, area, node, friendly_name, target_humidity, value_buf);
1065 climate_failed_row_(stream, obj, area, node, friendly_name, target_humidity, false);
1066 }
1067 }
1068 if (traits.has_feature_flags(climate::CLIMATE_SUPPORTS_TWO_POINT_TARGET_TEMPERATURE |
1070 std::string target_temp_low = "target_temperature_low";
1071 value_accuracy_to_buf(value_buf, obj->target_temperature_low, target_accuracy);
1072 climate_value_row_(stream, obj, area, node, friendly_name, target_temp_low, value_buf);
1073 std::string target_temp_high = "target_temperature_high";
1074 value_accuracy_to_buf(value_buf, obj->target_temperature_high, target_accuracy);
1075 climate_value_row_(stream, obj, area, node, friendly_name, target_temp_high, value_buf);
1076 } else {
1077 std::string target_temp = "target_temperature";
1078 value_accuracy_to_buf(value_buf, obj->target_temperature, target_accuracy);
1079 climate_value_row_(stream, obj, area, node, friendly_name, target_temp, value_buf);
1080 }
1081 if (traits.has_feature_flags(climate::CLIMATE_SUPPORTS_ACTION)) {
1082 std::string climate_trait_category = "action";
1083 const auto *climate_trait_value = climate::climate_action_to_string(obj->action);
1084 climate_setting_row_(stream, obj, area, node, friendly_name, climate_trait_category, climate_trait_value);
1085 }
1086 if (traits.get_supports_fan_modes()) {
1087 std::string climate_trait_category = "fan_mode";
1088 if (obj->fan_mode.has_value()) {
1089 const auto *climate_trait_value = climate::climate_fan_mode_to_string(obj->fan_mode.value());
1090 climate_setting_row_(stream, obj, area, node, friendly_name, climate_trait_category, climate_trait_value);
1091 climate_failed_row_(stream, obj, area, node, friendly_name, climate_trait_category, false);
1092 } else {
1093 climate_failed_row_(stream, obj, area, node, friendly_name, climate_trait_category, true);
1094 any_failures = true;
1095 }
1096 }
1097 if (traits.get_supports_presets()) {
1098 std::string climate_trait_category = "preset";
1099 if (obj->preset.has_value()) {
1100 const auto *climate_trait_value = climate::climate_preset_to_string(obj->preset.value());
1101 climate_setting_row_(stream, obj, area, node, friendly_name, climate_trait_category, climate_trait_value);
1102 climate_failed_row_(stream, obj, area, node, friendly_name, climate_trait_category, false);
1103 } else {
1104 climate_failed_row_(stream, obj, area, node, friendly_name, climate_trait_category, true);
1105 any_failures = true;
1106 }
1107 }
1108 if (traits.get_supports_swing_modes()) {
1109 std::string climate_trait_category = "swing_mode";
1110 const auto *climate_trait_value = climate::climate_swing_mode_to_string(obj->swing_mode);
1111 climate_setting_row_(stream, obj, area, node, friendly_name, climate_trait_category, climate_trait_value);
1112 }
1113 std::string all_climate_category = "all";
1114 climate_failed_row_(stream, obj, area, node, friendly_name, all_climate_category, any_failures);
1115}
1116#endif
1117
1118#if defined(USE_DATETIME_DATE) || defined(USE_DATETIME_DATETIME) || defined(USE_DATETIME_TIME)
1119void PrometheusHandler::date_time_rows_(AsyncResponseStream *stream, ProgmemStr failed_metric, ProgmemStr value_metric,
1120 EntityBase *obj, int64_t value_ms, std::string &area, std::string &node,
1121 std::string &friendly_name) {
1122 if (obj->is_internal() && !this->include_internal_)
1123 return;
1124 this->print_metric_labels_(stream, failed_metric, obj, area, node, friendly_name);
1125 if (!obj->has_state()) {
1126 stream->print(ESPHOME_F("\"} 1\n"));
1127 return;
1128 }
1129 stream->print(ESPHOME_F("\"} 0\n"));
1130 this->print_metric_labels_(stream, value_metric, obj, area, node, friendly_name);
1131 // Date and datetime are ms since the epoch (what Grafana expects), time is ms since midnight
1132 char buf[32];
1133 snprintf(buf, sizeof(buf), "\"} %" PRId64 "\n", value_ms);
1134 stream->print(buf);
1135}
1136#endif
1137
1138#ifdef USE_DATETIME_DATE
1139void PrometheusHandler::date_type_(AsyncResponseStream *stream) {
1140 stream->print(ESPHOME_F("#TYPE esphome_date_value gauge\n"));
1141 stream->print(ESPHOME_F("#TYPE esphome_date_failed gauge\n"));
1142}
1143void PrometheusHandler::date_row_(AsyncResponseStream *stream, datetime::DateEntity *obj, std::string &area,
1144 std::string &node, std::string &friendly_name) {
1145 int64_t value_ms = 0;
1146 if (obj->has_state()) {
1147 // DateEntity::state_as_esptime() leaves the time fields unset, so build midnight here
1148 ESPTime t{};
1149 t.year = obj->year;
1150 t.month = obj->month;
1151 t.day_of_month = obj->day;
1152 t.recalc_timestamp_local();
1153 value_ms = static_cast<int64_t>(t.timestamp) * 1000;
1154 }
1155 this->date_time_rows_(stream, ESPHOME_F("esphome_date_failed"), ESPHOME_F("esphome_date_value"), obj, value_ms, area,
1156 node, friendly_name);
1157}
1158#endif
1159
1160#ifdef USE_DATETIME_TIME
1161void PrometheusHandler::time_type_(AsyncResponseStream *stream) {
1162 stream->print(ESPHOME_F("#TYPE esphome_time_value gauge\n"));
1163 stream->print(ESPHOME_F("#TYPE esphome_time_failed gauge\n"));
1164}
1165void PrometheusHandler::time_row_(AsyncResponseStream *stream, datetime::TimeEntity *obj, std::string &area,
1166 std::string &node, std::string &friendly_name) {
1167 int64_t value_ms = 0;
1168 if (obj->has_state())
1169 value_ms = (static_cast<int64_t>(obj->hour) * 3600 + obj->minute * 60 + obj->second) * 1000;
1170 this->date_time_rows_(stream, ESPHOME_F("esphome_time_failed"), ESPHOME_F("esphome_time_value"), obj, value_ms, area,
1171 node, friendly_name);
1172}
1173#endif
1174
1175#ifdef USE_DATETIME_DATETIME
1176void PrometheusHandler::datetime_type_(AsyncResponseStream *stream) {
1177 stream->print(ESPHOME_F("#TYPE esphome_datetime_value gauge\n"));
1178 stream->print(ESPHOME_F("#TYPE esphome_datetime_failed gauge\n"));
1179}
1180void PrometheusHandler::datetime_row_(AsyncResponseStream *stream, datetime::DateTimeEntity *obj, std::string &area,
1181 std::string &node, std::string &friendly_name) {
1182 int64_t value_ms = 0;
1183 if (obj->has_state())
1184 value_ms = static_cast<int64_t>(obj->state_as_esptime().timestamp) * 1000;
1185 this->date_time_rows_(stream, ESPHOME_F("esphome_datetime_failed"), ESPHOME_F("esphome_datetime_value"), obj,
1186 value_ms, area, node, friendly_name);
1187}
1188#endif
1189
1190} // namespace esphome::prometheus
1191
1192#endif
const StringRef & get_name() const
Get the name of this Application set by pre_setup().
const StringRef & get_friendly_name() const
Get the friendly name of this Application set by pre_setup().
const char * get_area() const
Get the area of this Application set by pre_setup().
const ProgmemStringRef & get_name_progmem() const
The name as stored, for consumers that read flash themselves (e.g. API progmem fields).
Definition entity_base.h:94
bool is_internal() const
StringRef get_unit_of_measurement_ref() const
bool has_state() const
StringRef get_object_id_to(std::span< char, OBJECT_ID_MAX_LEN > buf) const
Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffe...
constexpr const char * progmem_ptr() const
Definition string_ref.h:244
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
Base class for all binary_sensor-type classes.
bool state
The current state of this binary sensor. Also used as the backing storage for StatefulEntityBase.
ClimateDevice - This is the base class for all climate integrations.
Definition climate.h:192
ClimateMode mode
The active mode of the climate device.
Definition climate.h:317
optional< ClimateFanMode > fan_mode
The active fan mode of the climate device.
Definition climate.h:311
ClimateTraits get_traits()
Get the traits of this climate device with all overrides applied.
Definition climate.cpp:482
float target_temperature
The target temperature of the climate device.
Definition climate.h:298
float current_humidity
The current humidity of the climate device, as reported from the integration.
Definition climate.h:294
ClimateSwingMode swing_mode
The active swing mode of the climate device.
Definition climate.h:323
float target_temperature_low
The minimum target temperature of the climate device, for climate devices with split target temperatu...
Definition climate.h:301
float current_temperature
The current temperature of the climate device, as reported from the integration.
Definition climate.h:291
ClimateAction action
The active state of the climate device.
Definition climate.h:320
optional< ClimatePreset > preset
The active preset of the climate device.
Definition climate.h:314
float target_humidity
The target humidity of the climate device.
Definition climate.h:308
float target_temperature_high
The maximum target temperature of the climate device, for climate devices with split target temperatu...
Definition climate.h:303
int8_t get_target_temperature_accuracy_decimals() const
Base class for all cover devices.
Definition cover.h:115
float tilt
The current tilt value of the cover from 0.0 to 1.0.
Definition cover.h:128
float position
The position of the cover from 0.0 (fully closed) to 1.0 (fully open).
Definition cover.h:126
virtual CoverTraits get_traits()=0
ESPTime state_as_esptime() const override
bool has_event() const
Check if an event has been triggered.
Definition event.h:75
StringRef get_last_event_type() const
Return the last triggered event type, or empty StringRef if no event triggered yet.
Definition event.h:54
virtual FanTraits get_traits()=0
bool oscillating
The current oscillation state of the fan.
Definition fan.h:113
bool state
The current on/off state of the fan.
Definition fan.h:111
int speed
The current fan speed level.
Definition fan.h:115
bool supports_speed() const
Return if this fan supports speed modes.
Definition fan_traits.h:27
bool supports_oscillation() const
Return if this fan supports oscillation.
Definition fan_traits.h:23
This class represents the color state for a light object.
void as_rgbw(float *red, float *green, float *blue, float *white) const
Convert these light color values to an RGBW representation and write them to red, green,...
bool is_on() const
Get the binary true/false state of these light color values.
void as_brightness(float *brightness) const
Convert these light color values to a brightness-only representation and write them to brightness.
This class represents the communication layer between the front-end MQTT layer and the hardware outpu...
Definition light_state.h:68
StringRef get_effect_name()
Return the name of the current effect, or if no effect is active "None".
const LightColorValues & get_reported_values() const
The values reported to the frontend: current_values while a light publishes intermediate states on an...
Definition light_state.h:82
const ConstVector< LightEffect * > & get_effects() const
Get all effects for this light state.
LightColorValues current_values
The current values of the light as outputted to the light.
bool supports_color_capability(ColorCapability color_capability) const
Base class for all locks.
Definition lock.h:112
LockState state
The current reported state of the lock.
Definition lock.h:131
Base-class for all numbers.
Definition number.h:29
void number_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void add_friendly_name_label_(AsyncResponseStream *stream, std::string &friendly_name)
void handle_update_state_(AsyncResponseStream *stream, update::UpdateState state)
void climate_setting_row_(AsyncResponseStream *stream, climate::Climate *obj, std::string &area, std::string &node, std::string &friendly_name, std::string &setting, const LogString *setting_value)
void event_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void media_player_row_(AsyncResponseStream *stream, media_player::MediaPlayer *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the media player state as prometheus data point.
void light_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void print_relabel_name_(AsyncResponseStream *stream, EntityBase *obj)
void text_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void update_entity_row_(AsyncResponseStream *stream, update::UpdateEntity *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the update state and info as prometheus data point.
void datetime_type_(AsyncResponseStream *stream)
Return the type for prometheus.
std::map< EntityBase *, std::string > relabel_map_id_
void fan_row_(AsyncResponseStream *stream, fan::Fan *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the fan state as prometheus data point.
void climate_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void binary_sensor_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void switch_row_(AsyncResponseStream *stream, switch_::Switch *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the switch values state as prometheus data point.
std::map< EntityBase *, std::string > relabel_map_name_
void sensor_row_(AsyncResponseStream *stream, sensor::Sensor *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the sensor state as prometheus data point.
void light_row_(AsyncResponseStream *stream, light::LightState *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the light values state as prometheus data point.
void climate_row_(AsyncResponseStream *stream, climate::Climate *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the climate state as prometheus data point.
void update_entity_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void climate_failed_row_(AsyncResponseStream *stream, climate::Climate *obj, std::string &area, std::string &node, std::string &friendly_name, std::string &category, bool is_failed_value)
void print_relabel_id_(AsyncResponseStream *stream, EntityBase *obj)
void binary_sensor_row_(AsyncResponseStream *stream, binary_sensor::BinarySensor *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the binary sensor state as prometheus data point.
void number_row_(AsyncResponseStream *stream, number::Number *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the number state as prometheus data point.
void valve_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void switch_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void media_player_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void event_row_(AsyncResponseStream *stream, event::Event *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the event values state as prometheus data point.
void text_sensor_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void text_sensor_row_(AsyncResponseStream *stream, text_sensor::TextSensor *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the text sensor values state as prometheus data point.
void add_area_label_(AsyncResponseStream *stream, std::string &area)
void print_metric_labels_(AsyncResponseStream *stream, ProgmemStr metric_name, EntityBase *obj, std::string &area, std::string &node, std::string &friendly_name)
Print metric name and common labels (id, area, node, friendly_name, name)
void date_row_(AsyncResponseStream *stream, datetime::DateEntity *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the date state as prometheus data point.
void select_row_(AsyncResponseStream *stream, select::Select *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the select state as prometheus data point.
void date_time_rows_(AsyncResponseStream *stream, ProgmemStr failed_metric, ProgmemStr value_metric, EntityBase *obj, int64_t value_ms, std::string &area, std::string &node, std::string &friendly_name)
Print the failed row and, when the entity has a state, the value row in milliseconds.
void cover_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void datetime_row_(AsyncResponseStream *stream, datetime::DateTimeEntity *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the datetime state as prometheus data point.
void select_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void time_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void date_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void add_node_label_(AsyncResponseStream *stream, std::string &node)
void handleRequest(AsyncWebServerRequest *req) override
void text_row_(AsyncResponseStream *stream, text::Text *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the text values state as prometheus data point.
void cover_row_(AsyncResponseStream *stream, cover::Cover *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the cover values state as prometheus data point.
void lock_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void valve_row_(AsyncResponseStream *stream, valve::Valve *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the valve state as prometheus data point.
void climate_value_row_(AsyncResponseStream *stream, climate::Climate *obj, std::string &area, std::string &node, std::string &friendly_name, std::string &category, const char *climate_value)
void fan_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void time_row_(AsyncResponseStream *stream, datetime::TimeEntity *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the time state as prometheus data point.
void sensor_type_(AsyncResponseStream *stream)
Return the type for prometheus.
void lock_row_(AsyncResponseStream *stream, lock::Lock *obj, std::string &area, std::string &node, std::string &friendly_name)
Return the lock values state as prometheus data point.
Base-class for all selects.
Definition select.h:28
StringRef current_option() const
Return the currently selected option, or empty StringRef if no state.
Definition select.h:42
Base-class for all sensors.
Definition sensor.h:48
float state
This member variable stores the last state that has passed through all filters.
Definition sensor.h:141
int8_t get_accuracy_decimals()
Get the accuracy in decimals, using the manual override if set.
Definition sensor.cpp:45
Base class for all switches.
Definition switch.h:43
bool state
The current reported state of the binary sensor.
Definition switch.h:60
Base-class for all text inputs.
Definition text.h:20
std::string state
Definition text.h:22
const UpdateState & state
const UpdateInfo & update_info
Base class for all valve devices.
Definition valve.h:102
float position
The position of the valve from 0.0 (fully closed) to 1.0 (fully open).
Definition valve.h:113
ValveOperation current_operation
The current operation of the valve (idle, opening, closing).
Definition valve.h:107
virtual ValveTraits get_traits()=0
bool get_supports_position() const
float target_humidity
Definition climate.h:19
bool state
Definition fan.h:2
const LogString * climate_action_to_string(ClimateAction action)
Convert the given ClimateAction to a human-readable string.
@ CLIMATE_SUPPORTS_CURRENT_HUMIDITY
@ CLIMATE_SUPPORTS_TWO_POINT_TARGET_TEMPERATURE
@ CLIMATE_SUPPORTS_CURRENT_TEMPERATURE
@ CLIMATE_REQUIRES_TWO_POINT_TARGET_TEMPERATURE
const LogString * climate_swing_mode_to_string(ClimateSwingMode swing_mode)
Convert the given ClimateSwingMode to a human-readable string.
const LogString * climate_preset_to_string(ClimatePreset preset)
Convert the given PresetMode to a human-readable string.
const LogString * climate_fan_mode_to_string(ClimateFanMode fan_mode)
Convert the given ClimateFanMode to a human-readable string.
const LogString * climate_mode_to_string(ClimateMode mode)
Convert the given ClimateMode to a human-readable string.
@ BRIGHTNESS
Master brightness of the light can be controlled.
@ RGB
Color can be controlled using RGB format (includes a brightness control for the color).
@ WHITE
Brightness of white channel can be controlled separately from other channels.
const char * media_player_state_to_string(MediaPlayerState state)
const LogString * valve_operation_to_str(ValveOperation op)
Definition valve.cpp:28
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:625
Application App
Global storage of Application pointer - only one Application can exist.
const __FlashStringHelper * ProgmemStr
Definition progmem.h:31
A more user-friendly version of struct tm from time.h.
Definition time.h:23
uint16_t timestamp
Definition tt21100.cpp:2