#include <hoermann_hcp.h>

Inheritance diagram for esphome::hoermann_hcp::HoermannHcp:

Public Member Functions
void	update () override

void	dump_config () override

template<typename F >
void	add_on_state_callback (F &&callback)

modbus::ResponseStatus	on_write_registers (uint16_t start_address, const modbus::RegisterValues &registers) override

modbus::ResponseStatus	on_read_holding_registers (uint16_t start_address, uint16_t number_of_registers, modbus::RegisterValues &registers) override

bool	open_door ()

bool	close_door ()

bool	impulse_door ()

bool	stop_door ()

bool	set_position (float position)

bool	toggle_light ()

DoorState	get_door_state () const

float	get_current_position () const

bool	is_valid () const

bool	is_light_on () const

bool	is_light_known () const

bool	is_light_heading_on () const

bool	cancel_light_toggle ()

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 void	setup ()
	Where the component's initialization should happen.

virtual void	loop ()
	This method will be called repeatedly.

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

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

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::modbus::ModbusServerDevice
virtual	~ModbusServerDevice ()=default

	ModbusServerDevice ()=default

	ModbusServerDevice (const ModbusServerDevice &)=delete

ModbusServerDevice &	operator= (const ModbusServerDevice &)=delete

	ModbusServerDevice (ModbusServerDevice &&)=delete

ModbusServerDevice &	operator= (ModbusServerDevice &&)=delete

void	set_address (uint8_t address)

uint8_t	get_address () const

virtual ResponseStatus	on_read_registers (uint16_t start_address, uint16_t number_of_registers, RegisterValues &registers)

virtual ResponseStatus	on_read_input_registers (uint16_t start_address, uint16_t number_of_registers, RegisterValues &registers)

virtual ResponseStatus	on_read_bits (uint16_t start_address, MutablePackedBits bits)
	Coil/discrete-input reads: set the requested bits (bit 0 = the coil at start_address) with bits.set().

virtual ResponseStatus	on_read_coils (uint16_t start_address, MutablePackedBits bits)

virtual ResponseStatus	on_read_discrete_inputs (uint16_t start_address, MutablePackedBits bits)

virtual ResponseStatus	on_write_coils (uint16_t start_address, PackedBits bits)
	Coil writes deliver the values as a PackedBits view over the hub's receive buffer (only valid during the call).

Protected Member Functions
bool	is_light_toggle_pending_ () const

uint8_t	unsent_light_toggles_ () const

void	record_response_ ()

bool	queue_command_ (const HoermannHcpCommand &command)

void	drop_command_ ()

void	light_toggle_settled_ ()

void	forget_light_toggles_ ()

void	push_command_registers_ (modbus::RegisterValues &registers)

void	on_position_reg_ (uint16_t value)

void	on_state_reg_ (uint16_t value)

void	on_light_reg_ (uint16_t value)

void	set_valid_ (bool valid)

void	set_door_state_ (DoorState state)

void	update_current_position_ ()

bool	has_target_ () const

void	clear_target_ ()

void	set_light_on_ (bool on)

void	set_light_seen_ (bool seen)

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.

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
CallbackManager< void()>	state_callback_

float	current_position_ {0.0f}

float	target_position_ {0.0f}

const HoermannHcpCommand *	next_command_ {nullptr}

uint32_t	command_queued_at_ {0}

uint32_t	target_queued_at_ {0}

uint32_t	command_written_at_ {0}

uint32_t	last_response_ {0}

uint32_t	light_toggle_released_at_ {0}

uint16_t	key_press_delay_ms_ {100}

uint16_t	connection_timeout_ms_ {2000}

uint16_t	prev_state_reg_ {0xFFFF}

uint16_t	command_reg_value_ {0}

DoorState	door_state_ {DoorState::CLOSED}

DoorState	target_direction_ {DoorState::STOPPED}

uint8_t	position_raw_ {0}

uint8_t	light_toggles_in_flight_ {0}

bool	target_started_ {false}

bool	valid_ {false}

bool	changed_ {false}

bool	light_on_ {false}

bool	light_seen_ {false}

bool	short_broadcast_logged_ {false}

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::modbus::ModbusServerDevice
uint8_t	address_ {0}

Detailed Description

Definition at line 36 of file hoermann_hcp.h.

