|
ESPHome 2026.11.0b6
|
#include <bang_bang_climate.h>
Protected Member Functions | |
| void | control (const climate::ClimateCall &call) override |
| Override control to change settings of the climate device. | |
| void | change_away_ (bool away) |
| Change the away setting, will reset target temperatures to defaults. | |
| climate::ClimateTraits | traits () override |
| Return the traits of this controller. | |
| void | compute_state_ () |
| Re-compute the state of this climate controller. | |
| void | switch_to_action_ (climate::ClimateAction action) |
| Switch the climate device to the given climate mode. | |
Protected Member Functions inherited from esphome::climate::Climate | |
| bool | set_fan_mode_ (ClimateFanMode mode) |
| Set fan mode. Reset custom fan mode. Return true if fan mode has been changed. | |
| bool | set_custom_fan_mode_ (const char *mode) |
| Set custom fan mode. Reset primary fan mode. Return true if fan mode has been changed. | |
| bool | set_custom_fan_mode_ (const char *mode, size_t len) |
| bool | set_custom_fan_mode_ (StringRef mode) |
| void | clear_custom_fan_mode_ () |
| Clear custom fan mode. | |
| bool | set_preset_ (ClimatePreset preset) |
| Set preset. Reset custom preset. Return true if preset has been changed. | |
| bool | set_custom_preset_ (const char *preset) |
| Set custom preset. Reset primary preset. Return true if preset has been changed. | |
| bool | set_custom_preset_ (const char *preset, size_t len) |
| bool | set_custom_preset_ (StringRef preset) |
| void | clear_custom_preset_ () |
| Clear custom preset. | |
| const char * | find_custom_fan_mode_ (const char *custom_fan_mode) |
| Find and return the matching custom fan mode pointer from traits, or nullptr if not found. | |
| const char * | find_custom_fan_mode_ (const char *custom_fan_mode, size_t len) |
| const char * | find_custom_preset_ (const char *custom_preset) |
| Find and return the matching custom preset pointer from traits, or nullptr if not found. | |
| const char * | find_custom_preset_ (const char *custom_preset, size_t len) |
| optional< ClimateDeviceRestoreState > | restore_state_ () |
| Restore the state of the climate device, call this from your setup() method. | |
| void | save_state_ (const ClimateTraits &traits) |
| Internal method to save the state of the climate device to recover memory. | |
| void | save_state_ () |
| void | dump_traits_ (const char *tag) |
Protected Member Functions inherited from esphome::EntityBase | |
| friend | void::setup () |
| friend | void::original_setup () |
| void | configure_entity_ (const char *name, uint32_t object_id_hash, uint32_t entity_fields) |
| Combined entity setup from codegen: set name, object_id hash, entity string indices, and flags. | |
| void | set_device_ (Device *device) |
| ESPPreferenceObject | make_entity_preference_ (size_t size, uint32_t version) |
| Non-template helpers for make_entity_preference() to avoid code bloat. | |
| ESPPreferenceObject | make_entity_preference_ (size_t size, uint32_t version, bool in_flash) |
| uint32_t | entity_preference_key_ (uint32_t version) |
| Key for both helpers; preference hash migration goes here. | |
Protected Member Functions inherited from esphome::Component | |
| friend | void::setup () |
| friend | void::original_setup () |
| void | set_component_source_ (uint8_t index) |
| Set where this component was loaded from for some debug messages. | |
| virtual void | call_setup () |
| void | call_dump_config_ () |
| void | enable_loop_slow_path_ () |
| void | set_component_state_ (uint8_t state) |
| Helper to set component state (clears state bits and sets new state) | |
| bool | set_status_flag_ (uint8_t flag) |
| Helper to set a status LED flag on both this component and the app. | |
| bool | set_error_flag_ (const LogString *message) |
| Set the error flag and log it; true when it was not set before. | |
| void | set_interval (const char *name, uint32_t interval, std::function< void()> &&f) |
| Set an interval function with a const char* name. | |
| void | set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f) |
| Set an interval function with a numeric ID (zero heap allocation). | |
| void | set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f) |
| void | set_interval (uint32_t interval, std::function< void()> &&f) |
| bool | cancel_interval (const char *name) |
| Cancel an interval function. | |
| bool | cancel_interval (uint32_t id) |
| bool | cancel_interval (InternalSchedulerID id) |
| void | set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f) |
| Set a timeout function with a const char* name. | |
| void | set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f) |
| Set a timeout function with a numeric ID (zero heap allocation). | |
| void | set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f) |
| void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
| bool | cancel_timeout (const char *name) |
| Cancel a timeout function. | |
| bool | cancel_timeout (uint32_t id) |
| bool | cancel_timeout (InternalSchedulerID id) |
| void | defer (const char *name, std::function< void()> &&f) |
| Defer a callback to the next loop() call with a const char* name. | |
| void | defer (std::function< void()> &&f) |
| Defer a callback to the next loop() call. | |
| void | defer (uint32_t id, std::function< void()> &&f) |
| Defer a callback with a numeric ID (zero heap allocation) | |
| bool | cancel_defer (const char *name) |
| Cancel a defer callback using the specified name, name must not be empty. | |
| bool | cancel_defer (uint32_t id) |
| void | status_clear_warning_slow_path_ () |
| void | status_clear_error_slow_path_ () |
Protected Attributes | |
| Trigger | idle_trigger_ |
| The trigger to call when the controller should switch to idle mode. | |
| Trigger | cool_trigger_ |
| The trigger to call when the controller should switch to cooling mode. | |
| Trigger | heat_trigger_ |
| The trigger to call when the controller should switch to heating mode. | |
| Trigger * | prev_trigger_ {nullptr} |
| A reference to the trigger that was previously active. | |
| bool | supports_cool_ {false} |
| Whether the controller supports cooling/heating. | |
| bool | supports_heat_ {false} |
| bool | supports_away_ {false} |
| BangBangClimateTargetTempConfig | normal_config_ {} |
| BangBangClimateTargetTempConfig | away_config_ {} |
Protected Attributes inherited from esphome::climate::Climate | |
| friend | ClimateCall |
| LazyCallbackManager< void(Climate &)> | state_callback_ {} |
| LazyCallbackManager< void(ClimateCall &)> | control_callback_ {} |
| ESPPreferenceObject | rtc_ |
| float | visual_min_temperature_override_ {NAN} |
| float | visual_max_temperature_override_ {NAN} |
| float | visual_target_temperature_step_override_ {NAN} |
| float | visual_current_temperature_step_override_ {NAN} |
| float | visual_min_humidity_override_ {NAN} |
| float | visual_max_humidity_override_ {NAN} |
Protected Attributes inherited from esphome::EntityBase | |
| ProgmemStringRef | name_ |
| uint32_t | object_id_hash_ {} |
| Device * | device_ {} |
| struct esphome::EntityBase::EntityFlags | flags_ |
| uint8_t | device_class_idx_ {} |
| uint8_t | uom_idx_ {} |
| uint8_t | icon_idx_ {} |
Protected Attributes inherited from esphome::Component | |
| uint8_t | component_source_index_ {0} |
| Index into component source PROGMEM lookup table (0 = not set) | |
| uint8_t | warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS} |
| Warn threshold in centiseconds (max 2550ms) | |
| uint8_t | component_state_ {0x00} |
| State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion. | |
| volatile bool | pending_enable_loop_ {false} |
| ISR-safe flag for enable_loop_soon_any_context. | |
| ComponentRuntimeStats | runtime_stats_ |
Additional Inherited Members | ||
Public Member Functions inherited from esphome::climate::Climate | ||
| Climate () | ||
| template<typename F > | ||
| void | add_on_state_callback (F &&callback) | |
| Add a callback for the climate device state, each time the state of the climate device is updated (using publish_state), this callback will be called. | ||
| template<typename F > | ||
| void | add_on_control_callback (F &&callback) | |
| Add a callback for the climate device configuration; each time the configuration parameters of a climate device is updated (using perform() of a ClimateCall), this callback will be called, before any on_state callback. | ||
| ClimateCall | make_call () | |
| Make a climate device control call, this is used to control the climate device, see the ClimateCall description for more info. | ||
| void | publish_state () | |
| Publish the state of the climate device, to be called from integrations. | ||
| ClimateTraits | get_traits () | |
| Get the traits of this climate device with all overrides applied. | ||
| void | set_visual_min_temperature_override (float visual_min_temperature_override) | |
| void | set_visual_max_temperature_override (float visual_max_temperature_override) | |
| void | set_visual_temperature_step_override (float target, float current) | |
| void | set_visual_min_humidity_override (float visual_min_humidity_override) | |
| void | set_visual_max_humidity_override (float visual_max_humidity_override) | |
| void | set_supported_custom_fan_modes (std::initializer_list< const char * > modes) | |
| Set the supported custom fan modes; the list is copied (stored on Climate, referenced by ClimateTraits). | ||
| void | set_supported_custom_fan_modes (const std::vector< const char * > &modes) | |
| template<size_t N> | ||
| void | set_supported_custom_fan_modes (const char *const (&modes)[N]) | |
| void | set_supported_custom_fan_modes_static (const char *const *modes, size_t count) | |
| Points at a static table that outlives the climate (codegen); call before any runtime copy. | ||
| void | set_supported_custom_presets (std::initializer_list< const char * > presets) | |
| Set the supported custom presets; the list is copied (stored on Climate, referenced by ClimateTraits). | ||
| void | set_supported_custom_presets (const std::vector< const char * > &presets) | |
| template<size_t N> | ||
| void | set_supported_custom_presets (const char *const (&presets)[N]) | |
| void | set_supported_custom_presets_static (const char *const *presets, size_t count) | |
| Points at a static table that outlives the climate (codegen); call before any runtime copy. | ||
| bool | has_custom_fan_mode () const | |
| Check if a custom fan mode is currently active. | ||
| bool | has_custom_preset () const | |
| Check if a custom preset is currently active. | ||
| StringRef | get_custom_fan_mode () const | |
| Get the active custom fan mode (read-only access). Returns StringRef. | ||
| StringRef | get_custom_preset () const | |
| Get the active custom preset (read-only access). Returns StringRef. | ||
Public Member Functions inherited from esphome::EntityBase | ||
| ESPDEPRECATED ("Use get_name_to() or get_log_name() instead. Will be removed in ESPHome 2027.5.0", "2026.11.0") const StringRef &get_name() const | ||
| The name is in flash here; the first call makes a RAM copy that is kept for the life of the device. | ||
| StringRef | get_name_to (std::span< char, ENTITY_NAME_BUF_SIZE > buffer) const | |
| Get the name of this Entity, copied out of flash into buffer. | ||
| ESPDEPRECATED ("Use get_name_to() or get_log_name() instead. Will be removed in ESPHome 2027.5.0", "2026.11.0") const StringRef &get_name() const | ||
| const StringRef & | get_name_to (std::span< char, ENTITY_NAME_BUF_SIZE >) const | |
| bool | name_equals (const StringRef &other) const | |
| const ProgmemStringRef & | get_name_progmem () const | |
| The name as stored, for consumers that read flash themselves (e.g. API progmem fields). | ||
| size_t | write_name_to (char *buf, size_t buf_size) const | |
| Copy the name into buf (null terminated), returns its length. | ||
| const LogString * | get_log_name () const | |
| Get the name for a "%s" log argument (LOG_STR_ARG). | ||
| bool | has_own_name () const | |
| uint32_t | get_object_id_hash () 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 (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer. | ||
| size_t | write_object_id_to (char *buf, size_t buf_size) const | |
| Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer. | ||
| bool | is_internal () const | |
| void | set_internal (bool internal) | |
| bool | is_disabled_by_default () const | |
| EntityCategory | get_entity_category () const | |
| const char * | get_device_class_to (std::span< char, MAX_DEVICE_CLASS_LENGTH > buffer) const | |
| ProgmemStringRef | get_device_class_progmem () const | |
| The device class as stored (in flash on ESP8266), for consumers that read flash themselves. | ||
| StringRef | get_unit_of_measurement_ref () const | |
| const char * | get_icon_to (std::span< char, MAX_ICON_LENGTH > buffer) const | |
| ProgmemStringRef | get_icon_progmem () const | |
| The icon as stored (in flash on ESP8266), for consumers that read flash themselves. | ||
| uint32_t | get_device_id () const | |
| Device * | get_device () const | |
| bool | has_state () const | |
| void | set_has_state (bool state) | |
| ESPDEPRECATED ("Use make_entity_preference<T>() instead, or preferences won't be migrated. " "See https://github.com/esphome/backlog/issues/85. Will be removed in 2027.1.0.", "2026.7.0") uint32_t get_preference_hash() | ||
| Get a unique hash for storing preferences/settings for this entity. | ||
| template<typename T > | ||
| ESPPreferenceObject | make_entity_preference (uint32_t version=0) | |
| Create a preference object for storing this entity's state/settings. | ||
| template<typename T > | ||
| ESPPreferenceObject | make_entity_preference (uint32_t version, bool in_flash) | |
| As make_entity_preference(), stored in flash or RTC memory where the backend supports the choice. | ||
Public Member Functions inherited from esphome::Component | ||
| virtual void | loop () | |
| This method will be called repeatedly. | ||
| virtual float | get_setup_priority () const | |
| priority of setup(). | ||
| float | get_actual_setup_priority () const | |
| void | set_setup_priority (float priority) | |
| void | call () | |
| virtual void | on_shutdown () | |
| virtual void | on_safe_shutdown () | |
| virtual bool | teardown () | |
| Called during teardown to allow component to gracefully finish operations. | ||
| virtual void | on_powerdown () | |
| Called last before a reboot or deep sleep to power down hardware. | ||
| uint8_t | get_component_state () const | |
| void | reset_to_construction_state () | |
| Reset this component back to the construction state to allow setup to run again. | ||
| bool | is_in_loop_state () const | |
| Check if this component has completed setup and is in the loop state. | ||
| bool | is_idle () const | |
| Check if this component is idle. | ||
| void | mark_failed () | |
| Mark this component as failed. | ||
| void | mark_failed (const LogString *message) | |
| bool ESPHOME_ALWAYS_INLINE | setup_check (bool ok) | |
Marks the component failed with message (default "Communication failed") unless ok; returns ok. | ||
| bool ESPHOME_ALWAYS_INLINE | setup_check (bool ok, const LogString *message) | |
| void | disable_loop () | |
| Disable this component's loop. | ||
| void | enable_loop () | |
| Enable this component's loop. | ||
| void | enable_loop_soon_any_context () | |
| Thread and ISR-safe version of enable_loop() that can be called from any context. | ||
| bool | is_failed () const | |
| bool | is_ready () const | |
| virtual bool | can_proceed () | |
| bool | status_has_warning () const | |
| bool | status_has_error () const | |
| void | status_set_warning () | |
| void | status_set_warning (const char *message) | |
| void | status_set_warning (const LogString *message) | |
| bool | status_comm_result (bool ok) | |
Clears the warning when ok, else sets it with message (default "Communication failed"); returns ok. | ||
| bool | status_comm_result (bool ok, const LogString *message) | |
| void | status_set_error () | |
| void | status_set_error (const LogString *message) | |
| void | status_clear_warning () | |
| void | status_clear_error () | |
| ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name | ||
| void | status_momentary_warning (uint32_t length=5000) | |
Set warning status flag and clear it after length ms. | ||
| void | status_momentary_warning (const LogString *message, uint32_t length=5000) | |
| ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name | ||
| void | status_momentary_error (uint32_t length=5000) | |
Set error status flag and clear it after length ms. | ||
| void | status_momentary_error (const LogString *message, uint32_t length=5000) | |
| bool | has_overridden_loop () const | |
| const LogString * | get_component_log_str () const ESPHOME_ALWAYS_INLINE | |
| Get the integration where this component was declared as a LogString for logging. | ||
| bool | should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out) | |
Data Fields inherited from esphome::climate::Climate | ||
| float | current_temperature {NAN} | |
| The current temperature of the climate device, as reported from the integration. | ||
| float | current_humidity {NAN} | |
| The current humidity of the climate device, as reported from the integration. | ||
| union { | ||
| float target_temperature | ||
| The target temperature of the climate device. More... | ||
| struct { | ||
| float target_temperature_low {NAN} | ||
| The minimum target temperature of the climate device, for climate devices with split target temperature. More... | ||
| float target_temperature_high {NAN} | ||
| The maximum target temperature of the climate device, for climate devices with split target temperature. More... | ||
| } | ||
| }; | ||
| float | target_humidity | |
| The target humidity of the climate device. | ||
| optional< ClimateFanMode > | fan_mode | |
| The active fan mode of the climate device. | ||
| optional< ClimatePreset > | preset | |
| The active preset of the climate device. | ||
| ClimateMode | mode {CLIMATE_MODE_OFF} | |
| The active mode of the climate device. | ||
| ClimateAction | action {CLIMATE_ACTION_OFF} | |
| The active state of the climate device. | ||
| ClimateSwingMode | swing_mode {CLIMATE_SWING_OFF} | |
| The active swing mode of the climate device. | ||
Data Fields inherited from esphome::Component | ||
| uint32_t | length = 5000) | |
Definition at line 19 of file bang_bang_climate.h.
|
protected |
Change the away setting, will reset target temperatures to defaults.
Definition at line 186 of file bang_bang_climate.cpp.
|
protected |
Re-compute the state of this climate controller.
Definition at line 96 of file bang_bang_climate.cpp.
|
overrideprotectedvirtual |
Override control to change settings of the climate device.
Implements esphome::climate::Climate.
Definition at line 46 of file bang_bang_climate.cpp.
|
protected |
Switch the climate device to the given climate mode.
Definition at line 141 of file bang_bang_climate.cpp.
|
overrideprotectedvirtual |
Return the traits of this controller.
Implements esphome::climate::Climate.
Definition at line 68 of file bang_bang_climate.cpp.
|
protected |
Definition at line 79 of file bang_bang_climate.h.
|
protected |
The trigger to call when the controller should switch to cooling mode.
Definition at line 58 of file bang_bang_climate.h.
|
protected |
The trigger to call when the controller should switch to heating mode.
Definition at line 61 of file bang_bang_climate.h.
|
protected |
The trigger to call when the controller should switch to idle mode.
In idle mode, the controller is assumed to have both heating and cooling disabled.
Definition at line 55 of file bang_bang_climate.h.
|
protected |
Definition at line 78 of file bang_bang_climate.h.
|
protected |
A reference to the trigger that was previously active.
This is so that the previous trigger can be stopped before enabling a new one.
Definition at line 66 of file bang_bang_climate.h.
|
protected |
Definition at line 76 of file bang_bang_climate.h.
|
protected |
Whether the controller supports cooling/heating.
A false value for this attribute means that the controller has no respective action (for example a thermostat, where only heating and not-heating is possible).
Definition at line 73 of file bang_bang_climate.h.
|
protected |
Definition at line 74 of file bang_bang_climate.h.