ESPHome: esphome/components/prometheus/prometheus_handler.cpp Source File

#include "prometheus_handler.h"

#if defined(USE_NETWORK) && !defined(USE_HOST)

#include "esphome/core/application.h"


namespace esphome::prometheus {


void PrometheusHandler::handleRequest(AsyncWebServerRequest *req) {

  AsyncResponseStream *stream = req->beginResponseStream("text/plain; version=0.0.4; charset=utf-8");

  std::string area = App.get_area();

  std::string node = App.get_name();

  std::string friendly_name = App.get_friendly_name();


#ifdef USE_SENSOR

  this->sensor_type_(stream);

  for (auto *obj : App.get_sensors())

    this->sensor_row_(stream, obj, area, node, friendly_name);

#endif


#ifdef USE_BINARY_SENSOR

  this->binary_sensor_type_(stream);

  for (auto *obj : App.get_binary_sensors())

    this->binary_sensor_row_(stream, obj, area, node, friendly_name);

#endif


#ifdef USE_FAN

  this->fan_type_(stream);

  for (auto *obj : App.get_fans())

    this->fan_row_(stream, obj, area, node, friendly_name);

#endif


#ifdef USE_LIGHT

  this->light_type_(stream);

  for (auto *obj : App.get_lights())

    this->light_row_(stream, obj, area, node, friendly_name);

#endif


#ifdef USE_COVER

  this->cover_type_(stream);

  for (auto *obj : App.get_covers())

    this->cover_row_(stream, obj, area, node, friendly_name);

#endif


#ifdef USE_SWITCH

  this->switch_type_(stream);

  for (auto *obj : App.get_switches())

    this->switch_row_(stream, obj, area, node, friendly_name);

#endif


#ifdef USE_LOCK

  this->lock_type_(stream);

  for (auto *obj : App.get_locks())

    this->lock_row_(stream, obj, area, node, friendly_name);

#endif


#ifdef USE_EVENT

  this->event_type_(stream);

  for (auto *obj : App.get_events())

    this->event_row_(stream, obj, area, node, friendly_name);

#endif


#ifdef USE_TEXT

  this->text_type_(stream);

  for (auto *obj : App.get_texts())

    this->text_row_(stream, obj, area, node, friendly_name);

#endif


#ifdef USE_TEXT_SENSOR

  this->text_sensor_type_(stream);

  for (auto *obj : App.get_text_sensors())

    this->text_sensor_row_(stream, obj, area, node, friendly_name);

#endif


#ifdef USE_NUMBER

  this->number_type_(stream);

  for (auto *obj : App.get_numbers())

    this->number_row_(stream, obj, area, node, friendly_name);

#endif


#ifdef USE_SELECT

  this->select_type_(stream);

  for (auto *obj : App.get_selects())

    this->select_row_(stream, obj, area, node, friendly_name);

#endif


#ifdef USE_MEDIA_PLAYER

  this->media_player_type_(stream);

  for (auto *obj : App.get_media_players())

    this->media_player_row_(stream, obj, area, node, friendly_name);

#endif


#ifdef USE_UPDATE

  this->update_entity_type_(stream);

  for (auto *obj : App.get_updates())

    this->update_entity_row_(stream, obj, area, node, friendly_name);

#endif


#ifdef USE_VALVE

  this->valve_type_(stream);

  for (auto *obj : App.get_valves())

    this->valve_row_(stream, obj, area, node, friendly_name);

#endif


#ifdef USE_CLIMATE

  this->climate_type_(stream);

  for (auto *obj : App.get_climates())

    this->climate_row_(stream, obj, area, node, friendly_name);

#endif


  req->send(stream);

}


void PrometheusHandler::print_relabel_id_(AsyncResponseStream *stream, EntityBase *obj) {

  auto item = relabel_map_id_.find(obj);

  if (item != relabel_map_id_.end()) {

    stream->print(item->second.c_str());

    return;

  }

  char object_id_buf[OBJECT_ID_MAX_LEN];

  stream->print(obj->get_object_id_to(object_id_buf).c_str());

}


void PrometheusHandler::print_relabel_name_(AsyncResponseStream *stream, EntityBase *obj) {

  auto item = relabel_map_name_.find(obj);

  if (item != relabel_map_name_.end()) {

    stream->print(item->second.c_str());

    return;

  }

  stream->print(reinterpret_cast<ProgmemStr>(obj->get_name_progmem().progmem_ptr()));

}


void PrometheusHandler::add_area_label_(AsyncResponseStream *stream, std::string &area) {

  if (!area.empty()) {

    stream->print(ESPHOME_F("\",area=\""));

    stream->print(area.c_str());

  }

}


void PrometheusHandler::add_node_label_(AsyncResponseStream *stream, std::string &node) {

  if (!node.empty()) {

    stream->print(ESPHOME_F("\",node=\""));

    stream->print(node.c_str());

  }

}


void PrometheusHandler::add_friendly_name_label_(AsyncResponseStream *stream, std::string &friendly_name) {

  if (!friendly_name.empty()) {

    stream->print(ESPHOME_F("\",friendly_name=\""));

    stream->print(friendly_name.c_str());

  }

}


void PrometheusHandler::print_metric_labels_(AsyncResponseStream *stream, ProgmemStr metric_name, EntityBase *obj,

                                             std::string &area, std::string &node, std::string &friendly_name) {

  stream->print(metric_name);

  stream->print(ESPHOME_F("{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

}


// Type-specific implementation

#ifdef USE_SENSOR


void PrometheusHandler::sensor_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_sensor_value gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_sensor_failed gauge\n"));

}


void PrometheusHandler::sensor_row_(AsyncResponseStream *stream, sensor::Sensor *obj, std::string &area,

                                    std::string &node, std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  if (!std::isnan(obj->state)) {

    // We have a valid value, output this value

    stream->print(ESPHOME_F("esphome_sensor_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 0\n"));

    // Data itself

    stream->print(ESPHOME_F("esphome_sensor_value{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\",unit=\""));

    stream->print(obj->get_unit_of_measurement_ref().c_str());

    stream->print(ESPHOME_F("\"} "));

    char value_buf[VALUE_ACCURACY_MAX_LEN];

    value_accuracy_to_buf(value_buf, obj->state, obj->get_accuracy_decimals());

    stream->print(value_buf);

    stream->print(ESPHOME_F("\n"));

  } else {

    // Invalid state

    stream->print(ESPHOME_F("esphome_sensor_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 1\n"));

  }

}


#endif


// Type-specific implementation

#ifdef USE_BINARY_SENSOR


void PrometheusHandler::binary_sensor_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_binary_sensor_value gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_binary_sensor_failed gauge\n"));

}


void PrometheusHandler::binary_sensor_row_(AsyncResponseStream *stream, binary_sensor::BinarySensor *obj,

                                           std::string &area, std::string &node, std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  if (obj->has_state()) {

    // We have a valid value, output this value

    stream->print(ESPHOME_F("esphome_binary_sensor_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 0\n"));

    // Data itself

    stream->print(ESPHOME_F("esphome_binary_sensor_value{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} "));

    stream->print(obj->state);

    stream->print(ESPHOME_F("\n"));

  } else {

    // Invalid state

    stream->print(ESPHOME_F("esphome_binary_sensor_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 1\n"));

  }

}


#endif


#ifdef USE_FAN


void PrometheusHandler::fan_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_fan_value gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_fan_failed gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_fan_speed gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_fan_oscillation gauge\n"));

}