Member Function Documentation

◆ add_on_state_callback()

template<typename F >

void esphome::hoermann_hcp::HoermannHcp::add_on_state_callback ( F && callback )

inline

Definition at line 42 of file hoermann_hcp.h.

◆ cancel_light_toggle()

bool esphome::hoermann_hcp::HoermannHcp::cancel_light_toggle ( )

Definition at line 305 of file hoermann_hcp.cpp.

◆ clear_target_()

void esphome::hoermann_hcp::HoermannHcp::clear_target_ ( )

protected

Definition at line 437 of file hoermann_hcp.cpp.

◆ close_door()

bool esphome::hoermann_hcp::HoermannHcp::close_door ( )

Definition at line 287 of file hoermann_hcp.cpp.

◆ drop_command_()

void esphome::hoermann_hcp::HoermannHcp::drop_command_ ( )

protected

Definition at line 371 of file hoermann_hcp.cpp.

◆ dump_config()

void esphome::hoermann_hcp::HoermannHcp::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 97 of file hoermann_hcp.cpp.

◆ forget_light_toggles_()

void esphome::hoermann_hcp::HoermannHcp::forget_light_toggles_ ( )

protected

Definition at line 395 of file hoermann_hcp.cpp.

◆ get_current_position()

float esphome::hoermann_hcp::HoermannHcp::get_current_position ( ) const

inline

Definition at line 62 of file hoermann_hcp.h.

◆ get_door_state()

DoorState esphome::hoermann_hcp::HoermannHcp::get_door_state ( ) const

inline

Definition at line 61 of file hoermann_hcp.h.

◆ has_target_()

bool esphome::hoermann_hcp::HoermannHcp::has_target_ ( ) const

inlineprotected

Definition at line 99 of file hoermann_hcp.h.

◆ impulse_door()

bool esphome::hoermann_hcp::HoermannHcp::impulse_door ( )

Definition at line 288 of file hoermann_hcp.cpp.

◆ is_light_heading_on()

bool esphome::hoermann_hcp::HoermannHcp::is_light_heading_on ( ) const

inline

Definition at line 70 of file hoermann_hcp.h.

◆ is_light_known()

bool esphome::hoermann_hcp::HoermannHcp::is_light_known ( ) const

inline

Definition at line 67 of file hoermann_hcp.h.

◆ is_light_on()

bool esphome::hoermann_hcp::HoermannHcp::is_light_on ( ) const

inline

Definition at line 64 of file hoermann_hcp.h.

◆ is_light_toggle_pending_()

bool esphome::hoermann_hcp::HoermannHcp::is_light_toggle_pending_ ( ) const

protected

Definition at line 299 of file hoermann_hcp.cpp.

◆ is_valid()

bool esphome::hoermann_hcp::HoermannHcp::is_valid ( ) const

inline

Definition at line 63 of file hoermann_hcp.h.

◆ light_toggle_settled_()

void esphome::hoermann_hcp::HoermannHcp::light_toggle_settled_ ( )

protected

Definition at line 384 of file hoermann_hcp.cpp.

◆ on_light_reg_()

void esphome::hoermann_hcp::HoermannHcp::on_light_reg_ ( uint16_t value )

protected

Definition at line 263 of file hoermann_hcp.cpp.

◆ on_position_reg_()

void esphome::hoermann_hcp::HoermannHcp::on_position_reg_ ( uint16_t value )

protected

Definition at line 217 of file hoermann_hcp.cpp.

◆ on_read_holding_registers()

modbus::ResponseStatus esphome::hoermann_hcp::HoermannHcp::on_read_holding_registers	(	uint16_t	start_address,
		uint16_t	number_of_registers,
		modbus::RegisterValues &	registers )

overridevirtual

Reimplemented from esphome::modbus::ModbusServerDevice.

Definition at line 104 of file hoermann_hcp.cpp.

◆ on_state_reg_()

void esphome::hoermann_hcp::HoermannHcp::on_state_reg_ ( uint16_t value )

protected

Definition at line 237 of file hoermann_hcp.cpp.

◆ on_write_registers()

modbus::ResponseStatus esphome::hoermann_hcp::HoermannHcp::on_write_registers	(	uint16_t	start_address,
		const modbus::RegisterValues &	registers )

overridevirtual

