ESPHome 2026.8.0-dev
Loading...
Searching...
No Matches
esphome::ds248x::DS248xComponent Class Reference

DS248x I2C-to-1-Wire Bridge Component. More...

#include <ds248x.h>

Inheritance diagram for esphome::ds248x::DS248xComponent:
esphome::Component esphome::i2c::I2CDevice

Public Member Functions

void setup () override
 
void dump_config () override
 
void on_shutdown () override
 
float get_setup_priority () const override
 
void set_sleep_pin (InternalGPIOPin *pin)
 
void set_bus_sleep (bool enabled)
 
void set_hub_sleep (bool enabled)
 
void set_channel_count (uint8_t count)
 
void set_active_pullup (bool enabled)
 
void set_val_trstl (uint8_t val)
 
void set_val_tmsp (uint8_t val)
 
void set_val_tw0l (uint8_t val)
 
void set_val_trec0 (uint8_t val)
 
void set_val_rwpu (uint8_t val)
 
uint8_t get_channel_count () const
 Get the channel count (1 for DS2482-100/DS2484, 8 for DS2482-800)
 
bool select_channel (uint8_t channel)
 
bool ow_reset (bool &presence)
 
bool ow_write_byte (uint8_t byte)
 
bool ow_read_byte (uint8_t &byte)
 
bool search_triplet (bool search_direction, uint8_t &status)
 
- 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_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)
 
- Public Member Functions inherited from esphome::i2c::I2CDevice
 I2CDevice ()=default
 we use the C++ default constructor
 
void set_i2c_address (uint8_t address)
 We store the address of the device on the bus.
 
uint8_t get_i2c_address () const
 Returns the I2C address of the object.
 
void set_i2c_bus (I2CBus *bus)
 we store the pointer to the I2CBus to use
 
I2CRegister reg (uint8_t a_register)
 calls the I2CRegister constructor
 
I2CRegister16 reg16 (uint16_t a_register)
 calls the I2CRegister16 constructor
 
ErrorCode read (uint8_t *data, size_t len) const
 reads an array of bytes from the device using an I2CBus
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len)
 reads an array of bytes from a specific register in the I²C device
 
ErrorCode read_register16 (uint16_t a_register, uint8_t *data, size_t len)
 reads an array of bytes from a specific register in the I²C device
 
ErrorCode write (const uint8_t *data, size_t len) const
 writes an array of bytes to a device using an I2CBus
 
ErrorCode write_read (const uint8_t *write_data, size_t write_len, uint8_t *read_data, size_t read_len) const
 writes an array of bytes to a device, then reads an array, as a single transaction
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len) const
 writes an array of bytes to a specific register in the I²C device
 
ErrorCode write_register16 (uint16_t a_register, const uint8_t *data, size_t len) const
 write an array of bytes to a specific register in the I²C device
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 Compat APIs All methods below have been added for compatibility reasons.
 
bool read_bytes_raw (uint8_t *data, uint8_t len) const
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
 
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
 
bool read_byte (uint8_t a_register, uint8_t *data)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len) const
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data) const
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len) const
 
bool write_byte (uint8_t a_register, uint8_t data) const
 
bool write_byte_16 (uint8_t a_register, uint16_t data) const
 

Protected Member Functions

bool set_read_pointer_ (uint8_t ptr)
 
bool wait_busy_ ()
 
bool device_reset_ ()
 
bool device_configure_ ()
 
bool configure_ds2484_port_ (uint8_t param, uint8_t val)
 
bool write_config_ ()
 
- 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

InternalGPIOPinsleep_pin_ {nullptr}
 
uint8_t channel_count_ = 1
 
bool bus_sleep_ {false}
 
bool hub_sleep_ {false}
 
bool active_pullup_ = false
 
bool ds2484_mode_ = false
 
uint8_t ds2484_trstl_ {DS2484_PARAM_UNSET}
 
uint8_t ds2484_tmsp_ {DS2484_PARAM_UNSET}
 
