OneWireBus implementation for DS248x I2C-to-1-Wire bridges. More...

#include <ds248x_one_wire_bus.h>

Inheritance diagram for esphome::ds248x::DS248xOneWireBus:

Public Member Functions
void	setup () override

void	dump_config () override

float	get_setup_priority () const override

void	set_parent (DS248xComponent *parent)
	Set the parent DS248x component.

void	set_channel (uint8_t channel)
	Set the 1-Wire channel (0-7, only relevant for DS2482-800)

uint8_t	get_channel () const
	Get the channel number.

int	reset_int () 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
bool	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)

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.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *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 ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

const LogString *	get_component_log_str () const ESPHOME_ALWAYS_INLINE
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Protected Member Functions
void	reset_search () override

uint64_t	search_int () override

bool	ensure_channel_ ()
	Select the channel on the DS248x before any 1-Wire operation.

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
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

virtual void	call_setup ()

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

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 id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

void	set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

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 id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

void	set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

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.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes
DS248xComponent *	parent_ {nullptr}

uint8_t	channel_ {0}

uint64_t	search_address_ {0}

uint8_t	search_last_discrepancy_ {0}

bool	search_last_device_flag_ {false}

Protected Attributes inherited from esphome::one_wire::OneWireBus
std::vector< uint64_t >	devices_

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

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 Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

ComponentRuntimeStats	runtime_stats_

Detailed Description

OneWireBus implementation for DS248x I2C-to-1-Wire bridges.

This class wraps the DS248xComponent to provide the one_wire::OneWireBus interface, enabling compatibility with all existing 1-Wire device components (dallas_temp, etc.).

For DS2482-800, multiple instances of this class can be created (one per channel). For DS2482-100/DS2484, a single instance is used.

Definition at line 19 of file ds248x_one_wire_bus.h.

Member Function Documentation

◆ dump_config()

void esphome::ds248x::DS248xOneWireBus::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 26 of file ds248x_one_wire_bus.cpp.

◆ ensure_channel_()

bool esphome::ds248x::DS248xOneWireBus::ensure_channel_ ( )

protected

Select the channel on the DS248x before any 1-Wire operation.

Definition at line 31 of file ds248x_one_wire_bus.cpp.

◆ get_channel()

uint8_t esphome::ds248x::DS248xOneWireBus::get_channel ( ) const

inline

Get the channel number.

Definition at line 32 of file ds248x_one_wire_bus.h.

◆ get_setup_priority()

float esphome::ds248x::DS248xOneWireBus::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 23 of file ds248x_one_wire_bus.h.

◆ read64()

uint64_t esphome::ds248x::DS248xOneWireBus::read64 ( )

overridevirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 84 of file ds248x_one_wire_bus.cpp.

◆ read8()

uint8_t esphome::ds248x::DS248xOneWireBus::read8 ( )

overridevirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 73 of file ds248x_one_wire_bus.cpp.

◆ reset_int()

int esphome::ds248x::DS248xOneWireBus::reset_int ( )

overridevirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 39 of file ds248x_one_wire_bus.cpp.

◆ reset_search()

void esphome::ds248x::DS248xOneWireBus::reset_search ( )

overrideprotectedvirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 100 of file ds248x_one_wire_bus.cpp.

◆ search_int()

uint64_t esphome::ds248x::DS248xOneWireBus::search_int ( )

overrideprotectedvirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 106 of file ds248x_one_wire_bus.cpp.

◆ set_channel()

void esphome::ds248x::DS248xOneWireBus::set_channel ( uint8_t channel )

inline

Set the 1-Wire channel (0-7, only relevant for DS2482-800)

Definition at line 29 of file ds248x_one_wire_bus.h.

◆ set_parent()

void esphome::ds248x::DS248xOneWireBus::set_parent ( DS248xComponent * parent )

inline

Set the parent DS248x component.

Definition at line 26 of file ds248x_one_wire_bus.h.

◆ setup()

void esphome::ds248x::DS248xOneWireBus::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file ds248x_one_wire_bus.cpp.

◆ write64()

void esphome::ds248x::DS248xOneWireBus::write64 ( uint64_t val )

overridevirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 60 of file ds248x_one_wire_bus.cpp.

◆ write8()

void esphome::ds248x::DS248xOneWireBus::write8 ( uint8_t val )

overridevirtual

Implements esphome::one_wire::OneWireBus.

Definition at line 51 of file ds248x_one_wire_bus.cpp.

Field Documentation

◆ channel_

uint8_t esphome::ds248x::DS248xOneWireBus::channel_ {0}

protected

Definition at line 49 of file ds248x_one_wire_bus.h.

◆ parent_

DS248xComponent* esphome::ds248x::DS248xOneWireBus::parent_ {nullptr}

protected

Definition at line 48 of file ds248x_one_wire_bus.h.

◆ search_address_

uint64_t esphome::ds248x::DS248xOneWireBus::search_address_ {0}

protected

Definition at line 52 of file ds248x_one_wire_bus.h.

◆ search_last_device_flag_

bool esphome::ds248x::DS248xOneWireBus::search_last_device_flag_ {false}

protected

Definition at line 54 of file ds248x_one_wire_bus.h.

◆ search_last_discrepancy_

uint8_t esphome::ds248x::DS248xOneWireBus::search_last_discrepancy_ {0}

protected

Definition at line 53 of file ds248x_one_wire_bus.h.

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

esphome/components/ds248x/ds248x_one_wire_bus.h
esphome/components/ds248x/ds248x_one_wire_bus.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ dump_config()

◆ ensure_channel_()

◆ get_channel()

◆ get_setup_priority()

◆ read64()

◆ read8()

◆ reset_int()

◆ reset_search()

◆ search_int()

◆ set_channel()

◆ set_parent()

◆ setup()

◆ write64()

◆ write8()

Field Documentation

◆ channel_

◆ parent_

◆ search_address_

◆ search_last_device_flag_

◆ search_last_discrepancy_