Reimplemented from esphome::modbus::ModbusServerDevice.

Definition at line 149 of file hoermann_hcp.cpp.

◆ open_door()

bool esphome::hoermann_hcp::HoermannHcp::open_door ( )

Definition at line 286 of file hoermann_hcp.cpp.

◆ push_command_registers_()

void esphome::hoermann_hcp::HoermannHcp::push_command_registers_ ( modbus::RegisterValues & registers )

protected

Definition at line 186 of file hoermann_hcp.cpp.

◆ queue_command_()

bool esphome::hoermann_hcp::HoermannHcp::queue_command_ ( const HoermannHcpCommand & command )

protected

Definition at line 268 of file hoermann_hcp.cpp.

◆ record_response_()

void esphome::hoermann_hcp::HoermannHcp::record_response_ ( )

protected

Definition at line 346 of file hoermann_hcp.cpp.

◆ set_door_state_()

void esphome::hoermann_hcp::HoermannHcp::set_door_state_ ( DoorState state )

protected

Definition at line 406 of file hoermann_hcp.cpp.

◆ set_light_on_()

void esphome::hoermann_hcp::HoermannHcp::set_light_on_ ( bool on )

protected

Definition at line 442 of file hoermann_hcp.cpp.

◆ set_light_seen_()

void esphome::hoermann_hcp::HoermannHcp::set_light_seen_ ( bool seen )

protected

Definition at line 456 of file hoermann_hcp.cpp.

◆ set_position()

bool esphome::hoermann_hcp::HoermannHcp::set_position ( float position )

Definition at line 324 of file hoermann_hcp.cpp.

◆ set_valid_()

void esphome::hoermann_hcp::HoermannHcp::set_valid_ ( bool valid )

protected

Definition at line 351 of file hoermann_hcp.cpp.

◆ stop_door()

bool esphome::hoermann_hcp::HoermannHcp::stop_door ( )

Definition at line 315 of file hoermann_hcp.cpp.

◆ toggle_light()

bool esphome::hoermann_hcp::HoermannHcp::toggle_light ( )

Definition at line 289 of file hoermann_hcp.cpp.

◆ unsent_light_toggles_()

uint8_t esphome::hoermann_hcp::HoermannHcp::unsent_light_toggles_ ( ) const

protected

Definition at line 301 of file hoermann_hcp.cpp.

◆ update()

void esphome::hoermann_hcp::HoermannHcp::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 60 of file hoermann_hcp.cpp.

◆ update_current_position_()

void esphome::hoermann_hcp::HoermannHcp::update_current_position_ ( )

protected

Definition at line 422 of file hoermann_hcp.cpp.

Field Documentation

◆ changed_

bool esphome::hoermann_hcp::HoermannHcp::changed_ {false}

protected

Definition at line 141 of file hoermann_hcp.h.

◆ command_queued_at_

uint32_t esphome::hoermann_hcp::HoermannHcp::command_queued_at_ {0}

protected

Definition at line 112 of file hoermann_hcp.h.

◆ command_reg_value_

uint16_t esphome::hoermann_hcp::HoermannHcp::command_reg_value_ {0}

protected

Definition at line 130 of file hoermann_hcp.h.

◆ command_written_at_

uint32_t esphome::hoermann_hcp::HoermannHcp::command_written_at_ {0}

protected

Definition at line 115 of file hoermann_hcp.h.

◆ connection_timeout_ms_

uint16_t esphome::hoermann_hcp::HoermannHcp::connection_timeout_ms_ {2000}

protected

Definition at line 124 of file hoermann_hcp.h.

◆ current_position_

float esphome::hoermann_hcp::HoermannHcp::current_position_ {0.0f}

protected

Definition at line 106 of file hoermann_hcp.h.

◆ door_state_

DoorState esphome::hoermann_hcp::HoermannHcp::door_state_ {DoorState::CLOSED}

protected

Definition at line 132 of file hoermann_hcp.h.

◆ key_press_delay_ms_

uint16_t esphome::hoermann_hcp::HoermannHcp::key_press_delay_ms_ {100}

protected

Definition at line 122 of file hoermann_hcp.h.

◆ last_response_

uint32_t esphome::hoermann_hcp::HoermannHcp::last_response_ {0}

protected

Definition at line 116 of file hoermann_hcp.h.

