ESPHome 2026.11.0-dev
Loading...
Searching...
No Matches
esphome::hoermann_hcp::HoermannHcp Class Reference

#include <hoermann_hcp.h>

Inheritance diagram for esphome::hoermann_hcp::HoermannHcp:
esphome::PollingComponent esphome::modbus::ModbusServerDevice esphome::Component

Protected Member Functions

void record_response_ ()
 
bool command_door_ (const HoermannHcpCommand &command)
 
bool queue_command_ (const HoermannHcpCommand &command)
 
void drop_command_ ()
 
void clear_light_request_ ()
 
void push_command_registers_ (modbus::RegisterValues &registers)
 
const HoermannHcpCommand * take_command_ ()
 
const HoermannHcpCommand * take_light_command_ ()
 
void on_position_reg_ (uint16_t value)
 
void on_state_reg_ (uint16_t value)
 
void on_light_reg_ (uint16_t value)
 
void add_identity_request_ (modbus::RegisterValues &registers, uint16_t command)
 
void arm_identity_request_ (IdentityPhase phase)
 
uint8_t identity_request_ () const
 
bool take_identity_request_ ()
 
uint8_t take_identity_transfer_ (const modbus::RegisterValues &registers)
 
void push_transfer_answer_ (modbus::RegisterValues &registers, uint16_t number_of_registers)
 
void publish_identity_ ()
 
void set_valid_ (bool valid)
 
void set_door_state_ (DoorState state)
 
void update_current_position_ ()
 
bool has_target_ () const
 
bool is_moving_or_starting_ () 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.
 
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

CallbackManager< void()> state_callback_
 
float current_position_ {0.0f}
 
float target_position_ {0.0f}
 
const HoermannHcpCommand * next_command_ {nullptr}
 
const HoermannHcpCommand * start_command_ {nullptr}
 
uint32_t command_queued_at_ {0}
 
uint32_t target_queued_at_ {0}
 
uint32_t last_response_ {0}
 
uint32_t light_since_ {0}
 
uint32_t last_stop_at_ {0}
 
uint32_t start_fetched_at_ {0}
 
bool stop_sent_ {false}
 
bool starting_ {false}
 
uint16_t connection_timeout_ms_ {2000}
 
uint16_t start_window_ms_ {5000}
 
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}
 
bool target_started_ {false}
 
bool valid_ {false}
 
bool changed_ {false}
 
bool light_on_ {false}
 
bool light_seen_ {false}
 
bool light_requested_ {false}
 
bool light_command_sent_ {false}
 
bool light_target_ {false}
 
bool door_state_seen_ {false}
 
bool short_broadcast_logged_ {false}
 
bool status_poll_pending_ {false}
 
uint32_t identity_asked_at_ {0}
 
IdentityPhase identity_phase_ {IdentityPhase::IDENTITY_PHASE_IDLE}
 
uint8_t identity_attempts_ {0}
 
uint8_t identity_unanswered_ {0}
 
uint8_t transfer_answer_counter_ {NO_TRANSFER_ANSWER}
 
uint8_t firmware_unreadable_len_ {0}
 
bool serial_unreadable_ {false}
 
bool firmware_unreadable_ {false}
 
char serial_number_ [2 *(SERIAL_FIRST_HALF_REGS+SERIAL_SECOND_HALF_REGS)+1] {}
 
char firmware_version_ [2 *FIRMWARE_REGS+1] {}
 
- 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}
 

Additional Inherited Members

- 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.
 
virtual void update ()=0
 
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 ()
 
 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::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).
 
- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 

Detailed Description

Definition at line 57 of file hoermann_hcp.h.

Member Function Documentation

◆ add_identity_request_()

void esphome::hoermann_hcp::HoermannHcp::add_identity_request_ ( modbus::RegisterValues & registers,
uint16_t command )
protected

Definition at line 360 of file hoermann_hcp.cpp.

◆ arm_identity_request_()

void esphome::hoermann_hcp::HoermannHcp::arm_identity_request_ ( IdentityPhase phase)
protected

Definition at line 376 of file hoermann_hcp.cpp.

◆ clear_light_request_()

void esphome::hoermann_hcp::HoermannHcp::clear_light_request_ ( )
protected

Definition at line 756 of file hoermann_hcp.cpp.

◆ clear_target_()

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

Definition at line 718 of file hoermann_hcp.cpp.

◆ command_door_()

