#include <output_lock.h>
Inheritance diagram for esphome::output::OutputLock:
Public Member Functions | |
| void | set_output (BinaryOutput *output) |
| float | get_setup_priority () const override |
| void | dump_config () 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 StringRef & | get_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... | |
| virtual void | loop () |
| This method will be called repeatedly. 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 |
| Protected Member Functions inherited from esphome::lock::Lock | |
| virtual void | open_latch () |
| Perform the open latch action with hardware. More... | |
| 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 | |
| output::BinaryOutput * | output_ |
| Protected Attributes inherited from esphome::lock::Lock | |
| friend | LockCall |
| CallbackManager< void()> | state_callback_ {} |
| Deduplicator< LockState > | publish_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 output_lock.h.
Member Function Documentation
◆ control()
|
overrideprotectedvirtual |
Implements esphome::lock::Lock.
Definition at line 11 of file output_lock.cpp.
◆ dump_config()
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 9 of file output_lock.cpp.
◆ get_setup_priority()
|
inlineoverridevirtual |
Reimplemented from esphome::Component.
Definition at line 14 of file output_lock.h.
◆ set_output()
|
inline |
Definition at line 12 of file output_lock.h.
Field Documentation
◆ output_
|
protected |
Definition at line 20 of file output_lock.h.
The documentation for this class was generated from the following files:
- /opt/build/esphome/esphome/components/output/lock/output_lock.h
- /opt/build/esphome/esphome/components/output/lock/output_lock.cpp
