#include <mcp4461_output.h>

Inheritance diagram for esphome::mcp4461::Mcp4461Wiper:

Public Member Functions
	Mcp4461Wiper (Mcp4461Component *parent, Mcp4461WiperIdx wiper)

void	set_level (float state)
	Set level of wiper. More...

void	set_state (bool state) override
	Enables/Disables current output using bool parameter. More...

void	turn_on () override
	Enables current output. More...

void	turn_off () override
	Disables current output. More...

float	read_state ()
	Read current device wiper state without updating internal output state. More...

float	update_state ()
	Update current output state using device wiper state. More...

void	increase_wiper ()
	Increase wiper by 1 tap. More...

void	decrease_wiper ()
	Decrease wiper by 1 tap. More...

void	enable_terminal (char terminal)
	Enable given terminal. More...

void	disable_terminal (char terminal)
	Disable given terminal. More...

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

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

Public Member Functions inherited from esphome::Parented< Mcp4461Component >
	Parented ()

	Parented (Mcp4461Component *parent)

Mcp4461Component *	get_parent () const
	Get the parent of this object. More...

void	set_parent (Mcp4461Component *parent)
	Set the parent of this object. More...

Protected Member Functions
void	write_state (float state) override

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 Attributes
Mcp4461Component *	parent_

Mcp4461WiperIdx	wiper_

float	state_

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::Parented< Mcp4461Component >
Mcp4461Component *	parent_

Detailed Description

Definition at line 11 of file mcp4461_output.h.

Constructor & Destructor Documentation

◆ Mcp4461Wiper()

esphome::mcp4461::Mcp4461Wiper::Mcp4461Wiper	(	Mcp4461Component *	parent,
		Mcp4461WiperIdx	wiper
	)

inline

Definition at line 13 of file mcp4461_output.h.

Member Function Documentation

◆ decrease_wiper()

void esphome::mcp4461::Mcp4461Wiper::decrease_wiper ( )

Decrease wiper by 1 tap.

Definition at line 60 of file mcp4461_output.cpp.

◆ disable_terminal()

void esphome::mcp4461::Mcp4461Wiper::disable_terminal ( char terminal )

Disable given terminal.

Parameters

[in] terminal single char parameter defining desired terminal to disable, one of { 'a', 'b', 'w', 'h' }

Definition at line 70 of file mcp4461_output.cpp.

◆ enable_terminal()

void esphome::mcp4461::Mcp4461Wiper::enable_terminal ( char terminal )

Enable given terminal.

Parameters

[in] terminal single char parameter defining desired terminal to enable, one of { 'a', 'b', 'w', 'h' }

Definition at line 68 of file mcp4461_output.cpp.

◆ increase_wiper()

void esphome::mcp4461::Mcp4461Wiper::increase_wiper ( )

Increase wiper by 1 tap.

Definition at line 52 of file mcp4461_output.cpp.

◆ read_state()

float esphome::mcp4461::Mcp4461Wiper::read_state ( )

Read current device wiper state without updating internal output state.

Returns: float - current device state as float in range 0 - 1.0

Definition at line 33 of file mcp4461_output.cpp.

◆ set_level()

void esphome::mcp4461::Mcp4461Wiper::set_level ( float state )

Set level of wiper.

Parameters

[in] state - The desired float level in range 0-1.0

Definition at line 13 of file mcp4461_output.cpp.

◆ set_state()

void esphome::mcp4461::Mcp4461Wiper::set_state ( bool state )

overridevirtual

Enables/Disables current output using bool parameter.

Parameters

[in] state boolean var representing desired state (true=ON, false=OFF)

Reimplemented from esphome::output::BinaryOutput.

Definition at line 40 of file mcp4461_output.cpp.

◆ turn_off()

void esphome::mcp4461::Mcp4461Wiper::turn_off ( )

overridevirtual

Disables current output.

Reimplemented from esphome::output::BinaryOutput.

Definition at line 50 of file mcp4461_output.cpp.

◆ turn_on()

void esphome::mcp4461::Mcp4461Wiper::turn_on ( )

overridevirtual

Enables current output.

Reimplemented from esphome::output::BinaryOutput.

Definition at line 48 of file mcp4461_output.cpp.

◆ update_state()

float esphome::mcp4461::Mcp4461Wiper::update_state ( )

Update current output state using device wiper state.

Returns: float - current updated output state as float in range 0 - 1.0

Definition at line 35 of file mcp4461_output.cpp.

◆ write_state()

void esphome::mcp4461::Mcp4461Wiper::write_state ( float state )

overrideprotectedvirtual

Implements esphome::output::FloatOutput.

Definition at line 27 of file mcp4461_output.cpp.

Field Documentation

◆ parent_

Mcp4461Component* esphome::mcp4461::Mcp4461Wiper::parent_

protected

Definition at line 43 of file mcp4461_output.h.

◆ state_

float esphome::mcp4461::Mcp4461Wiper::state_

protected

Definition at line 45 of file mcp4461_output.h.

◆ wiper_

Mcp4461WiperIdx esphome::mcp4461::Mcp4461Wiper::wiper_

protected

Definition at line 44 of file mcp4461_output.h.

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

/opt/build/esphome/esphome/components/mcp4461/output/mcp4461_output.h
/opt/build/esphome/esphome/components/mcp4461/output/mcp4461_output.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Mcp4461Wiper()

Member Function Documentation

◆ decrease_wiper()

◆ disable_terminal()

◆ enable_terminal()

◆ increase_wiper()

◆ read_state()

◆ set_level()

◆ set_state()

◆ turn_off()

◆ turn_on()

◆ update_state()

◆ write_state()

Field Documentation

◆ parent_

◆ state_

◆ wiper_