controller_registry.h

Go to the documentation of this file.

#pragma once
 
#include "esphome/core/defines.h"
 
#ifdef USE_CONTROLLER_REGISTRY
 
#include "esphome/core/helpers.h"
 
// Forward declarations
namespace esphome {
 
class Controller;
 
#ifdef USE_BINARY_SENSOR
namespace binary_sensor {
class BinarySensor;
}
#endif
 
#ifdef USE_FAN
namespace fan {
class Fan;
}
#endif
 
#ifdef USE_LIGHT
namespace light {
class LightState;
}
#endif
 
#ifdef USE_SENSOR
namespace sensor {
class Sensor;
}
#endif
 
#ifdef USE_SWITCH
namespace switch_ {
class Switch;
}
#endif
 
#ifdef USE_COVER
namespace cover {
class Cover;
}
#endif
 
#ifdef USE_TEXT_SENSOR
namespace text_sensor {
class TextSensor;
}
#endif
 
#ifdef USE_CLIMATE
namespace climate {
class Climate;
}
#endif
 
#ifdef USE_NUMBER
namespace number {
class Number;
}
#endif
 
#ifdef USE_DATETIME_DATE
namespace datetime {
class DateEntity;
}
#endif
 
#ifdef USE_DATETIME_TIME
namespace datetime {
class TimeEntity;
}
#endif
 
#ifdef USE_DATETIME_DATETIME
namespace datetime {
class DateTimeEntity;
}
#endif
 
#ifdef USE_TEXT
namespace text {
class Text;
}
#endif
 
#ifdef USE_SELECT
namespace select {
class Select;
}
#endif
 
#ifdef USE_LOCK
namespace lock {
class Lock;
}
#endif
 
#ifdef USE_VALVE
namespace valve {
class Valve;
}
#endif
 
#ifdef USE_MEDIA_PLAYER
namespace media_player {
class MediaPlayer;
}
#endif
 
#ifdef USE_ALARM_CONTROL_PANEL
namespace alarm_control_panel {
class AlarmControlPanel;
}
#endif
 
#ifdef USE_WATER_HEATER
namespace water_heater {
class WaterHeater;
}
#endif
 
#ifdef USE_EVENT
namespace event {
class Event;
}
#endif
 
#ifdef USE_UPDATE
namespace update {
class UpdateEntity;
}
#endif
 
class ControllerRegistry {
 public:
  static void register_controller(Controller *controller);
 
#ifdef USE_BINARY_SENSOR
  static void notify_binary_sensor_update(binary_sensor::BinarySensor *obj);
#endif
 
#ifdef USE_FAN
  static void notify_fan_update(fan::Fan *obj);
#endif
 
#ifdef USE_LIGHT
  static void notify_light_update(light::LightState *obj);
#endif
 
#ifdef USE_SENSOR
  static void notify_sensor_update(sensor::Sensor *obj);
#endif
 
#ifdef USE_SWITCH
  static void notify_switch_update(switch_::Switch *obj);
#endif
 
#ifdef USE_COVER
  static void notify_cover_update(cover::Cover *obj);
#endif
 
#ifdef USE_TEXT_SENSOR
  static void notify_text_sensor_update(text_sensor::TextSensor *obj);
#endif
 
#ifdef USE_CLIMATE
  static void notify_climate_update(climate::Climate *obj);
#endif
 
#ifdef USE_NUMBER
  static void notify_number_update(number::Number *obj);
#endif
 
#ifdef USE_DATETIME_DATE
  static void notify_date_update(datetime::DateEntity *obj);
#endif
 
#ifdef USE_DATETIME_TIME
  static void notify_time_update(datetime::TimeEntity *obj);
#endif
 
#ifdef USE_DATETIME_DATETIME
  static void notify_datetime_update(datetime::DateTimeEntity *obj);
#endif
 
#ifdef USE_TEXT
  static void notify_text_update(text::Text *obj);
#endif
 
#ifdef USE_SELECT
  static void notify_select_update(select::Select *obj);
#endif
 
#ifdef USE_LOCK
  static void notify_lock_update(lock::Lock *obj);
#endif
 
#ifdef USE_VALVE
  static void notify_valve_update(valve::Valve *obj);
#endif
 
#ifdef USE_MEDIA_PLAYER
  static void notify_media_player_update(media_player::MediaPlayer *obj);
#endif
 
#ifdef USE_ALARM_CONTROL_PANEL
  static void notify_alarm_control_panel_update(alarm_control_panel::AlarmControlPanel *obj);
#endif
 
#ifdef USE_WATER_HEATER
  static void notify_water_heater_update(water_heater::WaterHeater *obj);
#endif
 
#ifdef USE_EVENT
  static void notify_event(event::Event *obj);
#endif
 
#ifdef USE_UPDATE
  static void notify_update(update::UpdateEntity *obj);
#endif
 
