Refactor BedJet climate into Hub component (#3522)

esphome/components/bedjet/bedjet_codec.cpp

@@ -0,0 +1,161 @@
+#include "bedjet_codec.h"
+#include <cstdio>
+#include <cstring>
+
+namespace esphome {
+namespace bedjet {
+
+/// Converts a BedJet temp step into degrees Fahrenheit.
+float bedjet_temp_to_f(const uint8_t temp) {
+  // BedJet temp is "C*2"; to get F, multiply by 0.9 (half 1.8) and add 32.
+  return 0.9f * temp + 32.0f;
+}
+
+/** Cleans up the packet before sending. */
+BedjetPacket *BedjetCodec::clean_packet_() {
+  // So far no commands require more than 2 bytes of data.
+  assert(this->packet_.data_length <= 2);
+  for (int i = this->packet_.data_length; i < 2; i++) {
+    this->packet_.data[i] = '\0';
+  }
+  ESP_LOGV(TAG, "Created packet: %02X, %02X %02X", this->packet_.command, this->packet_.data[0], this->packet_.data[1]);
+  return &this->packet_;
+}
+
+/** Returns a BedjetPacket that will initiate a BedjetButton press. */
+BedjetPacket *BedjetCodec::get_button_request(BedjetButton button) {
+  this->packet_.command = CMD_BUTTON;
+  this->packet_.data_length = 1;
+  this->packet_.data[0] = button;
+  return this->clean_packet_();
+}
+
+/** Returns a BedjetPacket that will set the device's target `temperature`. */
+BedjetPacket *BedjetCodec::get_set_target_temp_request(float temperature) {
+  this->packet_.command = CMD_SET_TEMP;
+  this->packet_.data_length = 1;
+  this->packet_.data[0] = temperature * 2;
+  return this->clean_packet_();
+}
+
+/** Returns a BedjetPacket that will set the device's target fan speed. */
+BedjetPacket *BedjetCodec::get_set_fan_speed_request(const uint8_t fan_step) {
+  this->packet_.command = CMD_SET_FAN;
+  this->packet_.data_length = 1;
+  this->packet_.data[0] = fan_step;
+  return this->clean_packet_();
+}
+
+/** Returns a BedjetPacket that will set the device's current time. */
+BedjetPacket *BedjetCodec::get_set_time_request(const uint8_t hour, const uint8_t minute) {
+  this->packet_.command = CMD_SET_CLOCK;
+  this->packet_.data_length = 2;
+  this->packet_.data[0] = hour;
+  this->packet_.data[1] = minute;
+  return this->clean_packet_();
+}
+
+/** Returns a BedjetPacket that will set the device's remaining runtime. */
+BedjetPacket *BedjetCodec::get_set_runtime_remaining_request(const uint8_t hour, const uint8_t minute) {
+  this->packet_.command = CMD_SET_RUNTIME;
+  this->packet_.data_length = 2;
+  this->packet_.data[0] = hour;
+  this->packet_.data[1] = minute;
+  return this->clean_packet_();
+}
+
+/** Decodes the extra bytes that were received after being notified with a partial packet. */
+void BedjetCodec::decode_extra(const uint8_t *data, uint16_t length) {
+  ESP_LOGVV(TAG, "Received extra: %d bytes: %d %d %d %d", length, data[1], data[2], data[3], data[4]);
+  uint8_t offset = this->last_buffer_size_;
+  if (offset > 0 && length + offset <= sizeof(BedjetStatusPacket)) {
+    memcpy(((uint8_t *) (&this->buf_)) + offset, data, length);
+    ESP_LOGVV(TAG,
+              "Extra bytes: skip1=0x%08x, skip2=0x%04x, skip3=0x%02x; update phase=0x%02x, "
+              "flags=BedjetFlags <conn=%c, leds=%c, units=%c, mute=%c; packed=%02x>",
+              this->buf_.unused_1, this->buf_.unused_2, this->buf_.unused_3, this->buf_.update_phase,
+              this->buf_.flags.conn_test_passed ? '1' : '0', this->buf_.flags.leds_enabled ? '1' : '0',
+              this->buf_.flags.units_setup ? '1' : '0', this->buf_.flags.beeps_muted ? '1' : '0',
+              this->buf_.flags_packed);
+  } else {
+    ESP_LOGI(TAG, "Could not determine where to append to, last offset=%d, max size=%u, new size would be %d", offset,
+             sizeof(BedjetStatusPacket), length + offset);
+  }
+}
+
+/** Decodes the incoming status packet received on the BEDJET_STATUS_UUID.
+ *
+ * @return `true` if the packet was decoded and represents a "partial" packet; `false` otherwise.
+ */
+bool BedjetCodec::decode_notify(const uint8_t *data, uint16_t length) {
+  ESP_LOGV(TAG, "Received: %d bytes: %d %d %d %d", length, data[1], data[2], data[3], data[4]);
+
+  if (data[1] == PACKET_FORMAT_V3_HOME && data[3] == PACKET_TYPE_STATUS) {
+    // Clear old buffer
+    memset(&this->buf_, 0, sizeof(BedjetStatusPacket));
+    // Copy new data into buffer
+    memcpy(&this->buf_, data, length);
+    this->last_buffer_size_ = length;
+
+    // TODO: validate the packet checksum?
+    if (this->buf_.mode < 7 && this->buf_.target_temp_step >= 38 && this->buf_.target_temp_step <= 86 &&
+        this->buf_.actual_temp_step > 1 && this->buf_.actual_temp_step <= 100 && this->buf_.ambient_temp_step > 1 &&
+        this->buf_.ambient_temp_step <= 100) {
+      // and save it for the update() loop
+      this->status_packet_ = &this->buf_;
+      return this->buf_.is_partial;
+    } else {
+      this->status_packet_ = nullptr;
+      // TODO: log a warning if we detect that we connected to a non-V3 device.
+      ESP_LOGW(TAG, "Received potentially invalid packet (len %d):", length);
+    }
+  } else if (data[1] == PACKET_FORMAT_DEBUG || data[3] == PACKET_TYPE_DEBUG) {
+    // We don't actually know the packet format for this. Dump packets to log, in case a pattern presents itself.
+    ESP_LOGVV(TAG,
+              "received DEBUG packet: set1=%01fF, set2=%01fF, air=%01fF;  [7]=%d, [8]=%d, [9]=%d, [10]=%d, [11]=%d, "
+              "[12]=%d, [-1]=%d",
+              bedjet_temp_to_f(data[4]), bedjet_temp_to_f(data[5]), bedjet_temp_to_f(data[6]), data[7], data[8],
+              data[9], data[10], data[11], data[12], data[length - 1]);
+
+    if (this->has_status()) {
+      this->status_packet_->ambient_temp_step = data[6];
+    }
+  } else {
+    // TODO: log a warning if we detect that we connected to a non-V3 device.
+  }
+
+  return false;
+}
+
+/** @return `true` if the new packet is meaningfully different from the last seen packet. */
+bool BedjetCodec::compare(const uint8_t *data, uint16_t length) {
+  if (data == nullptr) {
+    return false;
+  }
+
+  if (length < 17) {
+    // New packet looks small, skip it.
+    return false;
+  }
+
+  if (this->buf_.packet_format != PACKET_FORMAT_V3_HOME ||
+      this->buf_.packet_type != PACKET_TYPE_STATUS) {  // No last seen packet, so take the new one.
+    return true;
+  }
+
+  if (data[1] != PACKET_FORMAT_V3_HOME || data[3] != PACKET_TYPE_STATUS) {  // New packet is not a v3 status, skip it.
+    return false;
+  }
+
+  // Now coerce it to a status packet and compare some key fields
+  const BedjetStatusPacket *test = reinterpret_cast<const BedjetStatusPacket *>(data);
+  // These are fields that will only change due to explicit action.
+  // That is why we do not check ambient or actual temp here, because those are environmental.
+  bool explicit_fields_changed = this->buf_.mode != test->mode || this->buf_.fan_step != test->fan_step ||
+                                 this->buf_.target_temp_step != test->target_temp_step;
+
+  return explicit_fields_changed;
+}
+
+}  // namespace bedjet
+}  // namespace esphome