#include <apc_proteous_cover.h>

Inheritance diagram for esphome::apc_proteous::APCProteousCover:

Public Member Functions
void	setup () override

void	loop () override

void	update () override

void	dump_config () override

cover::CoverTraits	get_traits () override

Public Member Functions inherited from esphome::cover::Cover
	Cover ()

CoverCall	make_call ()
	Construct a new cover call used to control the cover.

template<typename F >
void	add_on_state_callback (F &&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

bool	has_own_name () const

uint32_t	get_object_id_hash () const

StringRef	get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const
	Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.

size_t	write_object_id_to (char *buf, size_t buf_size) const
	Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.

bool	is_internal () const

void	set_internal (bool internal)

bool	is_disabled_by_default () const

EntityCategory	get_entity_category () const

const char *	get_device_class_to (std::span< char, MAX_DEVICE_CLASS_LENGTH > buffer) const

StringRef	get_unit_of_measurement_ref () const

const char *	get_icon_to (std::span< char, MAX_ICON_LENGTH > buffer) const

uint32_t	get_device_id () const

Device *	get_device () const

bool	has_state () const

void	set_has_state (bool state)

	ESPDEPRECATED ("Use make_entity_preference<T>() instead, or preferences won't be migrated. " "See https://github.com/esphome/backlog/issues/85. Will be removed in 2027.1.0.", "2026.7.0") uint32_t get_preference_hash()
	Get a unique hash for storing preferences/settings for this entity.

template<typename T >
ESPPreferenceObject	make_entity_preference (uint32_t version=0)
	Create a preference object for storing this entity's state/settings.

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms.

void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object.

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor.

void	start_poller ()

void	stop_poller ()

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)

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.

bool	is_idle () const
	Check if this component is idle.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *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 ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

	ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name

void	status_momentary_warning (uint32_t length=5000)
	Set warning status flag and clear it after `length` ms.

void	status_momentary_warning (const LogString *message, uint32_t length=5000)

	ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name

void	status_momentary_error (uint32_t length=5000)
	Set error status flag and clear it after `length` ms.

void	status_momentary_error (const LogString *message, uint32_t length=5000)

bool	has_overridden_loop () const

const LogString *	get_component_log_str () const ESPHOME_ALWAYS_INLINE
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Public Member Functions inherited from esphome::uart::UARTDevice
	UARTDevice ()=default

	UARTDevice (UARTComponent *parent)

void	set_uart_parent (UARTComponent *parent)

void	write_byte (uint8_t data)

void	set_rx_full_threshold (size_t rx_full_threshold)

void	set_rx_full_threshold_ms (size_t time)

size_t	get_rx_full_threshold ()

void	set_rx_timeout (size_t rx_timeout)

size_t	get_rx_timeout ()

void	write_array (const uint8_t *data, size_t len)

void	write_array_progmem (const uint8_t *data, size_t len)

void	write_array (const std::vector< uint8_t > &data)

template<size_t N>
void	write_array (const std::array< uint8_t, N > &data)

void	write_str (const char *str)

bool	read_byte (uint8_t *data)

bool	peek_byte (uint8_t *data)

bool	read_array (uint8_t *data, size_t len)

template<size_t N>
optional< std::array< uint8_t, N > >	read_array ()

size_t	available ()

UARTFlushResult	flush ()

int	read ()

size_t	write (uint8_t data)

