#include <modbus_output.h>

Inheritance diagram for esphome::modbus_controller::ModbusFloatOutput:

Public Types
using	write_transform_func_t = std::function< optional< float >(ModbusFloatOutput *, float, std::vector< uint16_t > &)>

Public Member Functions
	ModbusFloatOutput (uint16_t start_address, uint8_t offset, SensorValueType value_type, int register_count)

void	dump_config () override

void	set_parent (ModbusController *parent)

void	set_write_multiply (float factor)

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

void	set_write_template (write_transform_func_t &&f)

void	set_use_write_mutiple (bool use_write_multiple)

Public Member Functions inherited from esphome::output::FloatOutput
void	set_max_power (float max_power)
	Set the maximum power output of this component. More...

void	set_min_power (float min_power)
	Set the minimum power output of this component. More...

void	set_zero_means_zero (bool zero_means_zero)
	Sets this output to ignore min_power for a 0 state. More...

void	set_level (float state)
	Set the level of this float output, this is called from the front-end. More...

virtual void	update_frequency (float frequency)
	Set the frequency of the output for PWM outputs. More...

float	get_max_power () const
	Get the maximum power output. More...

float	get_min_power () const
	Get the minimum power output. More...

Public Member Functions inherited from esphome::output::BinaryOutput
void	set_inverted (bool inverted)
	Set the inversion state of this binary output. More...

void	set_power_supply (power_supply::PowerSupply *power_supply)
	Use this to connect up a power supply to this output. More...

virtual void	set_state (bool state)
	Enable or disable this binary output. More...

virtual void	turn_on ()
	Enable this binary output. More...

virtual void	turn_off ()
	Disable this binary output. More...

bool	is_inverted () const
	Return whether this binary output is inverted. More...

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

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::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 Member Functions
void	write_state (float value) override
	Write a value to the device. More...

Protected Member Functions inherited from esphome::output::FloatOutput
void	write_state (bool state) override
	Implement BinarySensor's write_enabled; this should never be called. More...

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 Attributes
optional< write_transform_func_t >	write_transform_func_ {nullopt}

ModbusController *	parent_

float	multiply_by_ {1.0}

bool	use_write_multiple_

Protected Attributes inherited from esphome::output::FloatOutput
float	max_power_ {1.0f}

float	min_power_ {0.0f}

bool	zero_means_zero_

Protected Attributes inherited from esphome::output::BinaryOutput
bool	inverted_ {false}

power_supply::PowerSupplyRequester	power_ {}

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}

Additional Inherited Members
Data Fields inherited from esphome::modbus_controller::SensorItem
ModbusRegisterType	register_type

SensorValueType	sensor_value_type

uint16_t	start_address

uint32_t	bitmask

uint8_t	offset

uint8_t	register_count

uint8_t	response_bytes {0}

uint16_t	skip_updates

std::vector< uint8_t >	custom_data {}

bool	force_new_range {false}

Detailed Description

Definition at line 12 of file modbus_output.h.

Member Typedef Documentation

◆ write_transform_func_t

using esphome::modbus_controller::ModbusFloatOutput::write_transform_func_t = std::function<optional<float>(ModbusFloatOutput *, float, std::vector<uint16_t> &)>

Definition at line 32 of file modbus_output.h.

Constructor & Destructor Documentation

◆ ModbusFloatOutput()

esphome::modbus_controller::ModbusFloatOutput::ModbusFloatOutput	(	uint16_t	start_address,
		uint8_t	offset,
		SensorValueType	value_type,
		int	register_count
	)

inline

Definition at line 14 of file modbus_output.h.

Member Function Documentation

◆ dump_config()

void esphome::modbus_controller::ModbusFloatOutput::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 51 of file modbus_output.cpp.

◆ parse_and_publish()

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

inlineoverridevirtual

Implements esphome::modbus_controller::SensorItem.

Definition at line 30 of file modbus_output.h.

◆ set_parent()

void esphome::modbus_controller::ModbusFloatOutput::set_parent ( ModbusController * parent )

inline

Definition at line 27 of file modbus_output.h.

◆ set_use_write_mutiple()

void esphome::modbus_controller::ModbusFloatOutput::set_use_write_mutiple ( bool use_write_multiple )

inline

Definition at line 34 of file modbus_output.h.

◆ set_write_multiply()

void esphome::modbus_controller::ModbusFloatOutput::set_write_multiply ( float factor )

inline

Definition at line 28 of file modbus_output.h.

◆ set_write_template()

void esphome::modbus_controller::ModbusFloatOutput::set_write_template ( write_transform_func_t && f )

inline

Definition at line 33 of file modbus_output.h.

◆ write_state()

void esphome::modbus_controller::ModbusFloatOutput::write_state ( float value )

overrideprotectedvirtual

Write a value to the device.

Implements esphome::output::FloatOutput.

Definition at line 13 of file modbus_output.cpp.

Field Documentation

◆ multiply_by_

float esphome::modbus_controller::ModbusFloatOutput::multiply_by_ {1.0}

protected

Definition at line 41 of file modbus_output.h.

◆ parent_

ModbusController* esphome::modbus_controller::ModbusFloatOutput::parent_

protected

Definition at line 40 of file modbus_output.h.

◆ use_write_multiple_

bool esphome::modbus_controller::ModbusFloatOutput::use_write_multiple_

protected

Definition at line 42 of file modbus_output.h.

◆ write_transform_func_

optional<write_transform_func_t> esphome::modbus_controller::ModbusFloatOutput::write_transform_func_ {nullopt}

protected

Definition at line 38 of file modbus_output.h.

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

/opt/build/esphome/esphome/components/modbus_controller/output/modbus_output.h
/opt/build/esphome/esphome/components/modbus_controller/output/modbus_output.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ write_transform_func_t

Constructor & Destructor Documentation

◆ ModbusFloatOutput()

Member Function Documentation

◆ dump_config()

◆ parse_and_publish()

◆ set_parent()

◆ set_use_write_mutiple()

◆ set_write_multiply()

◆ set_write_template()

◆ write_state()

Field Documentation

◆ multiply_by_

◆ parent_

◆ use_write_multiple_

◆ write_transform_func_