ESPHome  2024.11.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::am43::Am43Component Class Reference

#include <am43_cover.h>

Inheritance diagram for esphome::am43::Am43Component:
esphome::cover::Cover esphome::ble_client::BLEClientNode esphome::Component esphome::EntityBase esphome::EntityBase_DeviceClass

Public Member Functions

void setup () override
 
void loop () override
 
void gattc_event_handler (esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param) override
 
void dump_config () override
 
float get_setup_priority () const override
 
cover::CoverTraits get_traits () override
 
void set_pin (uint16_t pin)
 
void set_invert_position (bool invert_position)
 
- Public Member Functions inherited from esphome::cover::Cover
 Cover ()
 
CoverCall make_call ()
 Construct a new cover call used to control the cover. More...
 
 ESPDEPRECATED ("open() is deprecated, use make_call().set_command_open().perform() instead.", "2021.9") void open()
 Open the cover. More...
 
 ESPDEPRECATED ("close() is deprecated, use make_call().set_command_close().perform() instead.", "2021.9") void close()
 Close the cover. More...
 
 ESPDEPRECATED ("stop() is deprecated, use make_call().set_command_stop().perform() instead.", "2021.9") void stop()
 Stop the cover. More...
 
void add_on_state_callback (std::function< void()> &&f)
 
void publish_state (bool save=true)
 Publish the current state of the cover. More...
 
bool is_fully_open () const
 Helper method to check if the cover is fully open. Equivalent to comparing .position against 1.0. More...
 
bool is_fully_closed () const
 Helper method to check if the cover is fully closed. Equivalent to comparing .position against 0.0. More...
 
- 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::EntityBase_DeviceClass
std::string get_device_class ()
 Get the device class, using the manual override if set. More...
 
void set_device_class (const char *device_class)
 Manually set the device class. More...
 
- Public Member Functions inherited from esphome::ble_client::BLEClientNode
virtual void gap_event_handler (esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param)
 
void set_address (uint64_t address)
 
BLEClientparent ()
 
void set_ble_client_parent (BLEClient *parent)
 
- 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 cover::CoverCall &call) override
 
- Protected Member Functions inherited from esphome::cover::Cover
optional< CoverRestoreStaterestore_state_ ()
 
- 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_setup ()
 
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

uint16_t char_handle_
 
uint16_t pin_
 
bool invert_position_
 
std::unique_ptr< Am43Encoderencoder_
 
std::unique_ptr< Am43Decoderdecoder_
 
bool logged_in_
 
float position_
 
- Protected Attributes inherited from esphome::cover::Cover
friend CoverCall
 
CallbackManager< void()> state_callback_ {}
 
ESPPreferenceObject rtc_
 
- 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::EntityBase_DeviceClass
const char * device_class_ {nullptr}
 Device class override. More...
 
- Protected Attributes inherited from esphome::ble_client::BLEClientNode
BLEClientparent_
 
uint64_t address_
 
- 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::cover::Cover
CoverOperation current_operation {COVER_OPERATION_IDLE}
 The current operation of the cover (idle, opening, closing). More...
 
float position
 The position of the cover from 0.0 (fully closed) to 1.0 (fully open). More...
 
float tilt {COVER_OPEN}
 The current tilt value of the cover from 0.0 to 1.0. More...
 
- Data Fields inherited from esphome::ble_client::BLEClientNode
espbt::ESPBTClientclient
 
espbt::ClientState node_state
 

Detailed Description

Definition at line 18 of file am43_cover.h.

Member Function Documentation

◆ control()

void esphome::am43::Am43Component::control ( const cover::CoverCall call)
overrideprotectedvirtual

Implements esphome::cover::Cover.

Definition at line 50 of file am43_cover.cpp.

◆ dump_config()

void esphome::am43::Am43Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 13 of file am43_cover.cpp.

◆ gattc_event_handler()

void esphome::am43::Am43Component::gattc_event_handler ( esp_gattc_cb_event_t  event,
esp_gatt_if_t  gattc_if,
esp_ble_gattc_cb_param_t *  param 
)
overridevirtual

Reimplemented from esphome::ble_client::BLEClientNode.

Definition at line 79 of file am43_cover.cpp.

◆ get_setup_priority()

float esphome::am43::Am43Component::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 25 of file am43_cover.h.

◆ get_traits()

CoverTraits esphome::am43::Am43Component::get_traits ( )
overridevirtual

Implements esphome::cover::Cover.

Definition at line 41 of file am43_cover.cpp.

◆ loop()

void esphome::am43::Am43Component::loop ( )
overridevirtual

Reimplemented from esphome::ble_client::BLEClientNode.

Definition at line 26 of file am43_cover.cpp.

◆ set_invert_position()

void esphome::am43::Am43Component::set_invert_position ( bool  invert_position)
inline

Definition at line 28 of file am43_cover.h.

◆ set_pin()

void esphome::am43::Am43Component::set_pin ( uint16_t  pin)
inline

Definition at line 27 of file am43_cover.h.

◆ setup()

void esphome::am43::Am43Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 19 of file am43_cover.cpp.

Field Documentation

◆ char_handle_

uint16_t esphome::am43::Am43Component::char_handle_
protected

Definition at line 32 of file am43_cover.h.

◆ decoder_

std::unique_ptr<Am43Decoder> esphome::am43::Am43Component::decoder_
protected

Definition at line 36 of file am43_cover.h.

◆ encoder_

std::unique_ptr<Am43Encoder> esphome::am43::Am43Component::encoder_
protected

Definition at line 35 of file am43_cover.h.

◆ invert_position_

bool esphome::am43::Am43Component::invert_position_
protected

Definition at line 34 of file am43_cover.h.

◆ logged_in_

bool esphome::am43::Am43Component::logged_in_
protected

Definition at line 37 of file am43_cover.h.

◆ pin_

uint16_t esphome::am43::Am43Component::pin_
protected

Definition at line 33 of file am43_cover.h.

◆ position_

float esphome::am43::Am43Component::position_
protected

Definition at line 39 of file am43_cover.h.


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