hurricos/ssieb_esphome_components
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add ETA SH component

Browse Source
This commit is contained in:
Samuel Sieb
2024-01-13 23:40:40 -08:00
parent 2e08d43137
commit f066f6113c
4 changed files with 485 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
components/eta_sh/README.md Normal file
View File

@@ -0,0 +1,48 @@
# component to read and control an ETA SH system
A configured uart is required.
Example:
```yaml
eta_sh:
boiler_temperature:
name: Kesseltemperatur (Boiler temp)
fan_speed:
name: Gebläsedrehzahl (Speed of boiler Fan)
unit_of_measurement: RPM
return_temperature:
name: Kesselruecklauf (Boiler water return temp)
buffer_bottom_temperature:
name: Puffer unten (Water buffer bottom temp)
buffer_middle_temperature:
name: Puffer mitte (Water buffer middle temp)
buffer_top_temperature:
name: Puffer oben (Water buffer top temp)
exhaust_temperature:
name: Abgastemperatur (Exhaust temp)
room1_temperature:
name: Raumtemperatur (Room1 temp)
room1_output_temperature:
name: Vorlauf Raum 1 (Water to room1 temp)
outside_temperature:
name: Aussentemperatur (Outside temp)
buffer_load:
name: Pufferladezustand (Buffer load in %)
external_heater_temperature:
name: Externer Brenner (External Oven (expansion, e.g. Oil or Gas)
oxygen_sensor:
name: Restsauerstoff (o2 Sensor Percent / Lambda Sond. Returns 0 when oven off)
heater_status:
name: "Status" Status of the heater,
0: "Tür offen" (Door open)
1: "heizt an" (starting Fire)
2: "in Betrieb" (working)
3: "Übertemperatur" (over temperature Limit)
4: "Glutabbrand" (embers burning)
5: "Feuer aus" (no Fire)
6: "Ausgeschaltet" (heater off)
7: "Störung" (fault)
```
All sensors are optional.

189
components/eta_sh/__init__.py Normal file
View File

