ESPHome  2024.6.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::template_::TemplateLock Class Reference

#include <template_lock.h>

Inheritance diagram for esphome::template_::TemplateLock:
esphome::lock::Lock esphome::Component esphome::EntityBase

Public Member Functions

 TemplateLock ()
void dump_config () override
void set_state_lambda (std::function< optional< lock::LockState >()> &&f)
Triggerget_lock_trigger () const
Triggerget_unlock_trigger () const
Triggerget_open_trigger () const
void set_optimistic (bool optimistic)
void loop () override
float get_setup_priority () const override
- Public Member Functions inherited from esphome::lock::Lock
 Lock ()
LockCall make_call ()
 Make a lock device control call, this is used to control the lock device, see the LockCall description for more info. More...
void publish_state (LockState state)
 Publish a state to the front-end from the back-end. More...
void lock ()
 Turn this lock on. More...
void unlock ()
 Turn this lock off. More...
void open ()
 Open (unlatch) this lock. More...
void add_on_state_callback (std::function< void()> &&callback)
 Set callback for state changes. 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::Component
virtual void setup ()
 Where the component's initialization should happen. More...
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 lock::LockCall &call) override
void open_latch () override
- 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

optional< std::function< optional< lock::LockState >)> > f_
bool optimistic_ {false}
Triggerprev_trigger_ {nullptr}
- Protected Attributes inherited from esphome::lock::Lock
friend LockCall
CallbackManager< void()> state_callback_ {}
Deduplicator< LockStatepublish_dedup_
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::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::lock::Lock
LockState state {LOCK_STATE_NONE}
 The current reported state of the lock. More...
LockTraits traits

Detailed Description

Definition at line 10 of file template_lock.h.

Constructor & Destructor Documentation

◆ TemplateLock()

esphome::template_::TemplateLock::TemplateLock ( )

Definition at line 11 of file template_lock.cpp.

Member Function Documentation

◆ control()

void esphome::template_::TemplateLock::control ( const lock::LockCall call)

Implements esphome::lock::Lock.

Definition at line 23 of file template_lock.cpp.

◆ dump_config()

void esphome::template_::TemplateLock::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 53 of file template_lock.cpp.

◆ get_lock_trigger()

Trigger * esphome::template_::TemplateLock::get_lock_trigger ( ) const

Definition at line 50 of file template_lock.cpp.

◆ get_open_trigger()

Trigger * esphome::template_::TemplateLock::get_open_trigger ( ) const

Definition at line 52 of file template_lock.cpp.

◆ get_setup_priority()

float esphome::template_::TemplateLock::get_setup_priority ( ) const

Reimplemented from esphome::Component.

Definition at line 49 of file template_lock.cpp.

◆ get_unlock_trigger()

Trigger * esphome::template_::TemplateLock::get_unlock_trigger ( ) const

Definition at line 51 of file template_lock.cpp.

◆ loop()

void esphome::template_::TemplateLock::loop ( )

Reimplemented from esphome::Component.

Definition at line 14 of file template_lock.cpp.

◆ open_latch()

void esphome::template_::TemplateLock::open_latch ( )

Reimplemented from esphome::lock::Lock.

Definition at line 40 of file template_lock.cpp.

◆ set_optimistic()

void esphome::template_::TemplateLock::set_optimistic ( bool  optimistic)

Definition at line 47 of file template_lock.cpp.

◆ set_state_lambda()

void esphome::template_::TemplateLock::set_state_lambda ( std::function< optional< lock::LockState >()> &&  f)

Definition at line 48 of file template_lock.cpp.

Field Documentation

◆ f_

optional<std::function<optional<lock::LockState>)> > esphome::template_::TemplateLock::f_

Definition at line 29 of file template_lock.h.

◆ lock_trigger_

Trigger* esphome::template_::TemplateLock::lock_trigger_

Definition at line 31 of file template_lock.h.

◆ open_trigger_

Trigger* esphome::template_::TemplateLock::open_trigger_

Definition at line 33 of file template_lock.h.

◆ optimistic_

bool esphome::template_::TemplateLock::optimistic_ {false}

Definition at line 30 of file template_lock.h.

◆ prev_trigger_

Trigger* esphome::template_::TemplateLock::prev_trigger_ {nullptr}

Definition at line 34 of file template_lock.h.

◆ unlock_trigger_

Trigger* esphome::template_::TemplateLock::unlock_trigger_

Definition at line 32 of file template_lock.h.

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