ESPHome  2024.9.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::gpio::GPIOOneWireBus Class Reference

#include <gpio_one_wire.h>

Inheritance diagram for esphome::gpio::GPIOOneWireBus:
esphome::one_wire::OneWireBus esphome::Component

Public Member Functions

void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void set_pin (InternalGPIOPin *pin)
 
bool reset () override
 
void write8 (uint8_t val) override
 
void write64 (uint64_t val) override
 
uint8_t read8 () override
 
uint64_t read64 () override
 
- Public Member Functions inherited from esphome::one_wire::OneWireBus
void skip ()
 Write a command to the bus that addresses all devices by skipping the ROM. More...
 
bool select (uint64_t address)
 Select a specific address on the bus for the following command. More...
 
const std::vector< uint64_t > & get_devices ()
 Return the list of found devices. More...
 
void search ()
 Search for 1-Wire devices on the bus. More...
 
const LogString * get_model_str (uint8_t model)
 Get the description string for this model. 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 () 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...
 

Protected Member Functions

void reset_search () override
 
uint64_t search_int () override
 
void write_bit_ (bool bit)
 
bool read_bit_ ()
 
- Protected Member Functions inherited from esphome::one_wire::OneWireBus
void dump_devices_ (const char *tag)
 log the found devices 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

InternalGPIOPint_pin_
 
ISRInternalGPIOPin pin_
 
uint8_t last_discrepancy_ {0}
 
bool last_device_flag_ {false}
 
uint64_t address_
 
- Protected Attributes inherited from esphome::one_wire::OneWireBus
std::vector< uint64_t > devices_
 
- 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_one_wire.h.

Member Function Documentation

◆ dump_config()

void esphome::gpio::GPIOOneWireBus::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 19 of file gpio_one_wire.cpp.

◆ get_setup_priority()

float esphome::gpio::GPIOOneWireBus::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 14 of file gpio_one_wire.h.

◆ read64()

uint64_t IRAM_ATTR esphome::gpio::GPIOOneWireBus::read64 ( )
overridevirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 132 of file gpio_one_wire.cpp.

◆ read8()

uint8_t IRAM_ATTR esphome::gpio::GPIOOneWireBus::read8 ( )
overridevirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 124 of file gpio_one_wire.cpp.

◆ read_bit_()

bool HOT IRAM_ATTR esphome::gpio::GPIOOneWireBus::read_bit_ ( )
protected

Definition at line 77 of file gpio_one_wire.cpp.

◆ reset()

bool HOT IRAM_ATTR esphome::gpio::GPIOOneWireBus::reset ( )
overridevirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 25 of file gpio_one_wire.cpp.

◆ reset_search()

void esphome::gpio::GPIOOneWireBus::reset_search ( )
overrideprotectedvirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 140 of file gpio_one_wire.cpp.

◆ search_int()

uint64_t IRAM_ATTR esphome::gpio::GPIOOneWireBus::search_int ( )
overrideprotectedvirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 146 of file gpio_one_wire.cpp.

◆ set_pin()

void esphome::gpio::GPIOOneWireBus::set_pin ( InternalGPIOPin pin)
inline

Definition at line 16 of file gpio_one_wire.h.

◆ setup()

void esphome::gpio::GPIOOneWireBus::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 10 of file gpio_one_wire.cpp.

◆ write64()

void IRAM_ATTR esphome::gpio::GPIOOneWireBus::write64 ( uint64_t  val)
overridevirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 118 of file gpio_one_wire.cpp.

◆ write8()

void IRAM_ATTR esphome::gpio::GPIOOneWireBus::write8 ( uint8_t  val)
overridevirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 112 of file gpio_one_wire.cpp.

◆ write_bit_()

void HOT IRAM_ATTR esphome::gpio::GPIOOneWireBus::write_bit_ ( bool  bit)
protected

Definition at line 55 of file gpio_one_wire.cpp.

Field Documentation

◆ address_

uint64_t esphome::gpio::GPIOOneWireBus::address_
protected

Definition at line 32 of file gpio_one_wire.h.

◆ last_device_flag_

bool esphome::gpio::GPIOOneWireBus::last_device_flag_ {false}
protected

Definition at line 31 of file gpio_one_wire.h.

◆ last_discrepancy_

uint8_t esphome::gpio::GPIOOneWireBus::last_discrepancy_ {0}
protected

Definition at line 30 of file gpio_one_wire.h.

◆ pin_

ISRInternalGPIOPin esphome::gpio::GPIOOneWireBus::pin_
protected

Definition at line 29 of file gpio_one_wire.h.

◆ t_pin_

InternalGPIOPin* esphome::gpio::GPIOOneWireBus::t_pin_
protected

Definition at line 28 of file gpio_one_wire.h.


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