uint8_t ds2484_tw0l_ {DS2484_PARAM_UNSET}
 
uint8_t ds2484_trec0_ {DS2484_PARAM_UNSET}
 
uint8_t ds2484_rwpu_ {DS2484_PARAM_UNSET}
 
int8_t current_channel_ {-1}
 
- 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_
 
- Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t address_ {0x00}
 store the address of the device on the bus
 
I2CBusbus_ {nullptr}
 pointer to I2CBus instance
 

Static Protected Attributes

static constexpr uint8_t DS2484_PARAM_UNSET = 0xFF
 

Detailed Description

DS248x I2C-to-1-Wire Bridge Component.

This component manages the DS248x chip (DS2482-100, DS2482-800, DS2484). It provides low-level 1-Wire bus operations via I2C.

Usage: Configure DS248xOneWireBus instances for each channel. These buses implement the one_wire::OneWireBus interface for compatibility with all existing 1-Wire device components (dallas_temp, etc.).

Definition at line 59 of file ds248x.h.

Member Function Documentation

◆ configure_ds2484_port_()

bool esphome::ds248x::DS248xComponent::configure_ds2484_port_ ( uint8_t param,
uint8_t val )
protected

Definition at line 138 of file ds248x.cpp.

◆ device_configure_()

bool esphome::ds248x::DS248xComponent::device_configure_ ( )
protected

Definition at line 106 of file ds248x.cpp.

◆ device_reset_()

bool esphome::ds248x::DS248xComponent::device_reset_ ( )
protected

Definition at line 87 of file ds248x.cpp.

◆ dump_config()

void esphome::ds248x::DS248xComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 52 of file ds248x.cpp.

◆ get_channel_count()

uint8_t esphome::ds248x::DS248xComponent::get_channel_count ( ) const
inline

Get the channel count (1 for DS2482-100/DS2484, 8 for DS2482-800)

Definition at line 95 of file ds248x.h.

◆ get_setup_priority()

float esphome::ds248x::DS248xComponent::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 64 of file ds248x.h.

◆ on_shutdown()

void esphome::ds248x::DS248xComponent::on_shutdown ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 46 of file ds248x.cpp.

◆ ow_read_byte()

bool esphome::ds248x::DS248xComponent::ow_read_byte ( uint8_t & byte)

Definition at line 280 of file ds248x.cpp.

◆ ow_reset()

bool esphome::ds248x::DS248xComponent::ow_reset ( bool & presence)

Definition at line 229 of file ds248x.cpp.

◆ ow_write_byte()

bool esphome::ds248x::DS248xComponent::ow_write_byte ( uint8_t byte)

Definition at line 257 of file ds248x.cpp.

◆ search_triplet()

bool esphome::ds248x::DS248xComponent::search_triplet ( bool search_direction,
uint8_t & status )

Definition at line 300 of file ds248x.cpp.

◆ select_channel()

bool esphome::ds248x::DS248xComponent::select_channel ( uint8_t channel)

Definition at line 194 of file ds248x.cpp.

◆ set_active_pullup()

void esphome::ds248x::DS248xComponent::set_active_pullup ( bool enabled)
inline

Definition at line 70 of file ds248x.h.

◆ set_bus_sleep()

void esphome::ds248x::DS248xComponent::set_bus_sleep ( bool enabled)
inline

Definition at line 67 of file ds248x.h.

◆ set_channel_count()

void esphome::ds248x::DS248xComponent::set_channel_count ( uint8_t count)
inline

Definition at line 69 of file ds248x.h.

◆ set_hub_sleep()

void esphome::ds248x::DS248xComponent::set_hub_sleep ( bool enabled)
inline

Definition at line 68 of file ds248x.h.

◆ set_read_pointer_()

bool esphome::ds248x::DS248xComponent::set_read_pointer_ ( uint8_t ptr)
protected

Definition at line 67 of file ds248x.cpp.

