1
0
mirror of https://github.com/thooge/esp32-nmea2000-obp60.git synced 2025-12-14 06:23:07 +01:00

Merge remote-tracking branch 'origin/master'

This commit is contained in:
norbert-walter
2023-08-10 21:28:48 +02:00
32 changed files with 1113 additions and 165 deletions

View File

@@ -7,6 +7,10 @@
#define GW_BOAT_VALUE_LEN 32
#define GWSC(name) static constexpr const __FlashStringHelper* name=F(#name)
//see https://github.com/wellenvogel/esp32-nmea2000/issues/44
//factor to convert from N2k/SI rad/s to current NMEA rad/min
#define ROT_WA_FACTOR 60
class GwJsonDocument;
class GwBoatItemBase{
public:

View File

@@ -14,7 +14,7 @@ class FactoryResetRequest: public GwMessage{
protected:
virtual void processImpl(){
api->getLogger()->logDebug(GwLog::LOG,"reset request processing");
api->getConfig()->reset(true);
api->getConfig()->reset();
xTaskCreate([](void *p){
delay(500);
ESP.restart();

View File

@@ -1,6 +1,7 @@
#include "GWConfig.h"
#include <ArduinoJson.h>
#include <string.h>
#include <MD5Builder.h>
#define B(v) (v?"true":"false")
@@ -53,6 +54,7 @@ GwConfigInterface * GwConfigHandler::getConfigItem(const String name, bool dummy
#define PREF_NAME "gwprefs"
GwConfigHandler::GwConfigHandler(GwLog *logger): GwConfigDefinitions(){
this->logger=logger;
saltBase=esp_random();
}
bool GwConfigHandler::loadConfig(){
prefs.begin(PREF_NAME,true);
@@ -63,18 +65,6 @@ bool GwConfigHandler::loadConfig(){
prefs.end();
return true;
}
bool GwConfigHandler::saveConfig(){
prefs.begin(PREF_NAME,false);
for (int i=0;i<getNumConfig();i++){
if (configs[i]->hasChangedValue){
LOG_DEBUG(GwLog::LOG,"saving %s=%s",configs[i]->getName().c_str(),configs[i]->changedValue.c_str());
prefs.putString(configs[i]->getName().c_str(),configs[i]->changedValue);
}
}
prefs.end();
LOG_DEBUG(GwLog::LOG,"saved config");
return true;
}
bool GwConfigHandler::updateValue(String name, String value){
GwConfigInterface *i=getConfigItem(name);
@@ -83,18 +73,24 @@ bool GwConfigHandler::updateValue(String name, String value){
LOG_DEBUG(GwLog::LOG,"skip empty password %s",name.c_str());
}
else{
if (i->asString() == value){
return false;
}
LOG_DEBUG(GwLog::LOG,"update config %s=>%s",name.c_str(),i->isSecret()?"***":value.c_str());
i->updateValue(value);
prefs.begin(PREF_NAME,false);
prefs.putString(i->getName().c_str(),value);
prefs.end();
}
return true;
}
bool GwConfigHandler::reset(bool save){
bool GwConfigHandler::reset(){
LOG_DEBUG(GwLog::LOG,"reset config");
prefs.begin(PREF_NAME,false);
for (int i=0;i<getNumConfig();i++){
configs[i]->updateValue(configs[i]->getDefault());
prefs.putString(configs[i]->getName().c_str(),configs[i]->getDefault());
}
if (!save) return true;
return saveConfig();
prefs.end();
return true;
}
String GwConfigHandler::getString(const String name, String defaultv) const{
GwConfigInterface *i=getConfigItem(name,false);
@@ -122,6 +118,47 @@ bool GwConfigHandler::setValue(String name,String value){
return true;
}
bool GwConfigHandler::checkPass(String hash){
if (! getBool(useAdminPass)) return true;
String pass=getString(adminPassword);
unsigned long now=millis()/1000UL & ~0x7UL;
MD5Builder builder;
char buffer[2*sizeof(now)+1];
for (int i=0;i< 5 ;i++){
unsigned long base=saltBase+now;
toHex(base,buffer,2*sizeof(now)+1);
builder.begin();
builder.add(buffer);
builder.add(pass);
builder.calculate();
String md5=builder.toString();
bool rt=hash == md5;
logger->logDebug(GwLog::DEBUG,"checking pass %s, base=%ld, hash=%s, res=%d",
hash.c_str(),base,md5.c_str(),(int)rt);
if (rt) return true;
now -= 8;
}
return false;
}
static char hv(uint8_t nibble){
nibble=nibble&0xf;
if (nibble < 10) return (char)('0'+nibble);
return (char)('A'+nibble-10);
}
void GwConfigHandler::toHex(unsigned long v, char *buffer, size_t bsize)
{
uint8_t *bp = (uint8_t *)&v;
size_t i = 0;
for (; i < sizeof(v) && (2 * i + 1) < bsize; i++)
{
buffer[2 * i] = hv((*bp) >> 4);
buffer[2 * i + 1] = hv(*bp);
bp++;
}
if ((2 * i) < bsize)
buffer[2 * i] = 0;
}
void GwNmeaFilter::handleToken(String token, int index){
switch(index){
case 0:

View File

@@ -18,22 +18,25 @@ class GwConfigHandler: public GwConfigDefinitions{
public:
GwConfigHandler(GwLog *logger);
bool loadConfig();
bool saveConfig();
void stopChanges();
bool updateValue(String name, String value);
bool reset(bool save);
bool reset();
String toString() const;
String toJson() const;
String getString(const String name,const String defaultv="") const;
bool getBool(const String name,bool defaultv=false) const ;
int getInt(const String name,int defaultv=0) const;
GwConfigInterface * getConfigItem(const String name, bool dummy=false) const;
bool checkPass(String hash);
/**
* change the value of a config item
* will become a noop after stopChanges has been called
* !use with care! no checks of the value
*/
bool setValue(String name, String value);
static void toHex(unsigned long v,char *buffer,size_t bsize);
unsigned long getSaltBase(){return saltBase;}
private:
unsigned long saltBase=0;
};
#endif

View File

@@ -10,18 +10,6 @@ class GwConfigInterface{
const char * initialValue;
String value;
bool secret=false;
String changedValue;
bool hasChangedValue=false;
void updateValue(String value)
{
hasChangedValue = false;
if (value != this->value)
{
changedValue = value;
hasChangedValue = true;
}
}
public:
GwConfigInterface(const String &name, const char * initialValue, bool secret=false){
this->name=name;

View File

@@ -57,6 +57,52 @@
//brightness 0...255
#define GWLED_BRIGHTNESS 64
#endif
#ifdef BOARD_M5ATOM_RS232_CANUNIT
#define ESP32_CAN_TX_PIN GPIO_NUM_26
#define ESP32_CAN_RX_PIN GPIO_NUM_32
//if using rs232
#define GWSERIAL_TX 19
#define GWSERIAL_RX 22
#define GWSERIAL_MODE "BI"
#define GWBUTTON_PIN GPIO_NUM_39
#define GWBUTTON_ACTIVE LOW
//if GWBUTTON_PULLUPDOWN we enable a pulup/pulldown
#define GWBUTTON_PULLUPDOWN
//led handling
//if we define GWLED_FASTNET the arduino fastnet lib is used
#define GWLED_FASTLED
#define GWLED_TYPE SK6812
//color schema for fastled
#define GWLED_SCHEMA GRB
#define GWLED_PIN GPIO_NUM_27
//brightness 0...255
#define GWLED_BRIGHTNESS 64
#endif
#ifdef BOARD_M5ATOM_RS485_CANUNIT
#define ESP32_CAN_TX_PIN GPIO_NUM_26
#define ESP32_CAN_RX_PIN GPIO_NUM_32
//if using rs232
#define GWSERIAL_TX 19
#define GWSERIAL_RX 22
#define GWSERIAL_MODE "UNI"
#define GWBUTTON_PIN GPIO_NUM_39
#define GWBUTTON_ACTIVE LOW
//if GWBUTTON_PULLUPDOWN we enable a pulup/pulldown
#define GWBUTTON_PULLUPDOWN
//led handling
//if we define GWLED_FASTNET the arduino fastnet lib is used
#define GWLED_FASTLED
#define GWLED_TYPE SK6812
//color schema for fastled
#define GWLED_SCHEMA GRB
#define GWLED_PIN GPIO_NUM_27
//brightness 0...255
#define GWLED_BRIGHTNESS 64
#endif
#ifdef BOARD_M5STICK_CANUNIT
#define ESP32_CAN_TX_PIN GPIO_NUM_32
#define ESP32_CAN_RX_PIN GPIO_NUM_33

View File

@@ -21,6 +21,7 @@ void GwLog::logString(const char *fmt,...){
va_list args;
va_start(args,fmt);
xSemaphoreTake(locker, portMAX_DELAY);
recordCounter++;
vsnprintf(buffer,bufferSize-1,fmt,args);
buffer[bufferSize-1]=0;
if (! writer) {
@@ -40,6 +41,7 @@ void GwLog::logDebug(int level,const char *fmt,...){
va_list args;
va_start(args,fmt);
xSemaphoreTake(locker, portMAX_DELAY);
recordCounter++;
vsnprintf(buffer,bufferSize-1,fmt,args);
buffer[bufferSize-1]=0;
if (! writer) {

View File

@@ -15,6 +15,7 @@ class GwLog{
int logLevel=1;
GwLogWriter *writer;
SemaphoreHandle_t locker;
long long recordCounter=0;
public:
static const int LOG=1;
static const int ERROR=0;
@@ -29,6 +30,7 @@ class GwLog{
int isActive(int level){return level <= logLevel;};
void flush();
void setLevel(int level){this->logLevel=level;}
long long getRecordCounter(){return recordCounter;}
};
#define LOG_DEBUG(level,...){ if (logger != NULL && logger->isActive(level)) logger->logDebug(level,__VA_ARGS__);}

View File

@@ -526,7 +526,7 @@ private:
boatData->VAR->getDataWithDefault(N2kDoubleNA),
boatData->DEV->getDataWithDefault(N2kDoubleNA)
);
send(n2kMsg,msg.sourceId);
send(n2kMsg,msg.sourceId,"127250M");
}
void convertHDT(const SNMEA0183Msg &msg){
@@ -570,7 +570,7 @@ private:
UD(DEV);
tN2kMsg n2kMsg;
SetN2kMagneticHeading(n2kMsg,1,MHDG,DEV,VAR);
send(n2kMsg,msg.sourceId);
send(n2kMsg,msg.sourceId,"127250M");
}
void convertDPT(const SNMEA0183Msg &msg){
@@ -692,10 +692,19 @@ private:
LOG_DEBUG(GwLog::DEBUG, "failed to parse VHW %s", msg.line);
return;
}
if (! updateDouble(boatData->STW,STW,msg.sourceId)) return;
if (! updateDouble(boatData->HDG,TrueHeading,msg.sourceId)) return;
if (MagneticHeading == NMEA0183DoubleNA) MagneticHeading=N2kDoubleNA;
tN2kMsg n2kMsg;
if (updateDouble(boatData->HDG,TrueHeading,msg.sourceId)){
SetN2kTrueHeading(n2kMsg,1,TrueHeading);
send(n2kMsg,msg.sourceId);
}
if(updateDouble(boatData->MHDG,MagneticHeading,msg.sourceId)){
SetN2kMagneticHeading(n2kMsg,1,MagneticHeading,
boatData->DEV->getDataWithDefault(N2kDoubleNA),
boatData->VAR->getDataWithDefault(N2kDoubleNA)
);
send(n2kMsg,msg.sourceId,"127250M"); //ensure both mag and true are sent
}
if (! updateDouble(boatData->STW,STW,msg.sourceId)) return;
SetN2kBoatSpeed(n2kMsg,1,STW);
send(n2kMsg,msg.sourceId);
@@ -887,6 +896,7 @@ private:
LOG_DEBUG(GwLog::DEBUG,"unable to parse ROT %s",msg.line);
return;
}
ROT=ROT / ROT_WA_FACTOR;
if (! updateDouble(boatData->ROT,ROT,msg.sourceId)) return;
tN2kMsg n2kMsg;
SetN2kRateOfTurn(n2kMsg,1,ROT);
@@ -912,6 +922,23 @@ private:
send(n2kMsg,msg.sourceId);
}
void convertMTW(const SNMEA0183Msg &msg){
if (msg.FieldCount() < 2){
LOG_DEBUG(GwLog::DEBUG,"unable to parse MTW %s",msg.line);
return;
}
if (msg.Field(1)[0] != 'C'){
LOG_DEBUG(GwLog::DEBUG,"invalid temp unit in MTW %s",msg.line);
return;
}
if (msg.FieldLen(0) < 1) return;
double WTemp=CToKelvin(atof(msg.Field(0)));
UD(WTemp);
tN2kMsg n2kMsg;
SetN2kPGN130310(n2kMsg,1,WTemp);
send(n2kMsg,msg.sourceId);
}
//shortcut for lambda converters
#define CVL [](const SNMEA0183Msg &msg, NMEA0183DataToN2KFunctions *p) -> void
void registerConverters()
@@ -980,7 +1007,10 @@ private:
String(F("ROT")), &NMEA0183DataToN2KFunctions::convertROT);
converters.registerConverter(
129283UL,
String(F("XTE")), &NMEA0183DataToN2KFunctions::convertXTE);
String(F("XTE")), &NMEA0183DataToN2KFunctions::convertXTE);
converters.registerConverter(
130310UL,
String(F("MTW")), &NMEA0183DataToN2KFunctions::convertMTW);
unsigned long *xdrpgns=new unsigned long[8]{127505UL,127508UL,130312UL,130313UL,130314UL,127489UL,127488UL,127257UL};
converters.registerConverter(
8,

View File

@@ -32,7 +32,6 @@
N2kDataToNMEA0183::N2kDataToNMEA0183(GwLog * logger, GwBoatData *boatData,
SendNMEA0183MessageCallback callback, String talkerId)
{
@@ -1055,7 +1054,7 @@ private:
}
if (!updateDouble(boatData->ROT,ROT)) return;
tNMEA0183Msg nmeamsg;
if (NMEA0183SetROT(nmeamsg,ROT,talkerId)){
if (NMEA0183SetROT(nmeamsg,ROT * ROT_WA_FACTOR,talkerId)){
SendMessage(nmeamsg);
}
}

View File

@@ -118,4 +118,12 @@ bool GwWebServer::registerMainHandler(const char *url,RequestCreator creator){
return true;
}
bool GwWebServer::registerPostHandler(const char *url, ArRequestHandlerFunction requestHandler,
ArBodyHandlerFunction bodyHandler){
server->on(url,HTTP_POST,requestHandler,
[](AsyncWebServerRequest *request, const String& filename, size_t index, uint8_t *data, size_t len, bool final){},
bodyHandler);
return true;
}

View File

@@ -1,6 +1,7 @@
#ifndef _GWWEBSERVER_H
#define _GWWEBSERVER_H
#include <ESPAsyncWebServer.h>
#include <functional>
#include "GwMessage.h"
#include "GwLog.h"
class GwWebServer{
@@ -14,6 +15,7 @@ class GwWebServer{
~GwWebServer();
void begin();
bool registerMainHandler(const char *url,RequestCreator creator);
bool registerPostHandler(const char *url, ArRequestHandlerFunction requestHandler, ArBodyHandlerFunction bodyHandler);
void handleAsyncWebRequest(AsyncWebServerRequest *request, GwRequestMessage *msg);
AsyncWebServer * getServer(){return server;}
};

View File

@@ -41,19 +41,20 @@ double ps2ph(double v)
GwXDRType *types[] = {
new GwXDRType(GwXDRType::PRESS, "P", "P"),
new GwXDRType(GwXDRType::PRESS, "P", "B",
BarToP,
PtoBar,
BarToP),
"P"),
new GwXDRType(GwXDRType::VOLT, "U", "V"),
new GwXDRType(GwXDRType::AMP, "I", "A"),
new GwXDRType(GwXDRType::TEMP, "C", "K"),
new GwXDRType(GwXDRType::TEMP, "C", "C", CToKelvin, KelvinToC),
new GwXDRType(GwXDRType::TEMP, "C", "C", CToKelvin, KelvinToC,"K"),
new GwXDRType(GwXDRType::HUMID, "H", "P"), //percent
new GwXDRType(GwXDRType::VOLPERCENT, "V", "P"),
new GwXDRType(GwXDRType::VOLUME, "V", "M", m3ToL, ltrTom3),
new GwXDRType(GwXDRType::VOLUME, "V", "M", m3ToL, ltrTom3,"L"),
new GwXDRType(GwXDRType::FLOW, "R", "I", ps2ph, ph2ps),
new GwXDRType(GwXDRType::GENERIC, "G", ""),
new GwXDRType(GwXDRType::DISPLACEMENT, "A", "P"),
new GwXDRType(GwXDRType::DISPLACEMENTD, "A", "D",DegToRad,RadToDeg),
new GwXDRType(GwXDRType::DISPLACEMENTD, "A", "D",DegToRad,RadToDeg,"rd"),
new GwXDRType(GwXDRType::RPM,"T","R"),
//important to have 2x NULL!
NULL,

View File

@@ -44,14 +44,24 @@ class GwXDRType{
TypeCode code;
String xdrtype;
String xdrunit;
String boatDataUnit;
convert tonmea=NULL;
convert fromnmea=NULL;
GwXDRType(TypeCode tc,String xdrtype,String xdrunit,convert fromnmea=NULL,convert tonmea=NULL){
GwXDRType(TypeCode tc,String xdrtype,String xdrunit){
this->code=tc;
this->xdrtype=xdrtype;
this->xdrunit=xdrunit;
this->boatDataUnit=xdrunit;
this->fromnmea=fromnmea;
this->tonmea=tonmea;
}
GwXDRType(TypeCode tc,String xdrtype,String xdrunit,convert fromnmea,convert tonmea,String boatDataUnit=String()){
this->code=tc;
this->xdrtype=xdrtype;
this->xdrunit=xdrunit;
this->fromnmea=fromnmea;
this->tonmea=tonmea;
this->boatDataUnit=boatDataUnit.isEmpty()?xdrunit:boatDataUnit;
}
};
class GwXDRTypeMapping{
@@ -183,7 +193,7 @@ class GwXDRFoundMapping : public GwBoatItemNameProvider{
return String("xdr")+getTransducerName();
};
virtual String getBoatItemFormat(){
return "formatXdr:"+type->xdrtype+":"+type->xdrunit;
return "formatXdr:"+type->xdrtype+":"+type->boatDataUnit;
};
virtual ~GwXDRFoundMapping(){}
};