ESPHome 2026.10.0-dev
Loading...
Searching...
No Matches
one_wire_bus.cpp
Go to the documentation of this file.
1#include "one_wire_bus.h"
3
4namespace esphome::one_wire {
5
6static const char *const TAG = "one_wire";
7
8static const uint8_t DALLAS_MODEL_DS18S20 = 0x10;
9static const uint8_t DALLAS_MODEL_DS1822 = 0x22;
10static const uint8_t DALLAS_MODEL_DS18B20 = 0x28;
11static const uint8_t DALLAS_MODEL_DS1825 = 0x3B;
12static const uint8_t DALLAS_MODEL_DS28EA00 = 0x42;
13
14const uint8_t ONE_WIRE_ROM_SELECT = 0x55;
15const uint8_t ONE_WIRE_ROM_SEARCH = 0xF0;
16
17const std::vector<uint64_t> &OneWireBus::get_devices() { return this->devices_; }
18
20 int res = this->reset_int();
21 if (res == -1) {
22 ESP_LOGE(TAG, "1-wire bus is held low");
23 }
24 return res == 1;
25}
26
27bool IRAM_ATTR OneWireBus::select(uint64_t address) {
28 if (!this->reset_())
29 return false;
30 this->write8(ONE_WIRE_ROM_SELECT);
31 this->write64(address);
32 return true;
33}
34
36 this->devices_.clear();
37
38 this->reset_search();
39 uint64_t address;
40 while (true) {
41 if (!this->reset_()) {
42 // Reset failed or no devices present
43 return;
44 }
45
46 this->write8(ONE_WIRE_ROM_SEARCH);
47 address = this->search_int();
48 if (address == 0)
49 break;
50 auto *address8 = reinterpret_cast<uint8_t *>(&address);
51 if (crc8(address8, 7) != address8[7]) {
52 char hex_buf[17];
53 ESP_LOGW(TAG, "Dallas device 0x%s has invalid CRC.", format_hex_to(hex_buf, address));
54 } else {
55 this->devices_.push_back(address);
56 }
57 }
58}
59
61 if (!this->reset_())
62 return false;
63 this->write8(0xCC); // skip ROM
64 return true;
65}
66
67const LogString *OneWireBus::get_model_str(uint8_t model) {
68 switch (model) {
69 case DALLAS_MODEL_DS18S20:
70 return LOG_STR("DS18S20");
71 case DALLAS_MODEL_DS1822:
72 return LOG_STR("DS1822");
73 case DALLAS_MODEL_DS18B20:
74 return LOG_STR("DS18B20");
75 case DALLAS_MODEL_DS1825:
76 return LOG_STR("DS1825");
77 case DALLAS_MODEL_DS28EA00:
78 return LOG_STR("DS28EA00");
79 default:
80 return LOG_STR("Unknown");
81 }
82}
83
84void OneWireBus::dump_devices_(const char *tag) {
85 if (this->devices_.empty()) {
86 ESP_LOGW(tag, " Found no devices!");
87 } else {
88 ESP_LOGCONFIG(tag, " Found devices:");
89 char hex_buf[17]; // uint64_t = 16 hex chars + null
90 for (auto &address : this->devices_) {
91 ESP_LOGCONFIG(tag, " 0x%s (%s)", format_hex_to(hex_buf, address), LOG_STR_ARG(get_model_str(address & 0xff)));
92 }
93 }
94}
95
96} // namespace esphome::one_wire
uint8_t address
Definition bl0906.h:4
virtual void reset_search()=0
Reset the device search.
const std::vector< uint64_t > & get_devices()
Return the list of found devices.
std::vector< uint64_t > devices_
bool skip()
Write a command to the bus that addresses all devices by skipping the ROM.
void dump_devices_(const char *tag)
log the found devices
virtual int reset_int()=0
Bus Reset.
bool reset_()
Reset the bus, should be done before all write operations.
virtual void write64(uint64_t val)=0
Write a 64 bit unsigned integer to the bus. LSB first.
bool select(uint64_t address)
Select a specific address on the bus for the following command.
const LogString * get_model_str(uint8_t model)
Get the description string for this model.
virtual void write8(uint8_t val)=0
Write a word to the bus. LSB first.
void search()
Search for 1-Wire devices on the bus.
virtual uint64_t search_int()=0
Search for a 1-Wire device on the bus. Returns 0 if all devices have been found.
const uint8_t ONE_WIRE_ROM_SEARCH
const uint8_t ONE_WIRE_ROM_SELECT
uint8_t crc8(const uint8_t *data, uint8_t len, uint8_t crc, uint8_t poly, bool msb_first)
Calculate a CRC-8 checksum of data with size len.
Definition helpers.cpp:59
char * format_hex_to(char *buffer, size_t buffer_size, const uint8_t *data, size_t length)
Format byte array as lowercase hex to buffer (base implementation).
Definition helpers.cpp:353