ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
b_parasite.cpp
Go to the documentation of this file.
1#include "b_parasite.h"
3#include "esphome/core/log.h"
4
6
7ESPHOME_LOG_TAG(TAG, "b_parasite");
8
9void BParasite::dump_config() {
10 ESP_LOGCONFIG(TAG, "b_parasite");
11 LOG_SENSOR(" ", "Battery Voltage", this->battery_voltage_sensor_);
12 LOG_SENSOR(" ", "Temperature", this->temperature_sensor_);
13 LOG_SENSOR(" ", "Humidity", this->humidity_sensor_);
14 LOG_SENSOR(" ", "Soil Moisture", this->soil_moisture_sensor_);
15 LOG_SENSOR(" ", "Illuminance", this->illuminance_sensor_);
16}
17
18bool BParasite::parse_device(const ble_device_base::ESPBTDevice &device) {
19 if (device.address_uint64() != address_) {
20 ESP_LOGVV(TAG, "parse_device(): unknown MAC address.");
21 return false;
22 }
23 char addr_buf[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
24 ESP_LOGVV(TAG, "parse_device(): MAC address %s found.", device.address_str_to(addr_buf));
25 const auto &service_datas = device.get_service_datas();
26 if (service_datas.size() != 1) {
27 ESP_LOGE(TAG, "Unexpected service_datas size (%d)", service_datas.size());
28 return false;
29 }
30 const auto &service_data = service_datas[0];
31
32 ESP_LOGVV(TAG, "Service data:");
33 for (const uint8_t byte : service_data.data) {
34 ESP_LOGVV(TAG, "0x%02x", byte);
35 }
36
37 const auto &data = service_data.data;
38
39 if (data.size() < 10) {
40 ESP_LOGW(TAG, "Service data too short: %zu", data.size());
41 return false;
42 }
43
44 const uint8_t protocol_version = data[0] >> 4;
45 if (protocol_version != 1 && protocol_version != 2) {
46 ESP_LOGE(TAG, "Unsupported protocol version: %u", protocol_version);
47 return false;
48 }
49
50 // Some b-parasite versions have an (optional) illuminance sensor.
51 bool has_illuminance = data[0] & 0x1;
52
53 if (has_illuminance && data.size() < 18) {
54 ESP_LOGW(TAG, "Service data too short for illuminance: %zu", data.size());
55 return false;
56 }
57
58 // Counter for deduplicating messages.
59 uint8_t counter = data[1] & 0x0f;
60 if (last_processed_counter_ == counter) {
61 ESP_LOGVV(TAG, "Skipping already processed counter (%u)", counter);
62 return false;
63 }
64
65 // Battery voltage in millivolts.
66 uint16_t battery_millivolt = encode_value<uint16_t>(&data[2]);
67 float battery_voltage = battery_millivolt / 1000.0f;
68
69 // Temperature in 1000 * Celsius (protocol v1) or 100 * Celsius (protocol v2).
70 float temp_celsius;
71 if (protocol_version == 1) {
72 uint16_t temp_millicelsius = encode_value<uint16_t>(&data[4]);
73 temp_celsius = temp_millicelsius / 1000.0f;
74 } else {
75 int16_t temp_centicelsius = encode_value<int16_t>(&data[4]);
76 temp_celsius = temp_centicelsius / 100.0f;
77 }
78
79 // Relative air humidity in the range [0, 2^16).
80 uint16_t humidity = encode_value<uint16_t>(&data[6]);
81 float humidity_percent = (100.0f * humidity) / (1 << 16);
82
83 // Relative soil moisture in [0 - 2^16).
84 uint16_t soil_moisture = encode_value<uint16_t>(&data[8]);
85 float moisture_percent = (100.0f * soil_moisture) / (1 << 16);
86
87 // Ambient light in lux.
88 float illuminance = has_illuminance ? encode_value<uint16_t>(&data[16]) : 0.0f;
89
90 PUBLISH_STATE(this->battery_voltage_sensor_, battery_voltage);
91 PUBLISH_STATE(this->temperature_sensor_, temp_celsius);
92 PUBLISH_STATE(this->humidity_sensor_, humidity_percent);
93 PUBLISH_STATE(this->soil_moisture_sensor_, moisture_percent);
94 if (this->illuminance_sensor_ != nullptr) {
95 if (has_illuminance) {
96 this->illuminance_sensor_->publish_state(illuminance);
97 } else {
98 ESP_LOGE(TAG, "No lux information is present in the BLE packet");
99 }
100 }
101
102 last_processed_counter_ = counter;
103 return true;
104}
105
106} // namespace esphome::b_parasite
ESPDEPRECATED("Use address_str_to() instead. Removed in 2027.2.0.", "2026.8.0") std const char * address_str_to(char *buf) const
Return MAC as "XX:XX:XX:XX:XX:XX" string.
uint64_t address_uint64() const
Return MAC as packed uint64 (byte 0 in LSB — matches esp32's address_uint64).
const std::vector< ServiceData > & get_service_datas() const
Definition ble_device.h:225
ESPHOME_LOG_TAG(TAG, "b_parasite")
std::span< const uint8_t > data
constexpr T encode_value(const uint8_t *bytes)
Encode a value from its constituent bytes (from most to least significant) in an array with length si...
Definition helpers.h:1064