 protected:
  static StaticVector<Controller *, CONTROLLER_REGISTRY_MAX> controllers;
};
 
}  // namespace esphome
 
// Include controller.h AFTER the class definition so notify methods can be
// defined inline. This is safe because controller_registry.h is only ever
// included from .cpp files, never from other headers.
#include "esphome/core/controller.h"
 
namespace esphome {
 
// Inline notify methods — each is a tiny loop over 1-2 controllers.
// Defining them here (rather than in controller_registry.cpp) allows the
// compiler to inline them into the single call site in each entity's
// notify_frontend_(), eliminating an unnecessary function-call frame.
 
// NOLINTBEGIN(bugprone-macro-parentheses)
#define CONTROLLER_REGISTRY_NOTIFY(entity_type, entity_name) \
  inline void ControllerRegistry::notify_##entity_name##_update(entity_type *obj) { \
    for (auto *controller : controllers) { \
      controller->on_##entity_name##_update(obj); \
    } \
  }
 
#define CONTROLLER_REGISTRY_NOTIFY_NO_UPDATE_SUFFIX(entity_type, entity_name) \
  inline void ControllerRegistry::notify_##entity_name(entity_type *obj) { \
    for (auto *controller : controllers) { \
      controller->on_##entity_name(obj); \
    } \
  }
// NOLINTEND(bugprone-macro-parentheses)
 
#ifdef USE_BINARY_SENSOR
CONTROLLER_REGISTRY_NOTIFY(binary_sensor::BinarySensor, binary_sensor)
#endif
 
#ifdef USE_FAN
CONTROLLER_REGISTRY_NOTIFY(fan::Fan, fan)
#endif
 
#ifdef USE_LIGHT
CONTROLLER_REGISTRY_NOTIFY(light::LightState, light)
#endif
 
#ifdef USE_SENSOR
CONTROLLER_REGISTRY_NOTIFY(sensor::Sensor, sensor)
#endif
 
#ifdef USE_SWITCH
CONTROLLER_REGISTRY_NOTIFY(switch_::Switch, switch)
#endif
 
#ifdef USE_COVER
CONTROLLER_REGISTRY_NOTIFY(cover::Cover, cover)
#endif
 
#ifdef USE_TEXT_SENSOR
CONTROLLER_REGISTRY_NOTIFY(text_sensor::TextSensor, text_sensor)
#endif
 
#ifdef USE_CLIMATE
CONTROLLER_REGISTRY_NOTIFY(climate::Climate, climate)
#endif
 
#ifdef USE_NUMBER
CONTROLLER_REGISTRY_NOTIFY(number::Number, number)
#endif
 
#ifdef USE_DATETIME_DATE
CONTROLLER_REGISTRY_NOTIFY(datetime::DateEntity, date)
#endif
 
#ifdef USE_DATETIME_TIME
CONTROLLER_REGISTRY_NOTIFY(datetime::TimeEntity, time)
#endif
 
#ifdef USE_DATETIME_DATETIME
CONTROLLER_REGISTRY_NOTIFY(datetime::DateTimeEntity, datetime)
#endif
 
#ifdef USE_TEXT
CONTROLLER_REGISTRY_NOTIFY(text::Text, text)
#endif
 
#ifdef USE_SELECT
CONTROLLER_REGISTRY_NOTIFY(select::Select, select)
#endif
 
#ifdef USE_LOCK
CONTROLLER_REGISTRY_NOTIFY(lock::Lock, lock)
#endif
 
#ifdef USE_VALVE
CONTROLLER_REGISTRY_NOTIFY(valve::Valve, valve)
#endif
 
#ifdef USE_MEDIA_PLAYER
CONTROLLER_REGISTRY_NOTIFY(media_player::MediaPlayer, media_player)
#endif
 
#ifdef USE_ALARM_CONTROL_PANEL
CONTROLLER_REGISTRY_NOTIFY(alarm_control_panel::AlarmControlPanel, alarm_control_panel)
#endif
 
#ifdef USE_WATER_HEATER
CONTROLLER_REGISTRY_NOTIFY(water_heater::WaterHeater, water_heater)
#endif
 
#ifdef USE_EVENT
CONTROLLER_REGISTRY_NOTIFY_NO_UPDATE_SUFFIX(event::Event, event)
#endif
 
#ifdef USE_UPDATE
CONTROLLER_REGISTRY_NOTIFY_NO_UPDATE_SUFFIX(update::UpdateEntity, update)
#endif
 
#undef CONTROLLER_REGISTRY_NOTIFY
#undef CONTROLLER_REGISTRY_NOTIFY_NO_UPDATE_SUFFIX
 
}  // namespace esphome
 
#endif  // USE_CONTROLLER_REGISTRY