int	peek ()

	ESPDEPRECATED ("Use uart.final_validate_device_schema() in Python instead. Removed in 2027.3.0", "2026.9.0") void check_uart_settings(uint32_t baud_rate
	Check that the configuration of the UART bus matches the provided values and otherwise print a warning.

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

void	parse_response_ ()

void	send_command_ (const char *cmd)

void	write_command_ (const char *cmd, uint32_t now)

void	stop_cmd_ (uint32_t now)

void	retry_pending_command_ (uint32_t now)

void	clear_pending_ ()

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

Protected Member Functions inherited from esphome::EntityBase
friend	void::setup ()

friend	void::original_setup ()

void	configure_entity_ (const char *name, uint32_t object_id_hash, uint32_t entity_fields)
	Combined entity setup from codegen: set name, object_id hash, entity string indices, and flags.

void	set_device_ (Device *device)

ESPPreferenceObject	make_entity_preference_ (size_t size, uint32_t version)
	Non-template helper for make_entity_preference() to avoid code bloat.

void	calc_object_id_ ()

Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

bool	set_error_flag_ (const LogString *message)
	Set the error flag and log it; true when it was not set before.

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 id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

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

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

bool	cancel_interval (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

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 id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

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

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

bool	cancel_timeout (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

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.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes
optional< float >	target_position_ {}

const char *	pending_command_ {nullptr}

uint32_t	pending_command_time_ {0}

uint32_t	last_command_tx_ {0}

char	rx_buffer_ [MAX_RESPONSE_LEN+1]

uint8_t	rx_len_ {0}

uint8_t	command_retries_ {0}

bool	query_s_next_ {true}

Protected Attributes inherited from esphome::cover::Cover
friend	CoverCall

LazyCallbackManager< void()>	state_callback_ {}

ESPPreferenceObject	rtc_

Protected Attributes inherited from esphome::EntityBase
StringRef	name_

uint32_t	object_id_hash_ {}

Device *	device_ {}

struct esphome::EntityBase::EntityFlags	flags_

uint8_t	device_class_idx_ {}

uint8_t	uom_idx_ {}

uint8_t	icon_idx_ {}

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

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

ComponentRuntimeStats	runtime_stats_

Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponent *	parent_ {nullptr}

Static Protected Attributes
static constexpr size_t	MAX_RESPONSE_LEN = 16

static constexpr uint32_t	COMMAND_ACK_MS = 2000

static constexpr uint8_t	MAX_COMMAND_RETRIES = 3

static constexpr uint32_t	COMMAND_QUIET_MS = 250

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::Component
uint32_t	length = 5000)

Data Fields inherited from esphome::uart::UARTDevice
uint8_t	stop_bits = 1

uint8_t UARTParityOptions	parity = UART_CONFIG_PARITY_NONE

uint8_t UARTParityOptions uint8_t	data_bits = 8)

Detailed Description

Definition at line 9 of file apc_proteous_cover.h.

Member Function Documentation

◆ clear_pending_()

void esphome::apc_proteous::APCProteousCover::clear_pending_ ( )

protected

Definition at line 120 of file apc_proteous_cover.cpp.

◆ control()

void esphome::apc_proteous::APCProteousCover::control ( const cover::CoverCall & call )

overrideprotectedvirtual

Implements esphome::cover::Cover.

Definition at line 218 of file apc_proteous_cover.cpp.

◆ dump_config()

void esphome::apc_proteous::APCProteousCover::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 169 of file apc_proteous_cover.cpp.

◆ get_traits()

CoverTraits esphome::apc_proteous::APCProteousCover::get_traits ( )

overridevirtual

Implements esphome::cover::Cover.

Definition at line 174 of file apc_proteous_cover.cpp.

◆ loop()

void esphome::apc_proteous::APCProteousCover::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 29 of file apc_proteous_cover.cpp.

◆ parse_response_()

void esphome::apc_proteous::APCProteousCover::parse_response_ ( )

protected

Definition at line 52 of file apc_proteous_cover.cpp.

◆ retry_pending_command_()

void esphome::apc_proteous::APCProteousCover::retry_pending_command_ ( uint32_t now )

protected

Definition at line 125 of file apc_proteous_cover.cpp.

◆ send_command_()

void esphome::apc_proteous::APCProteousCover::send_command_ ( const char * cmd )

protected

Definition at line 188 of file apc_proteous_cover.cpp.

◆ setup()

void esphome::apc_proteous::APCProteousCover::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 20 of file apc_proteous_cover.cpp.

◆ stop_cmd_()

void esphome::apc_proteous::APCProteousCover::stop_cmd_ ( uint32_t now )

protected

Definition at line 205 of file apc_proteous_cover.cpp.

◆ update()

void esphome::apc_proteous::APCProteousCover::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 148 of file apc_proteous_cover.cpp.

◆ write_command_()

void esphome::apc_proteous::APCProteousCover::write_command_	(	const char *	cmd,
		uint32_t	now )

protected

Definition at line 182 of file apc_proteous_cover.cpp.

Field Documentation

◆ COMMAND_ACK_MS

uint32_t esphome::apc_proteous::APCProteousCover::COMMAND_ACK_MS = 2000

staticconstexprprotected

Definition at line 33 of file apc_proteous_cover.h.

◆ COMMAND_QUIET_MS

uint32_t esphome::apc_proteous::APCProteousCover::COMMAND_QUIET_MS = 250

staticconstexprprotected

Definition at line 38 of file apc_proteous_cover.h.

◆ command_retries_

uint8_t esphome::apc_proteous::APCProteousCover::command_retries_ {0}

protected

Definition at line 48 of file apc_proteous_cover.h.

◆ last_command_tx_

uint32_t esphome::apc_proteous::APCProteousCover::last_command_tx_ {0}

protected

Definition at line 45 of file apc_proteous_cover.h.

◆ MAX_COMMAND_RETRIES

uint8_t esphome::apc_proteous::APCProteousCover::MAX_COMMAND_RETRIES = 3

staticconstexprprotected

Definition at line 34 of file apc_proteous_cover.h.

◆ MAX_RESPONSE_LEN

size_t esphome::apc_proteous::APCProteousCover::MAX_RESPONSE_LEN = 16

staticconstexprprotected

Definition at line 28 of file apc_proteous_cover.h.

◆ pending_command_

const char* esphome::apc_proteous::APCProteousCover::pending_command_ {nullptr}

protected

Definition at line 43 of file apc_proteous_cover.h.

◆ pending_command_time_

uint32_t esphome::apc_proteous::APCProteousCover::pending_command_time_ {0}

protected

Definition at line 44 of file apc_proteous_cover.h.

◆ query_s_next_

bool esphome::apc_proteous::APCProteousCover::query_s_next_ {true}

protected

Definition at line 49 of file apc_proteous_cover.h.

◆ rx_buffer_

char esphome::apc_proteous::APCProteousCover::rx_buffer_[MAX_RESPONSE_LEN+1]

protected

Definition at line 46 of file apc_proteous_cover.h.

◆ rx_len_

uint8_t esphome::apc_proteous::APCProteousCover::rx_len_ {0}

protected

Definition at line 47 of file apc_proteous_cover.h.

◆ target_position_

optional<float> esphome::apc_proteous::APCProteousCover::target_position_ {}

protected

Definition at line 41 of file apc_proteous_cover.h.

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

esphome/components/apc_proteous/apc_proteous_cover.h
esphome/components/apc_proteous/apc_proteous_cover.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clear_pending_()

◆ control()

◆ dump_config()

◆ get_traits()

◆ loop()

◆ parse_response_()

◆ retry_pending_command_()

◆ send_command_()

◆ setup()

◆ stop_cmd_()

◆ update()

◆ write_command_()

Field Documentation

◆ COMMAND_ACK_MS

◆ COMMAND_QUIET_MS

◆ command_retries_

◆ last_command_tx_

◆ MAX_COMMAND_RETRIES

◆ MAX_RESPONSE_LEN

◆ pending_command_

◆ pending_command_time_

◆ query_s_next_

◆ rx_buffer_

◆ rx_len_

◆ target_position_