ESPHome  2024.6.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::tuya::TuyaCover Class Reference

#include <tuya_cover.h>

Inheritance diagram for esphome::tuya::TuyaCover:
esphome::cover::Cover esphome::Component esphome::EntityBase esphome::EntityBase_DeviceClass

Public Member Functions

void setup () override
void dump_config () override
void set_control_id (uint8_t control_id)
void set_direction_id (uint8_t direction_id)
void set_position_id (uint8_t position_id)
void set_position_report_id (uint8_t position_report_id)
void set_tuya_parent (Tuya *parent)
void set_min_value (uint32_t min_value)
void set_max_value (uint32_t max_value)
void set_invert_position (bool invert_position)
void set_invert_position_report (bool invert_position_report)
void set_restore_mode (TuyaCoverRestoreMode restore_mode)
- 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() instead.", "2021.9") void open()
 Open the cover. More...
 ESPDEPRECATED ("close() is deprecated, use make_call().set_command_close() 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::Component
virtual void loop ()
 This method will be called repeatedly. More...
virtual float get_setup_priority () const
 priority of setup(). 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 cover::CoverCall &call) override
void set_direction_ (bool inverted)
cover::CoverTraits get_traits () 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

TuyaCoverRestoreMode restore_mode_ {}
optional< uint8_t > control_id_ {}
optional< uint8_t > direction_id_ {}
optional< uint8_t > position_id_ {}
optional< uint8_t > position_report_id_ {}
uint32_t min_value_
uint32_t max_value_
uint32_t value_range_
bool invert_position_
bool invert_position_report_
- 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::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...

Detailed Description

Definition at line 16 of file tuya_cover.h.

Member Function Documentation

◆ control()

void esphome::tuya::TuyaCover::control ( const cover::CoverCall call)

Implements esphome::cover::Cover.

Definition at line 59 of file tuya_cover.cpp.

◆ dump_config()

void esphome::tuya::TuyaCover::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 106 of file tuya_cover.cpp.

◆ get_traits()

cover::CoverTraits esphome::tuya::TuyaCover::get_traits ( )

Implements esphome::cover::Cover.

Definition at line 132 of file tuya_cover.cpp.

◆ set_control_id()

void esphome::tuya::TuyaCover::set_control_id ( uint8_t  control_id)

Definition at line 20 of file tuya_cover.h.

◆ set_direction_()

void esphome::tuya::TuyaCover::set_direction_ ( bool  inverted)

Definition at line 92 of file tuya_cover.cpp.

◆ set_direction_id()

void esphome::tuya::TuyaCover::set_direction_id ( uint8_t  direction_id)

Definition at line 21 of file tuya_cover.h.

◆ set_invert_position()

void esphome::tuya::TuyaCover::set_invert_position ( bool  invert_position)

Definition at line 27 of file tuya_cover.h.

◆ set_invert_position_report()

void esphome::tuya::TuyaCover::set_invert_position_report ( bool  invert_position_report)

Definition at line 28 of file tuya_cover.h.

◆ set_max_value()

void esphome::tuya::TuyaCover::set_max_value ( uint32_t  max_value)

Definition at line 26 of file tuya_cover.h.

◆ set_min_value()

void esphome::tuya::TuyaCover::set_min_value ( uint32_t  min_value)

Definition at line 25 of file tuya_cover.h.

◆ set_position_id()

void esphome::tuya::TuyaCover::set_position_id ( uint8_t  position_id)

Definition at line 22 of file tuya_cover.h.

◆ set_position_report_id()

void esphome::tuya::TuyaCover::set_position_report_id ( uint8_t  position_report_id)

Definition at line 23 of file tuya_cover.h.

◆ set_restore_mode()

void esphome::tuya::TuyaCover::set_restore_mode ( TuyaCoverRestoreMode  restore_mode)

Definition at line 29 of file tuya_cover.h.

◆ set_tuya_parent()

void esphome::tuya::TuyaCover::set_tuya_parent ( Tuya parent)

Definition at line 24 of file tuya_cover.h.

◆ setup()

void esphome::tuya::TuyaCover::setup ( )

Reimplemented from esphome::Component.

Definition at line 15 of file tuya_cover.cpp.

Field Documentation

◆ control_id_

optional<uint8_t> esphome::tuya::TuyaCover::control_id_ {}

Definition at line 38 of file tuya_cover.h.

◆ direction_id_

optional<uint8_t> esphome::tuya::TuyaCover::direction_id_ {}

Definition at line 39 of file tuya_cover.h.

◆ invert_position_

bool esphome::tuya::TuyaCover::invert_position_

Definition at line 45 of file tuya_cover.h.

◆ invert_position_report_

bool esphome::tuya::TuyaCover::invert_position_report_

Definition at line 46 of file tuya_cover.h.

◆ max_value_

uint32_t esphome::tuya::TuyaCover::max_value_

Definition at line 43 of file tuya_cover.h.

◆ min_value_

uint32_t esphome::tuya::TuyaCover::min_value_

Definition at line 42 of file tuya_cover.h.

◆ parent_

Tuya* esphome::tuya::TuyaCover::parent_

Definition at line 36 of file tuya_cover.h.

◆ position_id_

optional<uint8_t> esphome::tuya::TuyaCover::position_id_ {}

Definition at line 40 of file tuya_cover.h.

◆ position_report_id_

optional<uint8_t> esphome::tuya::TuyaCover::position_report_id_ {}

Definition at line 41 of file tuya_cover.h.

◆ restore_mode_

TuyaCoverRestoreMode esphome::tuya::TuyaCover::restore_mode_ {}

Definition at line 37 of file tuya_cover.h.

◆ value_range_

uint32_t esphome::tuya::TuyaCover::value_range_

Definition at line 44 of file tuya_cover.h.

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