esphome::one_wire::OneWireDevice Class Reference

#include <one_wire.h>

Inheritance diagram for esphome::one_wire::OneWireDevice:

Public Member Functions
void	set_address (uint64_t address)
	store the address of the device
void	set_index (uint8_t index)
void	set_one_wire_bus (OneWireBus *bus)
	store the pointer to the OneWireBus to use
const std::string &	get_address_name ()
	Helper to create (and cache) the name for this sensor. For example "0xfe0000031f1eaf29".

Protected Member Functions
bool	check_address_or_index_ ()
	find an address if necessary should be called from setup
bool	send_command_ (uint8_t cmd)
	send command on the bus

Protected Attributes
uint64_t	address_ {0}
uint8_t	index_ {INDEX_NOT_SET}
OneWireBus *	bus_ {nullptr}
	pointer to OneWireBus instance
std::string	address_name_

Static Protected Attributes
static constexpr uint8_t	INDEX_NOT_SET = 255

Detailed Description

Definition at line 14 of file one_wire.h.

Member Function Documentation

check_address_or_index_()

bool esphome::one_wire::OneWireDevice::check_address_or_index_ ( )

protected

find an address if necessary should be called from setup

Definition at line 21 of file one_wire.cpp.

get_address_name()

const std::string & esphome::one_wire::OneWireDevice::get_address_name

(

)

Helper to create (and cache) the name for this sensor. For example "0xfe0000031f1eaf29".

Definition at line 8 of file one_wire.cpp.

send_command_()

bool esphome::one_wire::OneWireDevice::send_command_ ( uint8_t cmd )

protected

send command on the bus

Parameters

cmd	command to send

Definition at line 14 of file one_wire.cpp.

set_address()

void esphome::one_wire::OneWireDevice::set_address ( uint64_t address )

inline

store the address of the device

Parameters

address

of the device

Definition at line 18 of file one_wire.h.

set_index()

void esphome::one_wire::OneWireDevice::set_index ( uint8_t index )

inline

Definition at line 20 of file one_wire.h.

set_one_wire_bus()

void esphome::one_wire::OneWireDevice::set_one_wire_bus ( OneWireBus * bus )

inline

store the pointer to the OneWireBus to use

Parameters

bus	pointer to the OneWireBus object

Definition at line 24 of file one_wire.h.

Field Documentation

address_

uint64_t esphome::one_wire::OneWireDevice::address_ {0}

protected

Definition at line 32 of file one_wire.h.

address_name_

std::string esphome::one_wire::OneWireDevice::address_name_

protected

Definition at line 35 of file one_wire.h.

bus_

OneWireBus* esphome::one_wire::OneWireDevice::bus_ {nullptr}

protected

pointer to OneWireBus instance

Definition at line 34 of file one_wire.h.

index_

uint8_t esphome::one_wire::OneWireDevice::index_ {INDEX_NOT_SET}

protected

Definition at line 33 of file one_wire.h.

INDEX_NOT_SET

uint8_t esphome::one_wire::OneWireDevice::INDEX_NOT_SET = 255

staticconstexprprotected

Definition at line 30 of file one_wire.h.

---

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

• esphome/components/one_wire/one_wire.h
• esphome/components/one_wire/one_wire.cpp