bool esphome::hoermann_hcp::HoermannHcp::command_door_ ( const HoermannHcpCommand & command)
protected

Definition at line 582 of file hoermann_hcp.cpp.

◆ drop_command_()

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

Definition at line 666 of file hoermann_hcp.cpp.

◆ has_target_()

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

Definition at line 139 of file hoermann_hcp.h.

◆ identity_request_()

uint8_t esphome::hoermann_hcp::HoermannHcp::identity_request_ ( ) const
inlineprotected

Definition at line 123 of file hoermann_hcp.h.

◆ is_moving_or_starting_()

bool esphome::hoermann_hcp::HoermannHcp::is_moving_or_starting_ ( ) const
protected

Definition at line 580 of file hoermann_hcp.cpp.

◆ on_light_reg_()

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

Definition at line 555 of file hoermann_hcp.cpp.

◆ on_position_reg_()

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

Definition at line 508 of file hoermann_hcp.cpp.

◆ on_state_reg_()

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

Definition at line 528 of file hoermann_hcp.cpp.

◆ publish_identity_()

void esphome::hoermann_hcp::HoermannHcp::publish_identity_ ( )
protected

Definition at line 468 of file hoermann_hcp.cpp.

◆ push_command_registers_()

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

Definition at line 300 of file hoermann_hcp.cpp.

◆ push_transfer_answer_()

void esphome::hoermann_hcp::HoermannHcp::push_transfer_answer_ ( modbus::RegisterValues & registers,
uint16_t number_of_registers )
protected

Definition at line 460 of file hoermann_hcp.cpp.

◆ queue_command_()

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

Definition at line 560 of file hoermann_hcp.cpp.

◆ record_response_()

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

Definition at line 639 of file hoermann_hcp.cpp.

◆ set_door_state_()

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

Definition at line 671 of file hoermann_hcp.cpp.

◆ set_light_on_()

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

Definition at line 723 of file hoermann_hcp.cpp.

◆ set_light_seen_()

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

Definition at line 764 of file hoermann_hcp.cpp.

◆ set_valid_()

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

Definition at line 644 of file hoermann_hcp.cpp.

◆ take_command_()

const HoermannHcpCommand * esphome::hoermann_hcp::HoermannHcp::take_command_ ( )
protected

Definition at line 313 of file hoermann_hcp.cpp.

◆ take_identity_request_()

bool esphome::hoermann_hcp::HoermannHcp::take_identity_request_ ( )
protected

Definition at line 381 of file hoermann_hcp.cpp.

◆ take_identity_transfer_()

uint8_t esphome::hoermann_hcp::HoermannHcp::take_identity_transfer_ ( const modbus::RegisterValues & registers)
protected

Definition at line 404 of file hoermann_hcp.cpp.

◆ take_light_command_()

const HoermannHcpCommand * esphome::hoermann_hcp::HoermannHcp::take_light_command_ ( )
protected

Definition at line 349 of file hoermann_hcp.cpp.

◆ update_current_position_()

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

Definition at line 703 of file hoermann_hcp.cpp.

Field Documentation

◆ changed_

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

Definition at line 183 of file hoermann_hcp.h.

◆ command_queued_at_

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

Definition at line 153 of file hoermann_hcp.h.

◆ command_reg_value_

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

Definition at line 174 of file hoermann_hcp.h.

◆ connection_timeout_ms_

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

Definition at line 166 of file hoermann_hcp.h.

◆ current_position_

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

Definition at line 147 of file hoermann_hcp.h.

◆ door_state_

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

Definition at line 176 of file hoermann_hcp.h.

◆ door_state_seen_

bool esphome::hoermann_hcp::HoermannHcp::door_state_seen_ {false}
protected

Definition at line 189 of file hoermann_hcp.h.

◆ firmware_unreadable_

bool esphome::hoermann_hcp::HoermannHcp::firmware_unreadable_ {false}
protected

Definition at line 205 of file hoermann_hcp.h.

◆ firmware_unreadable_len_

uint8_t esphome::hoermann_hcp::HoermannHcp::firmware_unreadable_len_ {0}
protected

Definition at line 202 of file hoermann_hcp.h.

◆ firmware_version_

char esphome::hoermann_hcp::HoermannHcp::firmware_version_[2 *FIRMWARE_REGS+1] {}
protected

Definition at line 207 of file hoermann_hcp.h.

◆ identity_asked_at_

uint32_t esphome::hoermann_hcp::HoermannHcp::identity_asked_at_ {0}
protected

