#include <vbus_binary_sensor.h>

Inheritance diagram for esphome::vbus::VBusCustomSubBSensor:

Public Member Functions
void	set_message_parser (message_parser_t parser)

void	parse_message (std::vector< uint8_t > &message)

Public Member Functions inherited from esphome::binary_sensor::BinarySensor
	BinarySensor ()

void	publish_state (bool new_state)
	Publish a new state to the front-end.

void	publish_initial_state (bool new_state)
	Publish the initial state, this will not make the callback manager send callbacks and is meant only for the initial state on boot.

void	add_filter (Filter *filter)

void	add_filters (const std::vector< Filter * > &filters)

void	send_state_internal (bool new_state)

virtual bool	is_status_binary_sensor () const
	Return whether this binary sensor has outputted a state.

Public Member Functions inherited from esphome::StatefulEntityBase< bool >
virtual bool	has_state () const

virtual const bool &	get_state () const

virtual bool	get_state_default (bool default_value) const

void	invalidate_state ()

void	add_full_state_callback (std::function< void(optional< bool > previous, optional< bool > current)> &&callback)

void	add_on_state_callback (std::function< void(bool)> &&callback)

void	set_trigger_on_initial_state (bool trigger_on_initial_state)

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)

StringRef	get_icon_ref () const

uint32_t	get_device_id () const

void	set_device (Device *device)

bool	has_state () const

void	set_has_state (bool state)

uint32_t	get_preference_hash ()
	Get a unique hash for storing preferences/settings for this entity.

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.

StringRef	get_device_class_ref () const
	Get the device class as StringRef.

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

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=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error (const char *message=nullptr)

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 LogString *source)
	Set where this component was loaded from for some debug messages.

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

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Attributes
message_parser_t	message_parser_

Protected Attributes inherited from esphome::binary_sensor::BinarySensor
Filter *	filter_list_ {nullptr}

Protected Attributes inherited from esphome::StatefulEntityBase< bool >
optional< bool >	state_

bool	trigger_on_initial_state_

CallbackManager< void(optional< bool > previous, optional< bool > current)> *	full_state_callbacks_

CallbackManager< void(bool)> *	state_callbacks_

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::Component
const LogString *	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-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion.

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

Additional Inherited Members
Data Fields inherited from esphome::binary_sensor::BinarySensor
bool	state {}

Protected Member Functions inherited from esphome::StatefulEntityBase< bool >
bool	set_state_ (const optional< bool > &state)
	Set a new state for this entity.

Protected Member Functions inherited from esphome::EntityBase
StringRef	get_object_id_ref_for_api_ () const

virtual uint32_t	hash_base ()
	The hash_base() function has been deprecated.

void	calc_object_id_ ()

bool	is_object_id_dynamic_ () const
	Check if the object_id is dynamic (changes with MAC suffix)

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

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

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.

Detailed Description

Definition at line 126 of file vbus_binary_sensor.h.

Member Function Documentation

◆ parse_message()

void esphome::vbus::VBusCustomSubBSensor::parse_message ( std::vector< uint8_t > & message )

Definition at line 160 of file vbus_binary_sensor.cpp.

◆ set_message_parser()

void esphome::vbus::VBusCustomSubBSensor::set_message_parser ( message_parser_t parser )

inline

Definition at line 128 of file vbus_binary_sensor.h.

Field Documentation

◆ message_parser_

message_parser_t esphome::vbus::VBusCustomSubBSensor::message_parser_

protected

Definition at line 132 of file vbus_binary_sensor.h.

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

esphome/components/vbus/binary_sensor/vbus_binary_sensor.h
esphome/components/vbus/binary_sensor/vbus_binary_sensor.cpp

Public Member Functions