#include <gpio_one_wire.h>

Inheritance diagram for esphome::gpio::GPIOOneWireBus:

Public Member Functions
void	setup () override

void	dump_config () override

float	get_setup_priority () const override

void	set_pin (InternalGPIOPin *pin)

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.

bool	select (uint64_t address)
	Select a specific address on the bus for the following command.

const std::vector< uint64_t > &	get_devices ()
	Return the list of found devices.

void	search ()
	Search for 1-Wire devices on the bus.

const LogString *	get_model_str (uint8_t model)
	Get the description string for this model.

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

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.

bool	is_idle () const
	Check if this component is idle.

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)

Protected Member Functions
int	reset_int () override

void	reset_search () override

uint64_t	search_int () override

void	write_bit_ (bool bit)

bool	read_bit_ ()

bool	read_bit_ (uint32_t *t)

Protected Member Functions inherited from esphome::one_wire::OneWireBus
void	dump_devices_ (const char *tag)
	log the found devices

bool	reset_ ()
	Reset the bus, should be done before all write operations.

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
InternalGPIOPin *	t_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
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.

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 20 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 131 of file gpio_one_wire.cpp.

◆ read8()

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

overridevirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 123 of file gpio_one_wire.cpp.

◆ read_bit_() [1/2]

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

protected

Definition at line 87 of file gpio_one_wire.cpp.

◆ read_bit_() [2/2]

bool esphome::gpio::GPIOOneWireBus::read_bit_ ( uint32_t * t )

protected

◆ reset_int()

int HOT IRAM_ATTR esphome::gpio::GPIOOneWireBus::reset_int ( )

overrideprotectedvirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 26 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 116 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 109 of file gpio_one_wire.cpp.

◆ write_bit_()

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

protected

Definition at line 66 of file gpio_one_wire.cpp.

Field Documentation

◆ address_

uint64_t esphome::gpio::GPIOOneWireBus::address_

protected

Definition at line 31 of file gpio_one_wire.h.

◆ last_device_flag_

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

protected

Definition at line 30 of file gpio_one_wire.h.

◆ last_discrepancy_

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

protected

Definition at line 29 of file gpio_one_wire.h.

◆ pin_

ISRInternalGPIOPin esphome::gpio::GPIOOneWireBus::pin_

protected

Definition at line 28 of file gpio_one_wire.h.

◆ t_pin_

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

protected

Definition at line 27 of file gpio_one_wire.h.

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

esphome/components/gpio/one_wire/gpio_one_wire.h
esphome/components/gpio/one_wire/gpio_one_wire.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ dump_config()

◆ get_setup_priority()

◆ read64()

◆ read8()

◆ read_bit_() [1/2]

◆ read_bit_() [2/2]

◆ reset_int()

◆ reset_search()

◆ search_int()

◆ set_pin()

◆ setup()

◆ write64()

◆ write8()

◆ write_bit_()

Field Documentation

◆ address_

◆ last_device_flag_

◆ last_discrepancy_

◆ pin_

◆ t_pin_