@@ -0,0 +1,189 @@
import esphome.codegen as cg
import esphome.config_validation as cv
from esphome import automation
from esphome.components import uart, sensor
from esphome.const import (
CONF_ID,
CONF_TEMPERATURE,
DEVICE_CLASS_TEMPERATURE,
DEVICE_CLASS_VOLUME,
ICON_FAN,
ICON_GAUGE,
ICON_ROTATE_RIGHT,
ICON_THERMOMETER,
UNIT_CELSIUS,
UNIT_PERCENT,
)
MULTI_CONF = True
DEPENDENCIES = ['uart']
AUTO_LOAD = ['sensor']
eta_sh_ns = cg.esphome_ns.namespace('eta_sh')
ETA_SH = eta_sh_ns.class_('ETA_SH', cg.Component, uart.UARTDevice)
CONF_BOILER_TEMPERATURE = "boiler_temperature"
CONF_BUFFER_BOTTOM_TEMPERATURE = "buffer_bottom_temperature"
CONF_BUFFER_MIDDLE_TEMPERATURE = "buffer_middle_temperature"
CONF_BUFFER_TOP_TEMPERATURE = "buffer_top_temperature"
CONF_BUFFER_LOAD = "buffer_load"
CONF_EXHAUST_TEMPERATURE = "exhaust_temperature"
CONF_EXTERNAL_HEATER_TEMPERATURE = "external_heater_temperature"
CONF_FAN_SPEED = "fan_speed"
CONF_HEATER_STATUS = "heater_status"
CONF_OUTSIDE_TEMPERATURE = "outside_temperature"
CONF_OXYGEN_SENSOR = "oxygen_sensor"
CONF_RETURN_TEMPERATURE = "return_temperature"
CONF_ROOM1_TEMPERATURE = "room1_temperature"
CONF_ROOM1_OUTPUT_TEMPERATURE = "room1_output_temperature"
CONFIG_SCHEMA = cv.Schema(
{
cv.GenerateID(): cv.declare_id(ETA_SH),
cv.Optional(CONF_BOILER_TEMPERATURE): sensor.sensor_schema(
unit_of_measurement=UNIT_CELSIUS,
icon=ICON_THERMOMETER,
accuracy_decimals=1,
device_class=DEVICE_CLASS_TEMPERATURE,
),
cv.Optional(CONF_BUFFER_BOTTOM_TEMPERATURE): sensor.sensor_schema(
unit_of_measurement=UNIT_CELSIUS,
icon=ICON_THERMOMETER,
accuracy_decimals=1,
device_class=DEVICE_CLASS_TEMPERATURE,
),
cv.Optional(CONF_BUFFER_MIDDLE_TEMPERATURE): sensor.sensor_schema(
unit_of_measurement=UNIT_CELSIUS,
icon=ICON_THERMOMETER,
accuracy_decimals=1,
device_class=DEVICE_CLASS_TEMPERATURE,
),
cv.Optional(CONF_BUFFER_TOP_TEMPERATURE): sensor.sensor_schema(
unit_of_measurement=UNIT_CELSIUS,
icon=ICON_THERMOMETER,
accuracy_decimals=1,
device_class=DEVICE_CLASS_TEMPERATURE,
),
cv.Optional(CONF_BUFFER_LOAD): sensor.sensor_schema(
unit_of_measurement=UNIT_PERCENT,
icon=ICON_GAUGE,
accuracy_decimals=0,
device_class=DEVICE_CLASS_VOLUME,
),
cv.Optional(CONF_EXHAUST_TEMPERATURE): sensor.sensor_schema(
unit_of_measurement=UNIT_CELSIUS,
icon=ICON_THERMOMETER,
accuracy_decimals=1,
device_class=DEVICE_CLASS_TEMPERATURE,
),
cv.Optional(CONF_EXTERNAL_HEATER_TEMPERATURE): sensor.sensor_schema(
unit_of_measurement=UNIT_CELSIUS,
icon=ICON_THERMOMETER,
accuracy_decimals=1,
device_class=DEVICE_CLASS_TEMPERATURE,
),
cv.Optional(CONF_FAN_SPEED): sensor.sensor_schema(
icon=ICON_FAN,
accuracy_decimals=0,
),
cv.Optional(CONF_HEATER_STATUS) : sensor.sensor_schema(
accuracy_decimals=0,
device_class=DEVICE_CLASS_VOLUME,
),
cv.Optional(CONF_OUTSIDE_TEMPERATURE): sensor.sensor_schema(
unit_of_measurement=UNIT_CELSIUS,
icon=ICON_THERMOMETER,
accuracy_decimals=1,
device_class=DEVICE_CLASS_TEMPERATURE,
),
cv.Optional(CONF_OXYGEN_SENSOR): sensor.sensor_schema(
unit_of_measurement=UNIT_PERCENT,
icon=ICON_GAUGE,
accuracy_decimals=1,
device_class=DEVICE_CLASS_VOLUME,
),
cv.Optional(CONF_RETURN_TEMPERATURE): sensor.sensor_schema(
unit_of_measurement=UNIT_CELSIUS,
icon=ICON_THERMOMETER,
accuracy_decimals=1,
device_class=DEVICE_CLASS_TEMPERATURE,
),
cv.Optional(CONF_ROOM1_TEMPERATURE): sensor.sensor_schema(
unit_of_measurement=UNIT_CELSIUS,
icon=ICON_THERMOMETER,
accuracy_decimals=1,
device_class=DEVICE_CLASS_TEMPERATURE,
),
cv.Optional(CONF_ROOM1_OUTPUT_TEMPERATURE): sensor.sensor_schema(
unit_of_measurement=UNIT_CELSIUS,
icon=ICON_THERMOMETER,
accuracy_decimals=1,
device_class=DEVICE_CLASS_TEMPERATURE,
),
}
).extend(uart.UART_DEVICE_SCHEMA)
async def to_code(config):
var = cg.new_Pvariable(config[CONF_ID])
await cg.register_component(var, config)
await uart.register_uart_device(var, config)
if CONF_BOILER_TEMPERATURE in config:
sens = await sensor.new_sensor(config[CONF_BOILER_TEMPERATURE])
cg.add(var.set_boiler_temp_sensor(sens))
if CONF_BUFFER_BOTTOM_TEMPERATURE in config:
sens = await sensor.new_sensor(config[CONF_BUFFER_BOTTOM_TEMPERATURE])
cg.add(var.set_buffer_bottom_temp_sensor(sens))
if CONF_BUFFER_MIDDLE_TEMPERATURE in config:
sens = await sensor.new_sensor(config[CONF_BUFFER_MIDDLE_TEMPERATURE])
cg.add(var.set_buffer_middle_temp_sensor(sens))
if CONF_BUFFER_TOP_TEMPERATURE in config:
sens = await sensor.new_sensor(config[CONF_BUFFER_TOP_TEMPERATURE])
cg.add(var.set_buffer_top_temp_sensor(sens))
if CONF_BUFFER_LOAD in config:
sens = await sensor.new_sensor(config[CONF_BUFFER_LOAD])
cg.add(var.set_buffer_load_sensor(sens))
if CONF_EXHAUST_TEMPERATURE in config:
sens = await sensor.new_sensor(config[CONF_EXHAUST_TEMPERATURE])
cg.add(var.set_exhaust_temp_sensor(sens))
if CONF_EXTERNAL_HEATER_TEMPERATURE in config:
sens = await sensor.new_sensor(config[CONF_EXTERNAL_HEATER_TEMPERATURE])
cg.add(var.set_external_heater_temp_sensor(sens))
if CONF_FAN_SPEED in config:
sens = await sensor.new_sensor(config[CONF_FAN_SPEED])
cg.add(var.set_fan_speed_sensor(sens))
if CONF_HEATER_STATUS in config:
sens = await sensor.new_sensor(config[CONF_HEATER_STATUS])
cg.add(var.set_heater_status_sensor(sens))
if CONF_OUTSIDE_TEMPERATURE in config:
sens = await sensor.new_sensor(config[CONF_OUTSIDE_TEMPERATURE])
cg.add(var.set_outside_temp_sensor(sens))
if CONF_OXYGEN_SENSOR in config:
sens = await sensor.new_sensor(config[CONF_OXYGEN_SENSOR])
cg.add(var.set_oxygen_sensor(sens))
if CONF_RETURN_TEMPERATURE in config:
sens = await sensor.new_sensor(config[CONF_RETURN_TEMPERATURE])
cg.add(var.set_return_temp_sensor(sens))
if CONF_ROOM1_TEMPERATURE in config:
sens = await sensor.new_sensor(config[CONF_ROOM1_TEMPERATURE])
cg.add(var.set_room1_temp_sensor(sens))
if CONF_ROOM1_OUTPUT_TEMPERATURE in config:
sens = await sensor.new_sensor(config[CONF_ROOM1_OUTPUT_TEMPERATURE])
cg.add(var.set_room1_output_temp_sensor(sens))