void PrometheusHandler::fan_row_(AsyncResponseStream *stream, fan::Fan *obj, std::string &area, std::string &node,

                                 std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  stream->print(ESPHOME_F("esphome_fan_failed{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

  stream->print(ESPHOME_F("\"} 0\n"));

  // Data itself

  stream->print(ESPHOME_F("esphome_fan_value{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

  stream->print(ESPHOME_F("\"} "));

  stream->print(obj->state);

  stream->print(ESPHOME_F("\n"));

  // Speed if available

  if (obj->get_traits().supports_speed()) {

    stream->print(ESPHOME_F("esphome_fan_speed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} "));

    stream->print(obj->speed);

    stream->print(ESPHOME_F("\n"));

  }

  // Oscillation if available

  if (obj->get_traits().supports_oscillation()) {

    stream->print(ESPHOME_F("esphome_fan_oscillation{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} "));

    stream->print(obj->oscillating);

    stream->print(ESPHOME_F("\n"));

  }

}


#endif


#ifdef USE_LIGHT


void PrometheusHandler::light_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_light_state gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_light_color gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_light_effect_active gauge\n"));

}


void PrometheusHandler::light_row_(AsyncResponseStream *stream, light::LightState *obj, std::string &area,

                                   std::string &node, std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  // State

  print_metric_labels_(stream, ESPHOME_F("esphome_light_state"), obj, area, node, friendly_name);

  stream->print(ESPHOME_F("\"} "));

  stream->print(obj->get_reported_values().is_on());

  stream->print(ESPHOME_F("\n"));

  // Brightness and RGBW

  light::LightColorValues color = obj->current_values;

  float brightness, r, g, b, w;

  color.as_brightness(&brightness);

  color.as_rgbw(&r, &g, &b, &w);

  if (obj->get_traits().supports_color_capability(light::ColorCapability::BRIGHTNESS)) {

    print_metric_labels_(stream, ESPHOME_F("esphome_light_color"), obj, area, node, friendly_name);

    stream->print(ESPHOME_F("\",channel=\"brightness\"} "));

    stream->print(brightness);

    stream->print(ESPHOME_F("\n"));

  }

  if (obj->get_traits().supports_color_capability(light::ColorCapability::RGB)) {

    print_metric_labels_(stream, ESPHOME_F("esphome_light_color"), obj, area, node, friendly_name);

    stream->print(ESPHOME_F("\",channel=\"r\"} "));

    stream->print(r);

    stream->print(ESPHOME_F("\n"));

    print_metric_labels_(stream, ESPHOME_F("esphome_light_color"), obj, area, node, friendly_name);

    stream->print(ESPHOME_F("\",channel=\"g\"} "));

    stream->print(g);

    stream->print(ESPHOME_F("\n"));

    print_metric_labels_(stream, ESPHOME_F("esphome_light_color"), obj, area, node, friendly_name);

    stream->print(ESPHOME_F("\",channel=\"b\"} "));

    stream->print(b);

    stream->print(ESPHOME_F("\n"));

  }

  if (obj->get_traits().supports_color_capability(light::ColorCapability::WHITE)) {

    print_metric_labels_(stream, ESPHOME_F("esphome_light_color"), obj, area, node, friendly_name);

    stream->print(ESPHOME_F("\",channel=\"w\"} "));

    stream->print(w);

    stream->print(ESPHOME_F("\n"));

  }

  // Skip effect metrics if light has no effects

  if (!obj->get_effects().empty()) {

    // Effect

    StringRef effect = obj->get_effect_name();

    print_metric_labels_(stream, ESPHOME_F("esphome_light_effect_active"), obj, area, node, friendly_name);

    stream->print(ESPHOME_F("\",effect=\""));

    // Only vary based on effect

    if (effect == "None") {

      stream->print(ESPHOME_F("None\"} 0\n"));

    } else {

      // c_str() is safe as effect names are null-terminated strings from codegen

      stream->print(effect.c_str());

      stream->print(ESPHOME_F("\"} 1\n"));

    }

  }

}


#endif


#ifdef USE_COVER


void PrometheusHandler::cover_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_cover_value gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_cover_failed gauge\n"));

}


void PrometheusHandler::cover_row_(AsyncResponseStream *stream, cover::Cover *obj, std::string &area, std::string &node,

                                   std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  if (!std::isnan(obj->position)) {

    // We have a valid value, output this value

    stream->print(ESPHOME_F("esphome_cover_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 0\n"));

    // Data itself

    stream->print(ESPHOME_F("esphome_cover_value{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} "));

    stream->print(obj->position);

    stream->print(ESPHOME_F("\n"));

    if (obj->get_traits().get_supports_tilt()) {

      stream->print(ESPHOME_F("esphome_cover_tilt{id=\""));

      this->print_relabel_id_(stream, obj);

      add_area_label_(stream, area);

      add_node_label_(stream, node);

      add_friendly_name_label_(stream, friendly_name);

      stream->print(ESPHOME_F("\",name=\""));

      this->print_relabel_name_(stream, obj);

      stream->print(ESPHOME_F("\"} "));

      stream->print(obj->tilt);

      stream->print(ESPHOME_F("\n"));

    }

  } else {

    // Invalid state

    stream->print(ESPHOME_F("esphome_cover_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 1\n"));

  }

}


#endif


#ifdef USE_SWITCH


void PrometheusHandler::switch_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_switch_value gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_switch_failed gauge\n"));

}


void PrometheusHandler::switch_row_(AsyncResponseStream *stream, switch_::Switch *obj, std::string &area,

                                    std::string &node, std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  stream->print(ESPHOME_F("esphome_switch_failed{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

  stream->print(ESPHOME_F("\"} 0\n"));

  // Data itself

  stream->print(ESPHOME_F("esphome_switch_value{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

  stream->print(ESPHOME_F("\"} "));

  stream->print(obj->state);

  stream->print(ESPHOME_F("\n"));

}


#endif


#ifdef USE_LOCK


void PrometheusHandler::lock_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_lock_value gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_lock_failed gauge\n"));

}


void PrometheusHandler::lock_row_(AsyncResponseStream *stream, lock::Lock *obj, std::string &area, std::string &node,

                                  std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  stream->print(ESPHOME_F("esphome_lock_failed{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

  stream->print(ESPHOME_F("\"} 0\n"));

  // Data itself

  stream->print(ESPHOME_F("esphome_lock_value{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

  stream->print(ESPHOME_F("\"} "));

  stream->print(obj->state);

  stream->print(ESPHOME_F("\n"));

}


#endif


// Type-specific implementation

#ifdef USE_TEXT_SENSOR


void PrometheusHandler::text_sensor_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_text_sensor_value gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_text_sensor_failed gauge\n"));

}


void PrometheusHandler::text_sensor_row_(AsyncResponseStream *stream, text_sensor::TextSensor *obj, std::string &area,

                                         std::string &node, std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  if (obj->has_state()) {

    // We have a valid value, output this value

    stream->print(ESPHOME_F("esphome_text_sensor_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 0\n"));

    // Data itself

    stream->print(ESPHOME_F("esphome_text_sensor_value{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\",value=\""));

    stream->print(obj->state.c_str());

    stream->print(ESPHOME_F("\"} "));

    stream->print(ESPHOME_F("1.0"));

    stream->print(ESPHOME_F("\n"));

  } else {

    // Invalid state

    stream->print(ESPHOME_F("esphome_text_sensor_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 1\n"));

  }

}


#endif


// Type-specific implementation

#ifdef USE_TEXT


void PrometheusHandler::text_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_text_value gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_text_failed gauge\n"));

}


void PrometheusHandler::text_row_(AsyncResponseStream *stream, text::Text *obj, std::string &area, std::string &node,

                                  std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  if (obj->has_state()) {

    // We have a valid value, output this value

    stream->print(ESPHOME_F("esphome_text_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 0\n"));

    // Data itself

    stream->print(ESPHOME_F("esphome_text_value{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\",value=\""));

    stream->print(obj->state.c_str());

    stream->print(ESPHOME_F("\"} "));

    stream->print(ESPHOME_F("1.0"));

    stream->print(ESPHOME_F("\n"));

  } else {

    // Invalid state

    stream->print(ESPHOME_F("esphome_text_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 1\n"));

  }

}


#endif


// Type-specific implementation

#ifdef USE_EVENT


void PrometheusHandler::event_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_event_value gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_event_failed gauge\n"));

}


void PrometheusHandler::event_row_(AsyncResponseStream *stream, event::Event *obj, std::string &area, std::string &node,

                                   std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  if (obj->has_event()) {

    // We have a valid event type, output this value

    stream->print(ESPHOME_F("esphome_event_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 0\n"));

    // Data itself

    stream->print(ESPHOME_F("esphome_event_value{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\",last_event_type=\""));

    // get_last_event_type() returns StringRef (null-terminated)

    stream->print(obj->get_last_event_type().c_str());

    stream->print(ESPHOME_F("\"} "));

    stream->print(ESPHOME_F("1.0"));

    stream->print(ESPHOME_F("\n"));

  } else {

    // No event triggered yet

    stream->print(ESPHOME_F("esphome_event_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 1\n"));

  }

}


#endif


// Type-specific implementation

#ifdef USE_NUMBER


void PrometheusHandler::number_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_number_value gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_number_failed gauge\n"));

}


void PrometheusHandler::number_row_(AsyncResponseStream *stream, number::Number *obj, std::string &area,

                                    std::string &node, std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  if (!std::isnan(obj->state)) {

    // We have a valid value, output this value

    stream->print(ESPHOME_F("esphome_number_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 0\n"));

    // Data itself

    stream->print(ESPHOME_F("esphome_number_value{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} "));

    stream->print(obj->state);

    stream->print(ESPHOME_F("\n"));

  } else {

    // Invalid state

    stream->print(ESPHOME_F("esphome_number_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 1\n"));

  }

}


#endif


#ifdef USE_SELECT


void PrometheusHandler::select_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_select_value gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_select_failed gauge\n"));

}


void PrometheusHandler::select_row_(AsyncResponseStream *stream, select::Select *obj, std::string &area,

                                    std::string &node, std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  if (obj->has_state()) {

    // We have a valid value, output this value

    stream->print(ESPHOME_F("esphome_select_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 0\n"));

    // Data itself

    stream->print(ESPHOME_F("esphome_select_value{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\",value=\""));

    // c_str() is safe as option values are null-terminated strings from codegen

    stream->print(obj->current_option().c_str());

    stream->print(ESPHOME_F("\"} "));

    stream->print(ESPHOME_F("1.0"));

    stream->print(ESPHOME_F("\n"));

  } else {

    // Invalid state

    stream->print(ESPHOME_F("esphome_select_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 1\n"));

  }

}


#endif


#ifdef USE_MEDIA_PLAYER


void PrometheusHandler::media_player_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_media_player_state_value gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_media_player_volume gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_media_player_is_muted gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_media_player_failed gauge\n"));

}


void PrometheusHandler::media_player_row_(AsyncResponseStream *stream, media_player::MediaPlayer *obj,

                                          std::string &area, std::string &node, std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  stream->print(ESPHOME_F("esphome_media_player_failed{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

  stream->print(ESPHOME_F("\"} 0\n"));

  // Data itself

  stream->print(ESPHOME_F("esphome_media_player_state_value{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

  stream->print(ESPHOME_F("\",value=\""));

  stream->print(media_player::media_player_state_to_string(obj->state));

  stream->print(ESPHOME_F("\"} "));

  stream->print(ESPHOME_F("1.0"));

  stream->print(ESPHOME_F("\n"));

  stream->print(ESPHOME_F("esphome_media_player_volume{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

  stream->print(ESPHOME_F("\"} "));

  stream->print(obj->volume);

  stream->print(ESPHOME_F("\n"));

  stream->print(ESPHOME_F("esphome_media_player_is_muted{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

  stream->print(ESPHOME_F("\"} "));

  if (obj->is_muted()) {

    stream->print(ESPHOME_F("1.0"));

  } else {

    stream->print(ESPHOME_F("0.0"));

  }

  stream->print(ESPHOME_F("\n"));

}


#endif


#ifdef USE_UPDATE


void PrometheusHandler::update_entity_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_update_entity_state gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_update_entity_info gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_update_entity_failed gauge\n"));

}


void PrometheusHandler::handle_update_state_(AsyncResponseStream *stream, update::UpdateState state) {

  switch (state) {

    case update::UpdateState::UPDATE_STATE_UNKNOWN:

      stream->print("unknown");

      break;

    case update::UpdateState::UPDATE_STATE_NO_UPDATE:

      stream->print("none");

      break;

    case update::UpdateState::UPDATE_STATE_AVAILABLE:

      stream->print("available");

      break;

    case update::UpdateState::UPDATE_STATE_INSTALLING:

      stream->print("installing");

      break;

    default:

      stream->print("invalid");

      break;

  }

}


void PrometheusHandler::update_entity_row_(AsyncResponseStream *stream, update::UpdateEntity *obj, std::string &area,

                                           std::string &node, std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  if (obj->has_state()) {

    // We have a valid value, output this value

    stream->print(ESPHOME_F("esphome_update_entity_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 0\n"));

    // First update state

    stream->print(ESPHOME_F("esphome_update_entity_state{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\",value=\""));

    handle_update_state_(stream, obj->state);

    stream->print(ESPHOME_F("\"} "));

    stream->print(ESPHOME_F("1.0"));

    stream->print(ESPHOME_F("\n"));

    // Next update info

    stream->print(ESPHOME_F("esphome_update_entity_info{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\",current_version=\""));

    stream->print(obj->update_info.current_version.c_str());

    stream->print(ESPHOME_F("\",latest_version=\""));

    stream->print(obj->update_info.latest_version.c_str());

    stream->print(ESPHOME_F("\",title=\""));

    stream->print(obj->update_info.title.c_str());

    stream->print(ESPHOME_F("\"} "));

    stream->print(ESPHOME_F("1.0"));

    stream->print(ESPHOME_F("\n"));

  } else {

    // Invalid state

    stream->print(ESPHOME_F("esphome_update_entity_failed{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} 1\n"));

  }

}


#endif


#ifdef USE_VALVE


void PrometheusHandler::valve_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_valve_operation gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_valve_failed gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_valve_position gauge\n"));

}


void PrometheusHandler::valve_row_(AsyncResponseStream *stream, valve::Valve *obj, std::string &area, std::string &node,

                                   std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  stream->print(ESPHOME_F("esphome_valve_failed{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

  stream->print(ESPHOME_F("\"} 0\n"));

  // Data itself

  stream->print(ESPHOME_F("esphome_valve_operation{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

  stream->print(ESPHOME_F("\",operation=\""));

  stream->print(reinterpret_cast<ProgmemStr>(valve::valve_operation_to_str(obj->current_operation)));

  stream->print(ESPHOME_F("\"} "));

  stream->print(ESPHOME_F("1.0"));

  stream->print(ESPHOME_F("\n"));

  // Now see if position is supported

  if (obj->get_traits().get_supports_position()) {

    stream->print(ESPHOME_F("esphome_valve_position{id=\""));

    this->print_relabel_id_(stream, obj);

    add_area_label_(stream, area);

    add_node_label_(stream, node);

    add_friendly_name_label_(stream, friendly_name);

    stream->print(ESPHOME_F("\",name=\""));

    this->print_relabel_name_(stream, obj);

    stream->print(ESPHOME_F("\"} "));

    stream->print(obj->position);

    stream->print(ESPHOME_F("\n"));

  }

}


#endif


#ifdef USE_CLIMATE


void PrometheusHandler::climate_type_(AsyncResponseStream *stream) {

  stream->print(ESPHOME_F("#TYPE esphome_climate_setting gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_climate_value gauge\n"));

  stream->print(ESPHOME_F("#TYPE esphome_climate_failed gauge\n"));

}


void PrometheusHandler::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) {

  stream->print(ESPHOME_F("esphome_climate_setting{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

  stream->print(ESPHOME_F("\",category=\""));

  stream->print(setting.c_str());

  stream->print(ESPHOME_F("\",setting_value=\""));

#ifdef USE_ESP8266

  stream->print((const __FlashStringHelper *) setting_value);

#else

  stream->print(LOG_STR_ARG(setting_value));

#endif

  stream->print(ESPHOME_F("\"} "));

  stream->print(ESPHOME_F("1.0"));

  stream->print(ESPHOME_F("\n"));

}


void PrometheusHandler::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) {

  stream->print(ESPHOME_F("esphome_climate_value{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

  stream->print(ESPHOME_F("\",category=\""));

  stream->print(category.c_str());

  stream->print(ESPHOME_F("\"} "));

  stream->print(climate_value);

  stream->print(ESPHOME_F("\n"));

}


void PrometheusHandler::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) {

  stream->print(ESPHOME_F("esphome_climate_failed{id=\""));

  this->print_relabel_id_(stream, obj);

  add_area_label_(stream, area);

  add_node_label_(stream, node);

  add_friendly_name_label_(stream, friendly_name);

  stream->print(ESPHOME_F("\",name=\""));

  this->print_relabel_name_(stream, obj);

  stream->print(ESPHOME_F("\",category=\""));

  stream->print(category.c_str());

  stream->print(ESPHOME_F("\"} "));

  if (is_failed_value) {

    stream->print(ESPHOME_F("1.0"));

  } else {

    stream->print(ESPHOME_F("0.0"));

  }

  stream->print(ESPHOME_F("\n"));

}


void PrometheusHandler::climate_row_(AsyncResponseStream *stream, climate::Climate *obj, std::string &area,

                                     std::string &node, std::string &friendly_name) {

  if (obj->is_internal() && !this->include_internal_)

    return;

  // Data itself

  bool any_failures = false;

  std::string climate_mode_category = "mode";

  const auto *climate_mode_value = climate::climate_mode_to_string(obj->mode);

  climate_setting_row_(stream, obj, area, node, friendly_name, climate_mode_category, climate_mode_value);

  const auto traits = obj->get_traits();

  // Now see if traits is supported

  int8_t target_accuracy = traits.get_target_temperature_accuracy_decimals();

  int8_t current_accuracy = traits.get_current_temperature_accuracy_decimals();

  char value_buf[VALUE_ACCURACY_MAX_LEN];

  // max temp

  std::string max_temp = "maximum_temperature";

  value_accuracy_to_buf(value_buf, traits.get_visual_max_temperature(), target_accuracy);

  climate_value_row_(stream, obj, area, node, friendly_name, max_temp, value_buf);

  // min temp

  std::string min_temp = "minimum_temperature";

  value_accuracy_to_buf(value_buf, traits.get_visual_min_temperature(), target_accuracy);

  climate_value_row_(stream, obj, area, node, friendly_name, min_temp, value_buf);

  // now check optional traits

  if (traits.has_feature_flags(climate::CLIMATE_SUPPORTS_CURRENT_TEMPERATURE)) {

    std::string current_temp = "current_temperature";

    if (std::isnan(obj->current_temperature)) {

      climate_failed_row_(stream, obj, area, node, friendly_name, current_temp, true);

      any_failures = true;

    } else {

      value_accuracy_to_buf(value_buf, obj->current_temperature, current_accuracy);

      climate_value_row_(stream, obj, area, node, friendly_name, current_temp, value_buf);

      climate_failed_row_(stream, obj, area, node, friendly_name, current_temp, false);

    }

  }

  if (traits.has_feature_flags(climate::CLIMATE_SUPPORTS_CURRENT_HUMIDITY)) {

    std::string current_humidity = "current_humidity";

    if (std::isnan(obj->current_humidity)) {

      climate_failed_row_(stream, obj, area, node, friendly_name, current_humidity, true);

      any_failures = true;

    } else {

      value_accuracy_to_buf(value_buf, obj->current_humidity, 0);

      climate_value_row_(stream, obj, area, node, friendly_name, current_humidity, value_buf);

      climate_failed_row_(stream, obj, area, node, friendly_name, current_humidity, false);

    }

  }

  if (traits.has_feature_flags(climate::CLIMATE_SUPPORTS_TARGET_HUMIDITY)) {

    std::string target_humidity = "target_humidity";

    if (std::isnan(obj->target_humidity)) {

      climate_failed_row_(stream, obj, area, node, friendly_name, target_humidity, true);

      any_failures = true;

    } else {

      value_accuracy_to_buf(value_buf, obj->target_humidity, 0);

      climate_value_row_(stream, obj, area, node, friendly_name, target_humidity, value_buf);

      climate_failed_row_(stream, obj, area, node, friendly_name, target_humidity, false);

    }

  }

  if (traits.has_feature_flags(climate::CLIMATE_SUPPORTS_TWO_POINT_TARGET_TEMPERATURE |

                               climate::CLIMATE_REQUIRES_TWO_POINT_TARGET_TEMPERATURE)) {

    std::string target_temp_low = "target_temperature_low";

    value_accuracy_to_buf(value_buf, obj->target_temperature_low, target_accuracy);

    climate_value_row_(stream, obj, area, node, friendly_name, target_temp_low, value_buf);

    std::string target_temp_high = "target_temperature_high";

    value_accuracy_to_buf(value_buf, obj->target_temperature_high, target_accuracy);

    climate_value_row_(stream, obj, area, node, friendly_name, target_temp_high, value_buf);

  } else {

    std::string target_temp = "target_temperature";

    value_accuracy_to_buf(value_buf, obj->target_temperature, target_accuracy);

    climate_value_row_(stream, obj, area, node, friendly_name, target_temp, value_buf);

  }

  if (traits.has_feature_flags(climate::CLIMATE_SUPPORTS_ACTION)) {

    std::string climate_trait_category = "action";

    const auto *climate_trait_value = climate::climate_action_to_string(obj->action);

    climate_setting_row_(stream, obj, area, node, friendly_name, climate_trait_category, climate_trait_value);

  }

  if (traits.get_supports_fan_modes()) {

    std::string climate_trait_category = "fan_mode";

    if (obj->fan_mode.has_value()) {

      const auto *climate_trait_value = climate::climate_fan_mode_to_string(obj->fan_mode.value());

      climate_setting_row_(stream, obj, area, node, friendly_name, climate_trait_category, climate_trait_value);

      climate_failed_row_(stream, obj, area, node, friendly_name, climate_trait_category, false);

    } else {

      climate_failed_row_(stream, obj, area, node, friendly_name, climate_trait_category, true);

      any_failures = true;

    }

  }

  if (traits.get_supports_presets()) {

    std::string climate_trait_category = "preset";

    if (obj->preset.has_value()) {

      const auto *climate_trait_value = climate::climate_preset_to_string(obj->preset.value());

      climate_setting_row_(stream, obj, area, node, friendly_name, climate_trait_category, climate_trait_value);

      climate_failed_row_(stream, obj, area, node, friendly_name, climate_trait_category, false);

    } else {

      climate_failed_row_(stream, obj, area, node, friendly_name, climate_trait_category, true);

      any_failures = true;

    }

  }

  if (traits.get_supports_swing_modes()) {

    std::string climate_trait_category = "swing_mode";

    const auto *climate_trait_value = climate::climate_swing_mode_to_string(obj->swing_mode);

    climate_setting_row_(stream, obj, area, node, friendly_name, climate_trait_category, climate_trait_value);

  }

  std::string all_climate_category = "all";

  climate_failed_row_(stream, obj, area, node, friendly_name, all_climate_category, any_failures);

}


#endif


}  // namespace esphome::prometheus


#endif

application.h

esphome::Application::get_name
const StringRef & get_name() const
Get the name of this Application set by pre_setup().
Definition application.h:150

esphome::Application::get_friendly_name
const StringRef & get_friendly_name() const
Get the friendly name of this Application set by pre_setup().
Definition application.h:153

esphome::Application::get_area
const char * get_area() const
Get the area of this Application set by pre_setup().
Definition application.h:156

esphome::EntityBase
Definition entity_base.h:73

esphome::EntityBase::get_name_progmem
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

esphome::EntityBase::is_internal
bool is_internal() const
Definition entity_base.h:118

esphome::EntityBase::get_unit_of_measurement_ref
StringRef get_unit_of_measurement_ref() const
Definition entity_base.cpp:131

esphome::EntityBase::has_state
bool has_state() const
Definition entity_base.h:179

esphome::EntityBase::get_object_id_to
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...
Definition entity_base.cpp:163

esphome::ProgmemStringRef::progmem_ptr
constexpr const char * progmem_ptr() const
Definition string_ref.h:238

esphome::StringRef
StringRef is a reference to a string owned by something else.
Definition string_ref.h:31

esphome::StringRef::c_str
constexpr const char * c_str() const
Definition string_ref.h:78

esphome::binary_sensor::BinarySensor
Base class for all binary_sensor-type classes.
Definition binary_sensor.h:33

esphome::binary_sensor::BinarySensor::state
bool state
The current state of this binary sensor. Also used as the backing storage for StatefulEntityBase.
Definition binary_sensor.h:72

esphome::climate::Climate
ClimateDevice - This is the base class for all climate integrations.
Definition climate.h:192

esphome::climate::Climate::mode
ClimateMode mode
The active mode of the climate device.
Definition climate.h:317

esphome::climate::Climate::fan_mode
optional< ClimateFanMode > fan_mode
The active fan mode of the climate device.
Definition climate.h:311

esphome::climate::Climate::get_traits
ClimateTraits get_traits()
Get the traits of this climate device with all overrides applied.
Definition climate.cpp:482

esphome::climate::Climate::target_temperature
float target_temperature
The target temperature of the climate device.
Definition climate.h:298

esphome::climate::Climate::current_humidity
float current_humidity
The current humidity of the climate device, as reported from the integration.
Definition climate.h:294

esphome::climate::Climate::swing_mode
ClimateSwingMode swing_mode
The active swing mode of the climate device.
Definition climate.h:323

esphome::climate::Climate::target_temperature_low
float target_temperature_low
The minimum target temperature of the climate device, for climate devices with split target temperatu...
Definition climate.h:301

esphome::climate::Climate::current_temperature
float current_temperature
The current temperature of the climate device, as reported from the integration.
Definition climate.h:291

esphome::climate::Climate::action
ClimateAction action
The active state of the climate device.
Definition climate.h:320

esphome::climate::Climate::preset
optional< ClimatePreset > preset
The active preset of the climate device.
Definition climate.h:314

esphome::climate::Climate::target_humidity
float target_humidity
The target humidity of the climate device.
Definition climate.h:308

esphome::climate::Climate::target_temperature_high
float target_temperature_high
The maximum target temperature of the climate device, for climate devices with split target temperatu...
Definition climate.h:303

esphome::climate::ClimateTraits::get_target_temperature_accuracy_decimals
int8_t get_target_temperature_accuracy_decimals() const
Definition climate_traits.cpp:17

esphome::cover::Cover
Base class for all cover devices.
Definition cover.h:115

esphome::cover::Cover::tilt
float tilt
The current tilt value of the cover from 0.0 to 1.0.
Definition cover.h:128

esphome::cover::Cover::position
float position
The position of the cover from 0.0 (fully closed) to 1.0 (fully open).
Definition cover.h:126

esphome::cover::Cover::get_traits
virtual CoverTraits get_traits()=0

esphome::cover::CoverTraits::get_supports_tilt
bool get_supports_tilt() const
Definition cover_traits.h:15

esphome::event::Event
Definition event.h:23

esphome::event::Event::has_event
bool has_event() const
Check if an event has been triggered.
Definition event.h:75

esphome::event::Event::get_last_event_type
StringRef get_last_event_type() const
Return the last triggered event type, or empty StringRef if no event triggered yet.
Definition event.h:54

esphome::fan::Fan
Definition fan.h:108

esphome::fan::Fan::get_traits
virtual FanTraits get_traits()=0

esphome::fan::Fan::oscillating
bool oscillating
The current oscillation state of the fan.
Definition fan.h:113

esphome::fan::Fan::state
bool state
The current on/off state of the fan.
Definition fan.h:111

esphome::fan::Fan::speed
int speed
The current fan speed level.
Definition fan.h:115

esphome::fan::FanTraits::supports_speed
bool supports_speed() const
Return if this fan supports speed modes.
Definition fan_traits.h:27

esphome::fan::FanTraits::supports_oscillation
bool supports_oscillation() const
Return if this fan supports oscillation.
Definition fan_traits.h:23

esphome::light::LightColorValues
This class represents the color state for a light object.
Definition light_color_values.h:95

esphome::light::LightColorValues::as_rgbw
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,...
Definition light_color_values.h:185

esphome::light::LightColorValues::is_on
bool is_on() const
Get the binary true/false state of these light color values.
Definition light_color_values.h:272

esphome::light::LightColorValues::as_brightness
void as_brightness(float *brightness) const
Convert these light color values to a brightness-only representation and write them to brightness.
Definition light_color_values.h:170

esphome::light::LightState
This class represents the communication layer between the front-end MQTT layer and the hardware outpu...
Definition light_state.h:68

esphome::light::LightState::get_effect_name
StringRef get_effect_name()
Return the name of the current effect, or if no effect is active "None".
Definition light_state.cpp:230

esphome::light::LightState::get_reported_values
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

esphome::light::LightState::get_traits
LightTraits get_traits()
Definition light_state.cpp:32

esphome::light::LightState::get_effects
const ConstVector< LightEffect * > & get_effects() const
Get all effects for this light state.
Definition light_state.h:230

esphome::light::LightState::current_values
LightColorValues current_values
The current values of the light as outputted to the light.
Definition light_state.h:124

esphome::light::LightTraits::supports_color_capability
bool supports_color_capability(ColorCapability color_capability) const
Definition light_traits.h:23

esphome::lock::Lock
Base class for all locks.
Definition lock.h:112

esphome::lock::Lock::state
LockState state
The current reported state of the lock.
Definition lock.h:131

esphome::media_player::MediaPlayer
Definition media_player.h:149

esphome::media_player::MediaPlayer::state
MediaPlayerState state
Definition media_player.h:151

esphome::media_player::MediaPlayer::volume
float volume
Definition media_player.h:152

esphome::media_player::MediaPlayer::is_muted
virtual bool is_muted() const
Definition media_player.h:162

esphome::number::Number
Base-class for all numbers.
Definition number.h:29

esphome::number::Number::state
float state
Definition number.h:31

esphome::prometheus::PrometheusHandler::number_type_
void number_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:643

esphome::prometheus::PrometheusHandler::add_friendly_name_label_
void add_friendly_name_label_(AsyncResponseStream *stream, std::string &friendly_name)
Definition prometheus_handler.cpp:145

esphome::prometheus::PrometheusHandler::handle_update_state_
void handle_update_state_(AsyncResponseStream *stream, update::UpdateState state)
Definition prometheus_handler.cpp:799

esphome::prometheus::PrometheusHandler::climate_setting_row_
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)
Definition prometheus_handler.cpp:932

esphome::prometheus::PrometheusHandler::event_type_
void event_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:595

esphome::prometheus::PrometheusHandler::media_player_row_
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.
Definition prometheus_handler.cpp:740

esphome::prometheus::PrometheusHandler::light_type_
void light_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:318

esphome::prometheus::PrometheusHandler::print_relabel_name_
void print_relabel_name_(AsyncResponseStream *stream, EntityBase *obj)
Definition prometheus_handler.cpp:122

esphome::prometheus::PrometheusHandler::text_type_
void text_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:548

esphome::prometheus::PrometheusHandler::update_entity_row_
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.
Definition prometheus_handler.cpp:819

esphome::prometheus::PrometheusHandler::relabel_map_id_
std::map< EntityBase *, std::string > relabel_map_id_
Definition prometheus_handler.h:212

esphome::prometheus::PrometheusHandler::fan_row_
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.
Definition prometheus_handler.cpp:265

esphome::prometheus::PrometheusHandler::climate_type_
void climate_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:926

esphome::prometheus::PrometheusHandler::binary_sensor_type_
void binary_sensor_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:215

esphome::prometheus::PrometheusHandler::switch_row_
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.
Definition prometheus_handler.cpp:442

esphome::prometheus::PrometheusHandler::relabel_map_name_
std::map< EntityBase *, std::string > relabel_map_name_
Definition prometheus_handler.h:213

esphome::prometheus::PrometheusHandler::sensor_row_
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.
Definition prometheus_handler.cpp:170

esphome::prometheus::PrometheusHandler::light_row_
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.
Definition prometheus_handler.cpp:323

esphome::prometheus::PrometheusHandler::climate_row_
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.
Definition prometheus_handler.cpp:993

esphome::prometheus::PrometheusHandler::update_entity_type_
void update_entity_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:793

esphome::prometheus::PrometheusHandler::climate_failed_row_
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)
Definition prometheus_handler.cpp:972

esphome::prometheus::PrometheusHandler::print_relabel_id_
void print_relabel_id_(AsyncResponseStream *stream, EntityBase *obj)
Definition prometheus_handler.cpp:112

esphome::prometheus::PrometheusHandler::binary_sensor_row_
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.
Definition prometheus_handler.cpp:219

esphome::prometheus::PrometheusHandler::number_row_
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.
Definition prometheus_handler.cpp:647

esphome::prometheus::PrometheusHandler::valve_type_
void valve_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:878

esphome::prometheus::PrometheusHandler::switch_type_
void switch_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:438

esphome::prometheus::PrometheusHandler::media_player_type_
void media_player_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:734

esphome::prometheus::PrometheusHandler::event_row_
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.
Definition prometheus_handler.cpp:599

esphome::prometheus::PrometheusHandler::text_sensor_type_
void text_sensor_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:501

esphome::prometheus::PrometheusHandler::text_sensor_row_
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.
Definition prometheus_handler.cpp:505

esphome::prometheus::PrometheusHandler::add_area_label_
void add_area_label_(AsyncResponseStream *stream, std::string &area)
Definition prometheus_handler.cpp:131

esphome::prometheus::PrometheusHandler::print_metric_labels_
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)
Definition prometheus_handler.cpp:152

esphome::prometheus::PrometheusHandler::select_row_
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.
Definition prometheus_handler.cpp:691

esphome::prometheus::PrometheusHandler::cover_type_
void cover_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:382

esphome::prometheus::PrometheusHandler::select_type_
void select_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:687

esphome::prometheus::PrometheusHandler::add_node_label_
void add_node_label_(AsyncResponseStream *stream, std::string &node)
Definition prometheus_handler.cpp:138

esphome::prometheus::PrometheusHandler::handleRequest
void handleRequest(AsyncWebServerRequest *req) override
Definition prometheus_handler.cpp:7

esphome::prometheus::PrometheusHandler::text_row_
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.
Definition prometheus_handler.cpp:552

esphome::prometheus::PrometheusHandler::cover_row_
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.
Definition prometheus_handler.cpp:386

esphome::prometheus::PrometheusHandler::lock_type_
void lock_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:469

esphome::prometheus::PrometheusHandler::valve_row_
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.
Definition prometheus_handler.cpp:884

esphome::prometheus::PrometheusHandler::climate_value_row_
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)
Definition prometheus_handler.cpp:955

esphome::prometheus::PrometheusHandler::fan_type_
void fan_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:259

esphome::prometheus::PrometheusHandler::sensor_type_
void sensor_type_(AsyncResponseStream *stream)
Return the type for prometheus.
Definition prometheus_handler.cpp:166

esphome::prometheus::PrometheusHandler::lock_row_
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.
Definition prometheus_handler.cpp:473

esphome::select::Select
Base-class for all selects.
Definition select.h:28

esphome::select::Select::current_option
StringRef current_option() const
Return the currently selected option, or empty StringRef if no state.
Definition select.h:42

esphome::sensor::Sensor
Base-class for all sensors.
Definition sensor.h:47

esphome::sensor::Sensor::state
float state
This member variable stores the last state that has passed through all filters.
Definition sensor.h:140

esphome::sensor::Sensor::get_accuracy_decimals
int8_t get_accuracy_decimals()
Get the accuracy in decimals, using the manual override if set.
Definition sensor.cpp:45

esphome::switch_::Switch
Base class for all switches.
Definition switch.h:43

esphome::switch_::Switch::state
bool state
The current reported state of the binary sensor.
Definition switch.h:60

esphome::text::Text
Base-class for all text inputs.
Definition text.h:20

esphome::text::Text::state
std::string state
Definition text.h:22

esphome::text_sensor::TextSensor
Definition text_sensor.h:29

esphome::text_sensor::TextSensor::state
std::string state
Definition text_sensor.h:31

esphome::update::UpdateEntity
Definition update_entity.h:31

esphome::update::UpdateEntity::state
const UpdateState & state
Definition update_entity.h:40

esphome::update::UpdateEntity::update_info
const UpdateInfo & update_info
Definition update_entity.h:39

esphome::valve::Valve
Base class for all valve devices.
Definition valve.h:102

esphome::valve::Valve::position
float position
The position of the valve from 0.0 (fully closed) to 1.0 (fully open).
Definition valve.h:113

esphome::valve::Valve::current_operation
ValveOperation current_operation
The current operation of the valve (idle, opening, closing).
Definition valve.h:107

esphome::valve::Valve::get_traits
virtual ValveTraits get_traits()=0

esphome::valve::ValveTraits::get_supports_position
bool get_supports_position() const
Definition valve_traits.h:13

target_humidity
float target_humidity
Definition climate.h:19

state
bool state
Definition fan.h:2

esphome::climate::climate_action_to_string
const LogString * climate_action_to_string(ClimateAction action)
Convert the given ClimateAction to a human-readable string.
Definition climate_mode.cpp:18

esphome::climate::CLIMATE_SUPPORTS_CURRENT_HUMIDITY
@ CLIMATE_SUPPORTS_CURRENT_HUMIDITY
Definition climate_mode.h:114

esphome::climate::CLIMATE_SUPPORTS_TARGET_HUMIDITY
@ CLIMATE_SUPPORTS_TARGET_HUMIDITY
Definition climate_mode.h:116

esphome::climate::CLIMATE_SUPPORTS_TWO_POINT_TARGET_TEMPERATURE
@ CLIMATE_SUPPORTS_TWO_POINT_TARGET_TEMPERATURE
Definition climate_mode.h:110

esphome::climate::CLIMATE_SUPPORTS_CURRENT_TEMPERATURE
@ CLIMATE_SUPPORTS_CURRENT_TEMPERATURE
Definition climate_mode.h:108

esphome::climate::CLIMATE_SUPPORTS_ACTION
@ CLIMATE_SUPPORTS_ACTION
Definition climate_mode.h:118

esphome::climate::CLIMATE_REQUIRES_TWO_POINT_TARGET_TEMPERATURE
@ CLIMATE_REQUIRES_TWO_POINT_TARGET_TEMPERATURE
Definition climate_mode.h:112

esphome::climate::climate_swing_mode_to_string
const LogString * climate_swing_mode_to_string(ClimateSwingMode swing_mode)
Convert the given ClimateSwingMode to a human-readable string.
Definition climate_mode.cpp:34

esphome::climate::climate_preset_to_string
const LogString * climate_preset_to_string(ClimatePreset preset)
Convert the given PresetMode to a human-readable string.
Definition climate_mode.cpp:42

esphome::climate::climate_fan_mode_to_string
const LogString * climate_fan_mode_to_string(ClimateFanMode fan_mode)
Convert the given ClimateFanMode to a human-readable string.
Definition climate_mode.cpp:27

esphome::climate::climate_mode_to_string
const LogString * climate_mode_to_string(ClimateMode mode)
Convert the given ClimateMode to a human-readable string.
Definition climate_mode.cpp:9

esphome::light::ColorCapability::BRIGHTNESS
@ BRIGHTNESS
Master brightness of the light can be controlled.

esphome::light::ColorCapability::RGB
@ RGB
Color can be controlled using RGB format (includes a brightness control for the color).

esphome::light::ColorCapability::WHITE
@ WHITE
Brightness of white channel can be controlled separately from other channels.

esphome::media_player::media_player_state_to_string
const char * media_player_state_to_string(MediaPlayerState state)
Definition media_player.cpp:11

esphome::prometheus
Definition prometheus_handler.cpp:5

esphome::update::UpdateState
UpdateState
Definition update_entity.h:22

esphome::update::UPDATE_STATE_UNKNOWN
@ UPDATE_STATE_UNKNOWN
Definition update_entity.h:23

esphome::update::UPDATE_STATE_INSTALLING
@ UPDATE_STATE_INSTALLING
Definition update_entity.h:26

esphome::update::UPDATE_STATE_NO_UPDATE
@ UPDATE_STATE_NO_UPDATE
Definition update_entity.h:24

esphome::update::UPDATE_STATE_AVAILABLE
@ UPDATE_STATE_AVAILABLE
Definition update_entity.h:25

esphome::valve::valve_operation_to_str
const LogString * valve_operation_to_str(ValveOperation op)
Definition valve.cpp:28

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:625

esphome::App
Application App
Global storage of Application pointer - only one Application can exist.

ProgmemStr
const __FlashStringHelper * ProgmemStr
Definition progmem.h:31

prometheus_handler.h

esphome::update::UpdateInfo::title
std::string title
Definition update_entity.h:13

esphome::update::UpdateInfo::current_version
std::string current_version
Definition update_entity.h:12

esphome::update::UpdateInfo::latest_version
std::string latest_version
Definition update_entity.h:11