patrick/OpenDTU-old
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
4324ae3081
OpenDTU-old/lib/VeDirectFrameHandler/VeDirectFrameHandler.cpp
Philipp Sandhaus 7142921021
Integration of Victron SmartShunt via VE.Direct (#452) 
* Move Mppt logic to subclass

* Added Definitions for Shunts and restructering

* First integration of SmartShunt data into Web Interface

* Code cleanup

* VE.Direct: whitespace cleanup

* VE.Direct: manage HardwareSerial in unique_ptr

* VE.Direct: _efficiency is only needed by MPPT

* VE.Direct: keep as many members private as possible

* VE.Direct: use int8_t for pins (as before)

* VictronSmartShunt: _verboseLogging is not used

* VE.Direct: OR (off reason) is MPPT specific

it also applies to Phoenix inverters and Smart BuckBoost, but since
there is no support for those, the code is moved to the MPPT controller.

* Added Shunt alarms to liveview
Changed from double to int for several readings

* Update build.yml to allow manual builds

---------

Co-authored-by: Philipp Sandhaus <philipp.sandhaus@cewe.de>
Co-authored-by: Bernhard Kirchen <schlimmchen@posteo.net>
2023-09-22 17:24:57 +02:00

609 lines
14 KiB
C++
Raw Blame History

/* framehandler.cpp
*
* Arduino library to read from Victron devices using VE.Direct protocol.
* Derived from Victron framehandler reference implementation.
*
* The MIT License
*
* Copyright (c) 2019 Victron Energy BV
* Portions Copyright (C) 2020 Chris Terwilliger
* https://github.com/cterwilliger/VeDirectFrameHandler
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* 2020.05.05 - 0.2 - initial release
* 2020.06.21 - 0.2 - add MIT license, no code changes
* 2020.08.20 - 0.3 - corrected #include reference
*
*/
#include <Arduino.h>
#include "VeDirectFrameHandler.h"
// The name of the record that contains the checksum.
static constexpr char checksumTagName[] = "CHECKSUM";
// state machine
enum States {
IDLE = 1,
RECORD_BEGIN = 2,
RECORD_NAME = 3,
RECORD_VALUE = 4,
CHECKSUM = 5,
RECORD_HEX = 6
};
class Silent : public Print {
public:
size_t write(uint8_t c) final { return 0; }
};
static Silent MessageOutputDummy;
VeDirectFrameHandler::VeDirectFrameHandler() :
_msgOut(&MessageOutputDummy),
_lastUpdate(0),
_state(IDLE),
_checksum(0),
_textPointer(0),
_hexSize(0),
_name(""),
_value(""),
_debugIn(0),
_lastByteMillis(0)
{
}
void VeDirectFrameHandler::setVerboseLogging(bool verboseLogging)
{
_verboseLogging = verboseLogging;
if (!_verboseLogging) { _debugIn = 0; }
}
void VeDirectFrameHandler::init(int8_t rx, int8_t tx, Print* msgOut, bool verboseLogging, uint16_t hwSerialPort)
{
_vedirectSerial = std::make_unique<HardwareSerial>(hwSerialPort);
_vedirectSerial->begin(19200, SERIAL_8N1, rx, tx);
_vedirectSerial->flush();
_msgOut = msgOut;
setVerboseLogging(verboseLogging);
}
void VeDirectFrameHandler::dumpDebugBuffer() {
_msgOut->printf("[VE.Direct] serial input (%d Bytes):", _debugIn);
for (int i = 0; i < _debugIn; ++i) {
if (i % 16 == 0) {
_msgOut->printf("\r\n[VE.Direct]");
}
_msgOut->printf(" %02x", _debugBuffer[i]);
}
_msgOut->println("");
_debugIn = 0;
}
void VeDirectFrameHandler::loop()
{
while ( _vedirectSerial->available()) {
rxData(_vedirectSerial->read());
_lastByteMillis = millis();
}
// there will never be a large gap between two bytes of the same frame.
// if such a large gap is observed, reset the state machine so it tries
// to decode a new frame once more data arrives.
if (IDLE != _state && _lastByteMillis + 500 < millis()) {
_msgOut->printf("[VE.Direct] Resetting state machine (was %d) after timeout\r\n", _state);
if (_verboseLogging) { dumpDebugBuffer(); }
_checksum = 0;
_state = IDLE;
}
}
/*
* rxData
* This function is called by loop() which passes a byte of serial data
* Based on Victron's example code. But using String and Map instead of pointer and arrays
*/
void VeDirectFrameHandler::rxData(uint8_t inbyte)
{
if (_verboseLogging) {
_debugBuffer[_debugIn] = inbyte;
_debugIn = (_debugIn + 1) % _debugBuffer.size();
if (0 == _debugIn) {
_msgOut->println("[VE.Direct] ERROR: debug buffer overrun!");
}
}
if ( (inbyte == ':') && (_state != CHECKSUM) ) {
_prevState = _state; //hex frame can interrupt TEXT
_state = RECORD_HEX;
_hexSize = 0;
}
if (_state != RECORD_HEX) {
_checksum += inbyte;
}
inbyte = toupper(inbyte);
switch(_state) {
case IDLE:
/* wait for \n of the start of an record */
switch(inbyte) {
case '\n':
_state = RECORD_BEGIN;
break;
case '\r': /* Skip */
default:
break;
}
break;
case RECORD_BEGIN:
_textPointer = _name;
*_textPointer++ = inbyte;
_state = RECORD_NAME;
break;
case RECORD_NAME:
// The record name is being received, terminated by a \t
switch(inbyte) {
case '\t':
// the Checksum record indicates a EOR
if ( _textPointer < (_name + sizeof(_name)) ) {
*_textPointer = 0; /* Zero terminate */
if (strcmp(_name, checksumTagName) == 0) {
_state = CHECKSUM;
break;
}
}
_textPointer = _value; /* Reset value pointer */
_state = RECORD_VALUE;
break;
case '#': /* Ignore # from serial number*/
break;
default:
// add byte to name, but do no overflow
if ( _textPointer < (_name + sizeof(_name)) )
*_textPointer++ = inbyte;
break;
}
break;
case RECORD_VALUE:
// The record value is being received. The \r indicates a new record.
switch(inbyte) {
case '\n':
if ( _textPointer < (_value + sizeof(_value)) ) {
*_textPointer = 0; // make zero ended
textRxEvent(_name, _value);
}
_state = RECORD_BEGIN;
break;
case '\r': /* Skip */
break;
default:
// add byte to value, but do no overflow
if ( _textPointer < (_value + sizeof(_value)) )
*_textPointer++ = inbyte;
break;
}
break;
case CHECKSUM:
{
bool valid = _checksum == 0;
if (!valid) {
_msgOut->printf("[VE.Direct] checksum 0x%02x != 0, invalid frame\r\n", _checksum);
}
if (_verboseLogging) { dumpDebugBuffer(); }
_checksum = 0;
_state = IDLE;
frameEndEvent(valid);
break;
}
case RECORD_HEX:
_state = hexRxEvent(inbyte);
break;
}
}
/*
* textRxEvent
* This function is called every time a new name/value is successfully parsed. It writes the values to the temporary buffer.
*/
void VeDirectFrameHandler::textRxEvent(char * name, char * value, veStruct& frame) {
if (strcmp(name, "PID") == 0) {
frame.PID = strtol(value, nullptr, 0);
}
else if (strcmp(name, "SER") == 0) {
strcpy(frame.SER, value);
}
else if (strcmp(name, "FW") == 0) {
strcpy(frame.FW, value);
}
else if (strcmp(name, "V") == 0) {
frame.V = round(atof(value) / 10.0) / 100.0;
}
else if (strcmp(name, "I") == 0) {
frame.I = round(atof(value) / 10.0) / 100.0;
}
}
/*
* hexRxEvent
* This function records hex answers or async messages
*/
int VeDirectFrameHandler::hexRxEvent(uint8_t inbyte) {
int ret=RECORD_HEX; // default - continue recording until end of frame
switch (inbyte) {
case '\n':
// restore previous state
ret=_prevState;
break;
default:
_hexSize++;
if (_hexSize>=VE_MAX_HEX_LEN) { // oops -buffer overflow - something went wrong, we abort
_msgOut->println("[VE.Direct] hexRx buffer overflow - aborting read");
_hexSize=0;
ret=IDLE;
}
}
return ret;
}
bool VeDirectFrameHandler::isDataValid(veStruct frame) {
if (_lastUpdate == 0) {
return false;
}
if (strlen(frame.SER) == 0) {
return false;
}
return true;
}
unsigned long VeDirectFrameHandler::getLastUpdate()
{
return _lastUpdate;
}
/*
* getPidAsString
* This function returns the product id (PID) as readable text.
*/
String VeDirectFrameHandler::getPidAsString(uint16_t pid)
{
String strPID ="";
switch(pid) {
case 0x0300:
strPID = "BlueSolar MPPT 70|15";
break;
case 0xA040:
strPID = "BlueSolar MPPT 75|50";
break;
case 0xA041:
strPID = "BlueSolar MPPT 150|35";
break;
case 0xA042:
strPID = "BlueSolar MPPT 75|15";
break;
case 0xA043:
strPID = "BlueSolar MPPT 100|15";
break;
case 0xA044:
strPID = "BlueSolar MPPT 100|30";
break;
case 0xA045:
strPID = "BlueSolar MPPT 100|50";
break;
case 0xA046:
strPID = "BlueSolar MPPT 100|70";
break;
case 0xA047:
strPID = "BlueSolar MPPT 150|100";
break;
case 0xA049:
strPID = "BlueSolar MPPT 100|50 rev2";
break;
case 0xA04A:
strPID = "BlueSolar MPPT 100|30 rev2";
break;
case 0xA04B:
strPID = "BlueSolar MPPT 150|35 rev2";
break;
case 0XA04C:
strPID = "BlueSolar MPPT 75|10";
break;
case 0XA04D:
strPID = "BlueSolar MPPT 150|45";
break;
case 0XA04E:
strPID = "BlueSolar MPPT 150|60";
break;
case 0XA04F:
strPID = "BlueSolar MPPT 150|85";
break;
case 0XA050:
strPID = "SmartSolar MPPT 250|100";
break;
case 0XA051:
strPID = "SmartSolar MPPT 150|100";
break;
case 0XA052:
strPID = "SmartSolar MPPT 150|85";
break;
case 0XA053:
strPID = "SmartSolar MPPT 75|15";
break;
case 0XA054:
strPID = "SmartSolar MPPT 75|10";
break;
case 0XA055:
strPID = "SmartSolar MPPT 100|15";
break;
case 0XA056:
strPID = "SmartSolar MPPT 100|30";
break;
case 0XA057:
strPID = "SmartSolar MPPT 100|50";
break;
case 0XA058:
strPID = "SmartSolar MPPT 150|35";
break;
case 0XA059:
strPID = "SmartSolar MPPT 150|10 rev2";
break;
case 0XA05A:
strPID = "SmartSolar MPPT 150|85 rev2";
break;
case 0XA05B:
strPID = "SmartSolar MPPT 250|70";
break;
case 0XA05C:
strPID = "SmartSolar MPPT 250|85";
break;
case 0XA05D:
strPID = "SmartSolar MPPT 250|60";
break;
case 0XA05E:
strPID = "SmartSolar MPPT 250|45";
break;
case 0XA05F:
strPID = "SmartSolar MPPT 100|20";
break;
case 0XA060:
strPID = "SmartSolar MPPT 100|20 48V";
break;
case 0XA061:
strPID = "SmartSolar MPPT 150|45";
break;
case 0XA062:
strPID = "SmartSolar MPPT 150|60";
break;
case 0XA063:
strPID = "SmartSolar MPPT 150|70";
break;
case 0XA064:
strPID = "SmartSolar MPPT 250|85 rev2";
break;
case 0XA065:
strPID = "SmartSolar MPPT 250|100 rev2";
break;
case 0XA066:
strPID = "BlueSolar MPPT 100|20";
break;
case 0XA067:
strPID = "BlueSolar MPPT 100|20 48V";
break;
case 0XA068:
strPID = "SmartSolar MPPT 250|60 rev2";
break;
case 0XA069:
strPID = "SmartSolar MPPT 250|70 rev2";
break;
case 0XA06A:
strPID = "SmartSolar MPPT 150|45 rev2";
break;
case 0XA06B:
strPID = "SmartSolar MPPT 150|60 rev2";
break;
case 0XA06C:
strPID = "SmartSolar MPPT 150|70 rev2";
break;
case 0XA06D:
strPID = "SmartSolar MPPT 150|85 rev3";
break;
case 0XA06E:
strPID = "SmartSolar MPPT 150|100 rev3";
break;
case 0XA06F:
strPID = "BlueSolar MPPT 150|45 rev2";
break;
case 0XA070:
strPID = "BlueSolar MPPT 150|60 rev2";
break;
case 0XA071:
strPID = "BlueSolar MPPT 150|70 rev2";
break;
case 0XA102:
strPID = "SmartSolar MPPT VE.Can 150|70";
break;
case 0XA103:
strPID = "SmartSolar MPPT VE.Can 150|45";
break;
case 0XA104:
strPID = "SmartSolar MPPT VE.Can 150|60";
break;
case 0XA105:
strPID = "SmartSolar MPPT VE.Can 150|85";
break;
case 0XA106:
strPID = "SmartSolar MPPT VE.Can 150|100";
break;
case 0XA107:
strPID = "SmartSolar MPPT VE.Can 250|45";
break;
case 0XA108:
strPID = "SmartSolar MPPT VE.Can 250|60";
break;
case 0XA109:
strPID = "SmartSolar MPPT VE.Can 250|80";
break;
case 0XA10A:
strPID = "SmartSolar MPPT VE.Can 250|85";
break;
case 0XA10B:
strPID = "SmartSolar MPPT VE.Can 250|100";
break;
case 0XA10C:
strPID = "SmartSolar MPPT VE.Can 150|70 rev2";
break;
case 0XA10D:
strPID = "SmartSolar MPPT VE.Can 150|85 rev2";
break;
case 0XA10E:
strPID = "SmartSolar MPPT VE.Can 150|100 rev2";
break;
case 0XA10F:
strPID = "BlueSolar MPPT VE.Can 150|100";
break;
case 0XA110:
strPID = "SmartSolar MPPT RS 450|100";
break;
case 0XA112:
strPID = "BlueSolar MPPT VE.Can 250|70";
break;
case 0XA113:
strPID = "BlueSolar MPPT VE.Can 250|100";
break;
case 0XA114:
strPID = "SmartSolar MPPT VE.Can 250|70 rev2";
break;
case 0XA115:
strPID = "SmartSolar MPPT VE.Can 250|100 rev2";
break;
case 0XA116:
strPID = "SmartSolar MPPT VE.Can 250|85 rev2";
break;
case 0xA381:
strPID = "BMV-712 Smart";
break;
case 0xA382:
strPID = "BMV-710H Smart";
break;
case 0xA383:
strPID = "BMV-712 Smart Rev2";
break;
case 0xA389:
strPID = "SmartShunt 500A/50mV";
break;
case 0xA38A:
strPID = "SmartShunt 1000A/50mV";
break;
case 0xA38B:
strPID = "SmartShunt 2000A/50mV";
break;
case 0xA3F0:
strPID = "SmartShunt 2000A/50mV" ;
break;
default:
strPID = pid;
}
return strPID;
}
/*
* getErrAsString
* This function returns error state (ERR) as readable text.
*/
String VeDirectFrameHandler::getErrAsString(uint8_t err)
{
String strERR ="";
switch(err) {
case 0:
strERR = "No error";
break;
case 2:
strERR = "Battery voltage too high";
break;
case 17:
strERR = "Charger temperature too high";
break;
case 18:
strERR = "Charger over current";
break;
case 19:
strERR = "Charger current reversed";
break;
case 20:
strERR = "Bulk time limit exceeded";
break;
case 21:
strERR = "Current sensor issue(sensor bias/sensor broken)";
break;
case 26:
strERR = "Terminals overheated";
break;
case 28:
strERR = "Converter issue (dual converter models only)";
break;
case 33:
strERR = "Input voltage too high (solar panel)";
break;
case 34:
strERR = "Input current too high (solar panel)";
break;
case 38:
strERR = "Input shutdown (due to excessive battery voltage)";
break;
case 39:
strERR = "Input shutdown (due to current flow during off mode)";
break;
case 40:
strERR = "Input";
break;
case 65:
strERR = "Lost communication with one of devices";
break;
case 67:
strERR = "Synchronisedcharging device configuration issue";
break;
case 68:
strERR = "BMS connection lost";
break;
case 116:
strERR = "Factory calibration data lost";
break;
case 117:
strERR = "Invalid/incompatible firmware";
break;
case 118:
strERR = "User settings invalid";
break;
default:
strERR = err;
}
return strERR;
}
Reference in New Issue View Git Blame Copy Permalink