#include <am43_cover.h>

Inheritance diagram for esphome::am43::Am43Component:

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

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.

	ESPDEPRECATED ("open() is deprecated, use make_call().set_command_open().perform() instead.", "2021.9") void open()
	Open the cover.

	ESPDEPRECATED ("close() is deprecated, use make_call().set_command_close().perform() instead.", "2021.9") void close()
	Close the cover.

	ESPDEPRECATED ("stop() is deprecated, use make_call().set_command_stop().perform() instead.", "2021.9") void stop()
	Stop the cover.

void	add_on_state_callback (std::function< void()> &&f)

void	publish_state (bool save=true)
	Publish the current state of the cover.

bool	is_fully_open () const
	Helper method to check if the cover is fully open. Equivalent to comparing .position against 1.0.

bool	is_fully_closed () const
	Helper method to check if the cover is fully closed. Equivalent to comparing .position against 0.0.

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)

uint32_t	get_device_id () const

void	set_device (Device *device)

bool	has_state () const

void	set_has_state (bool state)

Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string	get_device_class ()
	Get the device class, using the manual override if set.

void	set_device_class (const char *device_class)
	Manually set the device class.

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)

BLEClient *	parent ()

void	set_ble_client_parent (BLEClient *parent)

Public Member Functions inherited from esphome::Component
virtual float	get_setup_priority () const
	priority of setup().

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop().

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

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.

const char *	get_component_source () const
	Get the integration where this component was declared as a string.

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Member Functions
void	control (const cover::CoverCall &call) override

Protected Member Functions inherited from esphome::cover::Cover
optional< CoverRestoreState >	restore_state_ ()

Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t	hash_base ()
	The hash_base() function has been deprecated.

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.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

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.

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.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Protected Attributes
uint16_t	char_handle_

uint16_t	pin_

bool	invert_position_

std::unique_ptr< Am43Encoder >	encoder_

std::unique_ptr< Am43Decoder >	decoder_

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_ {}

Device *	device_ {}

struct esphome::EntityBase::EntityFlags	flags_

Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char *	device_class_ {nullptr}
	Device class override.

Protected Attributes inherited from esphome::ble_client::BLEClientNode
BLEClient *	parent_

uint64_t	address_

Protected Attributes inherited from esphome::Component
const char *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-1: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED) Bit 2: STATUS_LED_WARNING Bit 3: STATUS_LED_ERROR Bits 4-7: Unused - reserved for future expansion (50% of the bits are free)

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

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).

float	position
	The position of the cover from 0.0 (fully closed) to 1.0 (fully open).

float	tilt {COVER_OPEN}
	The current tilt value of the cover from 0.0 to 1.0.

Data Fields inherited from esphome::ble_client::BLEClientNode
espbt::ESPBTClient *	client

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 52 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 81 of file am43_cover.cpp.

◆ get_traits()

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

overridevirtual

Implements esphome::cover::Cover.

Definition at line 43 of file am43_cover.cpp.

◆ loop()

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

overridevirtual

Reimplemented from esphome::ble_client::BLEClientNode.

Definition at line 28 of file am43_cover.cpp.

◆ set_invert_position()

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

inline

Definition at line 27 of file am43_cover.h.

◆ set_pin()

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

inline

Definition at line 26 of file am43_cover.h.

◆ setup()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 21 of file am43_cover.cpp.

Field Documentation

◆ char_handle_

uint16_t esphome::am43::Am43Component::char_handle_

protected

Definition at line 31 of file am43_cover.h.

◆ decoder_

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

protected

Definition at line 35 of file am43_cover.h.

◆ encoder_

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

protected

Definition at line 34 of file am43_cover.h.

◆ invert_position_

bool esphome::am43::Am43Component::invert_position_

protected

Definition at line 33 of file am43_cover.h.

◆ logged_in_

bool esphome::am43::Am43Component::logged_in_

protected

Definition at line 36 of file am43_cover.h.

◆ pin_

uint16_t esphome::am43::Am43Component::pin_

protected

Definition at line 32 of file am43_cover.h.

◆ position_

float esphome::am43::Am43Component::position_

protected

Definition at line 38 of file am43_cover.h.

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

esphome/components/am43/cover/am43_cover.h
esphome/components/am43/cover/am43_cover.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ control()

◆ dump_config()

◆ gattc_event_handler()

◆ get_traits()

◆ loop()

◆ set_invert_position()

◆ set_pin()

◆ setup()

Field Documentation

◆ char_handle_

◆ decoder_

◆ encoder_

◆ invert_position_

◆ logged_in_

◆ pin_

◆ position_