esphome::output::BinaryOutput Class Reference

#include <binary_output.h>

Inheritance diagram for esphome::output::BinaryOutput:

Public Member Functions
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...

Protected Member Functions
virtual void	write_state (bool state)=0

Protected Attributes
bool	inverted_ {false}
power_supply::PowerSupplyRequester	power_ {}

Detailed Description

Definition at line 18 of file binary_output.h.

Member Function Documentation

is_inverted()

bool esphome::output::BinaryOutput::is_inverted ( ) const

inline

Return whether this binary output is inverted.

Definition at line 61 of file binary_output.h.

set_inverted()

void esphome::output::BinaryOutput::set_inverted ( bool  inverted )

inline

Set the inversion state of this binary output.

Definition at line 21 of file binary_output.h.

set_power_supply()

void esphome::output::BinaryOutput::set_power_supply ( power_supply::PowerSupply *  power_supply )

inline

Use this to connect up a power supply to this output.

Whenever this output is enabled, the power supply will automatically be turned on.

Parameters

power_supply

The PowerSupplyComponent, set this to nullptr to disable the power supply.

Definition at line 30 of file binary_output.h.

set_state()

virtual void esphome::output::BinaryOutput::set_state ( bool  state )

inlinevirtual

Enable or disable this binary output.

Definition at line 34 of file binary_output.h.

turn_off()

virtual void esphome::output::BinaryOutput::turn_off ( )

inlinevirtual

Disable this binary output.

Definition at line 51 of file binary_output.h.

turn_on()

virtual void esphome::output::BinaryOutput::turn_on ( )

inlinevirtual

Enable this binary output.

Definition at line 43 of file binary_output.h.

write_state()

virtual void esphome::output::BinaryOutput::write_state ( bool  state )

protectedpure virtual

Implemented in esphome::output::FloatOutput, esphome::modbus_controller::ModbusBinaryOutput, esphome::ble_client::BLEBinaryOutput, esphome::gpio::GPIOBinaryOutput, esphome::max6956::MAX6956LedChannel, esphome::tm1638::TM1638OutputLed, and esphome::template_::TemplateBinaryOutput.

Field Documentation

inverted_

bool esphome::output::BinaryOutput::inverted_ {false}

protected

Definition at line 66 of file binary_output.h.

power_

power_supply::PowerSupplyRequester esphome::output::BinaryOutput::power_ {}

protected

Definition at line 68 of file binary_output.h.

---

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

• /opt/build/esphome/esphome/components/output/binary_output.h