Add Neey/EnerKey EK-24S4EB balancer support (Closes: syssi#444) (syssi#452)

Author: syssi

components/heltec_balancer_ble/heltec_balancer_ble.cpp

@@ -82,14 +82,6 @@ uint8_t crc(const uint8_t data[], const uint16_t len) {
   return crc;
 }
 
-uint8_t checksum_xor(const uint8_t data[], const uint16_t len) {
-  uint8_t checksum = 0;
-  for (uint16_t i = 0; i < len; i++) {
-    checksum = checksum ^ data[i];
-  }
-  return checksum;
-}
-
 void HeltecBalancerBle::dump_config() {  // NOLINT(google-readability-function-size,readability-function-size)
   ESP_LOGCONFIG(TAG, "HeltecBalancerBle");
   LOG_SENSOR("", "Minimum Cell Voltage", this->min_cell_voltage_sensor_);
@@ -173,6 +165,30 @@ void HeltecBalancerBle::gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt
                  this->parent_->address_str().c_str());
         break;
       }
+
+      // Services and characteristic of a GW-24S4EB, HW-2.8.0, SW-1.1.0, V1.0.0, 20210915 (3C:A5:51:XX:XX:XX)
+      //
+      // Service UUID: 0x1800
+      //  start_handle: 0x1  end_handle: 0x7
+      // Service UUID: 0xFFE0
+      //  start_handle: 0x8  end_handle: 0xffff
+      // Connected
+      //  characteristic 0xFFE1, handle 0xa, properties 0x1c
+      //  characteristic 0xFFE2, handle 0xd, properties 0x1c
+      //  characteristic 0xFFE3, handle 0x10, properties 0xc
+      // cfg_mtu status 0, mtu 244
+
+      // Services and characteristic of a EK-24S4EB, HW-3.2.0, ZH-1.2.9, V1.2.9, 20230608 (3C:A5:51:XX:XX:XX)
+      //
+      // Service UUID: 0x1800
+      //  start_handle: 0x1  end_handle: 0x7
+      // Service UUID: 0xFFE0
+      //  start_handle: 0x8  end_handle: 0xffff
+      // Connected
+      //  characteristic 0xFFE1, handle 0xa, properties 0x1c
+      //  characteristic 0xFFE2, handle 0xd, properties 0x1c
+      //  characteristic 0xFFE3, handle 0x10, properties 0xc
+      // cfg_mtu status 0, mtu 244
       this->char_handle_ = chr->handle;
 
       auto status = esp_ble_gattc_register_for_notify(this->parent()->get_gattc_if(), this->parent()->get_remote_bda(),
@@ -689,23 +705,41 @@ void HeltecBalancerBle::decode_device_info_(const std::vector<uint8_t> &data) {
 
 bool HeltecBalancerBle::send_command(uint8_t function, uint8_t command, uint8_t register_address, uint32_t value) {
   // Request device info:
+  //
+  // (GW-24S4EB, checksum_xor)
   // 0xAA 0x55 0x11 0x01 0x01 0x00 0x14 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0xFA 0xFF
+  // 0xAA 0x55 0x11 0x01 0x01 0x00 0x14 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x26 0xFF
+  // (EK-24S4EB, crc)
   //
   // Request cell info:
+  //
+  // (GW-24S4EB, checksum_xor, wrong data_len position)
   // 0xAA 0x55 0x11 0x01 0x02 0x00 0x00 0x14 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0xF9 0xFF
+  // 0xAA 0x55 0x11 0x01 0x02 0x00 0x14 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x27 0xFF
+  // (EK-24S4EB, crc)
   //
   // Request factory settings:
+  //
+  // (GW-24S4EB, checksum_xor)
   // 0xAA 0x55 0x11 0x01 0x03 0x00 0x14 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0xF8 0xFF
   //
   // Request settings:
+  //
+  // (GW-24S4EB, checksum_xor)
   // 0xAA 0x55 0x11 0x01 0x04 0x00 0x14 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0xFF 0xFF
+  // 0xAA 0x55 0x11 0x01 0x04 0x00 0x14 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x29 0xFF
+  // (EK-24S4EB, crc)
   //
   // Enable balancer:
+  //
+  // (GW-24S4EB, checksum_xor)
   // 0xAA 0x55 0x11 0x00 0x05 0x0D 0x14 0x00 0x01 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0xF3 0xFF
   //
   // Disable balancer:
+  //
+  // (GW-24S4EB, checksum_xor)
   // 0xAA 0x55 0x11 0x00 0x05 0x0D 0x14 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0xF2 0xFF
-  uint16_t length = (command == COMMAND_CELL_INFO) ? 0x1400 : 0x0014;  // Replicate behavior or bug of the android app
+  uint16_t length = 0x0014;
 
   uint8_t frame[20];
   frame[0] = SOF_REQUEST_BYTE1;  // Start sequence
@@ -726,7 +760,7 @@ bool HeltecBalancerBle::send_command(uint8_t function, uint8_t command, uint8_t
   frame[15] = 0x00;              // Data Byte 8
   frame[16] = 0x00;              // Data Byte 9
   frame[17] = 0x00;              // Data Byte 10
-  frame[18] = checksum_xor(frame, sizeof(frame) - 2);
+  frame[18] = crc(frame, sizeof(frame) - 2);
   frame[19] = END_OF_FRAME;  // End sequence
 
   ESP_LOGD(TAG, "Write register: %s", format_hex_pretty(frame, sizeof(frame)).c_str());