#include <modbus_textsensor.h>

Inheritance diagram for esphome::modbus_controller::ModbusTextSensor:

Public Types
using	transform_func_t = std::function< optional< std::string >(ModbusTextSensor *, std::string, const std::vector< uint8_t > &)>

Public Member Functions
	ModbusTextSensor (ModbusRegisterType register_type, uint16_t start_address, uint8_t offset, uint8_t register_count, uint16_t response_bytes, RawEncoding encode, uint16_t skip_updates, bool force_new_range)

void	dump_config () override

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

void	set_template (transform_func_t &&f)

Public Member Functions inherited from esphome::Component
virtual void	setup ()
	Where the component's initialization should happen. More...

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

virtual float	get_setup_priority () const
	priority of setup(). More...

float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

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

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed. More...

void	mark_failed (const char *message)

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

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

Public Member Functions inherited from esphome::text_sensor::TextSensor
std::string	get_state () const
	Getter-syntax for .state. More...

std::string	get_raw_state () const
	Getter-syntax for .raw_state. More...

void	publish_state (const std::string &state)

void	add_filter (Filter *filter)
	Add a filter to the filter chain. Will be appended to the back. More...

void	add_filters (const std::vector< Filter *> &filters)
	Add a list of vectors to the back of the filter chain. More...

void	set_filters (const std::vector< Filter *> &filters)
	Clear the filters and replace them by filters. More...

void	clear_filters ()
	Clear the entire filter chain. More...

void	add_on_state_callback (std::function< void(std::string)> callback)

void	add_on_raw_state_callback (std::function< void(std::string)> callback)
	Add a callback that will be called every time the sensor sends a raw value. More...

virtual std::string	unique_id ()
	Override this method to set the unique ID of this sensor. More...

bool	has_state ()

void	internal_send_state_to_frontend (const std::string &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)

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

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

Public Member Functions inherited from esphome::modbus_controller::SensorItem
void	set_custom_data (const std::vector< uint8_t > &data)

virtual size_t	get_register_size () const

void	set_register_size (uint8_t register_size)

Protected Attributes
optional< transform_func_t >	transform_func_ {nullopt}

RawEncoding	encode_

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component. More...

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

std::string	error_message_ {}

Protected Attributes inherited from esphome::text_sensor::TextSensor
CallbackManager< void(std::string)>	raw_callback_
	Storage for raw state callbacks. More...

CallbackManager< void(std::string)>	callback_
	Storage for filtered state callbacks. More...

Filter *	filter_list_ {nullptr}
	Store all active filters. More...

bool	has_state_ {false}

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_

bool	has_own_name_ {false}

bool	internal_ {false}

bool	disabled_by_default_ {false}

EntityCategory	entity_category_ {ENTITY_CATEGORY_NONE}

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

Additional Inherited Members
Data Fields inherited from esphome::text_sensor::TextSensor
std::string	state

std::string	raw_state

Data Fields inherited from esphome::modbus_controller::SensorItem
ModbusRegisterType	register_type {ModbusRegisterType::CUSTOM}

SensorValueType	sensor_value_type {SensorValueType::RAW}

uint16_t	start_address {0}

uint32_t	bitmask {0}

uint8_t	offset {0}

uint8_t	register_count {0}

uint8_t	response_bytes {0}

uint16_t	skip_updates {0}

std::vector< uint8_t >	custom_data {}

bool	force_new_range {false}

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

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

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

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

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

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

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

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

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

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

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

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

void	calc_object_id_ ()

Detailed Description

Definition at line 14 of file modbus_textsensor.h.

Member Typedef Documentation

◆ transform_func_t

using esphome::modbus_controller::ModbusTextSensor::transform_func_t = std::function<optional<std::string>(ModbusTextSensor *, std::string, const std::vector<uint8_t> &)>

Definition at line 34 of file modbus_textsensor.h.

Constructor & Destructor Documentation

◆ ModbusTextSensor()

esphome::modbus_controller::ModbusTextSensor::ModbusTextSensor	(	ModbusRegisterType	register_type,
		uint16_t	start_address,
		uint8_t	offset,
		uint8_t	register_count,
		uint16_t	response_bytes,
		RawEncoding	encode,
		uint16_t	skip_updates,
		bool	force_new_range
	)

inline

Definition at line 16 of file modbus_textsensor.h.

Member Function Documentation

◆ dump_config()

void esphome::modbus_controller::ModbusTextSensor::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 10 of file modbus_textsensor.cpp.

◆ parse_and_publish()

void esphome::modbus_controller::ModbusTextSensor::parse_and_publish ( const std::vector< uint8_t > & data )

overridevirtual

Implements esphome::modbus_controller::SensorItem.

Definition at line 12 of file modbus_textsensor.cpp.

◆ set_template()

void esphome::modbus_controller::ModbusTextSensor::set_template ( transform_func_t && f )

inline

Definition at line 35 of file modbus_textsensor.h.

Field Documentation

◆ encode_

RawEncoding esphome::modbus_controller::ModbusTextSensor::encode_

protected

Definition at line 40 of file modbus_textsensor.h.

◆ transform_func_

optional<transform_func_t> esphome::modbus_controller::ModbusTextSensor::transform_func_ {nullopt}

protected

Definition at line 38 of file modbus_textsensor.h.

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

/opt/build/esphome/esphome/components/modbus_controller/text_sensor/modbus_textsensor.h
/opt/build/esphome/esphome/components/modbus_controller/text_sensor/modbus_textsensor.cpp

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members