◆ set_sleep_pin()

void esphome::ds248x::DS248xComponent::set_sleep_pin ( InternalGPIOPin * pin)
inline

Definition at line 66 of file ds248x.h.

◆ set_val_rwpu()

void esphome::ds248x::DS248xComponent::set_val_rwpu ( uint8_t val)
inline

Definition at line 89 of file ds248x.h.

◆ set_val_tmsp()

void esphome::ds248x::DS248xComponent::set_val_tmsp ( uint8_t val)
inline

Definition at line 77 of file ds248x.h.

◆ set_val_trec0()

void esphome::ds248x::DS248xComponent::set_val_trec0 ( uint8_t val)
inline

Definition at line 85 of file ds248x.h.

◆ set_val_trstl()

void esphome::ds248x::DS248xComponent::set_val_trstl ( uint8_t val)
inline

Definition at line 73 of file ds248x.h.

◆ set_val_tw0l()

void esphome::ds248x::DS248xComponent::set_val_tw0l ( uint8_t val)
inline

Definition at line 81 of file ds248x.h.

◆ setup()

void esphome::ds248x::DS248xComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file ds248x.cpp.

◆ wait_busy_()

bool esphome::ds248x::DS248xComponent::wait_busy_ ( )
protected

Definition at line 69 of file ds248x.cpp.

◆ write_config_()

bool esphome::ds248x::DS248xComponent::write_config_ ( )
protected

Definition at line 157 of file ds248x.cpp.

Field Documentation

◆ active_pullup_

bool esphome::ds248x::DS248xComponent::active_pullup_ = false
protected

Definition at line 111 of file ds248x.h.

◆ bus_sleep_

bool esphome::ds248x::DS248xComponent::bus_sleep_ {false}
protected

Definition at line 109 of file ds248x.h.

◆ channel_count_

uint8_t esphome::ds248x::DS248xComponent::channel_count_ = 1
protected

Definition at line 108 of file ds248x.h.

◆ current_channel_

int8_t esphome::ds248x::DS248xComponent::current_channel_ {-1}
protected

Definition at line 122 of file ds248x.h.

◆ ds2484_mode_

bool esphome::ds248x::DS248xComponent::ds2484_mode_ = false
protected

Definition at line 114 of file ds248x.h.

◆ DS2484_PARAM_UNSET

uint8_t esphome::ds248x::DS248xComponent::DS2484_PARAM_UNSET = 0xFF
staticconstexprprotected

Definition at line 115 of file ds248x.h.

◆ ds2484_rwpu_

uint8_t esphome::ds248x::DS248xComponent::ds2484_rwpu_ {DS2484_PARAM_UNSET}
protected

Definition at line 120 of file ds248x.h.

◆ ds2484_tmsp_

uint8_t esphome::ds248x::DS248xComponent::ds2484_tmsp_ {DS2484_PARAM_UNSET}
protected

Definition at line 117 of file ds248x.h.

◆ ds2484_trec0_

uint8_t esphome::ds248x::DS248xComponent::ds2484_trec0_ {DS2484_PARAM_UNSET}
protected

Definition at line 119 of file ds248x.h.

◆ ds2484_trstl_

uint8_t esphome::ds248x::DS248xComponent::ds2484_trstl_ {DS2484_PARAM_UNSET}
protected

Definition at line 116 of file ds248x.h.

◆ ds2484_tw0l_

uint8_t esphome::ds248x::DS248xComponent::ds2484_tw0l_ {DS2484_PARAM_UNSET}
protected

Definition at line 118 of file ds248x.h.

◆ hub_sleep_

bool esphome::ds248x::DS248xComponent::hub_sleep_ {false}
protected

Definition at line 110 of file ds248x.h.

◆ sleep_pin_

InternalGPIOPin* esphome::ds248x::DS248xComponent::sleep_pin_ {nullptr}
protected

Definition at line 107 of file ds248x.h.


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