ESPHome  2021.10.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::gpio::GPIOBinaryOutput Class Reference

#include <gpio_binary_output.h>

Inheritance diagram for esphome::gpio::GPIOBinaryOutput:
esphome::output::BinaryOutput esphome::Component

Public Member Functions

void set_pin (GPIOPin *pin)
void setup () override
void dump_config () override
float get_setup_priority () const override
- 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 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 loop ()
 This method will be called repeatedly. 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 ()
virtual bool can_proceed ()
bool status_has_warning ()
bool status_has_error ()
void status_set_warning ()
void status_set_error ()
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...

Protected Member Functions

void write_state (bool state) override
- 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_timeout (uint32_t timeout, std::function< void()> &&f)
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
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

- 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

Detailed Description

Definition at line 10 of file gpio_binary_output.h.

Member Function Documentation

◆ dump_config()

void esphome::gpio::GPIOBinaryOutput::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 9 of file gpio_binary_output.cpp.

◆ get_setup_priority()

float esphome::gpio::GPIOBinaryOutput::get_setup_priority ( ) const

Reimplemented from esphome::Component.

Definition at line 20 of file gpio_binary_output.h.

◆ set_pin()

void esphome::gpio::GPIOBinaryOutput::set_pin ( GPIOPin pin)

Definition at line 12 of file gpio_binary_output.h.

◆ setup()

void esphome::gpio::GPIOBinaryOutput::setup ( )

Reimplemented from esphome::Component.

Definition at line 14 of file gpio_binary_output.h.

◆ write_state()

void esphome::gpio::GPIOBinaryOutput::write_state ( bool  state)

Implements esphome::output::BinaryOutput.

Definition at line 23 of file gpio_binary_output.h.

Field Documentation

◆ pin_

GPIOPin* esphome::gpio::GPIOBinaryOutput::pin_

Definition at line 25 of file gpio_binary_output.h.

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