ESPHome  2024.11.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::bedjet::BedJetClimate Class Reference

#include <bedjet_climate.h>

Inheritance diagram for esphome::bedjet::BedJetClimate:
esphome::climate::Climate esphome::bedjet::BedJetClient esphome::PollingComponent esphome::EntityBase esphome::Parented< BedJetHub > esphome::Component

Public Member Functions

void setup () override
 
void loop () override
 
void update () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void on_status (const BedjetStatusPacket *data) override
 
void on_bedjet_state (bool is_ready) override
 
std::string describe () override
 
void set_heating_mode (BedjetHeatMode mode)
 Sets the default strategy to use for climate::CLIMATE_MODE_HEAT. More...
 
void set_temperature_source (BedjetTemperatureSource source)
 Sets the temperature source to use for the climate entity's current temperature. More...
 
climate::ClimateTraits traits () override
 
- Public Member Functions inherited from esphome::climate::Climate
 Climate ()
 
void add_on_state_callback (std::function< void(Climate &)> &&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. More...
 
void add_on_control_callback (std::function< void(ClimateCall &)> &&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. More...
 
ClimateCall make_call ()
 Make a climate device control call, this is used to control the climate device, see the ClimateCall description for more info. More...
 
void publish_state ()
 Publish the state of the climate device, to be called from integrations. More...
 
ClimateTraits get_traits ()
 Get the traits of this climate device with all overrides applied. More...
 
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)
 
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_name () const
 
void set_name (const char *name)
 
bool has_own_name () const
 
std::string get_object_id () const
 
void set_object_id (const char *object_id)
 
uint32_t get_object_id_hash ()
 
bool is_internal () const
 
void set_internal (bool internal)
 
bool is_disabled_by_default () const
 
void set_disabled_by_default (bool disabled_by_default)
 
EntityCategory get_entity_category () const
 
void set_entity_category (EntityCategory entity_category)
 
std::string get_icon () const
 
void set_icon (const char *icon)
 
- Public Member Functions inherited from esphome::Parented< BedJetHub >
 Parented ()
 
 Parented (BedJetHub *parent)
 
BedJetHub * get_parent () const
 Get the parent of this object. More...
 
void set_parent (BedJetHub *parent)
 Set the parent of this object. More...
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
 
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
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 (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Member Functions

void control (const climate::ClimateCall &call) override
 
void reset_state_ ()
 Resets states to defaults. More...
 
bool update_status_ ()
 Attempts to update the climate device from the last received BedjetStatusPacket. More...
 
bool is_valid_ ()
 
- 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. More...
 
bool set_custom_fan_mode_ (const std::string &mode)
 Set custom fan mode. Reset primary fan mode. Return true if fan mode has been changed. More...
 
bool set_preset_ (ClimatePreset preset)
 Set preset. Reset custom preset. Return true if preset has been changed. More...
 
bool set_custom_preset_ (const std::string &preset)
 Set custom preset. Reset primary preset. Return true if preset has been changed. More...
 
optional< ClimateDeviceRestoreStaterestore_state_ ()
 Restore the state of the climate device, call this from your setup() method. More...
 
void save_state_ ()
 Internal method to save the state of the climate device to recover memory. More...
 
void dump_traits_ (const char *tag)
 
- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
 
void calc_object_id_ ()
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Protected Attributes

BedjetHeatMode heating_mode_ = HEAT_MODE_HEAT
 
BedjetTemperatureSource temperature_source_ = TEMPERATURE_SOURCE_AMBIENT
 
- Protected Attributes inherited from esphome::climate::Climate
friend ClimateCall
 
CallbackManager< void(Climate &)> state_callback_ {}
 
CallbackManager< void(ClimateCall &)> control_callback_ {}
 
ESPPreferenceObject rtc_
 
optional< float > visual_min_temperature_override_ {}
 
optional< float > visual_max_temperature_override_ {}
 
optional< float > visual_target_temperature_step_override_ {}
 
optional< float > visual_current_temperature_step_override_ {}
 
optional< float > visual_min_humidity_override_ {}
 
optional< float > visual_max_humidity_override_ {}
 
- Protected Attributes inherited from esphome::EntityBase
StringRef name_
 
const char * object_id_c_str_ {nullptr}
 
const char * icon_c_str_ {nullptr}
 
uint32_t object_id_hash_
 
bool has_own_name_ {false}
 
bool internal_ {false}
 
bool disabled_by_default_ {false}
 
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
 
- Protected Attributes inherited from esphome::bedjet::BedJetClient
friend BedJetHub
 
- Protected Attributes inherited from esphome::Parented< BedJetHub >
BedJetHub * parent_
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Additional Inherited Members

- Data Fields inherited from esphome::climate::Climate
ClimateMode mode {CLIMATE_MODE_OFF}
 The active mode of the climate device. More...
 
ClimateAction action {CLIMATE_ACTION_OFF}
 The active state of the climate device. More...
 
float current_temperature {NAN}
 The current temperature of the climate device, as reported from the integration. More...
 
float current_humidity {NAN}
 The current humidity of the climate device, as reported from the integration. More...
 
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. More...
 
optional< ClimateFanModefan_mode
 The active fan mode of the climate device. More...
 
ClimateSwingMode swing_mode
 The active swing mode of the climate device. More...
 
optional< std::string > custom_fan_mode
 The active custom fan mode of the climate device. More...
 
optional< ClimatePresetpreset
 The active preset of the climate device. More...
 
optional< std::string > custom_preset
 The active custom preset mode of the climate device. More...
 

Detailed Description

Definition at line 16 of file bedjet_climate.h.

Member Function Documentation

◆ control()

void esphome::bedjet::BedJetClimate::control ( const climate::ClimateCall call)
overrideprotectedvirtual

Implements esphome::climate::Climate.

Definition at line 88 of file bedjet_climate.cpp.

◆ describe()

std::string esphome::bedjet::BedJetClimate::describe ( )
overridevirtual

Implements esphome::bedjet::BedJetClient.

Definition at line 30 of file bedjet_climate.cpp.

◆ dump_config()

void esphome::bedjet::BedJetClimate::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 32 of file bedjet_climate.cpp.

◆ get_setup_priority()

float esphome::bedjet::BedJetClimate::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 22 of file bedjet_climate.h.

◆ is_valid_()

bool esphome::bedjet::BedJetClimate::is_valid_ ( )
inlineprotected

Definition at line 84 of file bedjet_climate.h.

◆ loop()

void esphome::bedjet::BedJetClimate::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 86 of file bedjet_climate.cpp.

◆ on_bedjet_state()

void esphome::bedjet::BedJetClimate::on_bedjet_state ( bool  is_ready)
overridevirtual

Implements esphome::bedjet::BedJetClient.

Definition at line 224 of file bedjet_climate.cpp.

◆ on_status()

void esphome::bedjet::BedJetClimate::on_status ( const BedjetStatusPacket data)
overridevirtual

Implements esphome::bedjet::BedJetClient.

Definition at line 226 of file bedjet_climate.cpp.

◆ reset_state_()

void esphome::bedjet::BedJetClimate::reset_state_ ( )
protected

Resets states to defaults.

Definition at line 76 of file bedjet_climate.cpp.

◆ set_heating_mode()

void esphome::bedjet::BedJetClimate::set_heating_mode ( BedjetHeatMode  mode)
inline

Sets the default strategy to use for climate::CLIMATE_MODE_HEAT.

Definition at line 30 of file bedjet_climate.h.

◆ set_temperature_source()

void esphome::bedjet::BedJetClimate::set_temperature_source ( BedjetTemperatureSource  source)
inline

Sets the temperature source to use for the climate entity's current temperature.

Definition at line 32 of file bedjet_climate.h.

◆ setup()

void esphome::bedjet::BedJetClimate::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 63 of file bedjet_climate.cpp.

◆ traits()

climate::ClimateTraits esphome::bedjet::BedJetClimate::traits ( )
inlineoverridevirtual

Implements esphome::climate::Climate.

Definition at line 34 of file bedjet_climate.h.

◆ update()

void esphome::bedjet::BedJetClimate::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 342 of file bedjet_climate.cpp.

◆ update_status_()

bool esphome::bedjet::BedJetClimate::update_status_ ( )
protected

Attempts to update the climate device from the last received BedjetStatusPacket.

This will be called from on_status() when the parent dispatches new status packets, and from update() when the polling interval is triggered.

Returns
true if the status has been applied; false if there is nothing to apply.

Definition at line 319 of file bedjet_climate.cpp.

Field Documentation

◆ heating_mode_

BedjetHeatMode esphome::bedjet::BedJetClimate::heating_mode_ = HEAT_MODE_HEAT
protected

Definition at line 78 of file bedjet_climate.h.

◆ temperature_source_

BedjetTemperatureSource esphome::bedjet::BedJetClimate::temperature_source_ = TEMPERATURE_SOURCE_AMBIENT
protected

Definition at line 79 of file bedjet_climate.h.


The documentation for this class was generated from the following files: