mirror/esphome-emporia-vue-utility
1
0
Fork 0
mirror of https://github.com/nekorevend/esphome-emporia-vue-utility.git synced 2026-01-10 05:10:40 -07:00
Code Issues Packages Projects Releases Wiki Activity

Formatted.

Browse Source
This commit is contained in:
Victor Chang
2024-06-06 22:01:06 -07:00
parent 2e0c6f853a
commit b3d1a1fda4
3 changed files with 779 additions and 748 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
esphome/components/emporia_vue_utility/emporia_vue_utility.cpp
View File

@@ -1,6 +1,7 @@
#include "esphome/core/log.h"
#include "emporia_vue_utility.h"
#include "esphome/core/log.h"
namespace esphome {
namespace emporia_vue_utility {
@@ -15,8 +16,9 @@ void EmporiaVueUtility::setup() {
}
void EmporiaVueUtility::update() {
// This seems to be called incessantly instead of at the set update interval...
// ESP_LOGD(TAG, "Got update call with an instructed interval of %d sec", this->update_interval_);
// This seems to be called incessantly instead of at the set update
// interval... ESP_LOGD(TAG, "Got update call with an instructed interval of
// %d sec", this->update_interval_);
}
void EmporiaVueUtility::loop() {
@@ -34,12 +36,9 @@ void EmporiaVueUtility::loop() {
/* sanity checks! */
if (next_meter_request >
now + (INITIAL_STARTUP_DELAY + METER_REJOIN_INTERVAL)) {
ESP_LOGD(TAG,
"Time jumped back (%lld > %lld + %lld); resetting",
(long long) next_meter_request,
(long long) now,
(long long) (INITIAL_STARTUP_DELAY +
METER_REJOIN_INTERVAL));
ESP_LOGD(TAG, "Time jumped back (%lld > %lld + %lld); resetting",
(long long)next_meter_request, (long long)now,
(long long)(INITIAL_STARTUP_DELAY + METER_REJOIN_INTERVAL));
next_meter_request = next_meter_join = 0;
}
@@ -52,7 +51,8 @@ void EmporiaVueUtility::loop() {
if (now < last_meter_reading + int(update_interval_ / 4)) {
// Sometimes a duplicate message is sent in quick succession.
// Ignoring the duplicate.
ESP_LOGD(TAG, "Got extra message %ds after the previous message.", now - last_meter_reading);
ESP_LOGD(TAG, "Got extra message %ds after the previous message.",
now - last_meter_reading);
break;
}
last_reading_has_error = 0;
@@ -104,7 +104,8 @@ void EmporiaVueUtility::loop() {
break;
case 'e':
// Unknown response type, but we can ignore.
ESP_LOGI(TAG, "Got 'e'-type message with value: %d", input_buffer.data[4]);
ESP_LOGI(TAG, "Got 'e'-type message with value: %d",
input_buffer.data[4]);
break;
default:
ESP_LOGE(TAG, "Unhandled response type '%c'", msg_type);
@@ -139,11 +140,16 @@ void EmporiaVueUtility::loop() {
return;
}
if (startup_step == 0) send_version_req();
else if (startup_step == 1) send_mac_req();
else if (startup_step == 2) send_install_code_req();
else if (startup_step == 3) send_meter_join();
else send_meter_request();
if (startup_step == 0)
send_version_req();
else if (startup_step == 1)
send_mac_req();
else if (startup_step == 2)
send_install_code_req();
else if (startup_step == 3)
send_meter_join();
else
send_meter_request();
}
}

164
esphome/components/emporia_vue_utility/emporia_vue_utility.h
View File

@@ -1,8 +1,8 @@
#pragma once
#include "esphome/core/component.h"
#include "esphome/components/sensor/sensor.h"
#include "esphome/components/uart/uart.h"
#include "esphome/core/component.h"
// Extra meter reading response debugging
#define DEBUG_VUE_RESPONSE true
@@ -74,13 +74,15 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
byte msg_type;
uint8_t data_len;
byte unknown0; // Payload Byte 0 : Always 0x18
byte increment; // Payload Byte 1 : Increments on each reading and rolls over
byte increment; // Payload Byte 1 : Increments on each reading and rolls
// over
byte unknown2[5]; // Payload Bytes 2 to 6
uint32_t import_wh; // Payload Bytes 7 to 10
byte unknown11[6]; // Payload Bytes 11 to 16
uint32_t export_wh; // Payload Bytes 17 to 20
byte unknown21[19]; // Payload Bytes 21 to 39
uint32_t watts; // Payload Bytes 40 to 43 : Starts with 0x2A, only use the last 24 bits.
uint32_t watts; // Payload Bytes 40 to 43 : Starts with 0x2A, only use the
// last 24 bits.
} __attribute__((packed));
// A Mac Address or install code response
@@ -128,13 +130,23 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
// The most recent cost unit
uint16_t cost_unit = 0;
void set_update_interval(uint32_t update_interval) { update_interval_ = update_interval / 1000; }
void set_update_interval(uint32_t update_interval) {
update_interval_ = update_interval / 1000;
}
void set_power_sensor(sensor::Sensor *sensor) { power_sensor_ = sensor; }
void set_power_export_sensor(sensor::Sensor *sensor) { power_export_sensor_ = sensor; }
void set_power_import_sensor(sensor::Sensor *sensor) { power_import_sensor_ = sensor; }
void set_power_export_sensor(sensor::Sensor *sensor) {
power_export_sensor_ = sensor;
}
void set_power_import_sensor(sensor::Sensor *sensor) {
power_import_sensor_ = sensor;
}
void set_energy_sensor(sensor::Sensor *sensor) { energy_sensor_ = sensor; }
void set_energy_export_sensor(sensor::Sensor *sensor) { energy_export_sensor_ = sensor; }
void set_energy_import_sensor(sensor::Sensor *sensor) { energy_import_sensor_ = sensor; }
void set_energy_export_sensor(sensor::Sensor *sensor) {
energy_export_sensor_ = sensor;
}
void set_energy_import_sensor(sensor::Sensor *sensor) {
energy_import_sensor_ = sensor;
}
void setup() override;
void update() override;
void loop() override;
@@ -145,8 +157,10 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
// Turn the wifi led on/off
void led_wifi(bool state) {
#if USE_LED_PINS
if (state) digitalWrite(LED_PIN_WIFI, 0);
else digitalWrite(LED_PIN_WIFI, 1);
if (state)
digitalWrite(LED_PIN_WIFI, 0);
else
digitalWrite(LED_PIN_WIFI, 1);
#endif
return;
}
@@ -154,8 +168,10 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
// Turn the link led on/off
void led_link(bool state) {
#if USE_LED_PINS
if (state) digitalWrite(LED_PIN_LINK, 0);
else digitalWrite(LED_PIN_LINK, 1);
if (state)
digitalWrite(LED_PIN_LINK, 0);
else
digitalWrite(LED_PIN_LINK, 1);
#endif
return;
}
@@ -227,7 +243,6 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
return 0;
default:
if (pos < data_len + 5) {
;
} else if (c == 0x0d) { // 0x0d == "/r", which should end a message
return pos;
@@ -273,11 +288,13 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
// Setup Meter Divisor
if ((mr2->meter_div > 10) || (mr2->meter_div < 1)) {
ESP_LOGW(TAG, "Unreasonable MeterDiv value %d, ignoring", mr2->meter_div);
ESP_LOGW(TAG, "Unreasonable MeterDiv value %d, ignoring",
mr2->meter_div);
last_reading_has_error = 1;
ask_for_bug_report();
} else if ((meter_div != 0) && (mr2->meter_div != meter_div)) {
ESP_LOGW(TAG, "MeterDiv value changed from %d to %d", meter_div, mr2->meter_div);
ESP_LOGW(TAG, "MeterDiv value changed from %d to %d", meter_div,
mr2->meter_div);
last_reading_has_error = 1;
meter_div = mr2->meter_div;
} else {
@@ -285,17 +302,19 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
}
// Setup Cost Unit
cost_unit = ((mr2->cost_unit & 0x00FF) << 8)
+ ((mr2->cost_unit & 0xFF00) >> 8);
cost_unit =
((mr2->cost_unit & 0x00FF) << 8) + ((mr2->cost_unit & 0xFF00) >> 8);
watt_hours = parse_meter_watt_hours_v2(mr2);
watts = parse_meter_watts_v2(mr2);
// Extra debugging of non-zero bytes, only on first packet or if DEBUG_VUE_RESPONSE is true
// Extra debugging of non-zero bytes, only on first packet or if
// DEBUG_VUE_RESPONSE is true
if ((DEBUG_VUE_RESPONSE) || (last_meter_reading == 0)) {
ESP_LOGD(TAG, "Meter Divisor: %d", meter_div);
ESP_LOGD(TAG, "Meter Cost Unit: %d", cost_unit);
ESP_LOGD(TAG, "Meter Flags: %02x %02x", mr2->maybe_flags[0], mr2->maybe_flags[1]);
ESP_LOGD(TAG, "Meter Flags: %02x %02x", mr2->maybe_flags[0],
mr2->maybe_flags[1]);
ESP_LOGD(TAG, "Meter Energy Flags: %02x", (byte)mr2->watt_hours);
ESP_LOGD(TAG, "Meter Power Flags: %02x", (byte)mr2->watts);
// Unlike the other values, ms_since_reset is in our native byte order
@@ -305,12 +324,11 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
for (int x = 1; x < pos / 4; x++) {
int y = x * 4;
if ( (input_buffer.data[y])
|| (input_buffer.data[y+1])
|| (input_buffer.data[y+2])
|| (input_buffer.data[y+3])) {
ESP_LOGD(TAG, "Meter Response Bytes %3d to %3d: %02x %02x %02x %02x", y-4, y-1,
input_buffer.data[y], input_buffer.data[y+1],
if ((input_buffer.data[y]) || (input_buffer.data[y + 1]) ||
(input_buffer.data[y + 2]) || (input_buffer.data[y + 3])) {
ESP_LOGD(
TAG, "Meter Response Bytes %3d to %3d: %02x %02x %02x %02x",
y - 4, y - 1, input_buffer.data[y], input_buffer.data[y + 1],
input_buffer.data[y + 2], input_buffer.data[y + 3]);
}
}
@@ -320,7 +338,8 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
// Quick validate, look for a magic number.
if (input_buffer.data[44] != 0x2A) {
ESP_LOGE(TAG, "Byte 44 was %02x instead of %02x", input_buffer.data[44], 0x2A);
ESP_LOGE(TAG, "Byte 44 was %02x instead of %02x", input_buffer.data[44],
0x2A);
last_reading_has_error = 1;
return;
}
@@ -332,17 +351,20 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
void ask_for_bug_report() {
ESP_LOGE(TAG, "If you continue to see this, try asking for help at");
ESP_LOGE(TAG, " https://community.home-assistant.io/t/emporia-vue-utility-connect/378347");
ESP_LOGE(TAG, "and include a few lines above this message and the data below until \"EOF\":");
ESP_LOGE(TAG,
" "
"https://community.home-assistant.io/t/"
"emporia-vue-utility-connect/378347");
ESP_LOGE(TAG,
"and include a few lines above this message and the data below "
"until \"EOF\":");
ESP_LOGE(TAG, "Full packet:");
for (int x = 1; x < pos / 4; x++) {
int y = x * 4;
if ( (input_buffer.data[y])
|| (input_buffer.data[y+1])
|| (input_buffer.data[y+2])
|| (input_buffer.data[y+3])) {
ESP_LOGE(TAG, " Meter Response Bytes %3d to %3d: %02x %02x %02x %02x", y-4, y-1,
input_buffer.data[y], input_buffer.data[y+1],
if ((input_buffer.data[y]) || (input_buffer.data[y + 1]) ||
(input_buffer.data[y + 2]) || (input_buffer.data[y + 3])) {
ESP_LOGE(TAG, " Meter Response Bytes %3d to %3d: %02x %02x %02x %02x",
y - 4, y - 1, input_buffer.data[y], input_buffer.data[y + 1],
input_buffer.data[y + 2], input_buffer.data[y + 3]);
}
}
@@ -369,8 +391,7 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
int8_t x;
watt_hours_raw = endian_swap(mr->watt_hours);
if (
(watt_hours_raw == 4194304) // "missing data" message (0x00 40 00 00)
if ((watt_hours_raw == 4194304) // "missing data" message (0x00 40 00 00)
|| (watt_hours_raw == 0)) {
ESP_LOGI(TAG, "Watt-hours value missing");
last_reading_has_error = 1;
@@ -455,22 +476,27 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
int32_t consumed_diff = int32_t(consumed) - int32_t(prev_consumed);
int32_t returned_diff = int32_t(returned) - int32_t(prev_returned);
// Sometimes the reported value is far larger than it should be. Let's ignore it.
if (std::abs(consumed_diff) > MAX_WH_CHANGE || std::abs(returned_diff) > MAX_WH_CHANGE) {
ESP_LOGW(TAG, "Reported watt-hour change is too large vs previous reading. Skipping.");
// The `prev_consumed` and `prev_returned` will still be given the current reading
// even if the value is erroneous.
// Sometimes the reported value is far larger than it should be. Let's
// ignore it.
if (std::abs(consumed_diff) > MAX_WH_CHANGE ||
std::abs(returned_diff) > MAX_WH_CHANGE) {
ESP_LOGW(TAG,
"Reported watt-hour change is too large vs previous reading. "
"Skipping.");
// The `prev_consumed` and `prev_returned` will still be given the current
// reading even if the value is erroneous.
//
// This approach should handle two scenarios:
// 1) Some sort of outage causes a long gap between the previous reading (or is 0 after
// a reboot) and the current reading. In this case, the difference from the previous
// reading can be "too" large, but actually be expected.
// 2) I have seen erroneous blips of a single sample with a value that is way too big.
// 1) Some sort of outage causes a long gap between the previous reading
// (or is 0 after a reboot) and the current reading. In this case, the
// difference from the previous reading can be "too" large, but actually
// be expected. 2) I have seen erroneous blips of a single sample with a
// value that is way too big.
//
// The code handles scenario #1 by ignoring the current reading but then continuing on
// as normal after.
// The code handles scenario #2 by ignoring the current reading, then ignoring the
// followup reading, then continuing on as normal.
// The code handles scenario #1 by ignoring the current reading but then
// continuing on as normal after. The code handles scenario #2 by ignoring
// the current reading, then ignoring the followup reading, then
// continuing on as normal.
//
// At worst, two consecutive samples will be ignored.
prev_consumed = consumed;
@@ -607,15 +633,10 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
struct Addr *mac;
mac = &input_buffer.addr;
snprintf(mgm_mac_address, sizeof(mgm_mac_address), "%02X:%02X:%02X:%02X:%02X:%02X:%02X:%02X",
mac->addr[7],
mac->addr[6],
mac->addr[5],
mac->addr[4],
mac->addr[3],
mac->addr[2],
mac->addr[1],
mac->addr[0]);
snprintf(mgm_mac_address, sizeof(mgm_mac_address),
"%02X:%02X:%02X:%02X:%02X:%02X:%02X:%02X", mac->addr[7],
mac->addr[6], mac->addr[5], mac->addr[4], mac->addr[3],
mac->addr[2], mac->addr[1], mac->addr[0]);
ESP_LOGI(TAG, "MGM Mac Address: %s", mgm_mac_address);
return (0);
}
@@ -625,15 +646,10 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
struct Addr *code;
code = &input_buffer.addr;
snprintf(mgm_install_code, sizeof(mgm_install_code), "%02X:%02X:%02X:%02X:%02X:%02X:%02X:%02X",
code->addr[0],
code->addr[1],
code->addr[2],
code->addr[3],
code->addr[4],
code->addr[5],
code->addr[6],
code->addr[7]);
snprintf(mgm_install_code, sizeof(mgm_install_code),
"%02X:%02X:%02X:%02X:%02X:%02X:%02X:%02X", code->addr[0],
code->addr[1], code->addr[2], code->addr[3], code->addr[4],
code->addr[5], code->addr[6], code->addr[7]);
ESP_LOGI(TAG, "MGM Install Code: %s (secret)", mgm_install_code);
return (0);
}
@@ -660,10 +676,15 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
ESP_LOGI(TAG, "MGM Firmware Version: %d", mgm_firmware_ver);
ESP_LOGI(TAG, "MGM Mac Address: %s", mgm_mac_address);
ESP_LOGI(TAG, "MGM Install Code: %s (secret)", mgm_install_code);
ESP_LOGI(TAG, "Trying to re-join the meter. If you continue to see this message");
ESP_LOGI(TAG, "you may need to move the device closer to your power meter or");
ESP_LOGI(TAG, "contact your utililty and ask them to reprovision the device.");
ESP_LOGI(TAG, "Also confirm that the above mac address & install code match");
ESP_LOGI(
TAG,
"Trying to re-join the meter. If you continue to see this message");
ESP_LOGI(TAG,
"you may need to move the device closer to your power meter or");
ESP_LOGI(TAG,
"contact your utililty and ask them to reprovision the device.");
ESP_LOGI(TAG,
"Also confirm that the above mac address & install code match");
ESP_LOGI(TAG, "what is printed on your device.");
ESP_LOGE(TAG, "You can also file a bug at");
ESP_LOGE(TAG, " https://forms.gle/duMdU2i7wWHdbK5TA");
@@ -701,6 +722,7 @@ class EmporiaVueUtility : public PollingComponent, public uart::UARTDevice {
delay(100);
}
}
private:
uint32_t update_interval_;
sensor::Sensor *power_sensor_{nullptr};

13
esphome/components/emporia_vue_utility/sensor.py
View File

@@ -10,7 +10,7 @@ from esphome.const import (
DEVICE_CLASS_POWER,
DEVICE_CLASS_ENERGY,
STATE_CLASS_MEASUREMENT,
STATE_CLASS_TOTAL_INCREASING
STATE_CLASS_TOTAL_INCREASING,
)
DEPENDENCIES = ["uart"]
@@ -29,8 +29,10 @@ ENERGY_SENSOR_TYPES = {
ALL_SENSOR_TYPES = {**POWER_SENSOR_TYPES, **ENERGY_SENSOR_TYPES}
emporia_vue_utility_ns = cg.esphome_ns.namespace('emporia_vue_utility')
EmporiaVueUtility = emporia_vue_utility_ns.class_('EmporiaVueUtility', cg.PollingComponent, uart.UARTDevice)
emporia_vue_utility_ns = cg.esphome_ns.namespace("emporia_vue_utility")
EmporiaVueUtility = emporia_vue_utility_ns.class_(
"EmporiaVueUtility", cg.PollingComponent, uart.UARTDevice
)
CONFIG_SCHEMA = cv.All(
cv.Schema(
@@ -53,13 +55,14 @@ CONFIG_SCHEMA = cv.All(
accuracy_decimals=0,
)
for name in ENERGY_SENSOR_TYPES
}
},
}
)
.extend(cv.polling_component_schema('30s'))
.extend(cv.polling_component_schema("30s"))
.extend(uart.UART_DEVICE_SCHEMA)
)
async def to_code(config):
var = cg.new_Pvariable(config[CONF_ID])
await cg.register_component(var, config)