◆ light_on_

bool esphome::hoermann_hcp::HoermannHcp::light_on_ {false}

protected

Definition at line 142 of file hoermann_hcp.h.

◆ light_seen_

bool esphome::hoermann_hcp::HoermannHcp::light_seen_ {false}

protected

Definition at line 143 of file hoermann_hcp.h.

◆ light_toggle_released_at_

uint32_t esphome::hoermann_hcp::HoermannHcp::light_toggle_released_at_ {0}

protected

Definition at line 119 of file hoermann_hcp.h.

◆ light_toggles_in_flight_

uint8_t esphome::hoermann_hcp::HoermannHcp::light_toggles_in_flight_ {0}

protected

Definition at line 138 of file hoermann_hcp.h.

◆ next_command_

const HoermannHcpCommand* esphome::hoermann_hcp::HoermannHcp::next_command_ {nullptr}

protected

Definition at line 111 of file hoermann_hcp.h.

◆ position_raw_

uint8_t esphome::hoermann_hcp::HoermannHcp::position_raw_ {0}

protected

Definition at line 137 of file hoermann_hcp.h.

◆ prev_state_reg_

uint16_t esphome::hoermann_hcp::HoermannHcp::prev_state_reg_ {0xFFFF}

protected

Definition at line 127 of file hoermann_hcp.h.

◆ short_broadcast_logged_

bool esphome::hoermann_hcp::HoermannHcp::short_broadcast_logged_ {false}

protected

Definition at line 144 of file hoermann_hcp.h.

◆ state_callback_

CallbackManager<void()> esphome::hoermann_hcp::HoermannHcp::state_callback_

protected

Definition at line 104 of file hoermann_hcp.h.

◆ target_direction_

DoorState esphome::hoermann_hcp::HoermannHcp::target_direction_ {DoorState::STOPPED}

protected

Definition at line 135 of file hoermann_hcp.h.

◆ target_position_

float esphome::hoermann_hcp::HoermannHcp::target_position_ {0.0f}

protected

Definition at line 108 of file hoermann_hcp.h.

◆ target_queued_at_

uint32_t esphome::hoermann_hcp::HoermannHcp::target_queued_at_ {0}

protected

Definition at line 114 of file hoermann_hcp.h.

◆ target_started_

bool esphome::hoermann_hcp::HoermannHcp::target_started_ {false}

protected

Definition at line 139 of file hoermann_hcp.h.

◆ valid_

bool esphome::hoermann_hcp::HoermannHcp::valid_ {false}

protected

Definition at line 140 of file hoermann_hcp.h.

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

esphome/components/hoermann_hcp/hoermann_hcp.h
esphome/components/hoermann_hcp/hoermann_hcp.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add_on_state_callback()

◆ cancel_light_toggle()

◆ clear_target_()

◆ close_door()

◆ drop_command_()

◆ dump_config()

◆ forget_light_toggles_()

◆ get_current_position()

◆ get_door_state()

◆ has_target_()

◆ impulse_door()

◆ is_light_heading_on()

◆ is_light_known()

◆ is_light_on()

◆ is_light_toggle_pending_()

◆ is_valid()

◆ light_toggle_settled_()

◆ on_light_reg_()

◆ on_position_reg_()

◆ on_read_holding_registers()

◆ on_state_reg_()

◆ on_write_registers()

◆ open_door()

◆ push_command_registers_()

◆ queue_command_()

◆ record_response_()

◆ set_door_state_()

◆ set_light_on_()

◆ set_light_seen_()

◆ set_position()

◆ set_valid_()

◆ stop_door()

◆ toggle_light()

◆ unsent_light_toggles_()

◆ update()

◆ update_current_position_()

Field Documentation

◆ changed_

◆ command_queued_at_

◆ command_reg_value_

◆ command_written_at_

◆ connection_timeout_ms_

◆ current_position_

◆ door_state_

◆ key_press_delay_ms_

◆ last_response_

◆ light_on_

◆ light_seen_

◆ light_toggle_released_at_

◆ light_toggles_in_flight_

◆ next_command_

◆ position_raw_

◆ prev_state_reg_

◆ short_broadcast_logged_

◆ state_callback_

◆ target_direction_

◆ target_position_

◆ target_queued_at_

◆ target_started_

◆ valid_