Skip to content

Commit

Permalink
FrameHandler: use frame containing V-Data for dataset timestamp
Browse files Browse the repository at this point in the history
  • Loading branch information
@SW-Niko
SW-Niko committed Jan 23, 2025
1 parent b4d45f8 commit 7df751c
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 37 deletions.
71 changes: 39 additions & 32 deletions lib/VeDirectFrameHandler/VeDirectFrameHandler.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,16 @@ template<typename T>
VeDirectFrameHandler<T>::VeDirectFrameHandler() :
_msgOut(&MessageOutputDummy),
_lastUpdate(0),
_actFrameNumber(0),
_endFrameNumber(0),
_state(State::IDLE),
_checksum(0),
_textPointer(0),
_hexSize(0),
_name(""),
_value(""),
_debugIn(0),
_lastByteMillis(0)
_lastByteMillis(0),
_dataValid(false),
_startUpPassed(false)
{
}

Expand All @@ -76,6 +76,8 @@ void VeDirectFrameHandler<T>::init(char const* who, int8_t rx, int8_t tx,
_msgOut = msgOut;
_verboseLogging = verboseLogging;
_debugIn = 0;
_startUpPassed = false; // to obtain a complete dataset after a new start or restart
_dataValid = false; // data is not valid on start or restart
snprintf(_logId, sizeof(_logId), "[VE.Direct %s %d/%d]", who, rx, tx);
if (_verboseLogging) { _msgOut->printf("%s init complete\r\n", _logId); }
}
Expand Down Expand Up @@ -211,27 +213,26 @@ void VeDirectFrameHandler<T>::rxData(uint8_t inbyte)
if (_verboseLogging) { dumpDebugBuffer(); }
if (_checksum == 0) {

// we use the field-label "V" to detect the start frame because all VE.Direct devices send this field
bool startFrame = false;
_frameContainsFieldV = false;
for (auto const& event : _textData) {
if (processTextData(event.first, event.second)) { startFrame = true; }
processTextData(event.first, event.second);
}

// related data can be fragmented across multiple frames (start frame -> end frame),
// so we check how many frames are required to get all related data
// once we kow the amount of frames we set the timestamp (_lastupdate) on the end frame
// Note: At startup, it may take up to 2 seconds for the first timestamp to become available.
if (startFrame) {
if (_actFrameNumber != 0) { _endFrameNumber = _actFrameNumber; } // buffer the end frame number
_actFrameNumber = 1;
} else {
if (_actFrameNumber != 0) { _actFrameNumber++; } // we do not count frames until we have a start frame
// A dataset can be fragmented across multiple frames,
// so we give just frames containing the field-label "V" a timestamp to avoid
// multible timestamps on related data. We also take care to have a complete dataset from
// multible frames after a start or restart or fault before we set the data as valid.
// Note: At startup, it may take up to 2 seconds for the first timestamp to be available
if (_frameContainsFieldV) {
if (_startUpPassed) {
_lastUpdate = millis();
_dataValid = true;
}
_startUpPassed = true;
}
if ((_endFrameNumber != 0) && (_actFrameNumber == _endFrameNumber)) { _lastUpdate = millis(); }
frameValidEvent();
}
else {
_actFrameNumber = 0;
_msgOut->printf("%s checksum 0x%02x != 0x00, invalid frame\r\n", _logId, _checksum);
}
reset();
Expand All @@ -245,53 +246,52 @@ void VeDirectFrameHandler<T>::rxData(uint8_t inbyte)

/*
* This function is called every time a new name/value is successfully parsed. It writes the values to the temporary buffer.
* Returns true if we have received the start frame (contains field-label "V")
*/
template<typename T>
bool VeDirectFrameHandler<T>::processTextData(std::string const& name, std::string const& value) {
void VeDirectFrameHandler<T>::processTextData(std::string const& name, std::string const& value) {
if (_verboseLogging) {
_msgOut->printf("%s Text Data '%s' = '%s'\r\n",
_logId, name.c_str(), value.c_str());
}

if (processTextDataDerived(name, value)) { return false; }
if (processTextDataDerived(name, value)) { return; }

if (name == "PID") {
_tmpFrame.productID_PID = strtol(value.c_str(), nullptr, 0);
return false;
return;
}

if (name == "SER") {
strncpy(_tmpFrame.serialNr_SER, value.c_str(), sizeof(_tmpFrame.serialNr_SER));
return false;
return;
}

if (name == "FW") {
_tmpFrame.firmwareVer_FWE[0] = '\0';
strncpy(_tmpFrame.firmwareVer_FW, value.c_str(), sizeof(_tmpFrame.firmwareVer_FW));
return false;
return;
}

// some devices use "FWE" instead of "FW" for the firmware version.
if (name == "FWE") {
_tmpFrame.firmwareVer_FW[0] = '\0';
strncpy(_tmpFrame.firmwareVer_FWE, value.c_str(), sizeof(_tmpFrame.firmwareVer_FWE));
return false;
return;
}

if (name == "V") {
_tmpFrame.batteryVoltage_V_mV = atol(value.c_str());
return true; // start frame
_frameContainsFieldV = true; // frame contains the field-label "V"
return;
}

if (name == "I") {
_tmpFrame.batteryCurrent_I_mA = atol(value.c_str());
return false;
return;
}

_msgOut->printf("%s Unknown text data '%s' (value '%s')\r\n",
_logId, name.c_str(), value.c_str());
return false;
}

/*
Expand Down Expand Up @@ -334,15 +334,22 @@ typename VeDirectFrameHandler<T>::State VeDirectFrameHandler<T>::hexRxEvent(uint
return ret;
}


// Returns true if the dataset is valid and not older than 10 seconds
template<typename T>
bool VeDirectFrameHandler<T>::isDataValid() const
bool VeDirectFrameHandler<T>::isDataValid()
{
// VE.Direct text frame data is valid if we receive a device voltage and
// the data is not older as 10 seconds and the end frame was received
// we accept a glitch where the data is valid for ten seconds when batteryVoltage_V_mV != 0.0f and (millis() - _lastUpdate) overflows
return (_tmpFrame.batteryVoltage_V_mV != 0.0f) && (millis() - _lastUpdate) < (10 * 1000) && _lastUpdate != 0;
// if the data is older than 10 seconds, it is no longer valid (millis() rollover safe)
if (_dataValid && (millis() - _lastUpdate > (10 * 1000))) {
_dataValid = false; // data is outdated
_startUpPassed = false; // reset the start-up condition
}

return _dataValid;
}

// Returns the millis() timestamp of the last successfully received dataset
// Note: Be aware of millis() rollover every 49 days
template<typename T>
uint32_t VeDirectFrameHandler<T>::getLastUpdate() const
{
Expand Down
11 changes: 6 additions & 5 deletions lib/VeDirectFrameHandler/VeDirectFrameHandler.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class VeDirectFrameHandler {
public:
virtual void loop(); // main loop to read ve.direct data
uint32_t getLastUpdate() const; // timestamp of last successful frame read
bool isDataValid() const; // return true if data valid and not outdated
bool isDataValid(); // return true if data valid and not outdated
T const& getData() const { return _tmpFrame; }
bool sendHexCommand(VeDirectHexCommand cmd, VeDirectHexRegister addr, uint32_t value = 0, uint8_t valsize = 0);
bool isStateIdle() const { return (_state == State::IDLE); }
Expand All @@ -37,9 +37,7 @@ class VeDirectFrameHandler {

bool _verboseLogging;
Print* _msgOut;
uint32_t _lastUpdate; // timestamp of end frame (data may be fragmented across multiple frames)
size_t _actFrameNumber; // counts the necessary frames to obtain all related data
size_t _endFrameNumber; // buffer the end frame number
uint32_t _lastUpdate; // timestamp of frame containing field "V"

T _tmpFrame;

Expand All @@ -50,7 +48,7 @@ class VeDirectFrameHandler {
void reset();
void dumpDebugBuffer();
void rxData(uint8_t inbyte); // byte of serial data
bool processTextData(std::string const& name, std::string const& value);
void processTextData(std::string const& name, std::string const& value);
virtual bool processTextDataDerived(std::string const& name, std::string const& value) = 0;
virtual void frameValidEvent() { }
bool disassembleHexData(VeDirectHexData &data); //return true if disassembling was possible
Expand Down Expand Up @@ -79,6 +77,9 @@ class VeDirectFrameHandler {
std::array<uint8_t, 512> _debugBuffer;
unsigned _debugIn;
uint32_t _lastByteMillis; // time of last parsed byte
bool _dataValid; // true if data is valid and not outdated
bool _startUpPassed; // helps to handle correct start up on multible frames
bool _frameContainsFieldV; // true if frame contains field "V"

/**
* not every frame contains every value the device is communicating, i.e.,
Expand Down

0 comments on commit 7df751c

Please sign in to comment.