Definition at line 195 of file hoermann_hcp.h.

◆ identity_attempts_

uint8_t esphome::hoermann_hcp::HoermannHcp::identity_attempts_ {0}
protected

Definition at line 197 of file hoermann_hcp.h.

◆ identity_phase_

IdentityPhase esphome::hoermann_hcp::HoermannHcp::identity_phase_ {IdentityPhase::IDENTITY_PHASE_IDLE}
protected

Definition at line 196 of file hoermann_hcp.h.

◆ identity_unanswered_

uint8_t esphome::hoermann_hcp::HoermannHcp::identity_unanswered_ {0}
protected

Definition at line 199 of file hoermann_hcp.h.

◆ last_response_

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

Definition at line 156 of file hoermann_hcp.h.

◆ last_stop_at_

uint32_t esphome::hoermann_hcp::HoermannHcp::last_stop_at_ {0}
protected

Definition at line 159 of file hoermann_hcp.h.

◆ light_command_sent_

bool esphome::hoermann_hcp::HoermannHcp::light_command_sent_ {false}
protected

Definition at line 187 of file hoermann_hcp.h.

◆ light_on_

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

Definition at line 184 of file hoermann_hcp.h.

◆ light_requested_

bool esphome::hoermann_hcp::HoermannHcp::light_requested_ {false}
protected

Definition at line 186 of file hoermann_hcp.h.

◆ light_seen_

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

Definition at line 185 of file hoermann_hcp.h.

◆ light_since_

uint32_t esphome::hoermann_hcp::HoermannHcp::light_since_ {0}
protected

Definition at line 158 of file hoermann_hcp.h.

◆ light_target_

bool esphome::hoermann_hcp::HoermannHcp::light_target_ {false}
protected

Definition at line 188 of file hoermann_hcp.h.

◆ next_command_

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

Definition at line 151 of file hoermann_hcp.h.

◆ position_raw_

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

Definition at line 180 of file hoermann_hcp.h.

◆ prev_state_reg_

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

Definition at line 171 of file hoermann_hcp.h.

◆ serial_number_

char esphome::hoermann_hcp::HoermannHcp::serial_number_[2 *(SERIAL_FIRST_HALF_REGS+SERIAL_SECOND_HALF_REGS)+1] {}
protected

Definition at line 206 of file hoermann_hcp.h.

◆ serial_unreadable_

bool esphome::hoermann_hcp::HoermannHcp::serial_unreadable_ {false}
protected

Definition at line 204 of file hoermann_hcp.h.

◆ short_broadcast_logged_

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

Definition at line 190 of file hoermann_hcp.h.

◆ start_command_

const HoermannHcpCommand* esphome::hoermann_hcp::HoermannHcp::start_command_ {nullptr}
protected

Definition at line 152 of file hoermann_hcp.h.

◆ start_fetched_at_

uint32_t esphome::hoermann_hcp::HoermannHcp::start_fetched_at_ {0}
protected

Definition at line 160 of file hoermann_hcp.h.

◆ start_window_ms_

uint16_t esphome::hoermann_hcp::HoermannHcp::start_window_ms_ {5000}
protected

Definition at line 168 of file hoermann_hcp.h.

◆ starting_

bool esphome::hoermann_hcp::HoermannHcp::starting_ {false}
protected

Definition at line 163 of file hoermann_hcp.h.

◆ state_callback_

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

Definition at line 145 of file hoermann_hcp.h.

◆ status_poll_pending_

bool esphome::hoermann_hcp::HoermannHcp::status_poll_pending_ {false}
protected

Definition at line 192 of file hoermann_hcp.h.

◆ stop_sent_

bool esphome::hoermann_hcp::HoermannHcp::stop_sent_ {false}
protected

Definition at line 161 of file hoermann_hcp.h.

◆ target_direction_

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

Definition at line 178 of file hoermann_hcp.h.

◆ target_position_

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

Definition at line 149 of file hoermann_hcp.h.

◆ target_queued_at_

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

Definition at line 155 of file hoermann_hcp.h.

◆ target_started_

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

Definition at line 181 of file hoermann_hcp.h.

◆ transfer_answer_counter_

uint8_t esphome::hoermann_hcp::HoermannHcp::transfer_answer_counter_ {NO_TRANSFER_ANSWER}
protected

Definition at line 200 of file hoermann_hcp.h.

◆ valid_

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

Definition at line 182 of file hoermann_hcp.h.


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