mirror of https://github.com/arendst/Tasmota.git
211 lines
8.3 KiB
C++
211 lines
8.3 KiB
C++
/*
|
|
xsns_115_wooliis.ino - Wooliis Hall Effect Coulometer (Battery capacity monitor) support for Tasmota
|
|
|
|
Copyright (C) 2024 Luca Melette
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifdef USE_WOOLIIS
|
|
/*********************************************************************************************\
|
|
* Wooliis Hall Effect Coulometer (Battery capacity monitor) with LCD
|
|
* Model variants: WLS-PVA050 WLS-PVA100 WLS-PVA200 WLS-PVA400 (current ratings 50A, 100A, 200A, 400A)
|
|
* Similar models: WLS-MVAxxx, WLS-TVAxxx, WLS-HVAxxx (not investigated)
|
|
*
|
|
* Manufacturer links:
|
|
* (Chinese) http://www.wooliis.com/products_view.aspx?ID=75
|
|
* (English) http://www.wooliis.com/Enproducts_view.aspx?ID=75
|
|
*
|
|
* Alternative branding: Drok (Ebay), AiLi (Amazon)
|
|
*
|
|
* Inside the case, on the PCB, there is an active serial port with labels Gnd/TX/RX/Vcc.
|
|
* In some product variants, it might be connected to a Bluetooth module for remote operation.
|
|
* On the TX pin, meter readings are sent out every 5 secs using 9600 8N1
|
|
*
|
|
* Values in binary messages can be mapped as follows:
|
|
*
|
|
* magic % Ah V A Wh_in Wh_out status ck
|
|
* b55b0101 64 03e8 0088 001d 00032b 0002b6 0000a8 6b
|
|
* 0 1 2 3 4 5 6 7 8 910 111213 141516 171819 20
|
|
*
|
|
* And decoded as:
|
|
* - Charge = 100 %
|
|
* - Remaining capacity = 100 Ah
|
|
* - Voltage = 13.6V
|
|
* - Current = 2.9 A
|
|
* - Energy IN = 81.1 Wh
|
|
* - Energy OUT = 69.4 Wh
|
|
* - Status = charging
|
|
*
|
|
* Hardware Serial will be selected if GPIO3 = [Wooliis RX]
|
|
\*********************************************************************************************/
|
|
|
|
#define XSNS_115 115
|
|
|
|
#define D_WOOLIIS "Wooliis"
|
|
|
|
#include <TasmotaSerial.h>
|
|
|
|
TasmotaSerial *WooliisSerial = nullptr;
|
|
|
|
typedef struct wooliis_data_t {
|
|
float remaining_capacity;
|
|
float voltage;
|
|
float current;
|
|
float energy_in;
|
|
float energy_out;
|
|
uint8_t status;
|
|
uint8_t valid = 0;
|
|
uint8_t charge_percent;
|
|
} wooliis_data_t;
|
|
|
|
wooliis_data_t *Wooliis = nullptr;
|
|
|
|
/*********************************************************************************************/
|
|
|
|
void WooliisReadData() // process the data sent by Wooliis battery capacity monitors every second
|
|
{
|
|
while (WooliisSerial->available() && WooliisSerial->peek() != 0xb5) {
|
|
WooliisSerial->read();
|
|
}
|
|
if (WooliisSerial->available() < 21) {
|
|
return;
|
|
}
|
|
uint8_t buffer[21];
|
|
WooliisSerial->readBytes(buffer, 21);
|
|
if (buffer[0] != 0xb5 && buffer[1] != 0x5b && buffer[2] == 0x01 && buffer[3] == 0x01) {
|
|
AddLog(LOG_LEVEL_DEBUG, PSTR("WLS: Flush %21_H"), buffer);
|
|
WooliisSerial->flush(); // Out of sync or wrong sensor connected
|
|
return;
|
|
}
|
|
|
|
uint8_t checksum = 0;
|
|
for (uint32_t i = 0; i < 20; i++) {
|
|
checksum += buffer[i];
|
|
}
|
|
checksum = 255 - checksum;
|
|
if (checksum != buffer[20]) {
|
|
AddLog(LOG_LEVEL_DEBUG, PSTR("WLS: " D_CHECKSUM_FAILURE));
|
|
return;
|
|
}
|
|
|
|
AddLog(LOG_LEVEL_DEBUG_MORE, PSTR("WLS: Rcvd %21_H"), buffer);
|
|
|
|
Wooliis->charge_percent = buffer[4];
|
|
Wooliis->remaining_capacity = 0.1f * ((uint16_t)buffer[5]<<8 | buffer[6]);
|
|
Wooliis->voltage = 0.1f * ((uint16_t)buffer[7]<<8 | buffer[8]);
|
|
Wooliis->current = (buffer[19] ? -0.1f : 0.1f) * ((uint16_t)buffer[9]<<8 | buffer[10]);
|
|
Wooliis->energy_in = 0.1f * ((uint32_t)buffer[11]<<16 | (uint16_t)buffer[12]<<8 | buffer[13]);
|
|
Wooliis->energy_out = 0.1f * ((uint32_t)buffer[14]<<16 | (uint16_t)buffer[15]<<8 | buffer[16]);
|
|
Wooliis->status = buffer[19];
|
|
|
|
Wooliis->valid = 1;
|
|
}
|
|
|
|
/*********************************************************************************************/
|
|
|
|
void WooliisInit(void) {
|
|
if (PinUsed(GPIO_WOOLIIS_RX)) {
|
|
WooliisSerial = new TasmotaSerial(Pin(GPIO_WOOLIIS_RX), -1, 1);
|
|
if (WooliisSerial->begin(9600)) {
|
|
if (WooliisSerial->hardwareSerial()) { ClaimSerial(); }
|
|
WooliisSerial->flush(); // Clear serial buffer
|
|
Wooliis = (wooliis_data_t*)calloc(sizeof(wooliis_data_t), 1);
|
|
if (nullptr == Wooliis) { return; }
|
|
AddLog(LOG_LEVEL_DEBUG, PSTR("WLS: Serial ready"));
|
|
}
|
|
}
|
|
}
|
|
|
|
#ifdef USE_WEBSERVER
|
|
const char HTTP_SNS_WOOLIIS_BCP[] = "{s}" D_BATTERY " " D_BATTERY_CHARGE "{m}%d " D_UNIT_PERCENT "{e}";
|
|
const char HTTP_SNS_WOOLIIS_CAP[] = "{s}" D_BATTERY " " D_CAPACITY "{m}%*_f " D_UNIT_CHARGE "{e}";
|
|
const char HTTP_SNS_WOOLIIS_CHG[] = "{s}" D_BATTERY " " D_CHARGING "{m}%s{e}";
|
|
const char HTTP_SNS_WOOLIIS_VOL[] = "{s}" D_BATTERY " " D_VOLTAGE "{m}%*_f " D_UNIT_VOLT "{e}";
|
|
const char HTTP_SNS_WOOLIIS_CUR[] = "{s}" D_BATTERY " " D_CURRENT "{m}%*_f " D_UNIT_AMPERE "{e}";
|
|
const char HTTP_SNS_WOOLIIS_POW[] = "{s}" D_BATTERY " " D_POWERUSAGE "{m}%*_f " D_UNIT_WATT "{e}";
|
|
const char HTTP_SNS_WOOLIIS_IMP[] = "{s}" D_BATTERY " " D_IMPORT "{m}%*_f " D_UNIT_WATTHOUR "{e}";
|
|
const char HTTP_SNS_WOOLIIS_EXP[] = "{s}" D_BATTERY " " D_EXPORT "{m}%*_f " D_UNIT_WATTHOUR "{e}";
|
|
#endif // USE_WEBSERVER
|
|
|
|
void WooliisShow(bool json) {
|
|
if (Wooliis->valid) {
|
|
float power = Wooliis->voltage*Wooliis->current;
|
|
if (json) {
|
|
ResponseAppend_P(PSTR(",\"" D_WOOLIIS "\":{"));
|
|
ResponseAppend_P(PSTR("\"" D_JSON_CAPACITY "\":%*_f,"), Settings->flag2.energy_resolution, &Wooliis->remaining_capacity);
|
|
ResponseAppend_P(PSTR("\"" D_JSON_CHARGING "\":%d,"), (Wooliis->status ? 1 : 0));
|
|
ResponseAppend_P(PSTR("\"" D_JSON_VOLTAGE "\":%*_f,"), Settings->flag2.voltage_resolution, &Wooliis->voltage);
|
|
ResponseAppend_P(PSTR("\"" D_JSON_CURRENT "\":%*_f,"), Settings->flag2.current_resolution, &Wooliis->current);
|
|
ResponseAppend_P(PSTR("\"" D_JSON_POWERUSAGE "\":%*_f,"), Settings->flag2.wattage_resolution, &power);
|
|
ResponseAppend_P(PSTR("\"" D_JSON_IMPORT "\":%*_f,"), Settings->flag2.energy_resolution, &Wooliis->energy_in);
|
|
ResponseAppend_P(PSTR("\"" D_JSON_EXPORT "\":%*_f"), Settings->flag2.energy_resolution, &Wooliis->energy_out);
|
|
ResponseJsonEnd();
|
|
#ifdef USE_DOMOTICZ
|
|
if (0 == TasmotaGlobal.tele_period) {
|
|
char pe[16];
|
|
snprintf_P(pe, sizeof(pe), PSTR("%d;%d"), Wooliis->voltage*Wooliis->current, Wooliis->energy_out);
|
|
DomoticzSensor(DZ_COUNT, Wooliis->charge_percent);
|
|
DomoticzSensor(DZ_VOLTAGE, Wooliis->voltage);
|
|
DomoticzSensor(DZ_CURRENT, Wooliis->current);
|
|
DomoticzSensor(DZ_POWER_ENERGY, pe);
|
|
}
|
|
#endif // USE_DOMOTICZ
|
|
} // if json
|
|
#ifdef USE_WEBSERVER
|
|
else {
|
|
WSContentSend_PD(HTTP_SNS_WOOLIIS_BCP, Wooliis->charge_percent);
|
|
WSContentSend_PD(HTTP_SNS_WOOLIIS_CAP, Settings->flag2.energy_resolution, &Wooliis->remaining_capacity);
|
|
WSContentSend_PD(HTTP_SNS_WOOLIIS_CHG, (Wooliis->status ? D_TRUE : D_FALSE));
|
|
WSContentSend_PD(HTTP_SNS_WOOLIIS_VOL, Settings->flag2.voltage_resolution, &Wooliis->voltage);
|
|
WSContentSend_PD(HTTP_SNS_WOOLIIS_CUR, Settings->flag2.current_resolution, &Wooliis->current);
|
|
WSContentSend_PD(HTTP_SNS_WOOLIIS_POW, Settings->flag2.wattage_resolution, &power);
|
|
WSContentSend_PD(HTTP_SNS_WOOLIIS_IMP, Settings->flag2.energy_resolution, &Wooliis->energy_in);
|
|
WSContentSend_PD(HTTP_SNS_WOOLIIS_EXP, Settings->flag2.energy_resolution, &Wooliis->energy_out);
|
|
}
|
|
#endif // USE_WEBSERVER
|
|
}
|
|
}
|
|
|
|
/*********************************************************************************************\
|
|
* Interface
|
|
\*********************************************************************************************/
|
|
|
|
bool Xsns115(uint32_t function)
|
|
{
|
|
bool result = false;
|
|
|
|
if (FUNC_INIT == function) {
|
|
WooliisInit();
|
|
}
|
|
else if (Wooliis) {
|
|
switch (function) {
|
|
case FUNC_EVERY_SECOND:
|
|
WooliisReadData();
|
|
break;
|
|
case FUNC_JSON_APPEND:
|
|
WooliisShow(1);
|
|
break;
|
|
#ifdef USE_WEBSERVER
|
|
case FUNC_WEB_SENSOR:
|
|
WooliisShow(0);
|
|
break;
|
|
#endif // USE_WEBSERVER
|
|
}
|
|
}
|
|
return result;
|
|
}
|
|
|
|
#endif // USE_WOOLIIS
|