#include <modbus_output.h>

Inheritance diagram for esphome::modbus_controller::ModbusBinaryOutput:

Public Types
using	write_transform_func_t = std::function<optional<bool>(ModbusBinaryOutput *, bool, std::vector<uint8_t> &)>

Public Member Functions
	ModbusBinaryOutput (uint16_t start_address, uint8_t offset)

void	dump_config () override

void	set_parent (ModbusController *parent)

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::BinaryOutput
void	set_inverted (bool inverted)
	Set the inversion state of this binary output.

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

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

virtual void	turn_on ()
	Enable this binary output.

virtual void	turn_off ()
	Disable this binary output.

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

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)

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)

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 (bool state) override

Protected Member Functions inherited from esphome::output::BinaryOutput
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.

Protected Attributes
optional< write_transform_func_t >	write_transform_func_ {nullopt}

ModbusController *	parent_ {nullptr}

bool	use_write_multiple_ {false}

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

power_supply::PowerSupplyRequester	power_ {}

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::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}

Detailed Description

Definition at line 45 of file modbus_output.h.

Member Typedef Documentation

◆ write_transform_func_t

using esphome::modbus_controller::ModbusBinaryOutput::write_transform_func_t = std::function<optional<bool>(ModbusBinaryOutput *, bool, std::vector<uint8_t> &)>

Definition at line 63 of file modbus_output.h.

Constructor & Destructor Documentation

◆ ModbusBinaryOutput()

esphome::modbus_controller::ModbusBinaryOutput::ModbusBinaryOutput	(	uint16_t	start_address,
		uint8_t	offset )

inline

Definition at line 47 of file modbus_output.h.

Member Function Documentation

◆ dump_config()

void esphome::modbus_controller::ModbusBinaryOutput::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 104 of file modbus_output.cpp.

◆ parse_and_publish()

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

inlineoverridevirtual

Implements esphome::modbus_controller::SensorItem.

Definition at line 61 of file modbus_output.h.

◆ set_parent()

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

inline

Definition at line 59 of file modbus_output.h.

◆ set_use_write_mutiple()

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

inline

Definition at line 65 of file modbus_output.h.

◆ set_write_template()

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

inline

Definition at line 64 of file modbus_output.h.

◆ write_state()

void esphome::modbus_controller::ModbusBinaryOutput::write_state ( bool state )

overrideprotectedvirtual

Implements esphome::output::BinaryOutput.

Definition at line 63 of file modbus_output.cpp.

Field Documentation

◆ parent_

ModbusController* esphome::modbus_controller::ModbusBinaryOutput::parent_ {nullptr}

protected

Definition at line 71 of file modbus_output.h.

◆ use_write_multiple_

bool esphome::modbus_controller::ModbusBinaryOutput::use_write_multiple_ {false}

protected

Definition at line 72 of file modbus_output.h.

◆ write_transform_func_

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

protected

Definition at line 69 of file modbus_output.h.

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

esphome/components/modbus_controller/output/modbus_output.h
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

◆ ModbusBinaryOutput()

Member Function Documentation

◆ dump_config()

◆ parse_and_publish()

◆ set_parent()

◆ set_use_write_mutiple()

◆ set_write_template()

◆ write_state()

Field Documentation

◆ parent_

◆ use_write_multiple_

◆ write_transform_func_