Skip to content

Commit

Permalink
Vedirect Cleanups (#417)
Browse files Browse the repository at this point in the history 
* VE.Direct: remove unused #defines

* VE.Direct: remove unused mStop member variable

* VE.Direct: whitespace cleanups

remove trailing whitespace and fix mixed indentation.
  • Loading branch information
@schlimmchen
schlimmchen authored Sep 12, 2023
1 parent 3df47d1 commit d984912
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 38 deletions.
43 changes: 20 additions & 23 deletions lib/VeDirectFrameHandler/VeDirectFrameHandler.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,37 @@
*
* 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"

Expand All @@ -54,14 +54,13 @@ HardwareSerial VedirectSerial(1);
VeDirectFrameHandler VeDirect;

class Silent : public Print {
public:
size_t write(uint8_t c) final { return 0; }
public:
size_t write(uint8_t c) final { return 0; }
};

static Silent MessageOutputDummy;

VeDirectFrameHandler::VeDirectFrameHandler() :
//mStop(false), // don't know what Victron uses this for, not using
_msgOut(&MessageOutputDummy),
_state(IDLE),
_checksum(0),
Expand Down Expand Up @@ -133,10 +132,9 @@ void VeDirectFrameHandler::rxData(uint8_t inbyte)
_msgOut->println("[VE.Direct] ERROR: debug buffer overrun!");
}

//if (mStop) return;
if ( (inbyte == ':') && (_state != CHECKSUM) ) {
_prevState = _state; //hex frame can interrupt TEXT
_state = RECORD_HEX;
_state = RECORD_HEX;
_hexSize = 0;
}
if (_state != RECORD_HEX) {
Expand Down Expand Up @@ -239,7 +237,7 @@ void VeDirectFrameHandler::textRxEvent(char * name, char * value) {
else if (strcmp(name, "LOAD") == 0) {
if (strcmp(value, "ON") == 0)
_tmpFrame.LOAD = true;
else
else
_tmpFrame.LOAD = false;
}
else if (strcmp(name, "CS") == 0) {
Expand Down Expand Up @@ -284,12 +282,11 @@ void VeDirectFrameHandler::textRxEvent(char * name, char * value) {
else if (strcmp(name, "H23") == 0) {
_tmpFrame.H23 = atoi(value);
}

}


/*
* frameEndEvent
* frameEndEvent
* This function is called at the end of the received frame. If the checksum is valid, the temp buffer is read line by line.
* If the name exists in the public buffer, the new value is copied to the public buffer. If not, a new name/value entry
* is created in the public buffer.
Expand All @@ -316,8 +313,8 @@ void VeDirectFrameHandler::frameEndEvent(bool valid) {
}

/*
* hexRxEvent
* This function records hex answers or async messages
* 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
Expand All @@ -327,7 +324,7 @@ int VeDirectFrameHandler::hexRxEvent(uint8_t inbyte) {
// restore previous state
ret=_prevState;
break;

default:
_hexSize++;
if (_hexSize>=VE_MAX_HEX_LEN) { // oops -buffer overflow - something went wrong, we abort
Expand All @@ -336,7 +333,7 @@ int VeDirectFrameHandler::hexRxEvent(uint8_t inbyte) {
ret=IDLE;
}
}

return ret;
}

Expand All @@ -352,7 +349,7 @@ bool VeDirectFrameHandler::isDataValid() {

unsigned long VeDirectFrameHandler::getLastUpdate()
{
return _lastUpdate;
return _lastUpdate;
}

/*
Expand Down Expand Up @@ -558,7 +555,7 @@ String VeDirectFrameHandler::getPidAsString(uint16_t pid)
break;
case 0XA110:
strPID = "SmartSolar MPPT RS 450|100";
break;
break;
case 0XA112:
strPID = "BlueSolar MPPT VE.Can 250|70";
break;
Expand Down Expand Up @@ -764,4 +761,4 @@ String VeDirectFrameHandler::getMpptAsString(uint8_t mppt)
strMPPT = mppt;
}
return strMPPT;
}
}
19 changes: 4 additions & 15 deletions lib/VeDirectFrameHandler/VeDirectFrameHandler.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,21 @@
*
* Arduino library to read from Victron devices using VE.Direct protocol.
* Derived from Victron framehandler reference implementation.
*
*
* 2020.05.05 - 0.2 - initial release
* 2021.02.23 - 0.3 - change frameLen to 22 per VE.Direct Protocol version 3.30
* 2022.08.20 - 0.4 - changes for OpenDTU
*
*
*/

#pragma once

#include <Arduino.h>
#include <array>

#ifndef VICTRON_PIN_TX
#define VICTRON_PIN_TX 21 // HardwareSerial TX Pin
#endif

#ifndef VICTRON_PIN_RX
#define VICTRON_PIN_RX 22 // HardwareSerial RX Pin
#endif

#define VE_MAX_NAME_LEN 9 // VE.Direct Protocol: max name size is 9 including /0
#define VE_MAX_VALUE_LEN 33 // VE.Direct Protocol: max value size is 33 including /0
#define VE_MAX_HEX_LEN 100 // Maximum size of hex frame - max payload 34 byte (=68 char) + safe buffer


typedef struct {
uint16_t PID; // product id
char SER[VE_MAX_VALUE_LEN]; // serial number
Expand Down Expand Up @@ -93,7 +83,7 @@ class VeDirectFrameHandler {
void loop(); // main loop to read ve.direct data
unsigned long getLastUpdate(); // timestamp of last successful frame read
bool isDataValid(); // return true if data valid and not outdated
String getPidAsString(uint16_t pid); // product id as string
String getPidAsString(uint16_t pid); // product id as string
String getCsAsString(uint8_t cs); // current state as string
String getErrAsString(uint8_t err); // errer state as string
String getOrAsString(uint32_t offReason); // off reason as string
Expand All @@ -109,12 +99,11 @@ class VeDirectFrameHandler {
void frameEndEvent(bool); // copy temp struct to public struct
int hexRxEvent(uint8_t);

//bool mStop; // not sure what Victron uses this for, not using
Print* _msgOut;
bool _verboseLogging;
int _state; // current state
int _prevState; // previous state
uint8_t _checksum; // checksum value
uint8_t _checksum; // checksum value
char * _textPointer; // pointer to the private buffer we're writing to, name or value
int _hexSize; // length of hex buffer
char _name[VE_MAX_VALUE_LEN]; // buffer for the field name
Expand Down

0 comments on commit d984912

Please sign in to comment.