192
components/eta_sh/eta_sh.cpp Normal file
View File

@@ -0,0 +1,192 @@
#include "eta_sh.h"
#include "esphome/core/log.h"
namespace esphome {
namespace eta_sh {
static const char *TAG = "eta_sh";
void ETA_SH::setup() {
std::vector<uint8_t> buffer;
int count = 0;
auto add_sensor = [&](sensor::Sensor *sensor, uint16_t datapoint) {
if (sensor == nullptr)
return;
count++;
buffer.push_back(0x08);
buffer.push_back(datapoint >> 8);
buffer.push_back(datapoint & 0xff);
};
buffer.push_back('{');
buffer.push_back('M');
buffer.push_back('C');
buffer.push_back(0);
buffer.push_back(0);
buffer.push_back(this->update_interval_);
add_sensor(this->boiler_temp_sensor_, 8);
add_sensor(this->buffer_bottom_temp_sensor_, 10);
add_sensor(this->buffer_middle_temp_sensor_, 11);
add_sensor(this->buffer_top_temp_sensor_, 12);
add_sensor(this->buffer_load_sensor_, 75);
add_sensor(this->exhaust_temp_sensor_, 15);
add_sensor(this->external_heater_temp_sensor_, 117);
add_sensor(this->fan_speed_sensor_,7);
add_sensor(this->heater_status_sensor_, 39);
add_sensor(this->outside_temp_sensor_, 70);
add_sensor(this->oxygen_sensor_ ,40);
add_sensor(this->return_temp_sensor_, 9);
add_sensor(this->room1_temp_sensor_, 66);
add_sensor(this->room1_output_temp_sensor_, 68);
if (count == 0) {
ESP_LOGW(TAG, "no sensors configured");
return;
}
buffer[3] = count * 3 + 1;
uint8_t csum = 0;
for (int i = 5; i < buffer.size(); i++)
csum += buffer[i];
buffer[4] = csum;
buffer.push_back('}');
this->write_array(buffer);
}
void ETA_SH::loop() {
while (this->available()) {
uint8_t c;
this->read_byte(&c);
if (!this->reading_) {
if (c == '{') {
this->reading_ = true;
this->buffer_.clear();
}
continue;
}
if ((this->buffer_.size() < 4) || (this->buffer_.size() < this->buffer_[2] + 4)) {
this->buffer_.push_back(c);
continue;
}
this->reading_ = false;
if (c != '}') {
ESP_LOGE(TAG, "didn't find end tag");
continue;
}
uint8_t *data = this->buffer_.data();
uint8_t csum = 0;
for (int i = 4; i < this->buffer_.size(); i++)
csum += data[i];
if (csum != data[3]) {
ESP_LOGE(TAG, "checksum failed: %02x != %02x", csum, data[3]);
continue;
}
handle_data_(data);
}
}
void ETA_SH::handle_data_(uint8_t *data) {
if ((data[0] != 'M') || (data[1] != 'D')) {
ESP_LOGV(TAG, "unhandled message: '%c%c'", data[0], data[1]);
return;
}
int count = data[2];
data += 4;
for (; count > 0; count -= 5, data += 5) {
if (data[0] != 8) {
ESP_LOGV(TAG, "data not for us: %02x (%d)", data[0], data[0]);
continue;
}
uint16_t datapoint = encode_uint16(data[1], data[2]);
uint16_t uvalue = encode_uint16(data[3], data[4]);
int16_t ivalue = (int16_t) uvalue;
switch (datapoint) {
case 7:
if (this->fan_speed_sensor_ != nullptr)
this->fan_speed_sensor_->publish_state((float)uvalue);
break;
case 8:
if (this->boiler_temp_sensor_ != nullptr)
this->boiler_temp_sensor_->publish_state((float)ivalue / 10);
break;
case 9:
if (this->return_temp_sensor_ != nullptr)
this->return_temp_sensor_->publish_state((float)ivalue / 10);
break;
case 10:
if (this->buffer_bottom_temp_sensor_ != nullptr)
this->buffer_bottom_temp_sensor_->publish_state((float)ivalue / 10);
break;
case 11:
if (this->buffer_middle_temp_sensor_ != nullptr)
this->buffer_middle_temp_sensor_->publish_state((float)ivalue / 10);
break;
case 12:
if (this->buffer_top_temp_sensor_ != nullptr)
this->buffer_top_temp_sensor_->publish_state((float)ivalue / 10);
break;
case 15:
if (this->exhaust_temp_sensor_ != nullptr)
this->exhaust_temp_sensor_->publish_state((float)ivalue / 10);
break;
case 39:
if (this->heater_status_sensor_ != nullptr)
this->heater_status_sensor_->publish_state((float)uvalue);
break;
case 40:
if (this->oxygen_sensor_ != nullptr) {
if (uvalue == 0x8000)
uvalue = 0;
this->oxygen_sensor_->publish_state((float)uvalue / 100);
}
break;
case 66:
if (this->room1_temp_sensor_ != nullptr)
this->room1_temp_sensor_->publish_state((float)ivalue / 10);
break;
case 68:
if (this->room1_output_temp_sensor_ != nullptr)
this->room1_output_temp_sensor_->publish_state((float)ivalue / 10);
break;
case 70:
if (this->outside_temp_sensor_ != nullptr)
this->outside_temp_sensor_->publish_state((float)ivalue / 10);
break;
case 75:
if (this->buffer_load_sensor_ != nullptr)
this->buffer_load_sensor_->publish_state(uvalue);
break;
case 117:
if (this->external_heater_temp_sensor_ != nullptr)
this->external_heater_temp_sensor_->publish_state((float)ivalue / 10);
break;
default:
ESP_LOGV(TAG, "unknown data value: %02x (%d)", datapoint, datapoint);
break;
}
}
}
void ETA_SH::dump_config() {
ESP_LOGCONFIG(TAG, "ETA SH:");
ESP_LOGCONFIG(TAG, " Update interval: %ds", this->update_interval_);
LOG_SENSOR(" ", "Boiler Temperature", this->boiler_temp_sensor_);
LOG_SENSOR(" ", "Buffer Bottom Temperature", this->buffer_bottom_temp_sensor_);
LOG_SENSOR(" ", "Buffer Middle Temperature", this->buffer_middle_temp_sensor_);
LOG_SENSOR(" ", "Buffer Top Temperature", this->buffer_top_temp_sensor_);
LOG_SENSOR(" ", "Buffer Load", this->buffer_load_sensor_);
LOG_SENSOR(" ", "Exhaust Temperature", this->exhaust_temp_sensor_);
LOG_SENSOR(" ", "External Heater Temperature", this->external_heater_temp_sensor_);
LOG_SENSOR(" ", "Fan Speed", this->fan_speed_sensor_);
LOG_SENSOR(" ", "Heater Status", this->heater_status_sensor_);
LOG_SENSOR(" ", "Outside Temperature", this->outside_temp_sensor_);
LOG_SENSOR(" ", "Oxygen Sensor", this->oxygen_sensor_);
LOG_SENSOR(" ", "Return Temperature", this->return_temp_sensor_);
LOG_SENSOR(" ", "Room 1 Temperature", this->room1_temp_sensor_);
LOG_SENSOR(" ", "Room 1 output Temperature", this->room1_output_temp_sensor_);
}
} // namespace eta_sh
} // namespace esphome

