ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
aranet.cpp
Go to the documentation of this file.
1#include "aranet.h"
2
3#include <cinttypes>
4
6#include "esphome/core/log.h"
7
8namespace esphome::aranet {
9
10ESPHOME_LOG_TAG(TAG, "aranet");
11static constexpr uint16_t ARANET_MANUFACTURER_ID = 0x0702;
12static constexpr size_t ARANET4_DATA_LENGTH = 22;
13static constexpr size_t OTHER_ARANET_DATA_LENGTH = 24;
14
21
22// Aranet does not publish an official advertisement specification. The layout below is corroborated by these
23// independently maintained implementations:
24// https://github.com/Anrijs/Aranet4-Python/blob/master/aranet4/client.py
25// https://github.com/Anrijs/Aranet4-ESP32/blob/main/src/Aranet4.h
26
28 ESP_LOGCONFIG(TAG, "Aranet");
29 LOG_SENSOR(" ", "Carbon Dioxide", this->co2_sensor_);
30 LOG_SENSOR(" ", "Temperature", this->temperature_sensor_);
31 LOG_SENSOR(" ", "Humidity", this->humidity_sensor_);
32 LOG_SENSOR(" ", "Pressure", this->pressure_sensor_);
33 LOG_SENSOR(" ", "Battery Level", this->battery_level_sensor_);
34 LOG_SENSOR(" ", "Measurement Interval", this->measurement_interval_sensor_);
35 LOG_SENSOR(" ", "Measurement Age", this->measurement_age_sensor_);
36 LOG_SENSOR(" ", "Signal Strength", this->signal_strength_sensor_);
37 LOG_SENSOR(" ", "Radon Concentration", this->radon_sensor_);
38 LOG_SENSOR(" ", "Radiation Dose Rate", this->radiation_rate_sensor_);
39 LOG_SENSOR(" ", "Radiation Total Dose", this->radiation_total_sensor_);
40 LOG_SENSOR(" ", "Radiation Dose Duration", this->radiation_duration_sensor_);
41}
42
44 if (device.address_uint64() != this->address_)
45 return false;
46
47 const auto manufacturer_uuid = ble_device_base::ESPBTUUID::from_uint16(ARANET_MANUFACTURER_ID);
48 for (const auto &manufacturer_data : device.get_manufacturer_datas()) {
49 if (manufacturer_data.uuid != manufacturer_uuid)
50 continue;
51
52 const auto &data = manufacturer_data.data;
53 if (data.size() != ARANET4_DATA_LENGTH && data.size() != OTHER_ARANET_DATA_LENGTH) {
54 if ((this->warned_ & WARNED_INVALID_LENGTH) == 0) {
55 ESP_LOGW(TAG, "Unexpected manufacturer data length: %u", static_cast<unsigned>(data.size()));
57 }
58 return false;
59 }
60
61 // Aranet4 has no device type byte, so its flags and trailer start one byte earlier
62 const bool is_aranet4 = data.size() == ARANET4_DATA_LENGTH;
63 if ((data[is_aranet4 ? 0 : 1] & 0x20) == 0) {
64 if ((this->warned_ & WARNED_INTEGRATION_DISABLED) == 0) {
65 ESP_LOGW(TAG, "Smart Home integration is disabled on the Aranet device");
67 }
68 return false;
69 }
70
71 if (!is_aranet4 && (data[0] == 0 || data[0] > 3)) {
72 if ((this->warned_ & WARNED_UNSUPPORTED_TYPE) == 0) {
73 ESP_LOGW(TAG, "Unsupported Aranet device type: %u", data[0]);
75 }
76 return false;
77 }
78 const auto device_type =
79 is_aranet4 ? AranetDeviceType::ARANET_DEVICE_TYPE_ARANET4 : static_cast<AranetDeviceType>(data[0]);
80
81 // Battery, measurement interval, measurement age and measurement counter
82 const uint8_t *trailer = &data[is_aranet4 ? 15 : 17];
83 const uint16_t measurement_interval = encode_uint16(trailer[3], trailer[2]);
84 const uint16_t measurement_age = encode_uint16(trailer[5], trailer[4]);
85 const uint8_t measurement_counter = trailer[6];
86
87 PUBLISH_STATE(this->measurement_age_sensor_, measurement_age);
88 PUBLISH_STATE(this->signal_strength_sensor_, device.get_rssi());
89
90 if (measurement_counter == this->last_measurement_counter_)
91 return true;
92 this->last_measurement_counter_ = measurement_counter;
93
94 // Not meaningful for Aranet Radiation, which stores its dose duration in these bytes
95 const float temperature = encode_uint16(data[11], data[10]) / 20.0f;
96 const float pressure = encode_uint16(data[13], data[12]) / 10.0f;
97 switch (device_type) {
99 const uint16_t co2 = encode_uint16(data[9], data[8]);
100 PUBLISH_STATE(this->co2_sensor_, co2);
101 PUBLISH_STATE(this->temperature_sensor_, temperature);
102 PUBLISH_STATE(this->pressure_sensor_, pressure);
103 PUBLISH_STATE(this->humidity_sensor_, data[14]);
104 ESP_LOGD(TAG, "Aranet4 CO2: %u ppm, temperature: %.1f C, humidity: %u%%, pressure: %.1f hPa", co2, temperature,
105 data[14], pressure);
106 break;
107 }
109 const float humidity = encode_uint16(data[15], data[14]) / 10.0f;
110 PUBLISH_STATE(this->temperature_sensor_, temperature);
111 PUBLISH_STATE(this->humidity_sensor_, humidity);
112 ESP_LOGD(TAG, "Aranet2 temperature: %.1f C, humidity: %.1f%%", temperature, humidity);
113 break;
114 }
116 const uint32_t radiation_total = encode_uint32(data[9], data[8], data[7], data[6]);
117 const uint32_t radiation_duration = encode_uint32(data[13], data[12], data[11], data[10]);
118 const uint16_t radiation_rate = encode_uint16(data[15], data[14]);
119 PUBLISH_STATE(this->radiation_rate_sensor_, radiation_rate / 1000.0f);
120 PUBLISH_STATE(this->radiation_total_sensor_, radiation_total);
121 PUBLISH_STATE(this->radiation_duration_sensor_, radiation_duration);
122 ESP_LOGD(TAG, "Aranet Radiation dose rate: %u nSv/h, total dose: %" PRIu32 " nSv", radiation_rate,
123 radiation_total);
124 break;
125 }
127 const uint16_t radon = encode_uint16(data[9], data[8]);
128 const float humidity = encode_uint16(data[15], data[14]) / 10.0f;
129 PUBLISH_STATE(this->radon_sensor_, radon);
130 // Aranet Radon One uses zero temperature and humidity to indicate fields not supported by that model.
131 if (temperature != 0)
132 PUBLISH_STATE(this->temperature_sensor_, temperature);
133 PUBLISH_STATE(this->pressure_sensor_, pressure);
134 if (humidity != 0)
135 PUBLISH_STATE(this->humidity_sensor_, humidity);
136 ESP_LOGD(TAG, "Aranet Radon: %u Bq/m3, temperature: %.1f C, humidity: %.1f%%, pressure: %.1f hPa", radon,
137 temperature, humidity, pressure);
138 break;
139 }
140 default:
141 break;
142 }
143 PUBLISH_STATE(this->battery_level_sensor_, trailer[0]);
144 PUBLISH_STATE(this->measurement_interval_sensor_, measurement_interval);
145
146 return true;
147 }
148
149 return false;
150}
151
152} // namespace esphome::aranet
uint16_t last_measurement_counter_
Definition aranet.h:22
static constexpr uint8_t WARNED_INVALID_LENGTH
Definition aranet.h:17
bool parse_device(const ble_device_base::ESPBTDevice &device) override
Definition aranet.cpp:43
static constexpr uint8_t WARNED_UNSUPPORTED_TYPE
Definition aranet.h:19
void dump_config() override
Definition aranet.cpp:27
static constexpr uint8_t WARNED_INTEGRATION_DISABLED
Definition aranet.h:18
uint64_t address_uint64() const
Return MAC as packed uint64 (byte 0 in LSB — matches esp32's address_uint64).
const std::vector< ServiceData > & get_manufacturer_datas() const
Definition ble_device.h:224
static ESPBTUUID from_uint16(uint16_t uuid)
ESPHOME_LOG_TAG(TAG, "aranet")
constexpr uint32_t encode_uint32(uint8_t byte1, uint8_t byte2, uint8_t byte3, uint8_t byte4)
Encode a 32-bit value given four bytes in most to least significant byte order.
Definition helpers.h:1051
constexpr uint16_t encode_uint16(uint8_t msb, uint8_t lsb)
Encode a 16-bit value given the most and least significant byte.
Definition helpers.h:1043
static void uint32_t
uint16_t temperature
Definition sun_gtil2.cpp:12
uint16_t trailer
uint8_t pressure
Definition tt21100.cpp:7