56
components/eta_sh/eta_sh.h Normal file
View File

@@ -0,0 +1,56 @@
#pragma once
#include "esphome/core/component.h"
#include "esphome/components/sensor/sensor.h"
#include "esphome/components/uart/uart.h"
namespace esphome {
namespace eta_sh {
class ETA_SH : public Component, public uart::UARTDevice {
public:
float get_setup_priority() const override { return setup_priority::LATE; }
void setup() override;
void loop() override;
void dump_config() override;
void set_update_interval(uint8_t interval) { this->update_interval_ = interval; }
void set_boiler_temp_sensor(sensor::Sensor *sensor) { this->boiler_temp_sensor_ = sensor; }
void set_buffer_bottom_temp_sensor(sensor::Sensor *sensor) { this->buffer_bottom_temp_sensor_ = sensor; }
void set_buffer_middle_temp_sensor(sensor::Sensor *sensor) { this->buffer_middle_temp_sensor_ = sensor; }
void set_buffer_top_temp_sensor(sensor::Sensor *sensor) { this->buffer_top_temp_sensor_ = sensor; }
void set_buffer_load_sensor(sensor::Sensor *sensor) { this->buffer_load_sensor_ = sensor; }
void set_exhaust_temp_sensor(sensor::Sensor *sensor) { this->exhaust_temp_sensor_ = sensor; }
void set_external_heater_temp_sensor(sensor::Sensor *sensor) { this->external_heater_temp_sensor_ = sensor; }
void set_fan_speed_sensor(sensor::Sensor *sensor) { this->fan_speed_sensor_ = sensor; }
void set_heater_status_sensor(sensor::Sensor *sensor) { this ->heater_status_sensor_ = sensor; }
void set_outside_temp_sensor(sensor::Sensor *sensor) { this->outside_temp_sensor_ = sensor; }
void set_oxygen_sensor(sensor::Sensor *sensor) { this->oxygen_sensor_ = sensor; }
void set_return_temp_sensor(sensor::Sensor *sensor) { this->return_temp_sensor_ = sensor; }
void set_room1_temp_sensor(sensor::Sensor *sensor) { this->room1_temp_sensor_ = sensor; }
void set_room1_output_temp_sensor(sensor::Sensor *sensor) { this->room1_output_temp_sensor_ = sensor; }
protected:
uint8_t update_interval_{0};
sensor::Sensor *boiler_temp_sensor_{nullptr};
sensor::Sensor *buffer_bottom_temp_sensor_{nullptr};
sensor::Sensor *buffer_middle_temp_sensor_{nullptr};
sensor::Sensor *buffer_top_temp_sensor_{nullptr};
sensor::Sensor *buffer_load_sensor_{nullptr};
sensor::Sensor *exhaust_temp_sensor_{nullptr};
sensor::Sensor *external_heater_temp_sensor_{nullptr};
sensor::Sensor *fan_speed_sensor_{nullptr};
sensor::Sensor *heater_status_sensor_{nullptr};
sensor::Sensor *outside_temp_sensor_{nullptr};
sensor::Sensor *oxygen_sensor_{nullptr};
sensor::Sensor *return_temp_sensor_{nullptr};
sensor::Sensor *room1_temp_sensor_{nullptr};
sensor::Sensor *room1_output_temp_sensor_{nullptr};
bool reading_{false};
std::vector<uint8_t> buffer_;
void handle_data_(uint8_t *data);
};
} // namespace eta_sh
} // namespace esphome