diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 2aeae17..ea089d5 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -62,5 +62,5 @@ jobs: with: repo_token: ${{ secrets.GITHUB_TOKEN }} tag: ${{ steps.version.outputs.version}} - file: ./.pio/build/*/*-{all,update}.bin + file: ./.pio/build/*/*${{ steps.version.outputs.version }}*-{all,update}.bin file_glob: true diff --git a/Readme.md b/Readme.md index a9a305f..5d2a20d 100644 --- a/Readme.md +++ b/Readme.md @@ -43,6 +43,10 @@ What is included For the details of the mapped PGNs and NMEA sentences refer to [Conversions](doc/Conversions.pdf). +License +------- +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 2 of the License](LICENSE), or (at your option) any later version. + Hardware -------- The software is prepared to run on different kinds of ESP32 based modules and accessoirs. For some of them prebuild binaries are available that only need to be flashed, others would require to add some definitions of the used PINs and features and to build the binary. @@ -170,6 +174,25 @@ For details refer to the [example description](lib/exampletask/Readme.md). Changelog --------- +[20251126](../../releases/tag/20251126) +* fix a bug in the Actisense reader that could lead to an endless loop (making the device completely non responsive) +* upgrade to 4.24.1 of the NMEA2000 library (2025/11/01) - refer to the [changes](https://github.com/ttlappalainen/NMEA2000/blob/master/Documents/src/changes.md) - Especially UTF8 support +********* +[20251007](../../releases/tag/20251007) +********* +* add AIS Aton translations (PGN 129041 <-> Ais class 21) +* improved mapping of AIS transducer information (NMEA2000) to AIS channel and Talker on NMEA0183 +* use a forked version of the NMEA2000 library (as an intermediate workaround) +* [#114](../../issues/114) correctly translate AIS type 1/3 from PGN 129038 +* add support for a generic S3 build in the build UI +* [#117](../../issues/117) add support for a transmit enable pin for RS 485 conections (also in the build UI) +* [#116](../../issues/116) SDA and SCL are swapped in the build UI +* [#112](../../issues/112) clearify licenses +* [#110](../../issues/110) / [#115](../../pull/115) support for the M5 GPS unit v1.1 +* [#102](../../issues/102) optimize Wifi reconnect handling +* [#111](../../pull/111) allow for a custom python build script +* [#113](../../issues/113) support for M5 stack Env4 + [20250305](../../releases/tag/20250305) ********* * better handling for reconnect to a raspberry pi after reset [#102](../../issues/102) diff --git a/doc/Conversions.odt b/doc/Conversions.odt index a44672b..1a181ac 100644 Binary files a/doc/Conversions.odt and b/doc/Conversions.odt differ diff --git a/doc/Conversions.pdf b/doc/Conversions.pdf index 3ed26e1..0361c69 100644 Binary files a/doc/Conversions.pdf and b/doc/Conversions.pdf differ diff --git a/extra_script.py b/extra_script.py index dd9a90b..3f41463 100644 --- a/extra_script.py +++ b/extra_script.py @@ -10,7 +10,7 @@ from datetime import datetime import re import pprint from platformio.project.config import ProjectConfig -from platformio.project.exception import InvalidProjectConfError + Import("env") #print(env.Dump()) @@ -104,18 +104,7 @@ def writeFileIfChanged(fileName,data): return True def mergeConfig(base,other): - try: - customconfig = env.GetProjectOption("custom_config") - except InvalidProjectConfError: - customconfig = None - for bdir in other: - if customconfig and os.path.exists(os.path.join(bdir,customconfig)): - cname=os.path.join(bdir,customconfig) - print("merge custom config {}".format(cname)) - with open(cname,'rb') as ah: - base += json.load(ah) - continue - cname=os.path.join(bdir,"config.json") + for cname in other: if os.path.exists(cname): print("merge config %s"%cname) with open(cname,'rb') as ah: @@ -161,13 +150,25 @@ def expandConfig(config): rt.append(replaceTexts(c,replace)) return rt -def generateMergedConfig(inFile,outFile,addDirs=[]): +def createUserItemList(dirs,itemName,files): + rt=[] + for d in dirs: + iname=os.path.join(d,itemName) + if os.path.exists(iname): + rt.append(iname) + for f in files: + if not os.path.exists(f): + raise Exception("user item %s not found"%f) + rt.append(f) + return rt + +def generateMergedConfig(inFile,outFile,addFiles=[]): if not os.path.exists(inFile): raise Exception("unable to read cfg file %s"%inFile) data="" with open(inFile,'rb') as ch: config=json.load(ch) - config=mergeConfig(config,addDirs) + config=mergeConfig(config,addFiles) config=expandConfig(config) data=json.dumps(config,indent=2) writeFileIfChanged(outFile,data) @@ -387,12 +388,7 @@ def getLibs(): -def joinFiles(target,pattern,dirlist): - flist=[] - for dir in dirlist: - fn=os.path.join(dir,pattern) - if os.path.exists(fn): - flist.append(fn) +def joinFiles(target,flist): current=False if os.path.exists(target): current=True @@ -463,7 +459,28 @@ def handleDeps(env): ) env.AddBuildMiddleware(injectIncludes) +def getOption(env,name,toArray=True): + try: + opt=env.GetProjectOption(name) + if toArray: + if opt is None: + return [] + if isinstance(opt,list): + return opt + return opt.split("\n" if "\n" in opt else ",") + return opt + except: + pass + if toArray: + return [] +def getFileList(files): + base=basePath() + rt=[] + for f in files: + if f is not None and f != "": + rt.append(os.path.join(base,f)) + return rt def prebuild(env): global userTaskDirs print("#prebuild running") @@ -473,14 +490,18 @@ def prebuild(env): if ldf_mode == 'off': print("##ldf off - own dependency handling") handleDeps(env) + extraConfigs=getOption(env,'custom_config',toArray=True) + extraJs=getOption(env,'custom_js',toArray=True) + extraCss=getOption(env,'custom_css',toArray=True) + userTaskDirs=getUserTaskDirs() mergedConfig=os.path.join(outPath(),os.path.basename(CFG_FILE)) - generateMergedConfig(os.path.join(basePath(),CFG_FILE),mergedConfig,userTaskDirs) + generateMergedConfig(os.path.join(basePath(),CFG_FILE),mergedConfig,createUserItemList(userTaskDirs,"config.json", getFileList(extraConfigs))) compressFile(mergedConfig,mergedConfig+".gz") generateCfg(mergedConfig,os.path.join(outPath(),CFG_INCLUDE),False) generateCfg(mergedConfig,os.path.join(outPath(),CFG_INCLUDE_IMPL),True) - joinFiles(os.path.join(outPath(),INDEXJS+".gz"),INDEXJS,["web"]+userTaskDirs) - joinFiles(os.path.join(outPath(),INDEXCSS+".gz"),INDEXCSS,["web"]+userTaskDirs) + joinFiles(os.path.join(outPath(),INDEXJS+".gz"),createUserItemList(["web"]+userTaskDirs,INDEXJS,getFileList(extraJs))) + joinFiles(os.path.join(outPath(),INDEXCSS+".gz"),createUserItemList(["web"]+userTaskDirs,INDEXCSS,getFileList(extraCss))) embedded=getEmbeddedFiles(env) filedefs=[] for ef in embedded: @@ -526,17 +547,16 @@ env.Append( ) #script does not run on clean yet - maybe in the future env.AddPostAction("clean",cleangenerated) - -#look for extra task scripts and include them here -for taskdir in userTaskDirs: - script = os.path.join(taskdir, "extra_task.py") +extraScripts=getFileList(getOption(env,'custom_script',toArray=True)) +for script in extraScripts: if os.path.isfile(script): - taskname = os.path.basename(os.path.normpath(taskdir)) - print("#extra task script for '{}'".format(taskname)) + print(f"#extra {script}") with open(script) as fh: try: - code = compile(fh.read(), taskname, 'exec') - except SyntaxError: - print("#ERROR: script does not compile") + code = compile(fh.read(), script, 'exec') + except SyntaxError as e: + print(f"#ERROR: script {script} does not compile: {e}") continue exec(code) + else: + print(f"#ERROR: script {script} not found") diff --git a/extra_script.py.new b/extra_script.py.new deleted file mode 100644 index dd9a90b..0000000 --- a/extra_script.py.new +++ /dev/null @@ -1,542 +0,0 @@ -print("running extra...") -import gzip -import shutil -import os -import sys -import inspect -import json -import glob -from datetime import datetime -import re -import pprint -from platformio.project.config import ProjectConfig -from platformio.project.exception import InvalidProjectConfError - -Import("env") -#print(env.Dump()) -OWN_FILE="extra_script.py" -GEN_DIR='lib/generated' -CFG_FILE='web/config.json' -XDR_FILE='web/xdrconfig.json' -INDEXJS="index.js" -INDEXCSS="index.css" -CFG_INCLUDE='GwConfigDefinitions.h' -CFG_INCLUDE_IMPL='GwConfigDefImpl.h' -XDR_INCLUDE='GwXdrTypeMappings.h' -TASK_INCLUDE='GwUserTasks.h' -GROVE_CONFIG="GwM5GroveGen.h" -GROVE_CONFIG_IN="lib/hardware/GwM5Grove.in" -EMBEDDED_INCLUDE="GwEmbeddedFiles.h" - -def getEmbeddedFiles(env): - rt=[] - efiles=env.GetProjectOption("board_build.embed_files") - for f in efiles.split("\n"): - if f == '': - continue - rt.append(f) - return rt - -def basePath(): - #see: https://stackoverflow.com/questions/16771894/python-nameerror-global-name-file-is-not-defined - return os.path.dirname(inspect.getfile(lambda: None)) - -def outPath(): - return os.path.join(basePath(),GEN_DIR) -def checkDir(): - dn=outPath() - if not os.path.exists(dn): - os.makedirs(dn) - if not os.path.isdir(dn): - print("unable to create %s"%dn) - return False - return True - -def isCurrent(infile,outfile): - if os.path.exists(outfile): - otime=os.path.getmtime(outfile) - itime=os.path.getmtime(infile) - if (otime >= itime): - own=os.path.join(basePath(),OWN_FILE) - if os.path.exists(own): - owntime=os.path.getmtime(own) - if owntime > otime: - return False - print("%s is newer then %s, no need to recreate"%(outfile,infile)) - return True - return False -def compressFile(inFile,outfile): - if isCurrent(inFile,outfile): - return - print("compressing %s"%inFile) - with open(inFile, 'rb') as f_in: - with gzip.open(outfile, 'wb') as f_out: - shutil.copyfileobj(f_in, f_out) - -def generateFile(infile,outfile,callback,inMode='rb',outMode='w'): - if isCurrent(infile,outfile): - return - print("creating %s"%outfile) - oh=None - with open(infile,inMode) as ch: - with open(outfile,outMode) as oh: - try: - callback(ch,oh,inFile=infile) - oh.close() - except Exception as e: - try: - oh.close() - except: - pass - os.unlink(outfile) - raise - -def writeFileIfChanged(fileName,data): - if os.path.exists(fileName): - with open(fileName,"r") as ih: - old=ih.read() - ih.close() - if old == data: - return False - print("#generating %s"%fileName) - with open(fileName,"w") as oh: - oh.write(data) - return True - -def mergeConfig(base,other): - try: - customconfig = env.GetProjectOption("custom_config") - except InvalidProjectConfError: - customconfig = None - for bdir in other: - if customconfig and os.path.exists(os.path.join(bdir,customconfig)): - cname=os.path.join(bdir,customconfig) - print("merge custom config {}".format(cname)) - with open(cname,'rb') as ah: - base += json.load(ah) - continue - cname=os.path.join(bdir,"config.json") - if os.path.exists(cname): - print("merge config %s"%cname) - with open(cname,'rb') as ah: - merge=json.load(ah) - base=base+merge - return base - -def replaceTexts(data,replacements): - if replacements is None: - return data - if isinstance(data,str): - for k,v in replacements.items(): - data=data.replace("$"+k,str(v)) - return data - if isinstance(data,list): - rt=[] - for e in data: - rt.append(replaceTexts(e,replacements)) - return rt - if isinstance(data,dict): - rt={} - for k,v in data.items(): - rt[replaceTexts(k,replacements)]=replaceTexts(v,replacements) - return rt - return data -def expandConfig(config): - rt=[] - for item in config: - type=item.get('type') - if type != 'array': - rt.append(item) - continue - replacements=item.get('replace') - children=item.get('children') - name=item.get('name') - if name is None: - name="#unknown#" - if not isinstance(replacements,list): - raise Exception("missing replacements at array %s"%name) - for replace in replacements: - if children is not None: - for c in children: - rt.append(replaceTexts(c,replace)) - return rt - -def generateMergedConfig(inFile,outFile,addDirs=[]): - if not os.path.exists(inFile): - raise Exception("unable to read cfg file %s"%inFile) - data="" - with open(inFile,'rb') as ch: - config=json.load(ch) - config=mergeConfig(config,addDirs) - config=expandConfig(config) - data=json.dumps(config,indent=2) - writeFileIfChanged(outFile,data) - -def generateCfg(inFile,outFile,impl): - if not os.path.exists(inFile): - raise Exception("unable to read cfg file %s"%inFile) - data="" - with open(inFile,'rb') as ch: - config=json.load(ch) - data+="//generated from %s\n"%inFile - l=len(config) - idx=0 - if not impl: - data+='#include "GwConfigItem.h"\n' - data+='class GwConfigDefinitions{\n' - data+=' public:\n' - data+=' int getNumConfig() const{return %d;}\n'%(l) - for item in config: - n=item.get('name') - if n is None: - continue - if len(n) > 15: - raise Exception("%s: config names must be max 15 caracters"%n) - data+=' static constexpr const char* %s="%s";\n'%(n,n) - data+="};\n" - else: - data+='void GwConfigHandler::populateConfigs(GwConfigInterface **config){\n' - for item in config: - name=item.get('name') - if name is None: - continue - data+=' configs[%d]='%(idx) - idx+=1 - secret="false"; - if item.get('type') == 'password': - secret="true" - data+=" new GwConfigInterface(%s,\"%s\",%s);\n"%(name,item.get('default'),secret) - data+='}\n' - writeFileIfChanged(outFile,data) - -def labelFilter(label): - return re.sub("[^a-zA-Z0-9]","",re.sub("\([0-9]*\)","",label)) -def generateXdrMappings(fp,oh,inFile=''): - jdoc=json.load(fp) - oh.write("static GwXDRTypeMapping* typeMappings[]={\n") - first=True - for cat in jdoc: - item=jdoc[cat] - cid=item.get('id') - if cid is None: - continue - tc=item.get('type') - if tc is not None: - if first: - first=False - else: - oh.write(",\n") - oh.write(" new GwXDRTypeMapping(%d,0,%d) /*%s*/"%(cid,tc,cat)) - fields=item.get('fields') - if fields is None: - continue - idx=0 - for fe in fields: - if not isinstance(fe,dict): - continue - tc=fe.get('t') - id=fe.get('v') - if id is None: - id=idx - idx+=1 - l=fe.get('l') or '' - if tc is None or id is None: - continue - if first: - first=False - else: - oh.write(",\n") - oh.write(" new GwXDRTypeMapping(%d,%d,%d) /*%s:%s*/"%(cid,id,tc,cat,l)) - oh.write("\n") - oh.write("};\n") - for cat in jdoc: - item=jdoc[cat] - cid=item.get('id') - if cid is None: - continue - selectors=item.get('selector') - if selectors is not None: - for selector in selectors: - label=selector.get('l') - value=selector.get('v') - if label is not None and value is not None: - label=labelFilter(label) - define=("GWXDRSEL_%s_%s"%(cat,label)).upper() - oh.write(" #define %s %s\n"%(define,value)) - fields=item.get('fields') - if fields is not None: - idx=0 - for field in fields: - v=field.get('v') - if v is None: - v=idx - else: - v=int(v) - label=field.get('l') - if v is not None and label is not None: - define=("GWXDRFIELD_%s_%s"%(cat,labelFilter(label))).upper(); - oh.write(" #define %s %s\n"%(define,str(v))) - idx+=1 - -class Grove: - def __init__(self,name) -> None: - self.name=name - def _ss(self,z=False): - if z: - return self.name - return self.name if self.name != 'Z' else '' - def _suffix(self): - return '_'+self.name if self.name != 'Z' else '' - def replace(self,line): - if line is None: - return line - return line.replace('$G$',self._ss()).replace('$Z$',self._ss(True)).replace('$GS$',self._suffix()) -def generateGroveDefs(inh,outh,inFile=''): - GROVES=[Grove('Z'),Grove('A'),Grove('B'),Grove('C')] - definition=[] - started=False - def writeConfig(): - for grove in GROVES: - for cl in definition: - outh.write(grove.replace(cl)) - - for line in inh: - if re.match(" *#GROVE",line): - started=True - if len(definition) > 0: - writeConfig() - definition=[] - continue - if started: - definition.append(line) - if len(definition) > 0: - writeConfig() - - - -userTaskDirs=[] - -def getUserTaskDirs(): - rt=[] - taskdirs=glob.glob(os.path.join( basePath(),'lib','*task*')) - for task in taskdirs: - rt.append(task) - return rt - -def checkAndAdd(file,names,ilist): - if not file.endswith('.h'): - return - match=False - for cmp in names: - #print("##check %s<->%s"%(f.lower(),cmp)) - if file.lower() == cmp: - match=True - if not match: - return - ilist.append(file) -def genereateUserTasks(outfile): - includes=[] - for task in userTaskDirs: - #print("##taskdir=%s"%task) - base=os.path.basename(task) - includeNames=[base.lower()+".h",'gw'+base.lower()+'.h'] - for f in os.listdir(task): - checkAndAdd(f,includeNames,includes) - includeData="" - for i in includes: - print("#task include %s"%i) - includeData+="#include <%s>\n"%i - writeFileIfChanged(outfile,includeData) - -def generateEmbedded(elist,outFile): - content="" - for entry in elist: - content+="EMBED_GZ_FILE(\"%s\",%s,\"%s\");\n"%entry - writeFileIfChanged(outFile,content) - -def getContentType(fn): - if (fn.endswith('.gz')): - fn=fn[0:-3] - if (fn.endswith('html')): - return "text/html" - if (fn.endswith('json')): - return "application/json" - if (fn.endswith('js')): - return "text/javascript" - if (fn.endswith('css')): - return "text/css" - return "application/octet-stream" - - -def getLibs(): - base=os.path.join(basePath(),"lib") - rt=[] - for sd in os.listdir(base): - if sd == '..': - continue - if sd == '.': - continue - fn=os.path.join(base,sd) - if os.path.isdir(fn): - rt.append(sd) - EXTRAS=['generated'] - for e in EXTRAS: - if not e in rt: - rt.append(e) - return rt - - - -def joinFiles(target,pattern,dirlist): - flist=[] - for dir in dirlist: - fn=os.path.join(dir,pattern) - if os.path.exists(fn): - flist.append(fn) - current=False - if os.path.exists(target): - current=True - for f in flist: - if not isCurrent(f,target): - current=False - break - if current: - print("%s is up to date"%target) - return - print("creating %s"%target) - with gzip.open(target,"wb") as oh: - for fn in flist: - print("adding %s to %s"%(fn,target)) - with open(fn,"rb") as rh: - shutil.copyfileobj(rh,oh) - - -OWNLIBS=getLibs()+["FS","WiFi"] -GLOBAL_INCLUDES=[] - -def handleDeps(env): - #overwrite the GetProjectConfig - #to inject all our libs - oldGetProjectConfig=env.GetProjectConfig - def GetProjectConfigX(env): - rt=oldGetProjectConfig() - cenv="env:"+env['PIOENV'] - libs=[] - for section,options in rt.as_tuple(): - if section == cenv: - for key,values in options: - if key == 'lib_deps': - libs=values - - mustUpdate=False - for lib in OWNLIBS: - if not lib in libs: - libs.append(lib) - mustUpdate=True - if mustUpdate: - update=[(cenv,[('lib_deps',libs)])] - rt.update(update) - return rt - env.AddMethod(GetProjectConfigX,"GetProjectConfig") - #store the list of all includes after we resolved - #the dependencies for our main project - #we will use them for all compilations afterwards - oldLibBuilder=env.ConfigureProjectLibBuilder - def ConfigureProjectLibBuilderX(env): - global GLOBAL_INCLUDES - project=oldLibBuilder() - #print("##ConfigureProjectLibBuilderX") - #pprint.pprint(project) - if project.depbuilders: - #print("##depbuilders %s"%",".join(map(lambda x: x.path,project.depbuilders))) - for db in project.depbuilders: - idirs=db.get_include_dirs() - for id in idirs: - if not id in GLOBAL_INCLUDES: - GLOBAL_INCLUDES.append(id) - return project - env.AddMethod(ConfigureProjectLibBuilderX,"ConfigureProjectLibBuilder") - def injectIncludes(env,node): - return env.Object( - node, - CPPPATH=env["CPPPATH"]+GLOBAL_INCLUDES - ) - env.AddBuildMiddleware(injectIncludes) - - -def prebuild(env): - global userTaskDirs - print("#prebuild running") - if not checkDir(): - sys.exit(1) - ldf_mode=env.GetProjectOption("lib_ldf_mode") - if ldf_mode == 'off': - print("##ldf off - own dependency handling") - handleDeps(env) - userTaskDirs=getUserTaskDirs() - mergedConfig=os.path.join(outPath(),os.path.basename(CFG_FILE)) - generateMergedConfig(os.path.join(basePath(),CFG_FILE),mergedConfig,userTaskDirs) - compressFile(mergedConfig,mergedConfig+".gz") - generateCfg(mergedConfig,os.path.join(outPath(),CFG_INCLUDE),False) - generateCfg(mergedConfig,os.path.join(outPath(),CFG_INCLUDE_IMPL),True) - joinFiles(os.path.join(outPath(),INDEXJS+".gz"),INDEXJS,["web"]+userTaskDirs) - joinFiles(os.path.join(outPath(),INDEXCSS+".gz"),INDEXCSS,["web"]+userTaskDirs) - embedded=getEmbeddedFiles(env) - filedefs=[] - for ef in embedded: - print("#checking embedded file %s"%ef) - (dn,fn)=os.path.split(ef) - pureName=fn - if pureName.endswith('.gz'): - pureName=pureName[0:-3] - ct=getContentType(pureName) - usname=ef.replace('/','_').replace('.','_') - filedefs.append((pureName,usname,ct)) - inFile=os.path.join(basePath(),"web",pureName) - if os.path.exists(inFile): - compressFile(inFile,ef) - else: - print("#WARNING: infile %s for %s not found"%(inFile,ef)) - generateEmbedded(filedefs,os.path.join(outPath(),EMBEDDED_INCLUDE)) - genereateUserTasks(os.path.join(outPath(), TASK_INCLUDE)) - generateFile(os.path.join(basePath(),XDR_FILE),os.path.join(outPath(),XDR_INCLUDE),generateXdrMappings) - generateFile(os.path.join(basePath(),GROVE_CONFIG_IN),os.path.join(outPath(),GROVE_CONFIG),generateGroveDefs,inMode='r') - version="dev"+datetime.now().strftime("%Y%m%d") - env.Append(CPPDEFINES=[('GWDEVVERSION',version)]) - -def cleangenerated(source, target, env): - od=outPath() - if os.path.isdir(od): - print("#cleaning up %s"%od) - for f in os.listdir(od): - if f == "." or f == "..": - continue - fn=os.path.join(od,f) - os.unlink(f) - - -print("#prescript...") -prebuild(env) -board="PLATFORM_BOARD_%s"%env["BOARD"].replace("-","_").upper() -print("Board=#%s#"%board) -print("BuildFlags=%s"%(" ".join(env["BUILD_FLAGS"]))) -env.Append( - LINKFLAGS=[ "-u", "custom_app_desc" ], - CPPDEFINES=[(board,"1")] -) -#script does not run on clean yet - maybe in the future -env.AddPostAction("clean",cleangenerated) - -#look for extra task scripts and include them here -for taskdir in userTaskDirs: - script = os.path.join(taskdir, "extra_task.py") - if os.path.isfile(script): - taskname = os.path.basename(os.path.normpath(taskdir)) - print("#extra task script for '{}'".format(taskname)) - with open(script) as fh: - try: - code = compile(fh.read(), taskname, 'exec') - except SyntaxError: - print("#ERROR: script does not compile") - continue - exec(code) diff --git a/extra_script.py.old b/extra_script.py.old deleted file mode 100644 index ed62c64..0000000 --- a/extra_script.py.old +++ /dev/null @@ -1,518 +0,0 @@ -print("running extra...") -import gzip -import shutil -import os -import sys -import inspect -import json -import glob -from datetime import datetime -import re -import pprint -from platformio.project.config import ProjectConfig - - -Import("env") -#print(env.Dump()) -OWN_FILE="extra_script.py" -GEN_DIR='lib/generated' -CFG_FILE='web/config.json' -XDR_FILE='web/xdrconfig.json' -INDEXJS="index.js" -INDEXCSS="index.css" -CFG_INCLUDE='GwConfigDefinitions.h' -CFG_INCLUDE_IMPL='GwConfigDefImpl.h' -XDR_INCLUDE='GwXdrTypeMappings.h' -TASK_INCLUDE='GwUserTasks.h' -GROVE_CONFIG="GwM5GroveGen.h" -GROVE_CONFIG_IN="lib/hardware/GwM5Grove.in" -EMBEDDED_INCLUDE="GwEmbeddedFiles.h" - -def getEmbeddedFiles(env): - rt=[] - efiles=env.GetProjectOption("board_build.embed_files") - for f in efiles.split("\n"): - if f == '': - continue - rt.append(f) - return rt - -def basePath(): - #see: https://stackoverflow.com/questions/16771894/python-nameerror-global-name-file-is-not-defined - return os.path.dirname(inspect.getfile(lambda: None)) - -def outPath(): - return os.path.join(basePath(),GEN_DIR) -def checkDir(): - dn=outPath() - if not os.path.exists(dn): - os.makedirs(dn) - if not os.path.isdir(dn): - print("unable to create %s"%dn) - return False - return True - -def isCurrent(infile,outfile): - if os.path.exists(outfile): - otime=os.path.getmtime(outfile) - itime=os.path.getmtime(infile) - if (otime >= itime): - own=os.path.join(basePath(),OWN_FILE) - if os.path.exists(own): - owntime=os.path.getmtime(own) - if owntime > otime: - return False - print("%s is newer then %s, no need to recreate"%(outfile,infile)) - return True - return False -def compressFile(inFile,outfile): - if isCurrent(inFile,outfile): - return - print("compressing %s"%inFile) - with open(inFile, 'rb') as f_in: - with gzip.open(outfile, 'wb') as f_out: - shutil.copyfileobj(f_in, f_out) - -def generateFile(infile,outfile,callback,inMode='rb',outMode='w'): - if isCurrent(infile,outfile): - return - print("creating %s"%outfile) - oh=None - with open(infile,inMode) as ch: - with open(outfile,outMode) as oh: - try: - callback(ch,oh,inFile=infile) - oh.close() - except Exception as e: - try: - oh.close() - except: - pass - os.unlink(outfile) - raise - -def writeFileIfChanged(fileName,data): - if os.path.exists(fileName): - with open(fileName,"r") as ih: - old=ih.read() - ih.close() - if old == data: - return False - print("#generating %s"%fileName) - with open(fileName,"w") as oh: - oh.write(data) - return True - -def mergeConfig(base,other): - for bdir in other: - cname=os.path.join(bdir,"config.json") - if os.path.exists(cname): - print("merge config %s"%cname) - with open(cname,'rb') as ah: - merge=json.load(ah) - base=base+merge - return base - -def replaceTexts(data,replacements): - if replacements is None: - return data - if isinstance(data,str): - for k,v in replacements.items(): - data=data.replace("$"+k,str(v)) - return data - if isinstance(data,list): - rt=[] - for e in data: - rt.append(replaceTexts(e,replacements)) - return rt - if isinstance(data,dict): - rt={} - for k,v in data.items(): - rt[replaceTexts(k,replacements)]=replaceTexts(v,replacements) - return rt - return data -def expandConfig(config): - rt=[] - for item in config: - type=item.get('type') - if type != 'array': - rt.append(item) - continue - replacements=item.get('replace') - children=item.get('children') - name=item.get('name') - if name is None: - name="#unknown#" - if not isinstance(replacements,list): - raise Exception("missing replacements at array %s"%name) - for replace in replacements: - if children is not None: - for c in children: - rt.append(replaceTexts(c,replace)) - return rt - -def generateMergedConfig(inFile,outFile,addDirs=[]): - if not os.path.exists(inFile): - raise Exception("unable to read cfg file %s"%inFile) - data="" - with open(inFile,'rb') as ch: - config=json.load(ch) - config=mergeConfig(config,addDirs) - config=expandConfig(config) - data=json.dumps(config,indent=2) - writeFileIfChanged(outFile,data) - -def generateCfg(inFile,outFile,impl): - if not os.path.exists(inFile): - raise Exception("unable to read cfg file %s"%inFile) - data="" - with open(inFile,'rb') as ch: - config=json.load(ch) - data+="//generated from %s\n"%inFile - l=len(config) - idx=0 - if not impl: - data+='#include "GwConfigItem.h"\n' - data+='class GwConfigDefinitions{\n' - data+=' public:\n' - data+=' int getNumConfig() const{return %d;}\n'%(l) - for item in config: - n=item.get('name') - if n is None: - continue - if len(n) > 15: - raise Exception("%s: config names must be max 15 caracters"%n) - data+=' static constexpr const char* %s="%s";\n'%(n,n) - data+="};\n" - else: - data+='void GwConfigHandler::populateConfigs(GwConfigInterface **config){\n' - for item in config: - name=item.get('name') - if name is None: - continue - data+=' configs[%d]='%(idx) - idx+=1 - secret="false"; - if item.get('type') == 'password': - secret="true" - data+=" new GwConfigInterface(%s,\"%s\",%s);\n"%(name,item.get('default'),secret) - data+='}\n' - writeFileIfChanged(outFile,data) - -def labelFilter(label): - return re.sub("[^a-zA-Z0-9]","",re.sub("\([0-9]*\)","",label)) -def generateXdrMappings(fp,oh,inFile=''): - jdoc=json.load(fp) - oh.write("static GwXDRTypeMapping* typeMappings[]={\n") - first=True - for cat in jdoc: - item=jdoc[cat] - cid=item.get('id') - if cid is None: - continue - tc=item.get('type') - if tc is not None: - if first: - first=False - else: - oh.write(",\n") - oh.write(" new GwXDRTypeMapping(%d,0,%d) /*%s*/"%(cid,tc,cat)) - fields=item.get('fields') - if fields is None: - continue - idx=0 - for fe in fields: - if not isinstance(fe,dict): - continue - tc=fe.get('t') - id=fe.get('v') - if id is None: - id=idx - idx+=1 - l=fe.get('l') or '' - if tc is None or id is None: - continue - if first: - first=False - else: - oh.write(",\n") - oh.write(" new GwXDRTypeMapping(%d,%d,%d) /*%s:%s*/"%(cid,id,tc,cat,l)) - oh.write("\n") - oh.write("};\n") - for cat in jdoc: - item=jdoc[cat] - cid=item.get('id') - if cid is None: - continue - selectors=item.get('selector') - if selectors is not None: - for selector in selectors: - label=selector.get('l') - value=selector.get('v') - if label is not None and value is not None: - label=labelFilter(label) - define=("GWXDRSEL_%s_%s"%(cat,label)).upper() - oh.write(" #define %s %s\n"%(define,value)) - fields=item.get('fields') - if fields is not None: - idx=0 - for field in fields: - v=field.get('v') - if v is None: - v=idx - else: - v=int(v) - label=field.get('l') - if v is not None and label is not None: - define=("GWXDRFIELD_%s_%s"%(cat,labelFilter(label))).upper(); - oh.write(" #define %s %s\n"%(define,str(v))) - idx+=1 - -class Grove: - def __init__(self,name) -> None: - self.name=name - def _ss(self,z=False): - if z: - return self.name - return self.name if self.name is not 'Z' else '' - def _suffix(self): - return '_'+self.name if self.name is not 'Z' else '' - def replace(self,line): - if line is None: - return line - return line.replace('$G$',self._ss()).replace('$Z$',self._ss(True)).replace('$GS$',self._suffix()) -def generateGroveDefs(inh,outh,inFile=''): - GROVES=[Grove('Z'),Grove('A'),Grove('B'),Grove('C')] - definition=[] - started=False - def writeConfig(): - for grove in GROVES: - for cl in definition: - outh.write(grove.replace(cl)) - - for line in inh: - if re.match(" *#GROVE",line): - started=True - if len(definition) > 0: - writeConfig() - definition=[] - continue - if started: - definition.append(line) - if len(definition) > 0: - writeConfig() - - - -userTaskDirs=[] - -def getUserTaskDirs(): - rt=[] - taskdirs=glob.glob(os.path.join( basePath(),'lib','*task*')) - for task in taskdirs: - rt.append(task) - return rt - -def checkAndAdd(file,names,ilist): - if not file.endswith('.h'): - return - match=False - for cmp in names: - #print("##check %s<->%s"%(f.lower(),cmp)) - if file.lower() == cmp: - match=True - if not match: - return - ilist.append(file) -def genereateUserTasks(outfile): - includes=[] - for task in userTaskDirs: - #print("##taskdir=%s"%task) - base=os.path.basename(task) - includeNames=[base.lower()+".h",'gw'+base.lower()+'.h'] - for f in os.listdir(task): - checkAndAdd(f,includeNames,includes) - includeData="" - for i in includes: - print("#task include %s"%i) - includeData+="#include <%s>\n"%i - writeFileIfChanged(outfile,includeData) - -def generateEmbedded(elist,outFile): - content="" - for entry in elist: - content+="EMBED_GZ_FILE(\"%s\",%s,\"%s\");\n"%entry - writeFileIfChanged(outFile,content) - -def getContentType(fn): - if (fn.endswith('.gz')): - fn=fn[0:-3] - if (fn.endswith('html')): - return "text/html" - if (fn.endswith('json')): - return "application/json" - if (fn.endswith('js')): - return "text/javascript" - if (fn.endswith('css')): - return "text/css" - return "application/octet-stream" - - -def getLibs(): - base=os.path.join(basePath(),"lib") - rt=[] - for sd in os.listdir(base): - if sd == '..': - continue - if sd == '.': - continue - fn=os.path.join(base,sd) - if os.path.isdir(fn): - rt.append(sd) - EXTRAS=['generated'] - for e in EXTRAS: - if not e in rt: - rt.append(e) - return rt - - - -def joinFiles(target,pattern,dirlist): - flist=[] - for dir in dirlist: - fn=os.path.join(dir,pattern) - if os.path.exists(fn): - flist.append(fn) - current=False - if os.path.exists(target): - current=True - for f in flist: - if not isCurrent(f,target): - current=False - break - if current: - print("%s is up to date"%target) - return - print("creating %s"%target) - with gzip.open(target,"wb") as oh: - for fn in flist: - print("adding %s to %s"%(fn,target)) - with open(fn,"rb") as rh: - shutil.copyfileobj(rh,oh) - - -OWNLIBS=getLibs()+["FS","WiFi"] -GLOBAL_INCLUDES=[] - -def handleDeps(env): - #overwrite the GetProjectConfig - #to inject all our libs - oldGetProjectConfig=env.GetProjectConfig - def GetProjectConfigX(env): - rt=oldGetProjectConfig() - cenv="env:"+env['PIOENV'] - libs=[] - for section,options in rt.as_tuple(): - if section == cenv: - for key,values in options: - if key == 'lib_deps': - libs=values - - mustUpdate=False - for lib in OWNLIBS: - if not lib in libs: - libs.append(lib) - mustUpdate=True - if mustUpdate: - update=[(cenv,[('lib_deps',libs)])] - rt.update(update) - return rt - env.AddMethod(GetProjectConfigX,"GetProjectConfig") - #store the list of all includes after we resolved - #the dependencies for our main project - #we will use them for all compilations afterwards - oldLibBuilder=env.ConfigureProjectLibBuilder - def ConfigureProjectLibBuilderX(env): - global GLOBAL_INCLUDES - project=oldLibBuilder() - #print("##ConfigureProjectLibBuilderX") - #pprint.pprint(project) - if project.depbuilders: - #print("##depbuilders %s"%",".join(map(lambda x: x.path,project.depbuilders))) - for db in project.depbuilders: - idirs=db.get_include_dirs() - for id in idirs: - if not id in GLOBAL_INCLUDES: - GLOBAL_INCLUDES.append(id) - return project - env.AddMethod(ConfigureProjectLibBuilderX,"ConfigureProjectLibBuilder") - def injectIncludes(env,node): - return env.Object( - node, - CPPPATH=env["CPPPATH"]+GLOBAL_INCLUDES - ) - env.AddBuildMiddleware(injectIncludes) - - -def prebuild(env): - global userTaskDirs - print("#prebuild running") - if not checkDir(): - sys.exit(1) - ldf_mode=env.GetProjectOption("lib_ldf_mode") - if ldf_mode == 'off': - print("##ldf off - own dependency handling") - handleDeps(env) - userTaskDirs=getUserTaskDirs() - mergedConfig=os.path.join(outPath(),os.path.basename(CFG_FILE)) - generateMergedConfig(os.path.join(basePath(),CFG_FILE),mergedConfig,userTaskDirs) - compressFile(mergedConfig,mergedConfig+".gz") - generateCfg(mergedConfig,os.path.join(outPath(),CFG_INCLUDE),False) - generateCfg(mergedConfig,os.path.join(outPath(),CFG_INCLUDE_IMPL),True) - joinFiles(os.path.join(outPath(),INDEXJS+".gz"),INDEXJS,["web"]+userTaskDirs) - joinFiles(os.path.join(outPath(),INDEXCSS+".gz"),INDEXCSS,["web"]+userTaskDirs) - embedded=getEmbeddedFiles(env) - filedefs=[] - for ef in embedded: - print("#checking embedded file %s"%ef) - (dn,fn)=os.path.split(ef) - pureName=fn - if pureName.endswith('.gz'): - pureName=pureName[0:-3] - ct=getContentType(pureName) - usname=ef.replace('/','_').replace('.','_') - filedefs.append((pureName,usname,ct)) - inFile=os.path.join(basePath(),"web",pureName) - if os.path.exists(inFile): - compressFile(inFile,ef) - else: - print("#WARNING: infile %s for %s not found"%(inFile,ef)) - generateEmbedded(filedefs,os.path.join(outPath(),EMBEDDED_INCLUDE)) - genereateUserTasks(os.path.join(outPath(), TASK_INCLUDE)) - generateFile(os.path.join(basePath(),XDR_FILE),os.path.join(outPath(),XDR_INCLUDE),generateXdrMappings) - generateFile(os.path.join(basePath(),GROVE_CONFIG_IN),os.path.join(outPath(),GROVE_CONFIG),generateGroveDefs,inMode='r') - version="dev"+datetime.now().strftime("%Y%m%d") - env.Append(CPPDEFINES=[('GWDEVVERSION',version)]) - -def cleangenerated(source, target, env): - od=outPath() - if os.path.isdir(od): - print("#cleaning up %s"%od) - for f in os.listdir(od): - if f == "." or f == "..": - continue - fn=os.path.join(od,f) - os.unlink(f) - - -print("#prescript...") -prebuild(env) -board="PLATFORM_BOARD_%s"%env["BOARD"].replace("-","_").upper() -print("Board=#%s#"%board) -print("BuildFlags=%s"%(" ".join(env["BUILD_FLAGS"]))) -env.Append( - LINKFLAGS=[ "-u", "custom_app_desc" ], - CPPDEFINES=[(board,"1")] -) -#script does not run on clean yet - maybe in the future -env.AddPostAction("clean",cleangenerated) diff --git a/lib/aisparser/ais_decoder.cpp b/lib/aisparser/ais_decoder.cpp index 6fece95..3c5dc00 100644 --- a/lib/aisparser/ais_decoder.cpp +++ b/lib/aisparser/ais_decoder.cpp @@ -627,7 +627,7 @@ void AisDecoder::decodeType21(PayloadBuffer &_buffer, unsigned int _uMsgType, in } // decode message fields (binary buffer has to go through all fields, but some fields are not used) - _buffer.getUnsignedValue(2); // repeatIndicator + auto repeat=_buffer.getUnsignedValue(2); // repeatIndicator auto mmsi = _buffer.getUnsignedValue(30); auto aidType = _buffer.getUnsignedValue(5); auto name = _buffer.getString(120); @@ -640,11 +640,11 @@ void AisDecoder::decodeType21(PayloadBuffer &_buffer, unsigned int _uMsgType, in auto toStarboard = _buffer.getUnsignedValue(6); _buffer.getUnsignedValue(4); // epfd type - _buffer.getUnsignedValue(6); // timestamp - _buffer.getBoolValue(); // off position + auto timestamp=_buffer.getUnsignedValue(6); // timestamp + auto offPosition=_buffer.getBoolValue(); // off position _buffer.getUnsignedValue(8); // reserved - _buffer.getBoolValue(); // RAIM - _buffer.getBoolValue(); // virtual aid + auto raim=_buffer.getBoolValue(); // RAIM + auto virtualAton=_buffer.getBoolValue(); // virtual aid _buffer.getBoolValue(); // assigned mode _buffer.getUnsignedValue(1); // spare @@ -654,7 +654,9 @@ void AisDecoder::decodeType21(PayloadBuffer &_buffer, unsigned int _uMsgType, in nameExt = _buffer.getString(88); } - onType21(mmsi, aidType, name + nameExt, posAccuracy, posLon, posLat, toBow, toStern, toPort, toStarboard); + onType21(mmsi, aidType, name + nameExt, posAccuracy, posLon, posLat, + toBow, toStern, toPort, toStarboard, + repeat,timestamp, raim, virtualAton, offPosition); } /* decode Voyage Report and Static Data (type nibble already pulled from buffer) */ diff --git a/lib/aisparser/ais_decoder.h b/lib/aisparser/ais_decoder.h index c908839..7872d3b 100644 --- a/lib/aisparser/ais_decoder.h +++ b/lib/aisparser/ais_decoder.h @@ -297,7 +297,8 @@ namespace AIS bool assigned, unsigned int repeat, bool raim) = 0; virtual void onType21(unsigned int _uMmsi, unsigned int _uAidType, const std::string &_strName, bool _bPosAccuracy, int _iPosLon, int _iPosLat, - unsigned int _uToBow, unsigned int _uToStern, unsigned int _uToPort, unsigned int _uToStarboard) = 0; + unsigned int _uToBow, unsigned int _uToStern, unsigned int _uToPort, unsigned int _uToStarboard, + unsigned int repeat,unsigned int timestamp, bool raim, bool virtualAton, bool offPosition) = 0; virtual void onType24A(unsigned int _uMsgType, unsigned int _repeat, unsigned int _uMmsi, const std::string &_strName) = 0; diff --git a/lib/appinfo/GwAppInfo.h b/lib/appinfo/GwAppInfo.h index f7eb143..0ccf711 100644 --- a/lib/appinfo/GwAppInfo.h +++ b/lib/appinfo/GwAppInfo.h @@ -14,6 +14,9 @@ #define LOGLEVEL GwLog::DEBUG #endif #endif - +#ifdef GWBUILD_NAME +#define FIRMWARE_TYPE GWSTRINGIFY(GWBUILD_NAME) +#else #define FIRMWARE_TYPE GWSTRINGIFY(PIO_ENV_BUILD) +#endif #define IDF_VERSION GWSTRINGIFY(ESP_IDF_VERSION_MAJOR) "." GWSTRINGIFY(ESP_IDF_VERSION_MINOR) "." GWSTRINGIFY(ESP_IDF_VERSION_PATCH) \ No newline at end of file diff --git a/lib/channel/GwChannel.cpp b/lib/channel/GwChannel.cpp index 9c79983..1a0d06f 100644 --- a/lib/channel/GwChannel.cpp +++ b/lib/channel/GwChannel.cpp @@ -249,3 +249,16 @@ unsigned long GwChannel::countTx(){ if (! countOut) return 0UL; return countOut->getGlobal(); } +String GwChannel::typeString(int type){ + switch (type){ + case GWSERIAL_TYPE_UNI: + return "UNI"; + case GWSERIAL_TYPE_BI: + return "BI"; + case GWSERIAL_TYPE_RX: + return "RX"; + case GWSERIAL_TYPE_TX: + return "TX"; + } + return "UNKNOWN"; +} \ No newline at end of file diff --git a/lib/channel/GwChannel.h b/lib/channel/GwChannel.h index 66fb4ae..6b34432 100644 --- a/lib/channel/GwChannel.h +++ b/lib/channel/GwChannel.h @@ -77,7 +77,8 @@ class GwChannel{ if (maxSourceId < 0) return source == sourceId; return (source >= sourceId && source <= maxSourceId); } - String getMode(){return impl->getMode();} + static String typeString(int type); + String getMode(){return typeString(impl->getType());} int getMinId(){return sourceId;}; }; diff --git a/lib/channel/GwChannelInterface.h b/lib/channel/GwChannelInterface.h index 68f519b..30550d9 100644 --- a/lib/channel/GwChannelInterface.h +++ b/lib/channel/GwChannelInterface.h @@ -1,10 +1,11 @@ #pragma once #include "GwBuffer.h" +#include "GwChannelModes.h" class GwChannelInterface{ public: virtual void loop(bool handleRead,bool handleWrite)=0; virtual void readMessages(GwMessageFetcher *writer)=0; virtual size_t sendToClients(const char *buffer, int sourceId, bool partial=false)=0; virtual Stream * getStream(bool partialWrites){ return NULL;} - virtual String getMode(){return "UNKNOWN";} + virtual int getType(){ return GWSERIAL_TYPE_BI;} //return the numeric type }; \ No newline at end of file diff --git a/lib/channel/GwChannelList.cpp b/lib/channel/GwChannelList.cpp index c9db748..8a85863 100644 --- a/lib/channel/GwChannelList.cpp +++ b/lib/channel/GwChannelList.cpp @@ -15,8 +15,10 @@ class SerInit{ int tx=-1; int mode=-1; int fixedBaud=-1; - SerInit(int s,int r,int t, int m, int b=-1): - serial(s),rx(r),tx(t),mode(m),fixedBaud(b){} + int ena=-1; + int elow=1; + SerInit(int s,int r,int t, int m, int b=-1,int en=-1,int el=-1): + serial(s),rx(r),tx(t),mode(m),fixedBaud(b),ena(en),elow(el){} }; std::vector serialInits; @@ -47,11 +49,20 @@ static int typeFromMode(const char *mode){ #ifndef GWSERIAL_RX #define GWSERIAL_RX -1 #endif +#ifndef GWSERIAL_ENA +#define GWSERIAL_ENA -1 +#endif +#ifndef GWSERIAL_ELO +#define GWSERIAL_ELO 0 +#endif +#ifndef GWSERIAL_BAUD +#define GWSERIAL_BAUD -1 +#endif #ifdef GWSERIAL_TYPE - CFG_SERIAL(SERIAL1_CHANNEL_ID, GWSERIAL_RX, GWSERIAL_TX, GWSERIAL_TYPE) + CFG_SERIAL(SERIAL1_CHANNEL_ID, GWSERIAL_RX, GWSERIAL_TX, GWSERIAL_TYPE,GWSERIAL_BAUD,GWSERIAL_ENA,GWSERIAL_ELO) #else #ifdef GWSERIAL_MODE -CFG_SERIAL(SERIAL1_CHANNEL_ID, GWSERIAL_RX, GWSERIAL_TX, typeFromMode(GWSERIAL_MODE)) +CFG_SERIAL(SERIAL1_CHANNEL_ID, GWSERIAL_RX, GWSERIAL_TX, typeFromMode(GWSERIAL_MODE),GWSERIAL_BAUD,GWSERIAL_ENA,GWSERIAL_ELO) #endif #endif // serial 2 @@ -61,11 +72,20 @@ CFG_SERIAL(SERIAL1_CHANNEL_ID, GWSERIAL_RX, GWSERIAL_TX, typeFromMode(GWSERIAL_M #ifndef GWSERIAL2_RX #define GWSERIAL2_RX -1 #endif +#ifndef GWSERIAL2_ENA +#define GWSERIAL2_ENA -1 +#endif +#ifndef GWSERIAL2_ELO +#define GWSERIAL2_ELO 0 +#endif +#ifndef GWSERIAL2_BAUD +#define GWSERIAL2_BAUD -1 +#endif #ifdef GWSERIAL2_TYPE - CFG_SERIAL(SERIAL2_CHANNEL_ID, GWSERIAL2_RX, GWSERIAL2_TX, GWSERIAL2_TYPE) + CFG_SERIAL(SERIAL2_CHANNEL_ID, GWSERIAL2_RX, GWSERIAL2_TX, GWSERIAL2_TYPE,GWSERIAL2_BAUD,GWSERIAL2_ENA,GWSERIAL2_ELO) #else #ifdef GWSERIAL2_MODE -CFG_SERIAL(SERIAL2_CHANNEL_ID, GWSERIAL2_RX, GWSERIAL2_TX, typeFromMode(GWSERIAL2_MODE)) +CFG_SERIAL(SERIAL2_CHANNEL_ID, GWSERIAL2_RX, GWSERIAL2_TX, typeFromMode(GWSERIAL2_MODE),GWSERIAL2_BAUD,GWSERIAL2_ENA,GWSERIAL2_ELO) #endif #endif class GwSerialLog : public GwLogWriter @@ -285,8 +305,8 @@ static ChannelParam channelParameters[]={ }; template -GwSerial* createSerial(GwLog *logger, T* s,int id, bool canRead=true){ - return new GwSerialImpl(logger,s,id,canRead); +GwSerial* createSerial(GwLog *logger, T* s,int id, int type, bool canRead=true){ + return new GwSerialImpl(logger,s,id,type,canRead); } static ChannelParam * findChannelParam(int id){ @@ -300,7 +320,7 @@ static ChannelParam * findChannelParam(int id){ return param; } -static GwSerial * createSerialImpl(GwConfigHandler *config,GwLog *logger, int idx,int rx,int tx, bool setLog=false){ +static GwSerial * createSerialImpl(GwConfigHandler *config,GwLog *logger, int idx,int type,int rx,int tx, bool setLog,int ena=-1,int elow=1){ LOG_DEBUG(GwLog::DEBUG,"create serial: channel=%d, rx=%d,tx=%d", idx,rx,tx); ChannelParam *param=findChannelParam(idx); @@ -312,19 +332,45 @@ static GwSerial * createSerialImpl(GwConfigHandler *config,GwLog *logger, int id GwLog *streamLog=setLog?nullptr:logger; switch(param->id){ case USB_CHANNEL_ID: - serialStream=createSerial(streamLog,&USBSerial,param->id); + serialStream=createSerial(streamLog,&USBSerial,param->id,type); break; case SERIAL1_CHANNEL_ID: - serialStream=createSerial(streamLog,&Serial1,param->id); + serialStream=createSerial(streamLog,&Serial1,param->id,type); break; case SERIAL2_CHANNEL_ID: - serialStream=createSerial(streamLog,&Serial2,param->id); + serialStream=createSerial(streamLog,&Serial2,param->id,type); break; } if (serialStream == nullptr){ LOG_DEBUG(GwLog::ERROR,"invalid serial config with id %d",param->id); return nullptr; } + if (ena >= 0){ + int value=-1; + if (type == GWSERIAL_TYPE_UNI){ + String cfgMode=config->getString(param->direction); + if (cfgMode == "send"){ + value=elow?0:1; + } + else{ + value=elow?1:0; + } + } + if (type == GWSERIAL_TYPE_RX){ + value=elow?1:0; + } + if (type == GWSERIAL_TYPE_TX){ + value=elow?0:1; + } + if (value >= 0){ + LOG_DEBUG(GwLog::LOG,"serial %d: setting output enable %d to %d",param->id,ena,value); + pinMode(ena,OUTPUT); + digitalWrite(ena,value); + } + else{ + LOG_DEBUG(GwLog::ERROR,"serial %d: output enable ignored for mode %d",param->id, type); + } + } serialStream->begin(config->getInt(param->baud,115200),SERIAL_8N1,rx,tx); if (setLog){ logger->setWriter(new GwSerialLog(serialStream,config->getBool(param->preventLog,false))); @@ -332,12 +378,13 @@ static GwSerial * createSerialImpl(GwConfigHandler *config,GwLog *logger, int id } return serialStream; } -static GwChannel * createChannel(GwLog *logger, GwConfigHandler *config, int id,GwChannelInterface *impl, int type=GWSERIAL_TYPE_BI){ +static GwChannel * createChannel(GwLog *logger, GwConfigHandler *config, int id,GwChannelInterface *impl){ ChannelParam *param=findChannelParam(id); if (param == nullptr){ LOG_DEBUG(GwLog::ERROR,"invalid channel id %d",id); return nullptr; } + int type=impl->getType(); bool canRead=false; bool canWrite=false; bool validType=false; @@ -425,10 +472,10 @@ void GwChannelList::begin(bool fallbackSerial){ GwChannel *channel=NULL; //usb if (! fallbackSerial){ - GwSerial *usbSerial=createSerialImpl(config, logger,USB_CHANNEL_ID,GWUSB_RX,GWUSB_TX,true); + GwSerial *usbSerial=createSerialImpl(config, logger,USB_CHANNEL_ID,GWSERIAL_TYPE_BI,GWUSB_RX,GWUSB_TX,true); if (usbSerial != nullptr){ usbSerial->enableWriteLock(); //as it is used for logging we need this additionally - GwChannel *usbChannel=createChannel(logger,config,USB_CHANNEL_ID,usbSerial,GWSERIAL_TYPE_BI); + GwChannel *usbChannel=createChannel(logger,config,USB_CHANNEL_ID,usbSerial); if (usbChannel != nullptr){ addChannel(usbChannel); } @@ -444,10 +491,11 @@ void GwChannelList::begin(bool fallbackSerial){ //new serial config handling for (auto &&init:serialInits){ - LOG_INFO("creating serial channel %d, rx=%d,tx=%d,type=%d",init.serial,init.rx,init.tx,init.mode); - GwSerial *ser=createSerialImpl(config,logger,init.serial,init.rx,init.tx); + LOG_INFO("creating serial channel %d, rx=%d,tx=%d,type=%d fixedBaud=%d ena=%d elow=%d", + init.serial,init.rx,init.tx,init.mode,init.fixedBaud,init.ena,init.elow); + GwSerial *ser=createSerialImpl(config,logger,init.serial,init.mode,init.rx,init.tx,false,init.ena,init.elow); if (ser != nullptr){ - channel=createChannel(logger,config,init.serial,ser,init.mode); + channel=createChannel(logger,config,init.serial,ser); if (channel != nullptr){ addChannel(channel); } @@ -466,8 +514,8 @@ void GwChannelList::begin(bool fallbackSerial){ config->getInt(config->remotePort), config->getBool(config->readTCL) ); + addChannel(createChannel(logger,config,TCP_CLIENT_CHANNEL_ID,client)); } - addChannel(createChannel(logger,config,TCP_CLIENT_CHANNEL_ID,client)); //udp writer if (config->getBool(GwConfigDefinitions::udpwEnabled)){ diff --git a/lib/config/GwConverterConfig.h b/lib/config/GwConverterConfig.h index 4a93a71..25ca39e 100644 --- a/lib/config/GwConverterConfig.h +++ b/lib/config/GwConverterConfig.h @@ -3,7 +3,7 @@ This code is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. + version 2 of the License, or (at your option) any later version. This code 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 diff --git a/lib/exampletask/Readme.md b/lib/exampletask/Readme.md index 7637ecf..3220242 100644 --- a/lib/exampletask/Readme.md +++ b/lib/exampletask/Readme.md @@ -57,6 +57,44 @@ Files Starting from Version 20250305 you should normally not use this file name any more as those styles would be added for all build environments. Instead define a parameter _custom_css_ in your [platformio.ini](platformio.ini) for the environments you would like to add some styles for. This parameter accepts a list of file names (relative to the project root, separated by , or as multi line entry) + * [script.py](script.py)
+ Starting from version 20251007 you can define a parameter "custom_script" in your [platformio.ini](platformio.ini). + This parameter can contain a list of file names (relative to the project root) that will be added as a [platformio extra script](https://docs.platformio.org/en/latest/scripting/index.html#scripting). The scripts will be loaded at the end of the main [extra_script](../../extra_script.py). + You can add code there that is specific for your build. + Example: + ``` + # PlatformIO extra script for obp60task + epdtype = "unknown" + pcbvers = "unknown" + for x in env["BUILD_FLAGS"]: + if x.startswith("-D HARDWARE_"): + pcbvers = x.split('_')[1] + if x.startswith("-D DISPLAY_"): + epdtype = x.split('_')[1] + + propfilename = os.path.join(env["PROJECT_LIBDEPS_DIR"], env ["PIOENV"], "GxEPD2/library.properties") + properties = {} + with open(propfilename, 'r') as file: + for line in file: + match = re.match(r'^([^=]+)=(.*)$', line) + if match: + key = match.group(1).strip() + value = match.group(2).strip() + properties[key] = value + + gxepd2vers = "unknown" + try: + if properties["name"] == "GxEPD2": + gxepd2vers = properties["version"] + except: + pass + + env["CPPDEFINES"].extend([("BOARD", env["BOARD"]), ("EPDTYPE", epdtype), ("PCBVERS", pcbvers), ("GXEPD2VERS", gxepd2vers)]) + + print("added hardware info to CPPDEFINES") + print("friendly board name is '{}'".format(env.GetProjectOption ("board_name"))) + ``` + Interfaces ---------- diff --git a/lib/exampletask/platformio.ini b/lib/exampletask/platformio.ini index 348b36c..74363a9 100644 --- a/lib/exampletask/platformio.ini +++ b/lib/exampletask/platformio.ini @@ -14,5 +14,6 @@ custom_config= lib/exampletask/exampleConfig.json custom_js=lib/exampletask/example.js custom_css=lib/exampletask/example.css +custom_script=lib/exampletask/script.py upload_port = /dev/esp32 upload_protocol = esptool \ No newline at end of file diff --git a/lib/exampletask/script.py b/lib/exampletask/script.py new file mode 100644 index 0000000..fb53d6f --- /dev/null +++ b/lib/exampletask/script.py @@ -0,0 +1,4 @@ +Import("env") + +print("exampletask extra script running") +syntax error here \ No newline at end of file diff --git a/lib/hardware/GwChannelModes.h b/lib/hardware/GwChannelModes.h new file mode 100644 index 0000000..e6c42de --- /dev/null +++ b/lib/hardware/GwChannelModes.h @@ -0,0 +1,23 @@ +/* + This code is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + This code 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 + Lesser General Public License for more details. + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + defines for the channel modes(types) +*/ +#ifndef _GWCHANNELMODES_H +#define _GWCHANNELMODES_H +#define GWSERIAL_TYPE_UNI 1 +#define GWSERIAL_TYPE_BI 2 +#define GWSERIAL_TYPE_RX 3 +#define GWSERIAL_TYPE_TX 4 +#define GWSERIAL_TYPE_UNK 0 +#endif \ No newline at end of file diff --git a/lib/hardware/GwHardware.h b/lib/hardware/GwHardware.h index 0b14ab3..10a7404 100644 --- a/lib/hardware/GwHardware.h +++ b/lib/hardware/GwHardware.h @@ -2,7 +2,7 @@ This code is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. + version 2 of the License, or (at your option) any later version. This code 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 @@ -20,11 +20,7 @@ #endif #ifndef _GWHARDWARE_H #define _GWHARDWARE_H -#define GWSERIAL_TYPE_UNI 1 -#define GWSERIAL_TYPE_BI 2 -#define GWSERIAL_TYPE_RX 3 -#define GWSERIAL_TYPE_TX 4 -#define GWSERIAL_TYPE_UNK 0 +#include "GwChannelModes.h" #include #include #include "GwAppInfo.h" diff --git a/lib/hardware/GwM5Base.h b/lib/hardware/GwM5Base.h index a3284ee..67c865e 100644 --- a/lib/hardware/GwM5Base.h +++ b/lib/hardware/GwM5Base.h @@ -2,7 +2,7 @@ This code is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. + version 2 of the License, or (at your option) any later version. This code 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 @@ -35,7 +35,12 @@ #ifdef M5_GPS_KIT GWRESOURCE_USE(BASE,M5_GPS_KIT) GWRESOURCE_USE(SERIAL1,M5_GPS_KIT) - #define _GWI_SERIAL1 BOARD_LEFT1,-1,GWSERIAL_TYPE_UNI,9600 + #define _GWI_SERIAL1 BOARD_LEFT1,-1,GWSERIAL_TYPE_RX,9600 +#endif +#ifdef M5_GPSV2_KIT + GWRESOURCE_USE(BASE,M5_GPSV2_KIT) + GWRESOURCE_USE(SERIAL1,M5_GPSV2_KIT) + #define _GWI_SERIAL1 BOARD_LEFT1,-1,GWSERIAL_TYPE_RX,115200 #endif //M5 ProtoHub @@ -61,11 +66,11 @@ #endif //can kit for M5 Atom -#ifdef M5_CAN_KIT +#if defined (M5_CAN_KIT) GWRESOURCE_USE(BASE,M5_CAN_KIT) GWRESOURCE_USE(CAN,M5_CANKIT) #define ESP32_CAN_TX_PIN BOARD_LEFT1 #define ESP32_CAN_RX_PIN BOARD_LEFT2 #endif -#endif \ No newline at end of file +#endif diff --git a/lib/hardware/GwM5Grove.h b/lib/hardware/GwM5Grove.h index 220ee01..44761a1 100644 --- a/lib/hardware/GwM5Grove.h +++ b/lib/hardware/GwM5Grove.h @@ -2,7 +2,7 @@ This code is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. + version 2 of the License, or (at your option) any later version. This code 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 diff --git a/lib/hardware/GwM5Grove.in b/lib/hardware/GwM5Grove.in index aed70a1..a3c8c06 100644 --- a/lib/hardware/GwM5Grove.in +++ b/lib/hardware/GwM5Grove.in @@ -2,7 +2,7 @@ This code is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. + version 2 of the License, or (at your option) any later version. This code 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 @@ -43,6 +43,13 @@ #define _GWI_SERIAL_GROOVE$GS$ GWSERIAL_TYPE_RX,9600 #endif +#GROVE +//https://docs.m5stack.com/en/unit/Unit-GPS%20v1.1 +#ifdef M5_GPSV11_UNIT$GS$ + GWRESOURCE_USE(GROOVE$G$,M5_GPSV11_UNIT$GS$) + #define _GWI_SERIAL_GROOVE$GS$ GWSERIAL_TYPE_RX,115200 +#endif + #GROVE //CAN via groove #ifdef M5_CANUNIT$GS$ @@ -64,15 +71,15 @@ #endif #GROVE -//#ifdef M5_ENV4$GS$ -// #ifndef M5_GROOVEIIC$GS$ -// #define M5_GROOVEIIC$GS$ -// #endif -// GROOVE_IIC(SHT3X,$Z$,1) -// GROOVE_IIC(BMP280,$Z$,1) -// #define _GWSHT3X -// #define _GWBMP280 -//#endif +#ifdef M5_ENV4$GS$ + #ifndef M5_GROOVEIIC$GS$ + #define M5_GROOVEIIC$GS$ + #endif + GROOVE_IIC(SHT4X,$Z$,1) + GROOVE_IIC(BMP280,$Z$,1) + #define _GWSHT4X + #define _GWBMP280 +#endif #GROVE //example: -DSHT3XG1_A : defines STH3Xn1 on grove A - x depends on the other devices @@ -93,6 +100,25 @@ #define _GWSHT3X #endif +#GROVE +//example: -DSHT4XG1_A : defines STH4Xn1 on grove A - x depends on the other devices +#ifdef GWSHT4XG1$GS$ + #ifndef M5_GROOVEIIC$GS$ + #define M5_GROOVEIIC$GS$ + #endif + GROOVE_IIC(SHT4X,$Z$,1) + #define _GWSHT4X +#endif + +#GROVE +#ifdef GWSHT4XG2$GS$ + #ifndef M5_GROOVEIIC$GS$ + #define M5_GROOVEIIC$GS$ + #endif + GROOVE_IIC(SHT4X,$Z$,2) + #define _GWSHT4X +#endif + #GROVE #ifdef GWQMP6988G1$GS$ #ifndef M5_GROOVEIIC$GS$ diff --git a/lib/iictask/GwBME280.cpp b/lib/iictask/GwBME280.cpp index 1bf541f..177a775 100644 --- a/lib/iictask/GwBME280.cpp +++ b/lib/iictask/GwBME280.cpp @@ -23,6 +23,7 @@ class BME280Config : public IICSensorBase{ bool prAct=true; bool tmAct=true; bool huAct=true; + bool sEnv=true; tN2kTempSource tmSrc=tN2kTempSource::N2kts_InsideTemperature; tN2kHumiditySource huSrc=tN2kHumiditySource::N2khs_InsideHumidity; tN2kPressureSource prSrc=tN2kPressureSource::N2kps_Atmospheric; @@ -152,6 +153,7 @@ SensorBase::Creator registerBME280(GwApi *api){ CFG_SGET(s, prNam, prefix); \ CFG_SGET(s, tmOff, prefix); \ CFG_SGET(s, prOff, prefix); \ + CFG_SGET(s, sEnv, prefix); \ s->busId = bus; \ s->addr = baddr; \ s->ok = true; \ diff --git a/lib/iictask/GwBMP280.cpp b/lib/iictask/GwBMP280.cpp index e51bd4b..bee51e4 100644 --- a/lib/iictask/GwBMP280.cpp +++ b/lib/iictask/GwBMP280.cpp @@ -29,6 +29,7 @@ class BMP280Config : public IICSensorBase{ public: bool prAct=true; bool tmAct=true; + bool sEnv=true; tN2kTempSource tmSrc=tN2kTempSource::N2kts_InsideTemperature; tN2kPressureSource prSrc=tN2kPressureSource::N2kps_Atmospheric; tN2kHumiditySource huSrc=tN2kHumiditySource::N2khs_Undef; @@ -150,6 +151,7 @@ SensorBase::Creator registerBMP280(GwApi *api){ CFG_SGET(s, prNam, prefix); \ CFG_SGET(s, tmOff, prefix); \ CFG_SGET(s, prOff, prefix); \ + CFG_SGET(s, sEnv,prefix); \ s->busId = bus; \ s->addr = baddr; \ s->ok = true; \ diff --git a/lib/iictask/GwIicSensors.h b/lib/iictask/GwIicSensors.h index 4937daa..49fe2fe 100644 --- a/lib/iictask/GwIicSensors.h +++ b/lib/iictask/GwIicSensors.h @@ -104,12 +104,19 @@ void sendN2kTemperature(GwApi *api,CFG &cfg,double value, int counterId){ template void sendN2kEnvironmentalParameters(GwApi *api,CFG &cfg,double tmValue, double huValue, double prValue, int counterId){ + if (! cfg.sEnv) return; tN2kMsg msg; SetN2kEnvironmentalParameters(msg,1,cfg.tmSrc,tmValue,cfg.huSrc,huValue,prValue); api->sendN2kMessage(msg); - api->increment(counterId,cfg.prefix+String("hum")); - api->increment(counterId,cfg.prefix+String("press")); - api->increment(counterId,cfg.prefix+String("temp")); + if (huValue != N2kDoubleNA){ + api->increment(counterId,cfg.prefix+String("ehum")); + } + if (prValue != N2kDoubleNA){ + api->increment(counterId,cfg.prefix+String("epress")); + } + if (tmValue != N2kDoubleNA){ + api->increment(counterId,cfg.prefix+String("etemp")); + } } #ifndef _GWI_IIC1 diff --git a/lib/iictask/GwIicTask.cpp b/lib/iictask/GwIicTask.cpp index 221a420..998e441 100644 --- a/lib/iictask/GwIicTask.cpp +++ b/lib/iictask/GwIicTask.cpp @@ -23,7 +23,7 @@ static std::vector iicGroveList; #include "GwBME280.h" #include "GwBMP280.h" #include "GwQMP6988.h" -#include "GwSHT3X.h" +#include "GwSHTXX.h" #include #include "GwTimer.h" @@ -91,6 +91,7 @@ void initIicTask(GwApi *api){ GwConfigHandler *config=api->getConfig(); std::vector creators; creators.push_back(registerSHT3X(api)); + creators.push_back(registerSHT4X(api)); creators.push_back(registerQMP6988(api)); creators.push_back(registerBME280(api)); creators.push_back(registerBMP280(api)); @@ -147,13 +148,13 @@ bool initWire(GwLog *logger, TwoWire &wire, int num){ #ifdef _GWI_IIC1 return initWireDo(logger,wire,num,_GWI_IIC1); #endif - return initWireDo(logger,wire,num,"",GWIIC_SDA,GWIIC_SCL); + return initWireDo(logger,wire,num,"",GWIIC_SCL,GWIIC_SDA); } if (num == 2){ #ifdef _GWI_IIC2 return initWireDo(logger,wire,num,_GWI_IIC2); #endif - return initWireDo(logger,wire,num,"",GWIIC_SDA2,GWIIC_SCL2); + return initWireDo(logger,wire,num,"",GWIIC_SCL2,GWIIC_SDA2); } return false; } diff --git a/lib/iictask/GwQMP6988.cpp b/lib/iictask/GwQMP6988.cpp index 4f2b78c..1638907 100644 --- a/lib/iictask/GwQMP6988.cpp +++ b/lib/iictask/GwQMP6988.cpp @@ -9,6 +9,9 @@ class QMP6988Config : public IICSensorBase{ public: String prNam="Pressure"; bool prAct=true; + bool sEnv=true; + tN2kTempSource tmSrc=tN2kTempSource::N2kts_InsideTemperature; + tN2kHumiditySource huSrc=tN2kHumiditySource::N2khs_Undef; tN2kPressureSource prSrc=tN2kPressureSource::N2kps_Atmospheric; float prOff=0; QMP6988 *device=nullptr; @@ -39,6 +42,7 @@ class QMP6988Config : public IICSensorBase{ float computed=pressure+prOff; LOG_DEBUG(GwLog::DEBUG,"%s measure %2.0fPa, computed %2.0fPa",prefix.c_str(), pressure,computed); sendN2kPressure(api,*this,computed,counterId); + sendN2kEnvironmentalParameters(api,*this,N2kDoubleNA,N2kDoubleNA,computed,counterId); } @@ -90,6 +94,7 @@ SensorBase::Creator registerQMP6988(GwApi *api){ CFG_SGET(s,prAct,prefix); \ CFG_SGET(s,intv,prefix); \ CFG_SGET(s,prOff,prefix); \ + CFG_SGET(s,sEnv,prefix); \ s->busId = bus; \ s->addr = baddr; \ s->ok = true; \ diff --git a/lib/iictask/GwSHT3X.cpp b/lib/iictask/GwSHT3X.cpp deleted file mode 100644 index c93486f..0000000 --- a/lib/iictask/GwSHT3X.cpp +++ /dev/null @@ -1,138 +0,0 @@ -#include "GwSHT3X.h" -#ifdef _GWSHT3X -class SHT3XConfig; -static GwSensorConfigInitializerList configs; -class SHT3XConfig : public IICSensorBase{ - public: - String tmNam; - String huNam; - bool tmAct=false; - bool huAct=false; - tN2kHumiditySource huSrc; - tN2kTempSource tmSrc; - SHT3X *device=nullptr; - using IICSensorBase::IICSensorBase; - virtual bool isActive(){ - return tmAct || huAct; - } - virtual bool initDevice(GwApi * api,TwoWire *wire){ - if (! isActive()) return false; - device=new SHT3X(); - device->init(addr,wire); - GwLog *logger=api->getLogger(); - LOG_DEBUG(GwLog::LOG,"initialized %s at address %d, intv %ld",prefix.c_str(),(int)addr,intv); - return true; - } - virtual bool preinit(GwApi * api){ - GwLog *logger=api->getLogger(); - LOG_DEBUG(GwLog::LOG,"%s configured",prefix.c_str()); - addHumidXdr(api,*this); - addTempXdr(api,*this); - return isActive(); - } - virtual void measure(GwApi * api,TwoWire *wire, int counterId) - { - if (!device) - return; - GwLog *logger=api->getLogger(); - int rt = 0; - if ((rt = device->get()) == 0) - { - double temp = device->cTemp; - temp = CToKelvin(temp); - double humid = device->humidity; - LOG_DEBUG(GwLog::DEBUG, "%s measure temp=%2.1f, humid=%2.0f",prefix.c_str(), (float)temp, (float)humid); - if (huAct) - { - sendN2kHumidity(api, *this, humid, counterId); - } - if (tmAct) - { - sendN2kTemperature(api, *this, temp, counterId); - } - } - else - { - LOG_DEBUG(GwLog::DEBUG, "unable to query %s: %d",prefix.c_str(), rt); - } - } - - virtual void readConfig(GwConfigHandler *cfg){ - if (ok) return; - configs.readConfig(this,cfg); - return; - } -}; -SensorBase::Creator creator=[](GwApi *api,const String &prfx)-> SensorBase*{ - if (! configs.knowsPrefix(prfx)) return nullptr; - return new SHT3XConfig(api,prfx); -}; -SensorBase::Creator registerSHT3X(GwApi *api){ - GwLog *logger=api->getLogger(); - #if defined(GWSHT3X) || defined (GWSHT3X11) - { - api->addSensor(creator(api,"SHT3X11")); - CHECK_IIC1(); - #pragma message "GWSHT3X11 defined" - } - #endif - #if defined(GWSHT3X12) - { - api->addSensor(creator(api,"SHT3X12")); - CHECK_IIC1(); - #pragma message "GWSHT3X12 defined" - } - #endif - #if defined(GWSHT3X21) - { - api->addSensor(creator(api,"SHT3X21")); - CHECK_IIC2(); - #pragma message "GWSHT3X21 defined" - } - #endif - #if defined(GWSHT3X22) - { - api->addSensor(creator(api,"SHT3X22")); - CHECK_IIC2(); - #pragma message "GWSHT3X22 defined" - } - #endif - return creator; -}; - -/** - * we do not dynamically compute the config names - * just to get compile time errors if something does not fit - * correctly - */ -#define CFGSHT3X(s, prefix, bus, baddr) \ - CFG_SGET(s, tmNam, prefix); \ - CFG_SGET(s, huNam, prefix); \ - CFG_SGET(s, iid, prefix); \ - CFG_SGET(s, tmAct, prefix); \ - CFG_SGET(s, huAct, prefix); \ - CFG_SGET(s, intv, prefix); \ - CFG_SGET(s, huSrc, prefix); \ - CFG_SGET(s, tmSrc, prefix); \ - s->busId = bus; \ - s->addr = baddr; \ - s->ok = true; \ - s->intv *= 1000; - -#define SCSHT3X(prefix, bus, addr) \ - GWSENSORDEF(configs, SHT3XConfig, CFGSHT3X, prefix, bus, addr) - -SCSHT3X(SHT3X11, 1, 0x44); -SCSHT3X(SHT3X12, 1, 0x45); -SCSHT3X(SHT3X21, 2, 0x44); -SCSHT3X(SHT3X22, 2, 0x45); - -#else -SensorBase::Creator registerSHT3X(GwApi *api){ - return SensorBase::Creator(); -} - -#endif - - - diff --git a/lib/iictask/GwSHTXX.cpp b/lib/iictask/GwSHTXX.cpp new file mode 100644 index 0000000..0cfcca7 --- /dev/null +++ b/lib/iictask/GwSHTXX.cpp @@ -0,0 +1,254 @@ +#include "GwSHTXX.h" +#if defined(_GWSHT3X) || defined(_GWSHT4X) +class SHTXXConfig : public IICSensorBase{ + public: + String tmNam; + String huNam; + bool tmAct=false; + bool huAct=false; + bool sEnv=true; + tN2kHumiditySource huSrc; + tN2kTempSource tmSrc; + using IICSensorBase::IICSensorBase; + virtual bool isActive(){ + return tmAct || huAct; + } + virtual bool preinit(GwApi * api){ + GwLog *logger=api->getLogger(); + LOG_DEBUG(GwLog::LOG,"%s configured",prefix.c_str()); + addHumidXdr(api,*this); + addTempXdr(api,*this); + return isActive(); + } + virtual bool doMeasure(GwApi * api,double &temp, double &humid){ + return false; + } + virtual void measure(GwApi * api,TwoWire *wire, int counterId) override + { + GwLog *logger=api->getLogger(); + double temp = N2kDoubleNA; + double humid = N2kDoubleNA; + if (doMeasure(api,temp,humid)){ + temp = CToKelvin(temp); + LOG_DEBUG(GwLog::DEBUG, "%s measure temp=%2.1f, humid=%2.0f",prefix.c_str(), (float)temp, (float)humid); + if (huAct) + { + sendN2kHumidity(api, *this, humid, counterId); + } + if (tmAct) + { + sendN2kTemperature(api, *this, temp, counterId); + } + if (huAct || tmAct){ + sendN2kEnvironmentalParameters(api,*this,temp,humid,N2kDoubleNA,counterId); + } + } + } + +}; +/** + * we do not dynamically compute the config names + * just to get compile time errors if something does not fit + * correctly + */ +#define INITSHTXX(type,prefix,bus,baddr) \ +[] (type *s ,GwConfigHandler *cfg) { \ + CFG_SGET(s, tmNam, prefix); \ + CFG_SGET(s, huNam, prefix); \ + CFG_SGET(s, iid, prefix); \ + CFG_SGET(s, tmAct, prefix); \ + CFG_SGET(s, huAct, prefix); \ + CFG_SGET(s, intv, prefix); \ + CFG_SGET(s, huSrc, prefix); \ + CFG_SGET(s, tmSrc, prefix); \ + CFG_SGET(s, sEnv,prefix); \ + s->busId = bus; \ + s->addr = baddr; \ + s->ok = true; \ + s->intv *= 1000; \ +} + +#if defined(_GWSHT3X) +class SHT3XConfig; +static GwSensorConfigInitializerList configs3; +class SHT3XConfig : public SHTXXConfig{ + SHT3X *device=nullptr; + public: + using SHTXXConfig::SHTXXConfig; + virtual bool initDevice(GwApi * api,TwoWire *wire)override{ + if (! isActive()) return false; + device=new SHT3X(); + device->init(addr,wire); + GwLog *logger=api->getLogger(); + LOG_DEBUG(GwLog::LOG,"initialized %s at address %d, intv %ld",prefix.c_str(),(int)addr,intv); + return true; + } + virtual bool doMeasure(GwApi *api,double &temp, double &humid) override{ + if (!device) + return false; + int rt=0; + GwLog *logger=api->getLogger(); + if ((rt = device->get()) == 0) + { + temp = device->cTemp; + humid = device->humidity; + return true; + } + else{ + LOG_DEBUG(GwLog::DEBUG, "unable to query %s: %d",prefix.c_str(), rt); + } + return false; + } + virtual void readConfig(GwConfigHandler *cfg) override{ + if (ok) return; + configs3.readConfig(this,cfg); + return; + } +}; + +SensorBase::Creator creator3=[](GwApi *api,const String &prfx)-> SensorBase*{ + if (! configs3.knowsPrefix(prfx)) return nullptr; + return new SHT3XConfig(api,prfx); + }; +SensorBase::Creator registerSHT3X(GwApi *api){ + GwLog *logger=api->getLogger(); + #if defined(GWSHT3X) || defined (GWSHT3X11) + { + api->addSensor(creator3(api,"SHT3X11")); + CHECK_IIC1(); + #pragma message "GWSHT3X11 defined" + } + #endif + #if defined(GWSHT3X12) + { + api->addSensor(creator3(api,"SHT3X12")); + CHECK_IIC1(); + #pragma message "GWSHT3X12 defined" + } + #endif + #if defined(GWSHT3X21) + { + api->addSensor(creator3(api,"SHT3X21")); + CHECK_IIC2(); + #pragma message "GWSHT3X21 defined" + } + #endif + #if defined(GWSHT3X22) + { + api->addSensor(creator3(api,"SHT3X22")); + CHECK_IIC2(); + #pragma message "GWSHT3X22 defined" + } + #endif + return creator3; +}; + + +#define SCSHT3X(prefix, bus, addr) \ + GwSensorConfigInitializer __initCFGSHT3X ## prefix \ + (configs3,GwSensorConfig(#prefix,INITSHTXX(SHT3XConfig,prefix,bus,addr))); + +SCSHT3X(SHT3X11, 1, 0x44); +SCSHT3X(SHT3X12, 1, 0x45); +SCSHT3X(SHT3X21, 2, 0x44); +SCSHT3X(SHT3X22, 2, 0x45); + +#endif +#if defined(_GWSHT4X) +class SHT4XConfig; +static GwSensorConfigInitializerList configs4; +class SHT4XConfig : public SHTXXConfig{ + SHT4X *device=nullptr; + public: + using SHTXXConfig::SHTXXConfig; + virtual bool initDevice(GwApi * api,TwoWire *wire)override{ + if (! isActive()) return false; + device=new SHT4X(); + device->begin(wire,addr); + GwLog *logger=api->getLogger(); + LOG_DEBUG(GwLog::LOG,"initialized %s at address %d, intv %ld",prefix.c_str(),(int)addr,intv); + return true; + } + virtual bool doMeasure(GwApi *api,double &temp, double &humid) override{ + if (!device) + return false; + GwLog *logger=api->getLogger(); + if (device->update()) + { + temp = device->cTemp; + humid = device->humidity; + return true; + } + else{ + LOG_DEBUG(GwLog::DEBUG, "unable to query %s",prefix.c_str()); + } + return false; + } + virtual void readConfig(GwConfigHandler *cfg) override{ + if (ok) return; + configs4.readConfig(this,cfg); + return; + } +}; + +SensorBase::Creator creator4=[](GwApi *api,const String &prfx)-> SensorBase*{ + if (! configs4.knowsPrefix(prfx)) return nullptr; + return new SHT4XConfig(api,prfx); + }; +SensorBase::Creator registerSHT4X(GwApi *api){ + GwLog *logger=api->getLogger(); + #if defined(GWSHT4X) || defined (GWSHT4X11) + { + api->addSensor(creator3(api,"SHT4X11")); + CHECK_IIC1(); + #pragma message "GWSHT4X11 defined" + } + #endif + #if defined(GWSHT4X12) + { + api->addSensor(creator3(api,"SHT4X12")); + CHECK_IIC1(); + #pragma message "GWSHT4X12 defined" + } + #endif + #if defined(GWSHT4X21) + { + api->addSensor(creator3(api,"SHT4X21")); + CHECK_IIC2(); + #pragma message "GWSHT4X21 defined" + } + #endif + #if defined(GWSHT4X22) + { + api->addSensor(creator3(api,"SHT4X22")); + CHECK_IIC2(); + #pragma message "GWSHT4X22 defined" + } + #endif + return creator4; +}; + + +#define SCSHT4X(prefix, bus, addr) \ + GwSensorConfigInitializer __initCFGSHT4X ## prefix \ + (configs4,GwSensorConfig(#prefix,INITSHTXX(SHT4XConfig,prefix,bus,addr))); + +SCSHT4X(SHT4X11, 1, 0x44); +SCSHT4X(SHT4X12, 1, 0x45); +SCSHT4X(SHT4X21, 2, 0x44); +SCSHT4X(SHT4X22, 2, 0x45); +#endif +#endif +#ifndef _GWSHT3X +SensorBase::Creator registerSHT3X(GwApi *api){ + return SensorBase::Creator(); +} +#endif +#ifndef _GWSHT4X +SensorBase::Creator registerSHT4X(GwApi *api){ + return SensorBase::Creator(); +} +#endif + + + diff --git a/lib/iictask/GwSHT3X.h b/lib/iictask/GwSHTXX.h similarity index 50% rename from lib/iictask/GwSHT3X.h rename to lib/iictask/GwSHTXX.h index 6a5dfcf..52829b9 100644 --- a/lib/iictask/GwSHT3X.h +++ b/lib/iictask/GwSHTXX.h @@ -1,10 +1,13 @@ -#ifndef _GWSHT3X_H -#define _GWSHT3X_H +#ifndef _GWSHTXX_H +#define _GWSHTXX_H #include "GwIicSensors.h" #ifdef _GWIIC #if defined(GWSHT3X) || defined(GWSHT3X11) || defined(GWSHT3X12) || defined(GWSHT3X21) || defined(GWSHT3X22) #define _GWSHT3X #endif + #if defined(GWSHT4X) || defined(GWSHT4X11) || defined(GWSHT4X12) || defined(GWSHT4X21) || defined(GWSHT4X22) + #define _GWSHT4X + #endif #else #undef _GWSHT3X #undef GWSHT3X @@ -12,9 +15,19 @@ #undef GWSHT3X12 #undef GWSHT3X21 #undef GWSHT3X22 + #undef _GWSHT4X + #undef GWSHT4X + #undef GWSHT4X11 + #undef GWSHT4X12 + #undef GWSHT4X21 + #undef GWSHT4X22 #endif #ifdef _GWSHT3X #include "SHT3X.h" #endif +#ifdef _GWSHT4X + #include "SHT4X.h" +#endif SensorBase::Creator registerSHT3X(GwApi *api); +SensorBase::Creator registerSHT4X(GwApi *api); #endif \ No newline at end of file diff --git a/lib/iictask/SHT3X.cpp b/lib/iictask/SHT3X.cpp index 7830cf5..c36d92e 100644 --- a/lib/iictask/SHT3X.cpp +++ b/lib/iictask/SHT3X.cpp @@ -1,4 +1,4 @@ -#include "GwSHT3X.h" +#include "GwSHTXX.h" #ifdef _GWSHT3X bool SHT3X::init(uint8_t slave_addr_in, TwoWire* wire_in) diff --git a/lib/iictask/SHT4X.cpp b/lib/iictask/SHT4X.cpp new file mode 100644 index 0000000..6d14473 --- /dev/null +++ b/lib/iictask/SHT4X.cpp @@ -0,0 +1,131 @@ +#include "GwSHTXX.h" +#ifdef _GWSHT4X + +uint8_t crc8(const uint8_t *data, int len) { + /* + * + * CRC-8 formula from page 14 of SHT spec pdf + * + * Test data 0xBE, 0xEF should yield 0x92 + * + * Initialization data 0xFF + * Polynomial 0x31 (x8 + x5 +x4 +1) + * Final XOR 0x00 + */ + + const uint8_t POLYNOMIAL(0x31); + uint8_t crc(0xFF); + + for (int j = len; j; --j) { + crc ^= *data++; + + for (int i = 8; i; --i) { + crc = (crc & 0x80) ? (crc << 1) ^ POLYNOMIAL : (crc << 1); + } + } + return crc; +} + +bool SHT4X::begin(TwoWire* wire, uint8_t addr) { + _addr = addr; + _wire = wire; + int error; + _wire->beginTransmission(addr); + error = _wire->endTransmission(); + if (error == 0) { + return true; + } + return false; +} + +bool SHT4X::update() { + uint8_t readbuffer[6]; + uint8_t cmd = SHT4x_NOHEAT_HIGHPRECISION; + uint16_t duration = 10; + + if (_heater == SHT4X_NO_HEATER) { + if (_precision == SHT4X_HIGH_PRECISION) { + cmd = SHT4x_NOHEAT_HIGHPRECISION; + duration = 10; + } + if (_precision == SHT4X_MED_PRECISION) { + cmd = SHT4x_NOHEAT_MEDPRECISION; + duration = 5; + } + if (_precision == SHT4X_LOW_PRECISION) { + cmd = SHT4x_NOHEAT_LOWPRECISION; + duration = 2; + } + } + + if (_heater == SHT4X_HIGH_HEATER_1S) { + cmd = SHT4x_HIGHHEAT_1S; + duration = 1100; + } + if (_heater == SHT4X_HIGH_HEATER_100MS) { + cmd = SHT4x_HIGHHEAT_100MS; + duration = 110; + } + + if (_heater == SHT4X_MED_HEATER_1S) { + cmd = SHT4x_MEDHEAT_1S; + duration = 1100; + } + if (_heater == SHT4X_MED_HEATER_100MS) { + cmd = SHT4x_MEDHEAT_100MS; + duration = 110; + } + + if (_heater == SHT4X_LOW_HEATER_1S) { + cmd = SHT4x_LOWHEAT_1S; + duration = 1100; + } + if (_heater == SHT4X_LOW_HEATER_100MS) { + cmd = SHT4x_LOWHEAT_100MS; + duration = 110; + } + // _i2c.writeByte(_addr, cmd, 1); + _wire->beginTransmission(_addr); + _wire->write(cmd); + _wire->write(1); + _wire->endTransmission(); + + + delay(duration); + + _wire->requestFrom(_addr, (uint8_t)6); + + for (uint16_t i = 0; i < 6; i++) { + readbuffer[i] = _wire->read(); + } + + if (readbuffer[2] != crc8(readbuffer, 2) || + readbuffer[5] != crc8(readbuffer + 3, 2)) { + return false; + } + + float t_ticks = (uint16_t)readbuffer[0] * 256 + (uint16_t)readbuffer[1]; + float rh_ticks = (uint16_t)readbuffer[3] * 256 + (uint16_t)readbuffer[4]; + + cTemp = -45 + 175 * t_ticks / 65535; + humidity = -6 + 125 * rh_ticks / 65535; + humidity = min(max(humidity, (float)0.0), (float)100.0); + return true; +} + +void SHT4X::setPrecision(sht4x_precision_t prec) { + _precision = prec; +} + +sht4x_precision_t SHT4X::getPrecision(void) { + return _precision; +} + +void SHT4X::setHeater(sht4x_heater_t heat) { + _heater = heat; +} + +sht4x_heater_t SHT4X::getHeater(void) { + return _heater; +} +#endif \ No newline at end of file diff --git a/lib/iictask/SHT4X.h b/lib/iictask/SHT4X.h new file mode 100644 index 0000000..dbfbabf --- /dev/null +++ b/lib/iictask/SHT4X.h @@ -0,0 +1,76 @@ +#ifndef __SHT4X_H_ +#define __SHT4X_H_ + +#include "Arduino.h" +#include "Wire.h" + +#define SHT40_I2C_ADDR_44 0x44 +#define SHT40_I2C_ADDR_45 0x45 +#define SHT41_I2C_ADDR_44 0x44 +#define SHT41_I2C_ADDR_45 0x45 +#define SHT45_I2C_ADDR_44 0x44 +#define SHT45_I2C_ADDR_45 0x45 + +#define SHT4x_DEFAULT_ADDR 0x44 /**< SHT4x I2C Address */ +#define SHT4x_NOHEAT_HIGHPRECISION \ + 0xFD /**< High precision measurement, no heater */ +#define SHT4x_NOHEAT_MEDPRECISION \ + 0xF6 /**< Medium precision measurement, no heater */ +#define SHT4x_NOHEAT_LOWPRECISION \ + 0xE0 /**< Low precision measurement, no heater */ + +#define SHT4x_HIGHHEAT_1S \ + 0x39 /**< High precision measurement, high heat for 1 sec */ +#define SHT4x_HIGHHEAT_100MS \ + 0x32 /**< High precision measurement, high heat for 0.1 sec */ +#define SHT4x_MEDHEAT_1S \ + 0x2F /**< High precision measurement, med heat for 1 sec */ +#define SHT4x_MEDHEAT_100MS \ + 0x24 /**< High precision measurement, med heat for 0.1 sec */ +#define SHT4x_LOWHEAT_1S \ + 0x1E /**< High precision measurement, low heat for 1 sec */ +#define SHT4x_LOWHEAT_100MS \ + 0x15 /**< High precision measurement, low heat for 0.1 sec */ + +#define SHT4x_READSERIAL 0x89 /**< Read Out of Serial Register */ +#define SHT4x_SOFTRESET 0x94 /**< Soft Reset */ + +typedef enum { + SHT4X_HIGH_PRECISION, + SHT4X_MED_PRECISION, + SHT4X_LOW_PRECISION, +} sht4x_precision_t; + +/** Optional pre-heater configuration setting */ +typedef enum { + SHT4X_NO_HEATER, + SHT4X_HIGH_HEATER_1S, + SHT4X_HIGH_HEATER_100MS, + SHT4X_MED_HEATER_1S, + SHT4X_MED_HEATER_100MS, + SHT4X_LOW_HEATER_1S, + SHT4X_LOW_HEATER_100MS, +} sht4x_heater_t; + +class SHT4X { + public: + bool begin(TwoWire* wire = &Wire, uint8_t addr = SHT40_I2C_ADDR_44); + bool update(void); + + float cTemp = 0; + float humidity = 0; + + void setPrecision(sht4x_precision_t prec); + sht4x_precision_t getPrecision(void); + void setHeater(sht4x_heater_t heat); + sht4x_heater_t getHeater(void); + + private: + TwoWire* _wire; + uint8_t _addr; + + sht4x_precision_t _precision = SHT4X_HIGH_PRECISION; + sht4x_heater_t _heater = SHT4X_NO_HEATER; +}; + +#endif diff --git a/lib/iictask/config.json b/lib/iictask/config.json index 54da57e..5cd50af 100644 --- a/lib/iictask/config.json +++ b/lib/iictask/config.json @@ -1,49 +1,77 @@ [ { "type": "array", - "name": "SHT3X", + "name": "SHTXX", "replace": [ { "b": "1", "i": "11", - "n": "99" + "n": "99", + "x": "3" }, { "b": "1", "i": "12", - "n": "98" + "n": "98", + "x": "3" }, { "b": "2", "i": "21", - "n": "109" + "n": "109", + "x": "3" }, { "b": "2", "i": "22", - "n": "108" + "n": "108", + "x": "3" + }, + { + "b": "1", + "i": "11", + "n": "119", + "x": "4" + }, + { + "b": "1", + "i": "12", + "n": "118", + "x": "4" + }, + { + "b": "2", + "i": "21", + "n": "129", + "x": "4" + }, + { + "b": "2", + "i": "22", + "n": "128", + "x": "4" } ], "children": [ { - "name": "SHT3X$itmAct", - "label": "SHT3X$i Temp", + "name": "SHT$xX$itmAct", + "label": "SHT$xX$i Temp", "type": "boolean", "default": "true", - "description": "Enable the $i. I2C SHT3x temp sensor (bus $b)", + "description": "Enable the $i. I2C SHT$xX temp sensor (bus $b)", "category": "iicsensors$b", "capabilities": { - "SHT3X$i": "true" + "SHT$xX$i": "true" } }, { - "name": "SHT3X$itmSrc", - "label": "SHT3X$i Temp Type", + "name": "SHT$xX$itmSrc", + "label": "SHT$xX$i Temp Type", "type": "list", "default": "2", - "description": "the NMEA2000 source type for the temperature", + "description": "the NMEA2000 source type for the temperature (PGN 130312,130311)", "list": [ { "l": "SeaTemperature", @@ -112,23 +140,23 @@ ], "category": "iicsensors$b", "capabilities": { - "SHT3X$i": "true" + "SHT$xX$i": "true" } }, { - "name": "SHT3X$ihuAct", - "label": "SHT3X$i Humidity", + "name": "SHT$xX$ihuAct", + "label": "SHT$xX$i Humidity", "type": "boolean", "default": "true", - "description": "Enable the $i. I2C SHT3x humidity sensor (bus $b)", + "description": "Enable the $i. I2C SHT$xX humidity sensor (bus $b)", "category": "iicsensors$b", "capabilities": { - "SHT3X$i": "true" + "SHT$xX$i": "true" } }, { - "name": "SHT3X$ihuSrc", - "label": "SHT3X$i Humid Type", + "name": "SHT$xX$ihuSrc", + "label": "SHT$xX$i Humid Type", "list": [ { "l": "OutsideHumidity", @@ -141,57 +169,68 @@ ], "category": "iicsensors$b", "capabilities": { - "SHT3X": "true" + "SHT$xX": "true" } }, { - "name": "SHT3X$iiid", - "label": "SHT3X$i N2K iid", + "name": "SHT$xX$iiid", + "label": "SHT$xX$i N2K iid", "type": "number", "default": "$n", - "description": "the N2K instance id for the $i. SHT3X Temperature and Humidity ", + "description": "the N2K instance id for the $i. SHT$xX Temperature and Humidity (PGN 130312,130311) ", "category": "iicsensors$b", "min": 0, "max": 253, "check": "checkMinMax", "capabilities": { - "SHT3X$i": "true" + "SHT$xX$i": "true" } }, { - "name": "SHT3X$iintv", - "label": "SHT3X$i Interval", + "name": "SHT$xX$isEnv", + "label": "SHT$xX$i send Env", + "type": "boolean", + "default": "true", + "description": "also send PGN 130311", + "category": "iicsensors$b", + "capabilities": { + "SHT$xX$i": "true" + } + }, + { + "name": "SHT$xX$iintv", + "label": "SHT$xX$i Interval", "type": "number", "default": 2, - "description": "Interval(s) to query SHT3X Temperature and Humidity (1...300)", + "description": "Interval(s) to query SHT$xX Temperature and Humidity (1...300)", "category": "iicsensors$b", "min": 1, "max": 300, "check": "checkMinMax", "capabilities": { - "SHT3X$i": "true" + "SHT$xX$i": "true" } }, { - "name": "SHT3X$itmNam", - "label": "SHT3X$i Temp XDR", + "name": "SHT$xX$itmNam", + "label": "SHT$xX$i Temp XDR", "type": "String", "default": "Temp$i", - "description": "set the XDR transducer name for the $i. SHT3X Temperature, leave empty to disable NMEA0183 XDR ", + "description": "set the XDR transducer name for the $i. SHT$xX Temperature, leave empty to disable NMEA0183 XDR ", "category": "iicsensors$b", "capabilities": { - "SHT3X$i": "true" + "SHT$xX$i": "true" } }, { - "name": "SHT3X$ihuNam", - "label": "SHT3X$i Humid XDR", + "name": "SHT$xX$ihuNam", + "label": "SHT$xX$i Humid XDR", "type": "String", "default": "Humidity$i", - "description": "set the XDR transducer name for the $i. SHT3X Humidity, leave empty to disable NMEA0183 XDR", + "description": "set the XDR transducer name for the $i. SHT$xX Humidity, leave empty to disable NMEA0183 XDR", "category": "iicsensors$b", "capabilities": { - "SHT3X$i": "true" + "SHT$xX$i": "true" } } ] @@ -247,6 +286,17 @@ "QMP6988$i": "true" } }, + { + "name": "QMP6988$isEnv", + "label": "QMP6988$i send Env", + "type": "boolean", + "default": "true", + "description": "also send PGN 130311", + "category": "iicsensors$b", + "capabilities": { + "QMP6988$i": "true" + } + }, { "name": "QMP6988$iintv", "label": "QMP6988-$i Interval", @@ -473,7 +523,7 @@ "label": "BME280-$i N2K iid", "type": "number", "default": "$n", - "description": "the N2K instance id for the BME280 Temperature and Humidity ", + "description": "the N2K instance id for the BME280 Temperature, Humidity, Pressure (PGN 130312,130313, 130314) ", "category": "iicsensors$b", "min": 0, "max": 253, @@ -482,6 +532,17 @@ "BME280$i": "true" } }, + { + "name": "BME280$isEnv", + "label": "BME280$i send Env", + "type": "boolean", + "default": "true", + "description": "also send PGN 130311", + "category": "iicsensors$b", + "capabilities": { + "BME280$i": "true" + } + }, { "name": "BME280$iintv", "label": "BME280-$i Interval", @@ -683,7 +744,7 @@ "label": "BMP280-$i N2K iid", "type": "number", "default": "$n", - "description": "the N2K instance id for the BMP280 Temperature", + "description": "the N2K instance id for the BMP280 Temperature/Pressure (PGN 130312,130314)", "category": "iicsensors$b", "min": 0, "max": 253, @@ -692,6 +753,17 @@ "BMP280$i": "true" } }, + { + "name": "BMP280$isEnv", + "label": "BMP280$i send Env", + "type": "boolean", + "default": "true", + "description": "also send PGN 130311", + "category": "iicsensors$b", + "capabilities": { + "BMP280$i": "true" + } + }, { "name": "BMP280$iintv", "label": "BMP280-$i Interval", diff --git a/lib/iictask/platformio.ini b/lib/iictask/platformio.ini index c0f10f7..31e17a3 100644 --- a/lib/iictask/platformio.ini +++ b/lib/iictask/platformio.ini @@ -11,6 +11,17 @@ build_flags= -D M5_CAN_KIT ${env.build_flags} +[env:m5stack-atom-env4] +extends = sensors +board = m5stack-atom +lib_deps = + ${env.lib_deps} + ${sensors.lib_deps} +build_flags= + -D M5_ENV4 + -D M5_CAN_KIT + ${env.build_flags} + [env:m5stack-atom-bme280] extends = sensors diff --git a/lib/nmea0183ton2k/NMEA0183AIStoNMEA2000.h b/lib/nmea0183ton2k/NMEA0183AIStoNMEA2000.h index 169f181..5f4e5ee 100644 --- a/lib/nmea0183ton2k/NMEA0183AIStoNMEA2000.h +++ b/lib/nmea0183ton2k/NMEA0183AIStoNMEA2000.h @@ -2,7 +2,7 @@ This code is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. + version 2 of the License, or (at your option) any later version. This code 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 @@ -27,6 +27,8 @@ const double nmTom = 1.852 * 1000; uint16_t DaysSince1970 = 0; +#define boolbit(b) (b?1:0) + class MyAisDecoder : public AIS::AisDecoder { public: @@ -82,25 +84,24 @@ class MyAisDecoder : public AIS::AisDecoder tN2kMsg N2kMsg; - // PGN129038 - - N2kMsg.SetPGN(129038L); - N2kMsg.Priority = 4; - N2kMsg.AddByte((_Repeat & 0x03) << 6 | (_uMsgType & 0x3f)); - N2kMsg.Add4ByteUInt(_uMmsi); - N2kMsg.Add4ByteDouble(_iPosLon / 600000.0, 1e-07); - N2kMsg.Add4ByteDouble(_iPosLat / 600000.0, 1e-07); - N2kMsg.AddByte((_timestamp & 0x3f) << 2 | (_Raim & 0x01) << 1 | (_bPosAccuracy & 0x01)); - N2kMsg.Add2ByteUDouble(decodeCog(_iCog), 1e-04); - N2kMsg.Add2ByteUDouble(_uSog * knToms/10.0, 0.01); - N2kMsg.AddByte(0x00); // Communication State (19 bits) - N2kMsg.AddByte(0x00); - N2kMsg.AddByte(0x00); // AIS transceiver information (5 bits) - N2kMsg.Add2ByteUDouble(decodeHeading(_iHeading), 1e-04); - N2kMsg.Add2ByteDouble(decodeRot(_iRot), 3.125E-05); // 1e-3/32.0 - N2kMsg.AddByte(0xF0 | (_uNavstatus & 0x0f)); - N2kMsg.AddByte(0xff); // Reserved - N2kMsg.AddByte(0xff); // SID (NA) + SetN2kPGN129038( + N2kMsg, + _uMsgType, + (tN2kAISRepeat)_Repeat, + _uMmsi, + _iPosLon/ 600000.0, + _iPosLat / 600000.0, + _bPosAccuracy, + _Raim, + _timestamp, + decodeCog(_iCog), + _uSog * knToms/10.0, + tN2kAISTransceiverInformation::N2kaischannel_A_VDL_reception, + decodeHeading(_iHeading), + decodeRot(_iRot), + (tN2kAISNavStatus)_uNavstatus, + 0xff + ); send(N2kMsg); } @@ -255,9 +256,40 @@ class MyAisDecoder : public AIS::AisDecoder send(N2kMsg); } - - virtual void onType21(unsigned int , unsigned int , const std::string &, bool , int , int , unsigned int , unsigned int , unsigned int , unsigned int ) override { + //mmsi, aidType, name + nameExt, posAccuracy, posLon, posLat, toBow, toStern, toPort, toStarboard + virtual void onType21(unsigned int mmsi , unsigned int aidType , const std::string & name, bool accuracy, int posLon, int posLat, unsigned int toBow, + unsigned int toStern, unsigned int toPort, unsigned int toStarboard, + unsigned int repeat,unsigned int timestamp, bool raim, bool virtualAton, bool offPosition) override { //Serial.println("21"); + //the name can be at most 120bit+88bit (35 byte) + termination -> 36 Byte + //in principle we should use tN2kAISAtoNReportData to directly call the library + //function for 129041. But this makes the conversion really complex. + bool assignedMode=false; + tN2kGNSStype gnssType=tN2kGNSStype::N2kGNSSt_GPS; //canboat considers 0 as undefined... + tN2kAISTransceiverInformation transceiverInfo=tN2kAISTransceiverInformation::N2kaischannel_A_VDL_reception; + tN2kMsg N2kMsg; + N2kMsg.SetPGN(129041); + N2kMsg.Priority=4; + N2kMsg.AddByte((repeat & 0x03) << 6 | (21 & 0x3f)); + N2kMsg.Add4ByteUInt(mmsi); //N2kData.UserID + N2kMsg.Add4ByteDouble(posLon / 600000.0, 1e-07); + N2kMsg.Add4ByteDouble(posLat / 600000.0, 1e-07); + N2kMsg.AddByte((timestamp & 0x3f)<<2 | boolbit(raim)<<1 | boolbit(accuracy)); + N2kMsg.Add2ByteUDouble(toBow+toStern, 0.1); + N2kMsg.Add2ByteUDouble(toPort+toStarboard, 0.1); + N2kMsg.Add2ByteUDouble(toStarboard, 0.1); + N2kMsg.Add2ByteUDouble(toBow, 0.1); + N2kMsg.AddByte(boolbit(assignedMode) << 7 + | boolbit(virtualAton) << 6 + | boolbit(offPosition) << 5 + | (aidType & 0x1f)); + N2kMsg.AddByte((gnssType & 0x0F) << 1 | 0xe0); + N2kMsg.AddByte(N2kUInt8NA); //status + N2kMsg.AddByte((transceiverInfo & 0x1f) | 0xe0); + //bit offset 208 (see canboat/pgns.xml) -> 26 bytes from start + //as MaxDataLen is 223 and the string can be at most 36 bytes + 2 byte heading - no further check here + N2kMsg.AddVarStr(name.c_str()); + send(N2kMsg); } virtual void onType24A(unsigned int _uMsgType, unsigned int _repeat, unsigned int _uMmsi, diff --git a/lib/nmea0183ton2k/NMEA0183DataToN2K.cpp b/lib/nmea0183ton2k/NMEA0183DataToN2K.cpp index ef17866..6989570 100644 --- a/lib/nmea0183ton2k/NMEA0183DataToN2K.cpp +++ b/lib/nmea0183ton2k/NMEA0183DataToN2K.cpp @@ -143,7 +143,7 @@ private: */ GwXDRFoundMapping getOtherFieldMapping(GwXDRFoundMapping &found, int field){ if (found.empty) return GwXDRFoundMapping(); - return xdrMappings->getMapping(found.definition->category, + return xdrMappings->getMapping(0,found.definition->category, found.definition->selector, field, found.instanceId); diff --git a/lib/nmea2kto0183/N2kDataToNMEA0183.cpp b/lib/nmea2kto0183/N2kDataToNMEA0183.cpp index dbf6af5..0c0e68c 100644 --- a/lib/nmea2kto0183/N2kDataToNMEA0183.cpp +++ b/lib/nmea2kto0183/N2kDataToNMEA0183.cpp @@ -708,12 +708,37 @@ private: } } + //helper for converting the AIS transceiver info to talker/channel + + void setTalkerChannel(tNMEA0183AISMsg &msg, tN2kAISTransceiverInformation &transceiver){ + bool channelA=true; + bool own=false; + switch (transceiver){ + case tN2kAISTransceiverInformation::N2kaischannel_A_VDL_reception: + channelA=true; + own=false; + break; + case tN2kAISTransceiverInformation::N2kaischannel_B_VDL_reception: + channelA=false; + own=false; + break; + case tN2kAISTransceiverInformation::N2kaischannel_A_VDL_transmission: + channelA=true; + own=true; + break; + case tN2kAISTransceiverInformation::N2kaischannel_B_VDL_transmission: + channelA=false; + own=true; + break; + } + msg.SetChannelAndTalker(channelA,own); + } + //***************************************************************************** // 129038 AIS Class A Position Report (Message 1, 2, 3) void HandleAISClassAPosReport(const tN2kMsg &N2kMsg) { - unsigned char SID; tN2kAISRepeat _Repeat; uint32_t _UserID; // MMSI double _Latitude =N2kDoubleNA; @@ -732,64 +757,19 @@ private: uint8_t _MessageType = 1; tNMEA0183AISMsg NMEA0183AISMsg; - if (ParseN2kPGN129038(N2kMsg, SID, _Repeat, _UserID, _Latitude, _Longitude, _Accuracy, _RAIM, _Seconds, + if (ParseN2kPGN129038(N2kMsg, _MessageType, _Repeat, _UserID, _Latitude, _Longitude, _Accuracy, _RAIM, _Seconds, _COG, _SOG, _Heading, _ROT, _NavStatus,_AISTransceiverInformation,_SID)) { -// Debug -#ifdef SERIAL_PRINT_AIS_FIELDS - Serial.println("–––––––––––––––––––––––– Msg 1 ––––––––––––––––––––––––––––––––"); - - const double pi = 3.1415926535897932384626433832795; - const double radToDeg = 180.0 / pi; - const double msTokn = 3600.0 / 1852.0; - const double radsToDegMin = 60 * 360.0 / (2 * pi); // [rad/s -> degree/minute] - Serial.print("Repeat: "); - Serial.println(_Repeat); - Serial.print("UserID: "); - Serial.println(_UserID); - Serial.print("Latitude: "); - Serial.println(_Latitude); - Serial.print("Longitude: "); - Serial.println(_Longitude); - Serial.print("Accuracy: "); - Serial.println(_Accuracy); - Serial.print("RAIM: "); - Serial.println(_RAIM); - Serial.print("Seconds: "); - Serial.println(_Seconds); - Serial.print("COG: "); - Serial.println(_COG * radToDeg); - Serial.print("SOG: "); - Serial.println(_SOG * msTokn); - Serial.print("Heading: "); - Serial.println(_Heading * radToDeg); - Serial.print("ROT: "); - Serial.println(_ROT * radsToDegMin); - Serial.print("NavStatus: "); - Serial.println(_NavStatus); -#endif + setTalkerChannel(NMEA0183AISMsg,_AISTransceiverInformation); + if (_MessageType < 1 || _MessageType > 3) _MessageType=1; //only allow type 1...3 for 129038 if (SetAISClassABMessage1(NMEA0183AISMsg, _MessageType, _Repeat, _UserID, _Latitude, _Longitude, _Accuracy, _RAIM, _Seconds, _COG, _SOG, _Heading, _ROT, _NavStatus)) { SendMessage(NMEA0183AISMsg); -#ifdef SERIAL_PRINT_AIS_NMEA - // Debug Print AIS-NMEA - Serial.print(NMEA0183AISMsg.GetPrefix()); - Serial.print(NMEA0183AISMsg.Sender()); - Serial.print(NMEA0183AISMsg.MessageCode()); - for (int i = 0; i < NMEA0183AISMsg.FieldCount(); i++) - { - Serial.print(","); - Serial.print(NMEA0183AISMsg.Field(i)); - } - char buf[7]; - sprintf(buf, "*%02X\r\n", NMEA0183AISMsg.GetCheckSum()); - Serial.print(buf); -#endif } } } // end 129038 AIS Class A Position Report Message 1/3 @@ -825,84 +805,18 @@ private: _Length, _Beam, _PosRefStbd, _PosRefBow, _ETAdate, _ETAtime, _Draught, _Destination,21, _AISversion, _GNSStype, _DTE, _AISinfo,_SID)) { - -#ifdef SERIAL_PRINT_AIS_FIELDS - // Debug Print N2k Values - Serial.println("––––––––––––––––––––––– Msg 5 –––––––––––––––––––––––––––––––––"); - Serial.print("MessageID: "); - Serial.println(_MessageID); - Serial.print("Repeat: "); - Serial.println(_Repeat); - Serial.print("UserID: "); - Serial.println(_UserID); - Serial.print("IMONumber: "); - Serial.println(_IMONumber); - Serial.print("Callsign: "); - Serial.println(_Callsign); - Serial.print("VesselType: "); - Serial.println(_VesselType); - Serial.print("Name: "); - Serial.println(_Name); - Serial.print("Length: "); - Serial.println(_Length); - Serial.print("Beam: "); - Serial.println(_Beam); - Serial.print("PosRefStbd: "); - Serial.println(_PosRefStbd); - Serial.print("PosRefBow: "); - Serial.println(_PosRefBow); - Serial.print("ETAdate: "); - Serial.println(_ETAdate); - Serial.print("ETAtime: "); - Serial.println(_ETAtime); - Serial.print("Draught: "); - Serial.println(_Draught); - Serial.print("Destination: "); - Serial.println(_Destination); - Serial.print("GNSStype: "); - Serial.println(_GNSStype); - Serial.print("DTE: "); - Serial.println(_DTE); - Serial.println("––––––––––––––––––––––– Msg 5 –––––––––––––––––––––––––––––––––"); -#endif - + setTalkerChannel(NMEA0183AISMsg,_AISinfo); if (SetAISClassAMessage5(NMEA0183AISMsg, _MessageID, _Repeat, _UserID, _IMONumber, _Callsign, _Name, _VesselType, _Length, _Beam, _PosRefStbd, _PosRefBow, _ETAdate, _ETAtime, _Draught, _Destination, - _GNSStype, _DTE)) + _GNSStype, _DTE,_AISversion)) { - - SendMessage(NMEA0183AISMsg.BuildMsg5Part1(NMEA0183AISMsg)); - -#ifdef SERIAL_PRINT_AIS_NMEA - // Debug Print AIS-NMEA Message Type 5, Part 1 - char buf[7]; - Serial.print(NMEA0183AISMsg.GetPrefix()); - Serial.print(NMEA0183AISMsg.Sender()); - Serial.print(NMEA0183AISMsg.MessageCode()); - for (int i = 0; i < NMEA0183AISMsg.FieldCount(); i++) - { - Serial.print(","); - Serial.print(NMEA0183AISMsg.Field(i)); + if (NMEA0183AISMsg.BuildMsg5Part1()){ + SendMessage(NMEA0183AISMsg); } - sprintf(buf, "*%02X\r\n", NMEA0183AISMsg.GetCheckSum()); - Serial.print(buf); -#endif - - SendMessage(NMEA0183AISMsg.BuildMsg5Part2(NMEA0183AISMsg)); - -#ifdef SERIAL_PRINT_AIS_NMEA - // Print AIS-NMEA Message Type 5, Part 2 - Serial.print(NMEA0183AISMsg.GetPrefix()); - Serial.print(NMEA0183AISMsg.Sender()); - Serial.print(NMEA0183AISMsg.MessageCode()); - for (int i = 0; i < NMEA0183AISMsg.FieldCount(); i++) - { - Serial.print(","); - Serial.print(NMEA0183AISMsg.Field(i)); + if (NMEA0183AISMsg.BuildMsg5Part2()){ + SendMessage(NMEA0183AISMsg); } - sprintf(buf, "*%02X\r\n", NMEA0183AISMsg.GetCheckSum()); - Serial.print(buf); -#endif + } } } @@ -926,35 +840,21 @@ private: tN2kAISUnit _Unit; bool _Display, _DSC, _Band, _Msg22, _State; tN2kAISMode _Mode; - tN2kAISTransceiverInformation _AISTranceiverInformation; + tN2kAISTransceiverInformation _AISTransceiverInformation; uint8_t _SID; if (ParseN2kPGN129039(N2kMsg, _MessageID, _Repeat, _UserID, _Latitude, _Longitude, _Accuracy, _RAIM, - _Seconds, _COG, _SOG, _AISTranceiverInformation, _Heading, _Unit, _Display, _DSC, _Band, _Msg22, _Mode, _State,_SID)) + _Seconds, _COG, _SOG, _AISTransceiverInformation, _Heading, _Unit, _Display, _DSC, _Band, _Msg22, _Mode, _State,_SID)) { tNMEA0183AISMsg NMEA0183AISMsg; - + setTalkerChannel(NMEA0183AISMsg,_AISTransceiverInformation); if (SetAISClassBMessage18(NMEA0183AISMsg, _MessageID, _Repeat, _UserID, _Latitude, _Longitude, _Accuracy, _RAIM, _Seconds, _COG, _SOG, _Heading, _Unit, _Display, _DSC, _Band, _Msg22, _Mode, _State)) { SendMessage(NMEA0183AISMsg); -#ifdef SERIAL_PRINT_AIS_NMEA - // Debug Print AIS-NMEA - Serial.print(NMEA0183AISMsg.GetPrefix()); - Serial.print(NMEA0183AISMsg.Sender()); - Serial.print(NMEA0183AISMsg.MessageCode()); - for (int i = 0; i < NMEA0183AISMsg.FieldCount(); i++) - { - Serial.print(","); - Serial.print(NMEA0183AISMsg.Field(i)); - } - char buf[7]; - sprintf(buf, "*%02X\r\n", NMEA0183AISMsg.GetCheckSum()); - Serial.print(buf); -#endif } } return; @@ -976,8 +876,10 @@ private: { tNMEA0183AISMsg NMEA0183AISMsg; + setTalkerChannel(NMEA0183AISMsg,_AISInfo); if (SetAISClassBMessage24PartA(NMEA0183AISMsg, _MessageID, _Repeat, _UserID, _Name)) { + SendMessage(NMEA0183AISMsg); } } return; @@ -1005,77 +907,51 @@ private: _Length, _Beam, _PosRefStbd, _PosRefBow, _MothershipID,_AISInfo,_SID)) { -// -#ifdef SERIAL_PRINT_AIS_FIELDS - // Debug Print N2k Values - Serial.println("––––––––––––––––––––––– Msg 24 ––––––––––––––––––––––––––––––––"); - Serial.print("MessageID: "); - Serial.println(_MessageID); - Serial.print("Repeat: "); - Serial.println(_Repeat); - Serial.print("UserID: "); - Serial.println(_UserID); - Serial.print("VesselType: "); - Serial.println(_VesselType); - Serial.print("Vendor: "); - Serial.println(_Vendor); - Serial.print("Callsign: "); - Serial.println(_Callsign); - Serial.print("Length: "); - Serial.println(_Length); - Serial.print("Beam: "); - Serial.println(_Beam); - Serial.print("PosRefStbd: "); - Serial.println(_PosRefStbd); - Serial.print("PosRefBow: "); - Serial.println(_PosRefBow); - Serial.print("MothershipID: "); - Serial.println(_MothershipID); - Serial.println("––––––––––––––––––––––– Msg 24 ––––––––––––––––––––––––––––––––"); -#endif - tNMEA0183AISMsg NMEA0183AISMsg; - - if (SetAISClassBMessage24(NMEA0183AISMsg, _MessageID, _Repeat, _UserID, _VesselType, _Vendor, _Callsign, + setTalkerChannel(NMEA0183AISMsg,_AISInfo); + if (SetAISClassBMessage24PartB(NMEA0183AISMsg, _MessageID, _Repeat, _UserID, _VesselType, _Vendor, _Callsign, _Length, _Beam, _PosRefStbd, _PosRefBow, _MothershipID)) { - - SendMessage(NMEA0183AISMsg.BuildMsg24PartA(NMEA0183AISMsg)); - -#ifdef SERIAL_PRINT_AIS_NMEA - // Debug Print AIS-NMEA - char buf[7]; - Serial.print(NMEA0183AISMsg.GetPrefix()); - Serial.print(NMEA0183AISMsg.Sender()); - Serial.print(NMEA0183AISMsg.MessageCode()); - for (int i = 0; i < NMEA0183AISMsg.FieldCount(); i++) - { - Serial.print(","); - Serial.print(NMEA0183AISMsg.Field(i)); - } - sprintf(buf, "*%02X\r\n", NMEA0183AISMsg.GetCheckSum()); - Serial.print(buf); -#endif - - SendMessage(NMEA0183AISMsg.BuildMsg24PartB(NMEA0183AISMsg)); - -#ifdef SERIAL_PRINT_AIS_NMEA - Serial.print(NMEA0183AISMsg.GetPrefix()); - Serial.print(NMEA0183AISMsg.Sender()); - Serial.print(NMEA0183AISMsg.MessageCode()); - for (int i = 0; i < NMEA0183AISMsg.FieldCount(); i++) - { - Serial.print(","); - Serial.print(NMEA0183AISMsg.Field(i)); - } - sprintf(buf, "*%02X\r\n", NMEA0183AISMsg.GetCheckSum()); - Serial.print(buf); -#endif + SendMessage(NMEA0183AISMsg); } } return; } + //***************************************************************************** + // PGN 129041 Aton + void HandleAISMessage21(const tN2kMsg &N2kMsg) + { + tN2kAISAtoNReportData data; + if (ParseN2kPGN129041(N2kMsg,data)){ + tNMEA0183AISMsg nmea0183Msg; + setTalkerChannel(nmea0183Msg,data.AISTransceiverInformation); + if (SetAISMessage21( + nmea0183Msg, + data.Repeat, + data.UserID, + data.Latitude, + data.Longitude, + data.Accuracy, + data.RAIM, + data.Seconds, + data.Length, + data.Beam, + data.PositionReferenceStarboard, + data.PositionReferenceTrueNorth, + data.AtoNType, + data.OffPositionIndicator, + data.VirtualAtoNFlag, + data.AssignedModeFlag, + data.GNSSType, + data.AtoNStatus, + data.AtoNName + )){ + SendMessage(nmea0183Msg); + } + } + } + void HandleSystemTime(const tN2kMsg &msg){ unsigned char sid=-1; uint16_t DaysSince1970=N2kUInt16NA; @@ -1271,12 +1147,12 @@ private: double Level=N2kDoubleNA; double Capacity=N2kDoubleNA; if (ParseN2kPGN127505(N2kMsg,Instance,FluidType,Level,Capacity)) { - GwXDRFoundMapping mapping=xdrMappings->getMapping(XDRFLUID,FluidType,0,Instance); + GwXDRFoundMapping mapping=xdrMappings->getMapping(Level,XDRFLUID,FluidType,0,Instance); if (updateDouble(&mapping,Level)){ LOG_DEBUG(GwLog::DEBUG+1,"found fluidlevel mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(Level)); } - mapping=xdrMappings->getMapping(XDRFLUID,FluidType,1,Instance); + mapping=xdrMappings->getMapping(Capacity, XDRFLUID,FluidType,1,Instance); if (updateDouble(&mapping,Capacity)){ LOG_DEBUG(GwLog::DEBUG+1,"found fluid capacity mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(Capacity)); @@ -1294,19 +1170,19 @@ private: double BatteryTemperature=N2kDoubleNA; if (ParseN2kPGN127508(N2kMsg,BatteryInstance,BatteryVoltage,BatteryCurrent,BatteryTemperature,SID)) { int i=0; - GwXDRFoundMapping mapping=xdrMappings->getMapping(XDRBAT,0,0,BatteryInstance); + GwXDRFoundMapping mapping=xdrMappings->getMapping(BatteryVoltage, XDRBAT,0,0,BatteryInstance); if (updateDouble(&mapping,BatteryVoltage)){ LOG_DEBUG(GwLog::DEBUG+1,"found BatteryVoltage mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(BatteryVoltage)); i++; } - mapping=xdrMappings->getMapping(XDRBAT,0,1,BatteryInstance); + mapping=xdrMappings->getMapping(BatteryCurrent,XDRBAT,0,1,BatteryInstance); if (updateDouble(&mapping,BatteryCurrent)){ LOG_DEBUG(GwLog::DEBUG+1,"found BatteryCurrent mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(BatteryCurrent)); i++; } - mapping=xdrMappings->getMapping(XDRBAT,0,2,BatteryInstance); + mapping=xdrMappings->getMapping(BatteryTemperature,XDRBAT,0,2,BatteryInstance); if (updateDouble(&mapping,BatteryTemperature)){ LOG_DEBUG(GwLog::DEBUG+1,"found BatteryTemperature mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(BatteryTemperature)); @@ -1338,13 +1214,13 @@ private: SendMessage(NMEA0183Msg); } int i=0; - GwXDRFoundMapping mapping=xdrMappings->getMapping(XDRTEMP,N2kts_OutsideTemperature,0,0); + GwXDRFoundMapping mapping=xdrMappings->getMapping(OutsideAmbientAirTemperature, XDRTEMP,N2kts_OutsideTemperature,0,0); if (updateDouble(&mapping,OutsideAmbientAirTemperature)){ LOG_DEBUG(GwLog::DEBUG+1,"found temperature mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(OutsideAmbientAirTemperature)); i++; } - mapping=xdrMappings->getMapping(XDRPRESSURE,N2kps_Atmospheric,0,0); + mapping=xdrMappings->getMapping(AtmosphericPressure,XDRPRESSURE,N2kps_Atmospheric,0,0); if (updateDouble(&mapping,AtmosphericPressure)){ LOG_DEBUG(GwLog::DEBUG+1,"found pressure mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(AtmosphericPressure)); @@ -1379,19 +1255,19 @@ private: SendMessage(NMEA0183Msg); } - GwXDRFoundMapping mapping=xdrMappings->getMapping(XDRTEMP,TempSource,0,0); + GwXDRFoundMapping mapping=xdrMappings->getMapping(Temperature, XDRTEMP,TempSource,0,0); if (updateDouble(&mapping,Temperature)){ LOG_DEBUG(GwLog::DEBUG+1,"found temperature mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(Temperature)); i++; } - mapping=xdrMappings->getMapping(XDRHUMIDITY,HumiditySource,0,0); + mapping=xdrMappings->getMapping(Humidity, XDRHUMIDITY,HumiditySource,0,0); if (updateDouble(&mapping,Humidity)){ LOG_DEBUG(GwLog::DEBUG+1,"found humidity mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(Humidity)); i++; } - mapping=xdrMappings->getMapping(XDRPRESSURE,N2kps_Atmospheric,0,0); + mapping=xdrMappings->getMapping(AtmosphericPressure, XDRPRESSURE,N2kps_Atmospheric,0,0); if (updateDouble(&mapping,AtmosphericPressure)){ LOG_DEBUG(GwLog::DEBUG+1,"found pressure mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(AtmosphericPressure)); @@ -1426,12 +1302,12 @@ private: SendMessage(NMEA0183Msg); } - GwXDRFoundMapping mapping=xdrMappings->getMapping(XDRTEMP,(int)TemperatureSource,0,TemperatureInstance); + GwXDRFoundMapping mapping=xdrMappings->getMapping(Temperature, XDRTEMP,(int)TemperatureSource,0,TemperatureInstance); if (updateDouble(&mapping,Temperature)){ LOG_DEBUG(GwLog::DEBUG+1,"found temperature mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(Temperature)); } - mapping=xdrMappings->getMapping(XDRTEMP,(int)TemperatureSource,1,TemperatureInstance); + mapping=xdrMappings->getMapping(setTemperature, XDRTEMP,(int)TemperatureSource,1,TemperatureInstance); if (updateDouble(&mapping,setTemperature)){ LOG_DEBUG(GwLog::DEBUG+1,"found temperature mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(setTemperature)); @@ -1449,12 +1325,13 @@ private: LOG_DEBUG(GwLog::DEBUG,"unable to parse PGN %d",msg.PGN); return; } - GwXDRFoundMapping mapping=xdrMappings->getMapping(XDRHUMIDITY,(int)HumiditySource,0,HumidityInstance); + GwXDRFoundMapping mapping; + mapping=xdrMappings->getMapping(ActualHumidity, XDRHUMIDITY,(int)HumiditySource,0,HumidityInstance); if (updateDouble(&mapping,ActualHumidity)){ LOG_DEBUG(GwLog::DEBUG+1,"found humidity mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(ActualHumidity)); } - mapping=xdrMappings->getMapping(XDRHUMIDITY,(int)HumiditySource,1,HumidityInstance); + mapping=xdrMappings->getMapping(SetHumidity, XDRHUMIDITY,(int)HumiditySource,1,HumidityInstance); if (updateDouble(&mapping,SetHumidity)){ LOG_DEBUG(GwLog::DEBUG+1,"found humidity mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(SetHumidity)); @@ -1472,7 +1349,7 @@ private: LOG_DEBUG(GwLog::DEBUG,"unable to parse PGN %d",msg.PGN); return; } - GwXDRFoundMapping mapping=xdrMappings->getMapping(XDRPRESSURE,(int)PressureSource,0,PressureInstance); + GwXDRFoundMapping mapping=xdrMappings->getMapping(ActualPressure, XDRPRESSURE,(int)PressureSource,0,PressureInstance); if (! updateDouble(&mapping,ActualPressure)) return; LOG_DEBUG(GwLog::DEBUG+1,"found pressure mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(ActualPressure)); @@ -1490,12 +1367,12 @@ private: LOG_DEBUG(GwLog::DEBUG,"unable to parse PGN %d",msg.PGN); } for (int i=0;i<8;i++){ - GwXDRFoundMapping mapping=xdrMappings->getMapping(XDRENGINE,0,i,instance); + GwXDRFoundMapping mapping=xdrMappings->getMapping(values[i], XDRENGINE,0,i,instance); if (! updateDouble(&mapping,values[i])) continue; addToXdr(mapping.buildXdrEntry(values[i])); } for (int i=0;i< 2;i++){ - GwXDRFoundMapping mapping=xdrMappings->getMapping(XDRENGINE,0,i+8,instance); + GwXDRFoundMapping mapping=xdrMappings->getMapping(ivalues[i],XDRENGINE,0,i+8,instance); if (! updateDouble(&mapping,ivalues[i])) continue; addToXdr(mapping.buildXdrEntry((double)ivalues[i])); } @@ -1511,7 +1388,7 @@ private: LOG_DEBUG(GwLog::DEBUG,"unable to parse PGN %d",msg.PGN); } for (int i=0;i<3;i++){ - GwXDRFoundMapping mapping=xdrMappings->getMapping(XDRATTITUDE,0,i,instance); + GwXDRFoundMapping mapping=xdrMappings->getMapping(values[i], XDRATTITUDE,0,i,instance); if (! updateDouble(&mapping,values[i])) continue; addToXdr(mapping.buildXdrEntry(values[i])); } @@ -1525,15 +1402,15 @@ private: speed,pressure,tilt)){ LOG_DEBUG(GwLog::DEBUG,"unable to parse PGN %d",msg.PGN); } - GwXDRFoundMapping mapping=xdrMappings->getMapping(XDRENGINE,0,10,instance); + GwXDRFoundMapping mapping=xdrMappings->getMapping(speed, XDRENGINE,0,10,instance); if (updateDouble(&mapping,speed)){ addToXdr(mapping.buildXdrEntry(speed)); } - mapping=xdrMappings->getMapping(XDRENGINE,0,11,instance); + mapping=xdrMappings->getMapping(pressure, XDRENGINE,0,11,instance); if (updateDouble(&mapping,pressure)){ addToXdr(mapping.buildXdrEntry(pressure)); } - mapping=xdrMappings->getMapping(XDRENGINE,0,12,instance); + mapping=xdrMappings->getMapping(tilt, XDRENGINE,0,12,instance); if (updateDouble(&mapping,tilt)){ addToXdr(mapping.buildXdrEntry((double)tilt)); } @@ -1559,12 +1436,12 @@ private: LOG_DEBUG(GwLog::DEBUG,"unable to parse PGN %d",msg.PGN); return; } - GwXDRFoundMapping mapping=xdrMappings->getMapping(XDRTEMP,(int)TemperatureSource,0,TemperatureInstance); + GwXDRFoundMapping mapping=xdrMappings->getMapping(Temperature, XDRTEMP,(int)TemperatureSource,0,TemperatureInstance); if (updateDouble(&mapping,Temperature)){ LOG_DEBUG(GwLog::DEBUG+1,"found temperature mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(Temperature)); } - mapping=xdrMappings->getMapping(XDRTEMP,(int)TemperatureSource,1,TemperatureInstance); + mapping=xdrMappings->getMapping(setTemperature, XDRTEMP,(int)TemperatureSource,1,TemperatureInstance); if (updateDouble(&mapping,setTemperature)){ LOG_DEBUG(GwLog::DEBUG+1,"found temperature mapping %s",mapping.definition->toString().c_str()); addToXdr(mapping.buildXdrEntry(setTemperature)); @@ -1614,6 +1491,7 @@ private: converters.registerConverter(129794UL, &N2kToNMEA0183Functions::HandleAISClassAMessage5); // AIS Class A Ship Static and Voyage related data, Message Type 5 converters.registerConverter(129809UL, &N2kToNMEA0183Functions::HandleAISClassBMessage24A); // AIS Class B "CS" Static Data Report, Part A converters.registerConverter(129810UL, &N2kToNMEA0183Functions::HandleAISClassBMessage24B); // AIS Class B "CS" Static Data Report, Part B + converters.registerConverter(129041UL, &N2kToNMEA0183Functions::HandleAISMessage21); // AIS Aton #endif } diff --git a/lib/nmea2ktoais/NMEA0183AISMessages.cpp b/lib/nmea2ktoais/NMEA0183AISMessages.cpp index a0f9ec0..7a64d70 100644 --- a/lib/nmea2ktoais/NMEA0183AISMessages.cpp +++ b/lib/nmea2ktoais/NMEA0183AISMessages.cpp @@ -26,7 +26,7 @@ OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -#include +#include "NMEA0183AISMessages.h" #include #include #include @@ -34,7 +34,7 @@ OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. //#include #include #include -#include +#include "NMEA0183AISMsg.h" const double pi=3.1415926535897932384626433832795; const double kmhToms=1000.0/3600.0; @@ -47,17 +47,15 @@ const double nmTom=1.852*1000; const double mToFathoms=0.546806649; const double mToFeet=3.2808398950131; const double radsToDegMin = 60 * 360.0 / (2 * pi); // [rad/s -> degree/minute] -const char Prefix='!'; -std::vector vships; -int numShips(){return vships.size();} // ************************ Helper for AIS *********************************** static bool AddMessageType(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageType); static bool AddRepeat(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t Repeat); static bool AddUserID(tNMEA0183AISMsg &NMEA0183AISMsg, uint32_t UserID); static bool AddIMONumber(tNMEA0183AISMsg &NMEA0183AISMsg, uint32_t &IMONumber); static bool AddText(tNMEA0183AISMsg &NMEA0183AISMsg, char *FieldVal, uint8_t length); +//static bool AddVesselType(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t VesselType); static bool AddDimensions(tNMEA0183AISMsg &NMEA0183AISMsg, double Length, double Beam, double PosRefStbd, double PosRefBow); static bool AddNavStatus(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t &NavStatus); static bool AddROT(tNMEA0183AISMsg &NMEA0183AISMsg, double &rot); @@ -81,8 +79,8 @@ static bool AddETADateTime(tNMEA0183AISMsg &NMEA0183AISMsg, uint16_t &ETAdate, d // // Got values from: ParseN2kPGN129038() bool SetAISClassABMessage1( tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageType, uint8_t Repeat, - uint32_t UserID, double Latitude, double Longitude, bool Accuracy, bool RAIM, uint8_t Seconds, - double COG, double SOG, double Heading, double ROT, uint8_t NavStatus ) { + uint32_t UserID, double Latitude, double Longitude, bool Accuracy, bool RAIM, uint8_t Seconds, + double COG, double SOG, double Heading, double ROT, uint8_t NavStatus ) { NMEA0183AISMsg.ClearAIS(); if ( !AddMessageType(NMEA0183AISMsg, MessageType) ) return false; // 0 - 5 | 6 Message Type -> Constant: 1 @@ -91,7 +89,7 @@ bool SetAISClassABMessage1( tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageType if ( !AddNavStatus(NMEA0183AISMsg, NavStatus) ) return false; // 38-41 | 4 Navigational Status e.g.: "Under way sailing" if ( !AddROT(NMEA0183AISMsg, ROT) ) return false; // 42-49 | 8 Rate of Turn (ROT) if ( !AddSOG(NMEA0183AISMsg, SOG) ) return false; // 50-59 | 10 [m/s -> kts] SOG with one digit x10, 1023 = N/A - if ( !NMEA0183AISMsg.AddBoolToPayloadBin(Accuracy, 1) ) return false;// 60 | 1 GPS Accuracy 1 oder 0, Default 0 + if ( !NMEA0183AISMsg.AddBoolToPayloadBin(Accuracy) ) return false;// 60 | 1 GPS Accuracy 1 oder 0, Default 0 if ( !AddLongitude(NMEA0183AISMsg, Longitude) ) return false; // 61-88 | 28 Longitude in Minutes / 10000 if ( !AddLatitude(NMEA0183AISMsg, Latitude) ) return false; // 89-115 | 27 Latitude in Minutes / 10000 if ( !AddCOG(NMEA0183AISMsg, COG) ) return false; // 116-127 | 12 Course over ground will be 3600 (0xE10) if that data is not available. @@ -99,17 +97,12 @@ bool SetAISClassABMessage1( tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageType if ( !AddSeconds(NMEA0183AISMsg, Seconds) ) return false; // 137-142 | 6 Seconds in UTC timestamp) if ( !NMEA0183AISMsg.AddIntToPayloadBin(0, 2) ) return false; // 143-144 | 2 Maneuver Indicator: 0 (default) 1, 2 (not delivered within this PGN) if ( !NMEA0183AISMsg.AddIntToPayloadBin(0, 3) ) return false; // 145-147 | 3 Spare - if ( !NMEA0183AISMsg.AddBoolToPayloadBin(RAIM, 1) ) return false; // 148-148 | 1 RAIM flag 0 = RAIM not in use (default), 1 = RAIM in use + if ( !NMEA0183AISMsg.AddBoolToPayloadBin(RAIM) ) return false; // 148-148 | 1 RAIM flag 0 = RAIM not in use (default), 1 = RAIM in use if ( !NMEA0183AISMsg.AddIntToPayloadBin(0, 19) ) return false; // 149-167 | 19 Radio Status (-> 0 NOT SENT WITH THIS PGN!!!!!) - - if ( !NMEA0183AISMsg.Init("VDM","AI", Prefix) ) return false; - if ( !NMEA0183AISMsg.AddStrField("1") ) return false; - if ( !NMEA0183AISMsg.AddStrField("1") ) return false; - if ( !NMEA0183AISMsg.AddEmptyField() ) return false; - if ( !NMEA0183AISMsg.AddStrField("A") ) return false; - if ( !NMEA0183AISMsg.AddStrField( NMEA0183AISMsg.GetPayload() ) ) return false; - if ( !NMEA0183AISMsg.AddStrField("0") ) return false; // Message 1,2,3 has always Zero Padding - + if ( !NMEA0183AISMsg.InitAis()) return false; + int padBits=0; + if ( !NMEA0183AISMsg.AddStrField( NMEA0183AISMsg.GetPayloadFix(padBits) ) ) return false; + if ( !NMEA0183AISMsg.AddUInt32Field(padBits) ) return false; return true; } @@ -121,14 +114,16 @@ bool SetAISClassAMessage5(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, u uint32_t UserID, uint32_t IMONumber, char *Callsign, char *Name, uint8_t VesselType, double Length, double Beam, double PosRefStbd, double PosRefBow, uint16_t ETAdate, double ETAtime, double Draught, - char *Destination, tN2kGNSStype GNSStype, uint8_t DTE ) { + char *Destination, tN2kGNSStype GNSStype, uint8_t DTE, + tN2kAISVersion AISversion) { // AIS Type 5 Message NMEA0183AISMsg.ClearAIS(); if ( !AddMessageType(NMEA0183AISMsg, 5) ) return false; // 0 - 5 | 6 Message Type -> Constant: 5 if ( !AddRepeat(NMEA0183AISMsg, Repeat) ) return false; // 6 - 7 | 2 Repeat Indicator: 0 = default; 3 = do not repeat any more if ( !AddUserID(NMEA0183AISMsg, UserID) ) return false; // 8 - 37 | 30 MMSI - if ( !NMEA0183AISMsg.AddIntToPayloadBin(1, 2) ) return false; // 38 - 39 | 2 AIS Version -> 0 oder 1 NOT DERIVED FROM N2k, Always 1!!!! + if ( !NMEA0183AISMsg.AddIntToPayloadBin((uint32_t)AISversion, 2) ) + return false; // 38 - 39 | 2 AIS Version -> 0 oder 1 NOT DERIVED FROM N2k, Always 1!!!! if ( !AddIMONumber(NMEA0183AISMsg, IMONumber) ) return false; // 40 - 69 | 30 IMO Number unisgned if ( !AddText(NMEA0183AISMsg, Callsign, 42) ) return false; // 70 - 111 | 42 Call Sign WDE4178 -> 7 6-bit characters -> Ascii lt. Table) if ( !AddText(NMEA0183AISMsg, Name, 120) ) return false; // 112-231 | 120 Vessel Name POINT FERMIN -> 20 6-bit characters -> Ascii lt. Table @@ -146,15 +141,17 @@ bool SetAISClassAMessage5(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, u // **************************************************************************** // AIS position report (class B 129039) -> Type 18: Standard Class B CS Position Report -// ParseN2kPGN129039(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, +// PGN129039 +// ParseN2kAISClassBPosition(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, // double &Latitude, double &Longitude, bool &Accuracy, bool &RAIM, -// uint8_t &Seconds, double &COG, double &SOG, double &Heading, tN2kAISUnit &Unit, -// bool &Display, bool &DSC, bool &Band, bool &Msg22, tN2kAISMode &Mode, bool &State) +// uint8_t &Seconds, double &COG, double &SOG, tN2kAISTransceiverInformation &AISTransceiverInformation, +// double &Heading, tN2kAISUnit &Unit, bool &Display, bool &DSC, bool &Band, bool &Msg22, tN2kAISMode &Mode, +// bool &State) // VDM, VDO (AIS VHF Data-link message 18) bool SetAISClassBMessage18(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, uint8_t Repeat, uint32_t UserID, - double Latitude, double Longitude, bool Accuracy, bool RAIM, - uint8_t Seconds, double COG, double SOG, double Heading, tN2kAISUnit Unit, - bool Display, bool DSC, bool Band, bool Msg22, bool Mode, bool State) { + double Latitude, double Longitude, bool Accuracy, bool RAIM, + uint8_t Seconds, double COG, double SOG, double Heading, tN2kAISUnit Unit, + bool Display, bool DSC, bool Band, bool Msg22, bool Mode, bool State) { // NMEA0183AISMsg.ClearAIS(); if ( !AddMessageType(NMEA0183AISMsg, MessageID) ) return false; // 0 - 5 | 6 Message Type -> Constant: 18 @@ -162,7 +159,7 @@ bool SetAISClassBMessage18(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, u if ( !AddUserID(NMEA0183AISMsg, UserID) ) return false; // 8 - 37 | 30 MMSI if ( !NMEA0183AISMsg.AddIntToPayloadBin(0, 8) ) return false; // 38-45 | 8 Regional Reserved if ( !AddSOG(NMEA0183AISMsg, SOG) ) return false; // 46-55 | 10 [m/s -> kts] SOG with one digit x10, 1023 = N/A - if ( !NMEA0183AISMsg.AddBoolToPayloadBin(Accuracy, 1)) return false; // 56 | 1 GPS Accuracy 1 oder 0, Default 0 + if ( !NMEA0183AISMsg.AddBoolToPayloadBin(Accuracy)) return false; // 56 | 1 GPS Accuracy 1 oder 0, Default 0 if ( !AddLongitude(NMEA0183AISMsg, Longitude) ) return false; // 57-84 | 28 Longitude in Minutes / 10000 if ( !AddLatitude(NMEA0183AISMsg, Latitude) ) return false; // 85-111 | 27 Latitude in Minutes / 10000 if ( !AddCOG(NMEA0183AISMsg, COG) ) return false; // 112-123 | 12 Course over ground will be 3600 (0xE10) if that data is not available. @@ -171,20 +168,16 @@ bool SetAISClassBMessage18(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, u if ( !NMEA0183AISMsg.AddIntToPayloadBin(0, 2) ) return false; // 139-140 | 2 Regional Reserved if ( !NMEA0183AISMsg.AddIntToPayloadBin(Unit, 1) ) return false; // 141 | 1 0=Class B SOTDMA unit 1=Class B CS (Carrier Sense) unit if ( !NMEA0183AISMsg.AddIntToPayloadBin(Display, 1) ) return false; // 142 | 1 0=No visual display, 1=Has display, (Probably not reliable). - if ( !NMEA0183AISMsg.AddBoolToPayloadBin(DSC, 1) ) return false; // 143 | 1 If 1, unit is attached to a VHF voice radio with DSC capability. - if ( !NMEA0183AISMsg.AddBoolToPayloadBin(Band, 1) ) return false; // 144 | 1 If this flag is 1, the unit can use any part of the marine channel. - if ( !NMEA0183AISMsg.AddBoolToPayloadBin(Msg22, 1) ) return false; // 145 | 1 If 1, unit can accept a channel assignment via Message Type 22. - if ( !NMEA0183AISMsg.AddBoolToPayloadBin(Mode, 1) ) return false; // 146 | 1 Assigned-mode flag: 0 = autonomous mode (default), 1 = assigned mode - if ( !NMEA0183AISMsg.AddBoolToPayloadBin(RAIM, 1) ) return false; // 147 | 1 as for Message Type 1,2,3 + if ( !NMEA0183AISMsg.AddBoolToPayloadBin(DSC) ) return false; // 143 | 1 If 1, unit is attached to a VHF voice radio with DSC capability. + if ( !NMEA0183AISMsg.AddBoolToPayloadBin(Band) ) return false; // 144 | 1 If this flag is 1, the unit can use any part of the marine channel. + if ( !NMEA0183AISMsg.AddBoolToPayloadBin(Msg22)) return false; // 145 | 1 If 1, unit can accept a channel assignment via Message Type 22. + if ( !NMEA0183AISMsg.AddBoolToPayloadBin(Mode) ) return false; // 146 | 1 Assigned-mode flag: 0 = autonomous mode (default), 1 = assigned mode + if ( !NMEA0183AISMsg.AddBoolToPayloadBin(RAIM) ) return false; // 147 | 1 as for Message Type 1,2,3 if ( !NMEA0183AISMsg.AddIntToPayloadBin(0, 20) ) return false; // 148-167 | 20 Radio Status not in PGN 129039 - - if ( !NMEA0183AISMsg.Init("VDM","AI", Prefix) ) return false; - if ( !NMEA0183AISMsg.AddStrField("1") ) return false; - if ( !NMEA0183AISMsg.AddStrField("1") ) return false; - if ( !NMEA0183AISMsg.AddEmptyField() ) return false; - if ( !NMEA0183AISMsg.AddStrField("B") ) return false; - if ( !NMEA0183AISMsg.AddStrField( NMEA0183AISMsg.GetPayload() ) ) return false; - if ( !NMEA0183AISMsg.AddStrField("0") ) return false; // Message 18, has always Zero Padding + if ( !NMEA0183AISMsg.InitAis()) return false; + int padBits=0; + if ( !NMEA0183AISMsg.AddStrField( NMEA0183AISMsg.GetPayloadFix(padBits) ) ) return false; + if ( !NMEA0183AISMsg.AddUInt32Field(padBits) ) return false; return true; } @@ -209,7 +202,7 @@ bool SetAISClassBMessage18(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, u // // PGN 129809 AIS Class B "CS" Static Data Report, Part A -> AIS VHF Data-link message 24 // PGN 129810 AIS Class B "CS" Static Data Report, Part B -> AIS VHF Data-link message 24 -// ParseN2kPGN129809 (const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, char *Name) -> store to vector +// ParseN2kPGN129809 (const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, char *Name) -> store to vector // ParseN2kPGN129810(const tN2kMsg &N2kMsg, uint8_t &MessageID, tN2kAISRepeat &Repeat, uint32_t &UserID, // uint8_t &VesselType, char *Vendor, char *Callsign, double &Length, double &Beam, // double &PosRefStbd, double &PosRefBow, uint32_t &MothershipID); @@ -217,41 +210,28 @@ bool SetAISClassBMessage18(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, u // Part A: MessageID, Repeat, UserID, ShipName -> store in vector to call on Part B arrivals!!! // Part B: MessageID, Repeat, UserID, VesselType (5), Callsign (5), Length & Beam, PosRefBow,.. (5) bool SetAISClassBMessage24PartA(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, uint8_t Repeat, uint32_t UserID, char *Name) { - - bool found = false; - for (size_t i = 0; i < vships.size(); i++) { - if ( vships[i]->_userID == UserID ) { - found = true; - break; - } - } - if ( ! found ) { - std::string nm; - nm+= Name; - vships.push_back(new ship(UserID, nm)); - } + // AIS Type 24 Message + NMEA0183AISMsg.ClearAIS(); + // Common for PART A AND Part B Bit 0 - 39 / len 40 + if ( !AddMessageType(NMEA0183AISMsg, 24) ) return false; // 0 - 5 | 6 Message Type -> Constant: 24 + if ( !AddRepeat(NMEA0183AISMsg, Repeat) ) return false; // 6 - 7 | 2 Repeat Indicator: 0 = default; 3 = do not repeat any more + if ( !AddUserID(NMEA0183AISMsg, UserID) ) return false; // 8 - 37 | 30 MMSI + if ( !NMEA0183AISMsg.AddIntToPayloadBin(0, 2) ) return false; // 38-39 | 2 Part Number 0-1 -> + // Part A: 40 + 128 = len 168 + if ( !AddText(NMEA0183AISMsg, Name, 120) ) return false; // 40-159 | 120 Vessel Name 20 6-bit characters -> Ascii Table + if ( !NMEA0183AISMsg.AddIntToPayloadBin(0, 8) ) return false; // 160-167 | 8 Spare + if ( !NMEA0183AISMsg.InitAis() ) return false; + int padBits=0; + if ( !NMEA0183AISMsg.AddStrField( NMEA0183AISMsg.GetPayloadFix(padBits) ) ) return false; + if ( !NMEA0183AISMsg.AddUInt32Field(padBits) ) return false; return true; } // *************************************************************************************************************** -bool SetAISClassBMessage24(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, uint8_t Repeat, +bool SetAISClassBMessage24PartB(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, uint8_t Repeat, uint32_t UserID, uint8_t VesselType, char *VendorID, char *Callsign, double Length, double Beam, double PosRefStbd, double PosRefBow, uint32_t MothershipID ) { - uint8_t PartNr = 0; // Identifier for the message part number; always 0 for Part A - char *ShipName = (char*)" "; // get from vector to look up for sent Messages Part A - - uint8_t i; - for ( i = 0; i < vships.size(); i++) { - if ( vships[i]->_userID == UserID ) { - ShipName = const_cast( vships[i]->_shipName.c_str() ); - } - } - if ( i > MAX_SHIP_IN_VECTOR ) { - std::vector::iterator it=vships.begin(); - delete *it; - vships.erase(it); - } // AIS Type 24 Message NMEA0183AISMsg.ClearAIS(); @@ -259,11 +239,7 @@ bool SetAISClassBMessage24(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, if ( !AddMessageType(NMEA0183AISMsg, 24) ) return false; // 0 - 5 | 6 Message Type -> Constant: 24 if ( !AddRepeat(NMEA0183AISMsg, Repeat) ) return false; // 6 - 7 | 2 Repeat Indicator: 0 = default; 3 = do not repeat any more if ( !AddUserID(NMEA0183AISMsg, UserID) ) return false; // 8 - 37 | 30 MMSI - if ( !NMEA0183AISMsg.AddIntToPayloadBin(PartNr, 2) ) return false; // 38-39 | 2 Part Number 0-1 -> - - // Part A: 40 + 128 = len 168 - if ( !AddText(NMEA0183AISMsg, ShipName, 120) ) return false; // 40-159 | 120 Vessel Name 20 6-bit characters -> Ascii Table - if ( !NMEA0183AISMsg.AddIntToPayloadBin(0, 8) ) return false; // 160-167 | 8 Spare + if ( !NMEA0183AISMsg.AddIntToPayloadBin(1, 2) ) return false; // 38-39 | 2 Part Number 0-1 -> // https://www.navcen.uscg.gov/?pageName=AISMessagesB // PART B: 40 + 128 = len 168 @@ -272,6 +248,59 @@ bool SetAISClassBMessage24(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, if ( !AddText(NMEA0183AISMsg, Callsign, 42) ) return false; // 218-259 | 90-131 | 42 Call Sign WDE4178 -> 7 6-bit characters, as in Msg Type 5 if ( !AddDimensions(NMEA0183AISMsg, Length, Beam, PosRefStbd, PosRefBow) ) return false; // 260-289 | 132-161 | 30 Dimensions if ( !NMEA0183AISMsg.AddIntToPayloadBin(0, 6) ) return false; // 290-295 | 162-167 | 6 Spare + if ( !NMEA0183AISMsg.InitAis() ) return false; + int padBits=0; + if ( !NMEA0183AISMsg.AddStrField( NMEA0183AISMsg.GetPayloadFix(padBits) ) ) return false; + if ( !NMEA0183AISMsg.AddUInt32Field(padBits) ) return false; + return true; +} + +// **************************************************************************** +// AIS ATON report (129041) -> Type 21: Position and status report for aids-to-navigation +// PGN129041 + +bool SetAISMessage21(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t Repeat, uint32_t UserID, + double Latitude, double Longitude, bool Accuracy, bool RAIM, + uint8_t Seconds, double Length, double Beam, double PositionReferenceStarboard, + double PositionReferenceTrueNord, tN2kAISAtoNType Type, bool OffPositionIndicator, + bool VirtualAtoNFlag, bool AssignedModeFlag, tN2kGNSStype GNSSType, uint8_t AtoNStatus, + char * atonName ) { + // + NMEA0183AISMsg.ClearAIS(); + if ( !AddMessageType(NMEA0183AISMsg, 21) ) return false; // 0 - 5 | 6 Message Type -> Constant: 18 + if ( !AddRepeat(NMEA0183AISMsg, Repeat) ) return false; // 6 - 7 | 2 Repeat Indicator: 0 = default; 3 = do not repeat any more + if ( !AddUserID(NMEA0183AISMsg, UserID) ) return false; // 8 - 37 | 30 MMSI + if ( ! NMEA0183AISMsg.AddIntToPayloadBin(Type,5)) return false; // | 5 aid type + //the name must be split: + //if it's > 120 bits the rest goes to the last parameter + if ( !NMEA0183AISMsg.AddEncodedCharToPayloadBin(atonName,120)) + return false; // | 120 name + if ( !NMEA0183AISMsg.AddBoolToPayloadBin(Accuracy) ) return false; // | 1 accuracy + if ( !AddLongitude(NMEA0183AISMsg,Longitude)) return false; // | 28 lon + if ( !AddLatitude(NMEA0183AISMsg,Latitude)) return false; // | 27 lat + if ( !AddDimensions(NMEA0183AISMsg, Length, Beam, + PositionReferenceStarboard, PositionReferenceTrueNord)) return false; // | 30 dim + if ( !AddEPFDFixType(NMEA0183AISMsg,GNSSType)) return false; // | 4 fix type + if ( !AddSeconds(NMEA0183AISMsg,Seconds)) return false; // | 6 second + if ( !NMEA0183AISMsg.AddBoolToPayloadBin(OffPositionIndicator)) + return false; // | 1 off + if ( !NMEA0183AISMsg.AddIntToPayloadBin(0,8)) return false; // | 8 reserverd + if ( !NMEA0183AISMsg.AddBoolToPayloadBin(RAIM)) return false; // | 1 raim + if ( !NMEA0183AISMsg.AddBoolToPayloadBin(VirtualAtoNFlag)) + return false; // | 1 virt + if ( !NMEA0183AISMsg.AddBoolToPayloadBin(AssignedModeFlag)) + return false; // | 1 assigned + if ( !NMEA0183AISMsg.AddIntToPayloadBin(0,1)) return false; // | 1 spare + size_t l=strlen(atonName); + if (l >=20){ + uint8_t bitlen=(l-20)*6; + if (bitlen > 88) bitlen=88; + if ( !NMEA0183AISMsg.AddEncodedCharToPayloadBin(atonName+20,bitlen)) return false; // | name + } + if ( !NMEA0183AISMsg.InitAis() ) return false; + int padBits=0; + if ( !NMEA0183AISMsg.AddStrField( NMEA0183AISMsg.GetPayload(padBits) ) ) return false; + if ( !NMEA0183AISMsg.AddUInt32Field(padBits) ) return false; return true; } @@ -325,7 +354,6 @@ bool AddIMONumber(tNMEA0183AISMsg &NMEA0183AISMsg, uint32_t &IMONumber) { // 120bit Name or Destination bool AddText(tNMEA0183AISMsg &NMEA0183AISMsg, char *FieldVal, uint8_t length) { uint8_t len = length/6; - if ( strlen(FieldVal) > len ) FieldVal[len] = 0; if ( !NMEA0183AISMsg.AddEncodedCharToPayloadBin(FieldVal, length) ) return false; return true; @@ -347,29 +375,26 @@ bool AddDimensions(tNMEA0183AISMsg &NMEA0183AISMsg, double Length, double Beam, uint16_t _PosRefStbd = 0; uint16_t _PosRefPort = 0; - if (PosRefBow < 0) PosRefBow=0; //could be N2kIsNA - if ( PosRefBow <= 511.0 ) { - _PosRefBow = round(PosRefBow); + if ( PosRefBow >= 0.0 && PosRefBow <= 511.0 ) { + _PosRefBow = ceil(PosRefBow); } else { _PosRefBow = 511; } - if (PosRefStbd < 0 ) PosRefStbd=0; //could be N2kIsNA - if (PosRefStbd <= 63.0 ) { - _PosRefStbd = round(PosRefStbd); + + if ( PosRefStbd >= 0.0 && PosRefStbd <= 63.0 ) { + _PosRefStbd = ceil(PosRefStbd); } else { _PosRefStbd = 63; } if ( !N2kIsNA(Length) ) { - if (Length >= PosRefBow){ - _PosRefStern=round(Length - PosRefBow); - } + _PosRefStern = ceil( Length ) - _PosRefBow; + if ( _PosRefStern < 0 ) _PosRefStern = 0; if ( _PosRefStern > 511 ) _PosRefStern = 511; } if ( !N2kIsNA(Beam) ) { - if (Beam >= PosRefStbd){ - _PosRefPort = round( Beam - PosRefStbd); - } + _PosRefPort = ceil( Beam ) - _PosRefStbd; + if ( _PosRefPort < 0 ) _PosRefPort = 0; if ( _PosRefPort > 63 ) _PosRefPort = 63; } @@ -572,3 +597,5 @@ bool AddETADateTime(tNMEA0183AISMsg &NMEA0183AISMsg, uint16_t &ETAdate, double & if ( ! NMEA0183AISMsg.AddIntToPayloadBin(minute, 6) ) return false; return true; } + + diff --git a/lib/nmea2ktoais/NMEA0183AISMessages.h b/lib/nmea2ktoais/NMEA0183AISMessages.h index a124574..d818a2b 100644 --- a/lib/nmea2ktoais/NMEA0183AISMessages.h +++ b/lib/nmea2ktoais/NMEA0183AISMessages.h @@ -27,29 +27,21 @@ OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #ifndef _tNMEA0183AISMessages_H_ #define _tNMEA0183AISMessages_H_ + #include #include #include #include -#include +#include "NMEA0183AISMsg.h" #include #include #include -#define MAX_SHIP_IN_VECTOR 200 -class ship { -public: - uint32_t _userID; - std::string _shipName; - - ship(uint32_t UserID, std::string ShipName) : _userID(UserID), _shipName(ShipName) {} -}; - // Types 1, 2 and 3: Position Report Class A or B bool SetAISClassABMessage1(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageType, uint8_t Repeat, - uint32_t UserID, double Latitude, double Longitude, bool Accuracy, bool RAIM, uint8_t Seconds, - double COG, double SOG, double Heading, double ROT, uint8_t NavStatus); + uint32_t UserID, double Latitude, double Longitude, bool Accuracy, bool RAIM, uint8_t Seconds, + double COG, double SOG, double Heading, double ROT, uint8_t NavStatus); //***************************************************************************** // AIS Class A Static and Voyage Related Data Message Type 5 @@ -57,14 +49,15 @@ bool SetAISClassAMessage5(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, ui uint32_t UserID, uint32_t IMONumber, char *Callsign, char *Name, uint8_t VesselType, double Length, double Beam, double PosRefStbd, double PosRefBow, uint16_t ETAdate, double ETAtime, double Draught, - char *Destination, tN2kGNSStype GNSStype, uint8_t DTE ); + char *Destination, tN2kGNSStype GNSStype, uint8_t DTE, + tN2kAISVersion AISversion); //***************************************************************************** // AIS position report (class B 129039) -> Standard Class B CS Position Report Message Type 18 Part B bool SetAISClassBMessage18(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, uint8_t Repeat, uint32_t UserID, - double Latitude, double Longitude, bool Accuracy, bool RAIM, - uint8_t Seconds, double COG, double SOG, double Heading, tN2kAISUnit Unit, - bool Display, bool DSC, bool Band, bool Msg22, bool Mode, bool State); + double Latitude, double Longitude, bool Accuracy, bool RAIM, + uint8_t Seconds, double COG, double SOG, double Heading, tN2kAISUnit Unit, + bool Display, bool DSC, bool Band, bool Msg22, bool Mode, bool State); //***************************************************************************** // Static Data Report Class B, Message Type 24 @@ -73,11 +66,19 @@ bool SetAISClassBMessage24PartA(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t Message //***************************************************************************** // Static Data Report Class B, Message Type 24 -bool SetAISClassBMessage24(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, uint8_t Repeat, +bool SetAISClassBMessage24PartB(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t MessageID, uint8_t Repeat, uint32_t UserID, uint8_t VesselType, char *VendorID, char *Callsign, double Length, double Beam, double PosRefStbd, double PosRefBow, uint32_t MothershipID ); -int numShips(); +//***************************************************************************** +// Aton class 21 +bool SetAISMessage21(tNMEA0183AISMsg &NMEA0183AISMsg, uint8_t Repeat, uint32_t UserID, + double Latitude, double Longitude, bool Accuracy, bool RAIM, + uint8_t Seconds, double Length, double Beam, double PositionReferenceStarboard, + double PositionReferenceTrueNord, tN2kAISAtoNType Type, bool OffPositionIndicator, + bool VirtualAtoNFlag, bool AssignedModeFlag, tN2kGNSStype GNSSType, uint8_t AtoNStatus, + char * atonName ); + inline int32_t aRoundToInt(double x) { return x >= 0 ? (int32_t) floor(x + 0.5) diff --git a/lib/nmea2ktoais/NMEA0183AISMsg.cpp b/lib/nmea2ktoais/NMEA0183AISMsg.cpp index 6abcf42..04118df 100644 --- a/lib/nmea2ktoais/NMEA0183AISMsg.cpp +++ b/lib/nmea2ktoais/NMEA0183AISMsg.cpp @@ -25,7 +25,7 @@ OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #include "NMEA0183AISMsg.h" #include -#include +//#include #include #include #include @@ -43,52 +43,37 @@ tNMEA0183AISMsg::tNMEA0183AISMsg() { //***************************************************************************** void tNMEA0183AISMsg::ClearAIS() { - PayloadBin[0]=0; Payload[0]=0; + PayloadBin.reset(); iAddPldBin=0; iAddPld=0; } -//***************************************************************************** -// Add 6bit with no data. -bool tNMEA0183AISMsg::AddEmptyFieldToPayloadBin(uint8_t iBits) { - - if ( (iAddPldBin + iBits * 6) >= AIS_BIN_MAX_LEN ) return false; // Is there room for any data - - for (uint8_t i=0;i= AIS_BIN_MAX_LEN ) return false; // Is there room for any data - AISBitSet bset(ival); + bset = ival; - PayloadBin[iAddPldBin]=0; uint16_t iAdd=iAddPldBin; for(int i = countBits-1; i >= 0 ; i--) { - PayloadBin[iAdd] = bset[i]?'1':'0'; + PayloadBin[iAdd]=bset [i]; iAdd++; } iAddPldBin += countBits; - PayloadBin[iAddPldBin]=0; return true; } -// **************************************************************************** -bool tNMEA0183AISMsg::AddBoolToPayloadBin(bool &bval, uint8_t size) { - int8_t iTemp; - (bval == true)? iTemp = 1 : iTemp = 0; - if ( ! AddIntToPayloadBin(iTemp, size) ) return false; +//**************************************************************************** +bool tNMEA0183AISMsg::AddBoolToPayloadBin(bool &bval) { + if ( (iAddPldBin + 1 ) >= AIS_BIN_MAX_LEN ) return false; + PayloadBin[iAddPldBin]=bval; + iAddPldBin++; return true; } @@ -99,13 +84,11 @@ bool tNMEA0183AISMsg::AddEncodedCharToPayloadBin(char *sval, size_t countBits) { if ( (iAddPldBin + countBits ) >= AIS_BIN_MAX_LEN ) return false; // Is there room for any data - PayloadBin[iAddPldBin]=0; - std::bitset<6> bs; - char * ptr; + const char * ptr; size_t len = strlen(sval); // e.g.: should be 7 for Callsign if ( len * 6 > countBits ) len = countBits / 6; - for (int i = 0; i +int tNMEA0183AISMsg::ConvertBinaryAISPayloadBinToAscii(std::bitset &src,uint16_t maxSize,uint16_t bitSize,uint16_t stoffset) { + Payload[0]='\0'; + uint16_t slen=maxSize; + if (stoffset >= slen) return 0; + slen-=stoffset; + uint16_t bitLen=bitSize > 0?bitSize:slen; + uint16_t len= bitLen / 6; + if ((len * 6) < bitLen) len+=1; + uint16_t padBits=0; uint32_t offset; - char s[7]; + std::bitset<6> s; uint8_t dec; int i; for ( i=0; i= 0){ + if ( !AddUInt32Field(sequence) ) return false; + } + else{ + if ( !AddEmptyField() ) return false; + } + if ( !AddStrField(channel) ) return false; + return true; +} +bool tNMEA0183AISMsg::BuildMsg5Part1() { + if ( iAddPldBin != 424 ) return false; + InitAis(2,1,5); + int padBits=0; + AddStrField( GetPayload(padBits,0,336)); + AddUInt32Field(padBits); + return true; } -const tNMEA0183AISMsg& tNMEA0183AISMsg::BuildMsg5Part2(tNMEA0183AISMsg &AISMsg) { - - Init("VDM", "AI", '!'); - AddStrField("2"); - AddStrField("2"); - AddStrField("5"); - AddStrField("A"); - AddStrField( GetPayloadType5_Part2() ); - AddStrField("2"); // Message 5, Part 2 has always 2 Padding Zeros - - return AISMsg; +bool tNMEA0183AISMsg::BuildMsg5Part2() { + if ( iAddPldBin != 424 ) return false; + InitAis(2,2,5); + int padBits=0; + AddStrField( GetPayload(padBits,336,88) ); + AddUInt32Field(padBits); + return true; } -const tNMEA0183AISMsg& tNMEA0183AISMsg::BuildMsg24PartA(tNMEA0183AISMsg &AISMsg) { - - Init("VDM", "AI", '!'); - AddStrField("1"); - AddStrField("1"); - AddEmptyField(); - AddStrField("A"); - AddStrField( GetPayloadType24_PartA() ); - AddStrField("0"); - - return AISMsg; -} - -const tNMEA0183AISMsg& tNMEA0183AISMsg::BuildMsg24PartB(tNMEA0183AISMsg &AISMsg) { - - Init("VDM", "AI", '!'); - AddStrField("1"); - AddStrField("1"); - AddEmptyField(); - AddStrField("A"); - AddStrField( GetPayloadType24_PartB() ); - AddStrField("0"); // Message 24, both parts have always Zero Padding - - return AISMsg; -} //******************************* AIS PAYLOADS ********************************* -//****************************************************************************** // get converted Payload for Message 1, 2, 3 & 18, always Length 168 -const char *tNMEA0183AISMsg::GetPayload() { - - uint16_t lenbin = strlen( PayloadBin); - if ( lenbin != 168 ) return nullptr; - - if ( !ConvertBinaryAISPayloadBinToAscii( PayloadBin ) ) return nullptr; +const char *tNMEA0183AISMsg::GetPayloadFix(int &padBits,uint16_t fixLen){ + uint16_t lenbin = iAddPldBin; + if ( lenbin != fixLen ) return nullptr; + return GetPayload(padBits,0,0); +} +const char *tNMEA0183AISMsg::GetPayload(int &padBits,uint16_t offset,uint16_t bitLen) { + padBits=ConvertBinaryAISPayloadBinToAscii(PayloadBin,iAddPldBin, bitLen,offset ); return Payload; } -//****************************************************************************** -// get converted Part 1 of Payload for Message 5 -const char *tNMEA0183AISMsg::GetPayloadType5_Part1() { - - uint16_t lenbin = strlen( PayloadBin); - if ( lenbin != 424 ) return nullptr; - - char to[337]; - strncpy(to, PayloadBin, 336); // First Part is always 336 Length - to[336]=0; - - if ( !ConvertBinaryAISPayloadBinToAscii( to ) ) return nullptr; - - return Payload; -} - -//****************************************************************************** -// get converted Part 2 of Payload for Message 5 -const char *tNMEA0183AISMsg::GetPayloadType5_Part2() { - - uint16_t lenbin = strlen( PayloadBin); - if ( lenbin != 424 ) return nullptr; - - lenbin = 88; // Second Part is always 424 - 336 + 2 padding Zeros in Length - char to[91]; - strncpy(to, PayloadBin + 336, lenbin); - to[88]='0'; to[89]='0'; to[90]=0; - - if ( !ConvertBinaryAISPayloadBinToAscii( to ) ) return nullptr; - return Payload; -} - -//****************************************************************************** -// get converted Part A of Payload for Message 24 -// Bit 0.....167, len 168 -// In PayloadBin is Part A and Part B chained together with Length 296 -const char *tNMEA0183AISMsg::GetPayloadType24_PartA() { - uint16_t lenbin = strlen( PayloadBin); - if ( lenbin != 296 ) return nullptr; // too short for Part A - - char to[169]; // Part A has Length 168 - *to = '\0'; - for (int i=0; i<168; i++){ - to[i] = PayloadBin[i]; - } - to[168]=0; - if ( !ConvertBinaryAISPayloadBinToAscii( to ) ) return nullptr; - return Payload; - -} - -//****************************************************************************** -// get converted Part B of Payload for Message 24 -// Bit 0.....38 + bit39='1' (part number) + bit 168........295 296='\0' of total PayloadBin -// binary part B: len 40 + 128 = len 168 -const char *tNMEA0183AISMsg::GetPayloadType24_PartB() { - uint16_t lenbin = strlen( PayloadBin); - if ( lenbin != 296 ) return nullptr; // too short for Part B - char to[169]; // Part B has Length 168 - *to = '\0'; - for (int i=0; i<39; i++){ - to[i] = PayloadBin[i]; - } - to[39] = 49; // part number 1 - for (int i=40; i<168; i++) { - to[i] = PayloadBin[i+128]; - } - to[168]=0; - if ( !ConvertBinaryAISPayloadBinToAscii( to ) ) return nullptr; - return Payload; -} diff --git a/lib/nmea2ktoais/NMEA0183AISMsg.h b/lib/nmea2ktoais/NMEA0183AISMsg.h index 4dfbc7f..ae9f656 100644 --- a/lib/nmea2ktoais/NMEA0183AISMsg.h +++ b/lib/nmea2ktoais/NMEA0183AISMsg.h @@ -45,43 +45,48 @@ OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #define BITSET_LENGTH 120 -typedef std::bitset AISBitSet; class tNMEA0183AISMsg : public tNMEA0183Msg { protected: // AIS-NMEA + std::bitset bset; static const char *EmptyAISField; // 6bits 0 not used yet..... static const char *AsciChar; uint16_t iAddPldBin; char Payload[AIS_MSG_MAX_LEN]; uint8_t iAddPld; - + char talker[4]="VDM"; + char channel[2]="A"; + std::bitset PayloadBin; public: - char PayloadBin[AIS_BIN_MAX_LEN]; - char PayloadBin2[AIS_BIN_MAX_LEN]; // Clear message void ClearAIS(); public: tNMEA0183AISMsg(); - const char *GetPayload(); - const char *GetPayloadType5_Part1(); - const char *GetPayloadType5_Part2(); - const char *GetPayloadType24_PartA(); - const char *GetPayloadType24_PartB(); - const char *GetPayloadBin() const { return PayloadBin; } + const char *GetPayloadFix(int &padBits,uint16_t fixLen=168); + const char *GetPayload(int &padBits,uint16_t offset=0,uint16_t bitLen=0); - const tNMEA0183AISMsg& BuildMsg5Part1(tNMEA0183AISMsg &AISMsg); - const tNMEA0183AISMsg& BuildMsg5Part2(tNMEA0183AISMsg &AISMsg); - const tNMEA0183AISMsg& BuildMsg24PartA(tNMEA0183AISMsg &AISMsg); - const tNMEA0183AISMsg& BuildMsg24PartB(tNMEA0183AISMsg &AISMsg); + bool BuildMsg5Part1(); + bool BuildMsg5Part2(); + bool InitAis(int max=1,int number=1,int sequence=-1); // Generally Used bool AddIntToPayloadBin(int32_t ival, uint16_t countBits); - bool AddBoolToPayloadBin(bool &bval, uint8_t size); + bool AddBoolToPayloadBin(bool &bval); bool AddEncodedCharToPayloadBin(char *sval, size_t Length); - bool AddEmptyFieldToPayloadBin(uint8_t iBits); - bool ConvertBinaryAISPayloadBinToAscii(const char *payloadbin); + /** + * @param channelA - if set A, otherwise B + * @param own - if set VDO, else VDM + */ + void SetChannelAndTalker(bool channelA,bool own=false); + /** + * convert the payload to ascii + * return the number of padding bits + * @param bitSize the number of bits to be used, 0 - use all bits + */ + template + int ConvertBinaryAISPayloadBinToAscii(std::bitset &src,uint16_t maxSize, uint16_t bitSize,uint16_t offset=0); // AIS Helper functions protected: diff --git a/lib/nmea2ktoais/README.md b/lib/nmea2ktoais/README.md index 9d83553..1d55424 100644 --- a/lib/nmea2ktoais/README.md +++ b/lib/nmea2ktoais/README.md @@ -1,11 +1,11 @@ -# NMEA2000 -> NMEA0183 AIS converter v1.0.0 +# NMEA2000 to NMEA0183 AIS Converter -Import from https://github.com/ronzeiller/NMEA0183-AIS NMEA0183 AIS library © Ronnie Zeiller, www.zeiller.eu Addendum for NMEA2000 and NMEA0183 Library from Timo Lappalainen https://github.com/ttlappalainen +to get NMEA0183 AIS data from N2k-bus ## Conversions: @@ -15,6 +15,33 @@ Addendum for NMEA2000 and NMEA0183 Library from Timo Lappalainen https://github. - NMEA2000 PGN 129809 => AIS Class B "CS" Static Data Report, making a list of UserID (MMSI) and Ship Names used for Message 24 Part A - NMEA2000 PGN 129810 => AIS Class B "CS" Static Data Report, Message 24 Part A+B +### Versions +1.0.6 2024-03-25 +- fixed to work with Timo´s NMEA2000 v4.21.3 + +1.0.5 2023-12-02 +- removed VDO remote print statements + +1.0.4 2023-12-02 +- merged @Isoltero master with fixed memory over run, added VDO remote print statements Thanks to Luis Soltero +- fixed example, thanks to @arduinomnomnom + +1.0.3 2022-05-01 +- Update Examples: AISTransceiverInformation in ParseN2kPGN129039 for changes in NMEA2000 library: https://github.com/ttlappalainen/NMEA2000 + + +1.0.2 2022-04-30 +- bugfix: malloc without free. Thanks to Luis Soltero (Issue https://github.com/ronzeiller/NMEA0183-AIS/issues/3) + +1.0.1 2022-03-15 +- bugfix: buffer overrun missing space for termination. Thanks to Luis Soltero (Issue https://github.com/ronzeiller/NMEA0183-AIS/issues/2) + +2020-12-25 +- corrected Navigational Status 0. Thanks to Li-Ren (Issue https://github.com/ronzeiller/NMEA0183-AIS/issues/1) + +1.0.0 2019-11-24 +- initial upload + ### Remarks 1. Message Type could be set to 1 or 3 (identical messages) on demand 2. Maneuver Indicator (not part of NMEA2000 PGN 129038) => will be set to 0 (default) @@ -33,17 +60,14 @@ To use this library you need also: ## License -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. +MIT license + +Copyright (c) 2019-2022 Ronnie Zeiller, www.zeiller.eu + +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. diff --git a/lib/obp60task/BoatDataCalibration.cpp b/lib/obp60task/BoatDataCalibration.cpp deleted file mode 100644 index 9543926..0000000 --- a/lib/obp60task/BoatDataCalibration.cpp +++ /dev/null @@ -1,190 +0,0 @@ -#if defined BOARD_OBP60S3 || defined BOARD_OBP40S3 - -#include "BoatDataCalibration.h" -#include -#include -#include - -CalibrationDataList calibrationData; -std::unordered_map CalibrationDataList::calibMap; // list of calibration data instances - -void CalibrationDataList::readConfig(GwConfigHandler* config, GwLog* logger) -// Initial load of calibration data into internal list -// This method is called once at init phase of to read the configuration values -{ - std::string instance; - double offset; - double slope; - double smooth; - - String calInstance = ""; - String calOffset = ""; - String calSlope = ""; - String calSmooth = ""; - - // Load user format configuration values - String lengthFormat = config->getString(config->lengthFormat); // [m|ft] - String distanceFormat = config->getString(config->distanceFormat); // [m|km|nm] - String speedFormat = config->getString(config->speedFormat); // [m/s|km/h|kn] - String windspeedFormat = config->getString(config->windspeedFormat); // [m/s|km/h|kn|bft] - String tempFormat = config->getString(config->tempFormat); // [K|C|F] - - // Read calibration settings for data instances - for (int i = 0; i < MAX_CALIBRATION_DATA; i++) { - calInstance = "calInstance" + String(i + 1); - calOffset = "calOffset" + String(i + 1); - calSlope = "calSlope" + String(i + 1); - calSmooth = "calSmooth" + String(i + 1); - - instance = std::string(config->getString(calInstance, "---").c_str()); - if (instance == "---") { - LOG_DEBUG(GwLog::LOG, "no calibration data for instance no. %d", i + 1); - continue; - } - calibMap[instance] = { 0.0f, 1.0f, 1.0f, 0.0f, false }; - offset = (config->getString(calOffset, "")).toFloat(); - slope = (config->getString(calSlope, "")).toFloat(); - smooth = (config->getString(calSmooth, "")).toInt(); // user input is int; further math is done with double - - // Convert calibration values to internal standard formats - if (instance == "AWS" || instance == "TWS") { - if (windspeedFormat == "m/s") { - // No conversion needed - } else if (windspeedFormat == "km/h") { - offset /= 3.6; // Convert km/h to m/s - } else if (windspeedFormat == "kn") { - offset /= 1.94384; // Convert kn to m/s - } else if (windspeedFormat == "bft") { - offset *= 2 + (offset / 2); // Convert Bft to m/s (approx) -> to be improved - } - - } else if (instance == "AWA" || instance == "COG" || instance == "TWA" || instance == "TWD" || instance == "HDM" || instance == "PRPOS" || instance == "RPOS") { - offset *= M_PI / 180; // Convert deg to rad - - } else if (instance == "DBT") { - if (lengthFormat == "m") { - // No conversion needed - } else if (lengthFormat == "ft") { - offset /= 3.28084; // Convert ft to m - } - - } else if (instance == "SOG" || instance == "STW") { - if (speedFormat == "m/s") { - // No conversion needed - } else if (speedFormat == "km/h") { - offset /= 3.6; // Convert km/h to m/s - } else if (speedFormat == "kn") { - offset /= 1.94384; // Convert kn to m/s - } - - } else if (instance == "WTemp") { - if (tempFormat == "K" || tempFormat == "C") { - // No conversion needed - } else if (tempFormat == "F") { - offset *= 9.0 / 5.0; // Convert °F to K - slope *= 9.0 / 5.0; // Convert °F to K - } - } - - // transform smoothing factor from {0.01..10} to {0.3..0.95} and invert for exponential smoothing formula - if (smooth <= 0) { - smooth = 0; - } else { - if (smooth > 10) { - smooth = 10; - } - smooth = 0.3 + ((smooth - 0.01) * (0.95 - 0.3) / (10 - 0.01)); - } - smooth = 1 - smooth; - - calibMap[instance].offset = offset; - calibMap[instance].slope = slope; - calibMap[instance].smooth = smooth; - calibMap[instance].isCalibrated = false; - LOG_DEBUG(GwLog::LOG, "calibration data: %s, offset: %f, slope: %f, smoothing: %f", instance.c_str(), - calibMap[instance].offset, calibMap[instance].slope, calibMap[instance].smooth); - } - LOG_DEBUG(GwLog::LOG, "all calibration data read"); -} - -void CalibrationDataList::calibrateInstance(GwApi::BoatValue* boatDataValue, GwLog* logger) -// Method to calibrate the boat data value -{ - std::string instance = boatDataValue->getName().c_str(); - double offset = 0; - double slope = 1.0; - double dataValue = 0; - std::string format = ""; - - if (calibMap.find(instance) == calibMap.end()) { - LOG_DEBUG(GwLog::DEBUG, "BoatDataCalibration: %s not in calibration list", instance.c_str()); - return; - } else if (!boatDataValue->valid) { // no valid boat data value, so we don't want to apply calibration data - calibMap[instance].isCalibrated = false; - return; - } else { - offset = calibMap[instance].offset; - slope = calibMap[instance].slope; - dataValue = boatDataValue->value; - format = boatDataValue->getFormat().c_str(); - LOG_DEBUG(GwLog::DEBUG, "BoatDataCalibration: %s: value: %f, format: %s", instance.c_str(), dataValue, format.c_str()); - - if (format == "formatWind") { // instance is of type angle - dataValue = (dataValue * slope) + offset; - dataValue = fmod(dataValue, 2 * M_PI); - if (dataValue > (M_PI)) { - dataValue -= (2 * M_PI); - } else if (dataValue < (M_PI * -1)) { - dataValue += (2 * M_PI); - } - } else if (format == "formatCourse") { // instance is of type direction - dataValue = (dataValue * slope) + offset; - dataValue = fmod(dataValue, 2 * M_PI); - if (dataValue < 0) { - dataValue += (2 * M_PI); - } - } else if (format == "kelvinToC") { // instance is of type temperature - dataValue = ((dataValue - 273.15) * slope) + offset + 273.15; - } else { - - dataValue = (dataValue * slope) + offset; - } - - calibMap[instance].isCalibrated = true; - boatDataValue->value = dataValue; - - calibrationData.smoothInstance(boatDataValue, logger); // smooth the boat data value - calibMap[instance].value = boatDataValue->value; // store the calibrated + smoothed value in the list - - LOG_DEBUG(GwLog::DEBUG, "BoatDataCalibration: %s: Offset: %f, Slope: %f, Result: %f", instance.c_str(), offset, slope, calibMap[instance].value); - } -} - -void CalibrationDataList::smoothInstance(GwApi::BoatValue* boatDataValue, GwLog* logger) -// Method to smoothen the boat data value -{ - static std::unordered_map lastValue; // array for last values of smoothed boat data values - - std::string instance = boatDataValue->getName().c_str(); - double oldValue = 0; - double dataValue = boatDataValue->value; - double smoothFactor = 0; - - if (!boatDataValue->valid) { // no valid boat data value, so we don't want to smoothen value - return; - } else if (calibMap.find(instance) == calibMap.end()) { - LOG_DEBUG(GwLog::DEBUG, "BoatDataCalibration: smooth factor for %s not found in calibration list", instance.c_str()); - return; - } else { - smoothFactor = calibMap[instance].smooth; - - if (lastValue.find(instance) != lastValue.end()) { - oldValue = lastValue[instance]; - dataValue = oldValue + (smoothFactor * (dataValue - oldValue)); // exponential smoothing algorithm - } - lastValue[instance] = dataValue; // store the new value for next cycle; first time, store only the current value and return - boatDataValue->value = dataValue; // set the smoothed value to the boat data value - } -} - -#endif \ No newline at end of file diff --git a/lib/obp60task/BoatDataCalibration.h b/lib/obp60task/BoatDataCalibration.h deleted file mode 100644 index d906fa9..0000000 --- a/lib/obp60task/BoatDataCalibration.h +++ /dev/null @@ -1,34 +0,0 @@ -// Functions lib for data instance calibration - -#ifndef _BOATDATACALIBRATION_H -#define _BOATDATACALIBRATION_H - -// #include "Pagedata.h" -#include "GwApi.h" -#include -#include - -#define MAX_CALIBRATION_DATA 3 // maximum number of calibration data instances - -typedef struct { - double offset; // calibration offset - double slope; // calibration slope - double smooth; // smoothing factor - double value; // calibrated data value - bool isCalibrated; // is data instance value calibrated? -} TypeCalibData; - -class CalibrationDataList { -public: - static std::unordered_map calibMap; // list of calibration data instances - - void readConfig(GwConfigHandler* config, GwLog* logger); - void calibrateInstance(GwApi::BoatValue* boatDataValue, GwLog* logger); - void smoothInstance(GwApi::BoatValue* boatDataValue, GwLog* logger); - -private: -}; - -extern CalibrationDataList calibrationData; // this list holds all calibration data - -#endif \ No newline at end of file diff --git a/lib/obp60task/ImageDecoder.cpp b/lib/obp60task/ImageDecoder.cpp new file mode 100644 index 0000000..545ace6 --- /dev/null +++ b/lib/obp60task/ImageDecoder.cpp @@ -0,0 +1,14 @@ +#include "ImageDecoder.h" +#include + +// Decoder for Base64 content +bool ImageDecoder::decodeBase64(const String& base64, uint8_t* outBuffer, size_t outSize, size_t& decodedSize) { + int ret = mbedtls_base64_decode( + outBuffer, + outSize, + &decodedSize, + (const unsigned char*)base64.c_str(), + base64.length() + ); + return (ret == 0); +} diff --git a/lib/obp60task/ImageDecoder.h b/lib/obp60task/ImageDecoder.h new file mode 100644 index 0000000..473b168 --- /dev/null +++ b/lib/obp60task/ImageDecoder.h @@ -0,0 +1,9 @@ + +#pragma once +#include +#include + +class ImageDecoder { +public: + bool decodeBase64(const String& base64, uint8_t* outBuffer, size_t outSize, size_t& decodedSize); +}; diff --git a/lib/obp60task/LedSpiTask.cpp b/lib/obp60task/LedSpiTask.cpp index fbbd640..74497e7 100644 --- a/lib/obp60task/LedSpiTask.cpp +++ b/lib/obp60task/LedSpiTask.cpp @@ -22,9 +22,11 @@ static uint8_t mulcolor(uint8_t f1, uint8_t f2){ } Color setBrightness(const Color &color,uint8_t brightness){ + if (brightness > 100) brightness = 100; + uint16_t br255=brightness*255; br255=br255/100; - //very simple for now + //Very simple for now Color rt=color; rt.g=mulcolor(rt.g,br255); rt.b=mulcolor(rt.b,br255); diff --git a/lib/obp60task/NetworkClient.cpp b/lib/obp60task/NetworkClient.cpp new file mode 100644 index 0000000..66b973d --- /dev/null +++ b/lib/obp60task/NetworkClient.cpp @@ -0,0 +1,181 @@ +#include "NetworkClient.h" + +extern "C" { + #include "puff.h" +} + +// Constructor +NetworkClient::NetworkClient(size_t reserveSize) + : _doc(reserveSize), + _valid(false) +{ +} + +// Skip GZIP Header an goto DEFLATE content +int NetworkClient::skipGzipHeader(const uint8_t* data, size_t len) { + if (len < 10) return -1; + + if (data[0] != 0x1F || data[1] != 0x8B || data[2] != 8) { + return -1; + } + + size_t pos = 10; + uint8_t flags = data[3]; + + if (flags & 4) { + if (pos + 2 > len) return -1; + uint16_t xlen = data[pos] | (data[pos+1] << 8); + pos += 2 + xlen; + } + + if (flags & 8) { + while (pos < len && data[pos] != 0) pos++; + pos++; + } + + if (flags & 16) { + while (pos < len && data[pos] != 0) pos++; + pos++; + } + + if (flags & 2) pos += 2; + + if (pos >= len) return -1; + + return pos; +} + +// HTTP GET + GZIP Decompression (reading in chunks) +bool NetworkClient::httpGetGzip(const String& url, uint8_t*& outData, size_t& outLen) { + + const size_t capacity = READLIMIT; // Read limit for data (can be adjusted in NetworkClient.h) + uint8_t* buffer = (uint8_t*)malloc(capacity); + + if (!buffer) { + if (DEBUG) {Serial.println("Malloc failed (buffer");} + return false; + } + + HTTPClient http; + + // Timeouts to prevent hanging connections + http.setConnectTimeout(CONNECTIONTIMEOUT); // Connect timeout in ms (can be adjusted in NetworkClient.h) + http.setTimeout(TCPREADTIMEOUT); // Read timeout in ms (can be adjusted in NetworkClient.h) + + http.begin(url); + http.addHeader("Accept-Encoding", "gzip"); + + int code = http.GET(); + if (code != HTTP_CODE_OK) { + Serial.printf("HTTP ERROR: %d\n", code); + + // Hard reset HTTP + socket + WiFiClient* tmp = http.getStreamPtr(); + if (tmp) tmp->stop(); // Force close TCP socket + http.end(); + + free(buffer); + return false; + } + + WiFiClient* stream = http.getStreamPtr(); + + size_t len = 0; + uint32_t lastData = millis(); + const uint32_t READ_TIMEOUT = READDATATIMEOUT; // Timeout for reading data (can be adjusted in NetworkClient.h) + + bool complete = false; + + while (http.connected() && !complete) { + + size_t avail = stream->available(); + + if (avail == 0) { + if (millis() - lastData > READ_TIMEOUT) { + Serial.println("TIMEOUT waiting for data!"); + break; + } + delay(1); + continue; + } + + if (len + avail > capacity) + avail = capacity - len; + + int read = stream->readBytes(buffer + len, avail); + len += read; + lastData = millis(); + + if (DEBUG) {Serial.printf("Read chunk: %d (total: %d)\n", read, (int)len);} + + if (len < 20) continue; // Not enough data for header + + int headerOffset = skipGzipHeader(buffer, len); + if (headerOffset < 0) continue; + + unsigned long testLen = len * 8; // Dynamic expansion + uint8_t* test = (uint8_t*)malloc(testLen); + + if (!test) continue; + + unsigned long srcLen = len - headerOffset; + + int res = puff(test, &testLen, buffer + headerOffset, &srcLen); + if (res == 0) { + if (DEBUG) {Serial.printf("Decompress OK! Size: %lu bytes\n", testLen);} + outData = test; + outLen = testLen; + complete = true; + break; + } + + free(test); + } + + // --- Added: Force-close connection in all cases to avoid stuck TCP sockets --- + if (stream) stream->stop(); + + http.end(); + free(buffer); + + if (!complete) { + Serial.println("Failed to complete decompress."); + return false; + } + + return true; +} + +// Decompress JSON +bool NetworkClient::fetchAndDecompressJson(const String& url) { + + _valid = false; + + uint8_t* raw = nullptr; + size_t rawLen = 0; + + if (!httpGetGzip(url, raw, rawLen)) { + Serial.println("GZIP download/decompress failed."); + return false; + } + + DeserializationError err = deserializeJson(_doc, raw, rawLen); + free(raw); + + if (err) { + Serial.printf("JSON ERROR: %s\n", err.c_str()); + return false; + } + + if (DEBUG) {Serial.println("JSON OK!");} + _valid = true; + return true; +} + +JsonDocument& NetworkClient::json() { + return _doc; +} + +bool NetworkClient::isValid() const { + return _valid; +} diff --git a/lib/obp60task/NetworkClient.h b/lib/obp60task/NetworkClient.h new file mode 100644 index 0000000..84d7a87 --- /dev/null +++ b/lib/obp60task/NetworkClient.h @@ -0,0 +1,27 @@ +#pragma once +#include +#include +#include + +#define DEBUG false // Debug flag for NetworkClient for more live information +#define READLIMIT 200000 // HTTP read limit in byte for gzip content (can be adjusted) +#define CONNECTIONTIMEOUT 3000 // Timeout in ms for HTTP connection +#define TCPREADTIMEOUT 2000 // Timeout in ms for read HTTP client stack +#define READDATATIMEOUT 2000 // Timeout in ms for read data + +class NetworkClient { +public: + NetworkClient(size_t reserveSize = 0); + + bool fetchAndDecompressJson(const String& url); + JsonDocument& json(); + bool isValid() const; + +private: + DynamicJsonDocument _doc; + bool _valid; + + int skipGzipHeader(const uint8_t* data, size_t len); + bool httpGetGzip(const String& url, uint8_t*& outData, size_t& outLen); +}; + diff --git a/lib/obp60task/OBP60Extensions.cpp b/lib/obp60task/OBP60Extensions.cpp index e45c90b..76c6334 100644 --- a/lib/obp60task/OBP60Extensions.cpp +++ b/lib/obp60task/OBP60Extensions.cpp @@ -1,9 +1,9 @@ #if defined BOARD_OBP60S3 || defined BOARD_OBP40S3 #include -#include // Driver for PCF8574 output modul from Horter #include // I2C #include // Driver for DS1388 RTC +#include // PCF8574 modules from Horter #include "SunRise.h" // Lib for sunrise and sunset calculation #include "Pagedata.h" #include "OBP60Hardware.h" @@ -27,9 +27,7 @@ #include "fonts/IBM8x8px.h" // E-Ink Display -#define GxEPD_WIDTH 400 // Display width -#define GxEPD_HEIGHT 300 // Display height - +// Definition for e-paper width an height refer OBP60Hardware.h #ifdef DISPLAY_GDEW042T2 // Set display type and SPI pins for display GxEPD2_BW display(GxEPD2_420(OBP_SPI_CS, OBP_SPI_DC, OBP_SPI_RST, OBP_SPI_BUSY)); // GDEW042T2 400x300, UC8176 (IL0398) @@ -59,7 +57,7 @@ GxEPD2_BW & getdisplay(){r #endif // Horter I2C moduls -PCF8574 pcf8574_Out(PCF8574_I2C_ADDR1); // First digital output modul PCF8574 from Horter +PCF8574 pcf8574_Modul1(PCF8574_I2C_ADDR1); // First digital IO modul PCF8574 from Horter // FRAM Adafruit_FRAM_I2C fram; @@ -90,10 +88,11 @@ void hardwareInit(GwApi *api) Wire.begin(); // Init PCF8574 digital outputs - Wire.setClock(I2C_SPEED); // Set I2C clock on 10 kHz - if(pcf8574_Out.begin()){ // Initialize PCF8574 - pcf8574_Out.write8(255); // Clear all outputs + Wire.setClock(I2C_SPEED_LOW); // Set I2C clock on 10 kHz + if(pcf8574_Modul1.begin()){ // Initialize PCF8574 + pcf8574_Modul1.write8(255); // Clear all outputs (low activ) } + Wire.setClock(I2C_SPEED); // Set I2C clock on 100 kHz fram = Adafruit_FRAM_I2C(); if (esp_reset_reason() == ESP_RST_POWERON) { // help initialize FRAM @@ -194,6 +193,28 @@ void powerInit(String powermode) { } } +void setPCF8574PortPinModul1(uint8_t pin, uint8_t value) +{ + static bool firstRunFinished; + static uint8_t port1; // Retained data for port bits + // If fisrt run then set all outputs to low + if(firstRunFinished == false){ + port1 = 255; // Low active + firstRunFinished = true; + } + if (pin > 7) return; + Wire.setClock(I2C_SPEED_LOW); // Set I2C clock on 10 kHz for longer wires + // Set bit + if (pcf8574_Modul1.begin(port1)) // Check module availability and start it + { + if (value == LOW) port1 &= ~(1 << pin); // Set bit + else port1 |= (1 << pin); + pcf8574_Modul1.write8(port1); // Write byte + } + Wire.setClock(I2C_SPEED); // Set I2C clock on 100 kHz +} + + void setPortPin(uint pin, bool value){ pinMode(pin, OUTPUT); digitalWrite(pin, value); @@ -310,6 +331,40 @@ void toggleBacklightLED(uint brightness, const Color &color){ ledTaskData->setLedData(current); } +void stepsBacklightLED(uint brightness, const Color &color){ + static uint step = 0; + uint actBrightness = 0; + // Different brightness steps + if(step == 0){ + actBrightness = brightness; // 100% from brightess + statusBacklightLED = true; + } + if(step == 1){ + actBrightness = brightness * 0.5; // 50% from brightess + statusBacklightLED = true; + } + if(step == 2){ + actBrightness = brightness * 0.2; // 20% from brightess + statusBacklightLED = true; + } + if(step == 3){ + actBrightness = 0; // 0% + statusBacklightLED = false; + } + if(actBrightness < 5){ // Limiter if values too low + actBrightness = 5; + } + step = step + 1; // Increment step counter + if(step == 4){ // Reset counter + step = 0; + } + if (ledTaskData == nullptr) return; + Color nv=setBrightness(statusBacklightLED?color:COLOR_BLACK,actBrightness); + LedInterface current=ledTaskData->getLedData(); + current.setBacklight(nv); + ledTaskData->setLedData(current); +} + void setFlashLED(bool status){ if (ledTaskData == nullptr) return; Color c=status?COLOR_RED:COLOR_BLACK; @@ -429,12 +484,33 @@ void drawTextCenter(int16_t cx, int16_t cy, String text) { getdisplay().print(text); } +// Draw centered botton with centered text +void drawButtonCenter(int16_t cx, int16_t cy, int8_t sx, int8_t sy, String text, uint16_t fg, uint16_t bg, bool inverted) { + int16_t x1, y1; + uint16_t w, h; + uint16_t color; + + getdisplay().getTextBounds(text, cx, cy, &x1, &y1, &w, &h); // Find text center + getdisplay().setCursor(cx - w/2, cy + h/2); // Set cursor to center + //getdisplay().drawPixel(cx, cy, fg); // Debug pixel for center position + if (inverted) { + getdisplay().fillRoundRect(cx - sx / 2, cy - sy / 2, sx, sy, 5, fg); // Draw button + getdisplay().setTextColor(bg); + getdisplay().print(text); // Draw text + } + else{ + getdisplay().drawRoundRect(cx - sx / 2, cy - sy / 2, sx, sy, 5, fg); // Draw button + getdisplay().setTextColor(fg); + getdisplay().print(text); // Draw text + } +} + // Draw right aligned text void drawTextRalign(int16_t x, int16_t y, String text) { int16_t x1, y1; uint16_t w, h; getdisplay().getTextBounds(text, 0, 150, &x1, &y1, &w, &h); - getdisplay().setCursor(x - w, y); + getdisplay().setCursor(x - w - 1, y); // '-1' required since some strings wrap around w/o it getdisplay().print(text); } @@ -905,4 +981,30 @@ void doImageRequest(GwApi *api, int *pageno, const PageStruct pages[MAX_PAGE_NUM imageBuffer.clear(); } + + +// Calculate the distance between two Geo coordinates +double distanceBetweenCoordinates(double lat1, double lon1, double lat2, double lon2) { + // Grad → Radiant + double lat1Rad = lat1 * DEG_TO_RAD; + double lon1Rad = lon1 * DEG_TO_RAD; + double lat2Rad = lat2 * DEG_TO_RAD; + double lon2Rad = lon2 * DEG_TO_RAD; + + // Differenzen + double dLat = lat2Rad - lat1Rad; + double dLon = lon2Rad - lon1Rad; + + // Haversine-Formel + double a = sin(dLat / 2.0) * sin(dLat / 2.0) + + cos(lat1Rad) * cos(lat2Rad) * + sin(dLon / 2.0) * sin(dLon / 2.0); + + double c = 2.0 * atan2(sqrt(a), sqrt(1.0 - a)); + + // Abstand in Metern + return double(EARTH_RADIUS) * c; +} + + #endif diff --git a/lib/obp60task/OBP60Extensions.h b/lib/obp60task/OBP60Extensions.h index 15d2396..604c356 100644 --- a/lib/obp60task/OBP60Extensions.h +++ b/lib/obp60task/OBP60Extensions.h @@ -7,6 +7,7 @@ #include "Graphics.h" #include // E-paper lib V2 #include // I2C FRAM +#include #ifdef BOARD_OBP40S3 #include "esp_vfs_fat.h" @@ -30,6 +31,9 @@ #define FRAM_BAROGRAPH_START 0x0400 #define FRAM_BAROGRAPH_END 0x13FF +#define PI 3.1415926535897932384626433832795 +#define EARTH_RADIUS 6371000.0 + extern Adafruit_FRAM_I2C fram; extern bool hasFRAM; extern bool hasSDCard; @@ -85,13 +89,14 @@ uint8_t getLastPage(); void hardwareInit(GwApi *api); void powerInit(String powermode); +void setPCF8574PortPinModul1(uint8_t pin, uint8_t value);// Set PCF8574 port pin void setPortPin(uint pin, bool value); // Set port pin for extension port - void togglePortPin(uint pin); // Toggle extension port pin Color colorMapping(const String &colorString); // Color mapping string to CHSV colors void setBacklightLED(uint brightness, const Color &color);// Set backlight LEDs void toggleBacklightLED(uint brightness,const Color &color);// Toggle backlight LEDs +void stepsBacklightLED(uint brightness, const Color &color);// Set backlight LEDs in 4 steps (100%, 50%, 10%, 0%) BacklightMode backlightMapping(const String &backlightString);// Configuration string to value void setFlashLED(bool status); // Set flash LED @@ -104,6 +109,7 @@ void setBuzzerPower(uint power); // Set buzzer power String xdrDelete(String input); // Delete xdr prefix from string void drawTextCenter(int16_t cx, int16_t cy, String text); +void drawButtonCenter(int16_t cx, int16_t cy, int8_t sx, int8_t sy, String text, uint16_t fg, uint16_t bg, bool inverted); void drawTextRalign(int16_t x, int16_t y, String text); void drawTextBoxed(Rect box, String text, uint16_t fg, uint16_t bg, bool inverted, bool border); diff --git a/lib/obp60task/OBP60Formatter.cpp b/lib/obp60task/OBP60Formatter.cpp index cfdcc96..9b42102 100644 --- a/lib/obp60task/OBP60Formatter.cpp +++ b/lib/obp60task/OBP60Formatter.cpp @@ -49,12 +49,22 @@ String formatLongitude(double lon) { return String(degree, 0) + "\x90 " + String(minute, 4) + "' " + ((lon > 0) ? "E" : "W"); } -FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ +// Convert and format boat value from SI to user defined format (definition for compatibility purposes) +FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata) { + + return formatValue(value, commondata, false); // call with standard handling of user setting for simulation data +} + +// Convert and format boat value from SI to user defined format +// generate random simulation data; can be deselected to use conversion+formatting function even in simulation mode +FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata, bool ignoreSimuDataSetting){ GwLog *logger = commondata.logger; FormattedData result; static int dayoffset = 0; double rawvalue = 0; + result.cvalue = value->value; + // Load configuration values String stimeZone = commondata.config->getString(commondata.config->timeZone); // [UTC -14.00...+12.00] double timeZone = stimeZone.toDouble(); @@ -64,9 +74,15 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ String windspeedFormat = commondata.config->getString(commondata.config->windspeedFormat); // [m/s|km/h|kn|bft] String tempFormat = commondata.config->getString(commondata.config->tempFormat); // [K|°C|°F] String dateFormat = commondata.config->getString(commondata.config->dateFormat); // [DE|GB|US] - bool usesimudata = commondata.config->getBool(commondata.config->useSimuData); // [on|off] String precision = commondata.config->getString(commondata.config->valueprecision); // [1|2] + bool usesimudata; + if (ignoreSimuDataSetting){ + usesimudata = false; // ignore user setting for simulation data; we want to format the boat value passed to this function + } else { + usesimudata = commondata.config->getBool(commondata.config->useSimuData); // [on|off] + } + // If boat value not valid if (! value->valid && !usesimudata){ result.svalue = "---"; @@ -76,14 +92,24 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ const char* fmt_dec_1; const char* fmt_dec_10; const char* fmt_dec_100; + double limit_dec_10; + double limit_dec_100; if (precision == "1") { - fmt_dec_1 = "%3.1f"; - fmt_dec_10 = "%3.0f"; - fmt_dec_100 = "%3.0f"; + // + //All values are displayed using a DSEG7* font. In this font, ' ' is a very short space, and '.' takes up no space at all. + //For a space that is as long as a number, '!' is used. For details see https://www.keshikan.net/fonts-e.html + // + fmt_dec_1 = "!%1.1f"; //insert a blank digit and then display a two-digit number + fmt_dec_10 = "!%2.0f"; //insert a blank digit and then display a two-digit number + fmt_dec_100 = "%3.0f"; //dispay a three digit number + limit_dec_10=9.95; // use fmt_dec_1 below this number to avoid formatting 9.96 as 10.0 instead of 10 + limit_dec_100=99.5; } else { fmt_dec_1 = "%3.2f"; fmt_dec_10 = "%3.1f"; fmt_dec_100 = "%3.0f"; + limit_dec_10=9.995; + limit_dec_100=99.95; } // LOG_DEBUG(GwLog::DEBUG,"formatValue init: getFormat: %s date->value: %f time->value: %f", value->getFormat(), commondata.date->value, commondata.time->value); @@ -149,6 +175,7 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ val = modf(val*3600.0/60.0, &intmin); modf(val*60.0,&intsec); snprintf(buffer, bsize, "%02.0f:%02.0f:%02.0f", inthr, intmin, intsec); + result.cvalue = timeInSeconds; } else{ static long sec; @@ -158,6 +185,7 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ } sec = sec % 60; snprintf(buffer, bsize, "11:36:%02i", int(sec)); + result.cvalue = sec; lasttime = millis(); } if(timeZone == 0){ @@ -178,6 +206,7 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ snprintf(buffer, bsize, "%3.0f", rawvalue); } result.unit = ""; + result.cvalue = rawvalue; } //######################################################## else if (value->getFormat() == "formatCourse" || value->getFormat() == "formatWind"){ @@ -187,14 +216,15 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = value->value; } else { - course = 2.53 + float(random(0, 10) / 100.0); + course = M_PI_2 + float(random(-17, 17) / 100.0); // create random course/wind values with 90° +/- 10° rawvalue = course; } - course = course * 57.2958; // Unit conversion form rad to deg + course = course * RAD_TO_DEG; // Unit conversion form rad to deg // Format 3 numbers with prefix zero snprintf(buffer,bsize,"%03.0f",course); result.unit = "Deg"; + result.cvalue = course; } //######################################################## else if (value->getFormat() == "formatKnots" && (value->getName() == "SOG" || value->getName() == "STW")){ @@ -204,7 +234,7 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = value->value; } else{ - rawvalue = 4.0 + float(random(0, 40)); + rawvalue = 4.0 + float(random(-30, 40) / 10.0); // create random speed values from [1..8] m/s speed = rawvalue; } if (String(speedFormat) == "km/h"){ @@ -219,15 +249,16 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ speed = speed; // Unit conversion form m/s to m/s result.unit = "m/s"; } - if(speed < 10) { + if(speed < limit_dec_10) { snprintf(buffer, bsize, fmt_dec_1, speed); } - else if (speed < 100) { + else if (speed < limit_dec_100) { snprintf(buffer, bsize, fmt_dec_10, speed); } else { snprintf(buffer, bsize, fmt_dec_100, speed); } + result.cvalue = speed; } //######################################################## else if (value->getFormat() == "formatKnots" && (value->getName() == "AWS" || value->getName() == "TWS" || value->getName() == "MaxAws" || value->getName() == "MaxTws")){ @@ -237,7 +268,7 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = value->value; } else { - rawvalue = 4.0 + float(random(0, 40)); + rawvalue = 4.0 + float(random(0, 40) / 10.0); // create random wind speed values from [4..8] m/s speed = rawvalue; } if (String(windspeedFormat) == "km/h"){ @@ -298,16 +329,17 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ snprintf(buffer, bsize, "%2.0f", speed); } else{ - if (speed < 10){ + if (speed < limit_dec_10){ snprintf(buffer, bsize, fmt_dec_1, speed); } - else if (speed < 100){ + else if (speed < limit_dec_100){ snprintf(buffer, bsize, fmt_dec_10, speed); } else { snprintf(buffer, bsize, fmt_dec_100, speed); } } + result.cvalue = speed; } //######################################################## else if (value->getFormat() == "formatRot"){ @@ -334,6 +366,7 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ if (rotation <= -10 || rotation >= 10){ snprintf(buffer, bsize, "%3.0f", rotation); } + result.cvalue = rotation; } //######################################################## else if (value->getFormat() == "formatDop"){ @@ -350,15 +383,16 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ if (dop > 99.9){ dop = 99.9; } - if (dop < 10){ + if (dop < limit_dec_10){ snprintf(buffer, bsize, fmt_dec_1, dop); } - else if(dop < 100){ + else if(dop < limit_dec_100){ snprintf(buffer, bsize, fmt_dec_10, dop); } else { snprintf(buffer, bsize, fmt_dec_100, dop); } + result.cvalue = dop; } //######################################################## else if (value->getFormat() == "formatLatitude"){ @@ -383,6 +417,7 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = 35.0 + float(random(0, 10)) / 10000.0; snprintf(buffer, bsize, " 51\" %2.4f' N", rawvalue); } + result.cvalue = rawvalue; } //######################################################## else if (value->getFormat() == "formatLongitude"){ @@ -407,6 +442,7 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = 6.0 + float(random(0, 10)) / 100000.0; snprintf(buffer, bsize, " 15\" %2.4f'", rawvalue); } + result.cvalue = rawvalue; } //######################################################## else if (value->getFormat() == "formatDepth"){ @@ -416,7 +452,7 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = value->value; } else { - rawvalue = 18.0 + float(random(0, 100)) / 10.0; + rawvalue = 18.0 + float(random(0, 100)) / 10.0; // create random depth values from [18..28] metres depth = rawvalue; } if(String(lengthFormat) == "ft"){ @@ -426,15 +462,16 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ else{ result.unit = "m"; } - if (depth < 10) { + if (depth < limit_dec_10) { snprintf(buffer, bsize, fmt_dec_1, depth); } - else if (depth < 100){ + else if (depth < limit_dec_100){ snprintf(buffer, bsize, fmt_dec_10, depth); } else { snprintf(buffer, bsize, fmt_dec_100, depth); } + result.cvalue = depth; } //######################################################## else if (value->getFormat() == "formatXte"){ @@ -467,6 +504,7 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ if(xte >= 100){ snprintf(buffer,bsize,"%3.0f",xte); } + result.cvalue = xte; } //######################################################## else if (value->getFormat() == "kelvinToC"){ @@ -490,15 +528,16 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ else{ result.unit = "K"; } - if(temp < 10) { + if(temp < limit_dec_10) { snprintf(buffer, bsize, fmt_dec_1, temp); } - else if (temp < 100) { + else if (temp < limit_dec_100) { snprintf(buffer, bsize, fmt_dec_10, temp); } else { snprintf(buffer, bsize, fmt_dec_100, temp); } + result.cvalue = temp; } //######################################################## else if (value->getFormat() == "mtr2nm"){ @@ -522,15 +561,16 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ else { result.unit = "m"; } - if (distance < 10){ + if (distance < limit_dec_10){ snprintf(buffer, bsize, fmt_dec_1, distance); } - else if (distance < 100){ + else if (distance < limit_dec_100){ snprintf(buffer, bsize, fmt_dec_10, distance); } else { snprintf(buffer, bsize, fmt_dec_100, distance); } + result.cvalue = distance; } //######################################################## // Special XDR formats @@ -549,6 +589,7 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ } snprintf(buffer, bsize, "%4.0f", pressure); result.unit = "hPa"; + result.cvalue = pressure; } //######################################################## else if (value->getFormat() == "formatXdr:P:B"){ @@ -564,6 +605,7 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ } snprintf(buffer, bsize, "%4.0f", pressure); result.unit = "mBar"; + result.cvalue = pressure; } //######################################################## else if (value->getFormat() == "formatXdr:U:V"){ @@ -576,13 +618,14 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = 12 + float(random(0, 30)) / 10.0; voltage = rawvalue; } - if (voltage < 10) { + if (voltage < limit_dec_10) { snprintf(buffer, bsize, fmt_dec_1, voltage); } else { snprintf(buffer, bsize, fmt_dec_10, voltage); } result.unit = "V"; + result.cvalue = voltage; } //######################################################## else if (value->getFormat() == "formatXdr:I:A"){ @@ -595,16 +638,17 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = 8.2 + float(random(0, 50)) / 10.0; current = rawvalue; } - if (current < 10) { + if (current < limit_dec_10) { snprintf(buffer, bsize, fmt_dec_1, current); } - else if(current < 100) { + else if(current < limit_dec_100) { snprintf(buffer, bsize, fmt_dec_10, current); } else { snprintf(buffer, bsize, fmt_dec_100, current); } result.unit = "A"; + result.cvalue = current; } //######################################################## else if (value->getFormat() == "formatXdr:C:K"){ @@ -617,16 +661,17 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = 21.8 + float(random(0, 50)) / 10.0; temperature = rawvalue; } - if (temperature < 10) { + if (temperature < limit_dec_10) { snprintf(buffer, bsize, fmt_dec_1, temperature); } - else if (temperature < 100) { + else if (temperature < limit_dec_100) { snprintf(buffer, bsize, fmt_dec_10, temperature); } else { snprintf(buffer, bsize, fmt_dec_100, temperature); } result.unit = "Deg C"; + result.cvalue = temperature; } //######################################################## else if (value->getFormat() == "formatXdr:C:C"){ @@ -639,16 +684,17 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = 21.8 + float(random(0, 50)) / 10.0; temperature = rawvalue; } - if (temperature < 10) { + if (temperature < limit_dec_10) { snprintf(buffer, bsize, fmt_dec_1, temperature); } - else if(temperature < 100) { + else if(temperature < limit_dec_100) { snprintf(buffer, bsize, fmt_dec_10, temperature); } else { snprintf(buffer, bsize, fmt_dec_100, temperature); } result.unit = "Deg C"; + result.cvalue = temperature; } //######################################################## else if (value->getFormat() == "formatXdr:H:P"){ @@ -661,16 +707,17 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = 41.3 + float(random(0, 50)) / 10.0; humidity = rawvalue; } - if (humidity < 10) { + if (humidity < limit_dec_10) { snprintf(buffer, bsize, fmt_dec_1, humidity); } - else if(humidity < 100) { + else if(humidity < limit_dec_100) { snprintf(buffer, bsize, fmt_dec_10, humidity); } else { snprintf(buffer, bsize, fmt_dec_100, humidity); } result.unit = "%"; + result.cvalue = humidity; } //######################################################## else if (value->getFormat() == "formatXdr:V:P"){ @@ -683,16 +730,17 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = 85.8 + float(random(0, 50)) / 10.0; volume = rawvalue; } - if (volume < 10) { + if (volume < limit_dec_10) { snprintf(buffer, bsize, fmt_dec_1, volume); } - else if (volume < 100) { + else if (volume < limit_dec_100) { snprintf(buffer, bsize, fmt_dec_10, volume); } - else if (volume >= 100) { + else if (volume >= limit_dec_100) { snprintf(buffer, bsize, fmt_dec_100, volume); } result.unit = "%"; + result.cvalue = volume; } //######################################################## else if (value->getFormat() == "formatXdr:V:M"){ @@ -705,16 +753,17 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = 75.2 + float(random(0, 50)) / 10.0; volume = rawvalue; } - if (volume < 10) { + if (volume < limit_dec_10) { snprintf(buffer, bsize, fmt_dec_1, volume); } - else if (volume < 100) { + else if (volume < limit_dec_100) { snprintf(buffer, bsize, fmt_dec_10, volume); } else { snprintf(buffer, bsize, fmt_dec_100, volume); } result.unit = "l"; + result.cvalue = volume; } //######################################################## else if (value->getFormat() == "formatXdr:R:I"){ @@ -727,16 +776,17 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = 7.5 + float(random(0, 20)) / 10.0; flow = rawvalue; } - if (flow < 10) { + if (flow < limit_dec_10) { snprintf(buffer, bsize, fmt_dec_1, flow); } - else if (flow < 100) { + else if (flow < limit_dec_100) { snprintf(buffer, bsize, fmt_dec_10, flow); } else { snprintf(buffer, bsize, fmt_dec_100, flow); } result.unit = "l/min"; + result.cvalue = flow; } //######################################################## else if (value->getFormat() == "formatXdr:G:"){ @@ -749,16 +799,17 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = 18.5 + float(random(0, 20)) / 10.0; generic = rawvalue; } - if (generic < 10) { + if (generic < limit_dec_10) { snprintf(buffer, bsize, fmt_dec_1, generic); } - else if (generic < 100) { + else if (generic < limit_dec_100) { snprintf(buffer, bsize, fmt_dec_10, generic); } else { snprintf(buffer, bsize, fmt_dec_100, generic); } result.unit = ""; + result.cvalue = generic; } //######################################################## else if (value->getFormat() == "formatXdr:A:P"){ @@ -771,16 +822,17 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = 55.3 + float(random(0, 20)) / 10.0; dplace = rawvalue; } - if (dplace < 10) { + if (dplace < limit_dec_10) { snprintf(buffer, bsize, fmt_dec_1, dplace); } - else if (dplace < 100) { + else if (dplace < limit_dec_100) { snprintf(buffer, bsize, fmt_dec_10, dplace); } else { snprintf(buffer, bsize, fmt_dec_100, dplace); } result.unit = "%"; + result.cvalue = dplace; } //######################################################## else if (value->getFormat() == "formatXdr:A:D"){ @@ -801,6 +853,7 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ snprintf(buffer,bsize,"%3.0f",angle); } result.unit = "Deg"; + result.cvalue = angle; } //######################################################## else if (value->getFormat() == "formatXdr:T:R"){ @@ -813,31 +866,33 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ rawvalue = 2505 + random(0, 20); rpm = rawvalue; } - if (rpm < 10) { + if (rpm < limit_dec_10) { snprintf(buffer, bsize, fmt_dec_1, rpm); } - else if (rpm < 100) { + else if (rpm < limit_dec_100) { snprintf(buffer, bsize, fmt_dec_10, rpm); } else { snprintf(buffer, bsize, fmt_dec_100, rpm); } result.unit = "rpm"; + result.cvalue = rpm; } //######################################################## // Default format //######################################################## else { - if (value->value < 10) { + if (value->value < limit_dec_10) { snprintf(buffer, bsize, fmt_dec_1, value->value); } - else if (value->value < 100) { + else if (value->value < limit_dec_100) { snprintf(buffer, bsize, fmt_dec_10, value->value); } else { snprintf(buffer, bsize, fmt_dec_100, value->value); } result.unit = ""; + result.cvalue = value->value; } buffer[bsize] = 0; result.value = rawvalue; // Return value is only necessary in case of simulation of graphic pointer @@ -845,4 +900,30 @@ FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata){ return result; } +// Helper method for conversion of any data value from SI to user defined format +double convertValue(const double &value, const String &name, const String &format, CommonData &commondata) +{ + std::unique_ptr tmpBValue; // Temp variable to get converted data value from + double result; // data value converted to user defined target data format + constexpr bool NO_SIMUDATA = true; // switch off simulation feature of function + + // prepare temporary BoatValue structure for use in + tmpBValue = std::unique_ptr(new GwApi::BoatValue(name)); // we don't need boat value name for pure value conversion + tmpBValue->setFormat(format); + tmpBValue->valid = true; + tmpBValue->value = value; + + result = formatValue(tmpBValue.get(), commondata, NO_SIMUDATA).cvalue; // get value (converted); ignore any simulation data setting + return result; +} + +// Helper method for conversion of any data value from SI to user defined format +double convertValue(const double &value, const String &format, CommonData &commondata) +{ + double result; // data value converted to user defined target data format + + result = convertValue(value, "dummy", format, commondata); + return result; +} + #endif diff --git a/lib/obp60task/OBP60Hardware.h b/lib/obp60task/OBP60Hardware.h index ac366c8..6d038d3 100644 --- a/lib/obp60task/OBP60Hardware.h +++ b/lib/obp60task/OBP60Hardware.h @@ -1,11 +1,12 @@ // General hardware definitions // CAN and RS485 bus pin definitions see obp60task.h -#ifdef HARDWARE_V21 +#if defined HARDWARE_V20 || HARDWARE_V21 // Direction pin for RS485 NMEA0183 #define OBP_DIRECTION_PIN 18 // I2C - #define I2C_SPEED 10000UL // 10kHz clock speed on I2C bus + #define I2C_SPEED 10000UL // 100kHz clock speed on I2C bus + #define I2C_SPEED_LOW 1000UL // 10kHz clock speed on I2C bus for external bus #define OBP_I2C_SDA 47 #define OBP_I2C_SCL 21 // DS1388 RTC @@ -22,8 +23,8 @@ #define AS5600_I2C_ADDR 0x36 // Addr. 0x36 (fix) // INA219 #define SHUNT_VOLTAGE 0.075 // Shunt voltage in V by max. current (75mV) - #define INA219_I2C_ADDR1 0x40 // Addr. 0x41 (fix A0 = 5V, A1 = GND) for battery - #define INA219_I2C_ADDR2 0x41 // Addr. 0x44 (fix A0 = GND, A1 = 5V) for solar panels + #define INA219_I2C_ADDR1 0x41 // Addr. 0x41 (fix A0 = 5V, A1 = GND) for battery + #define INA219_I2C_ADDR2 0x44 // Addr. 0x44 (fix A0 = GND, A1 = 5V) for solar panels #define INA219_I2C_ADDR3 0x45 // Addr. 0x45 (fix A0 = 5V, A1 = 5V) for generator // INA226 #define INA226_I2C_ADDR1 0x41 // Addr. 0x41 (fix A0 = 5V, A1 = GND) for battery @@ -42,6 +43,8 @@ #define OBP_SPI_DIN 48 #define SHOW_TIME 6000 // Show time in [ms] for logo and WiFi QR code #define FULL_REFRESH_TIME 600 // Refresh cycle time in [s][600...3600] for full display update (very important healcy function) + #define GxEPD_WIDTH 400 // Display width + #define GxEPD_HEIGHT 300 // Display height // GPS (NEO-6M, NEO-M8N, ATGM336H) #define OBP_GPS_RX 2 @@ -82,7 +85,8 @@ // Direction pin for RS485 NMEA0183 #define OBP_DIRECTION_PIN 8 // I2C - #define I2C_SPEED 100000UL // 100kHz clock speed on I2C bus + #define I2C_SPEED 100000UL // 100kHz clock speed on I2C bus + #define I2C_SPEED_LOW 1000UL // 10kHz clock speed on I2C bus for external bus #define OBP_I2C_SDA 21 #define OBP_I2C_SCL 38 // DS1388 RTC @@ -99,8 +103,8 @@ #define AS5600_I2C_ADDR 0x36 // Addr. 0x36 (fix) // INA219 #define SHUNT_VOLTAGE 0.075 // Shunt voltage in V by max. current (75mV) - #define INA219_I2C_ADDR1 0x40 // Addr. 0x41 (fix A0 = 5V, A1 = GND) for battery - #define INA219_I2C_ADDR2 0x41 // Addr. 0x44 (fix A0 = GND, A1 = 5V) for solar panels + #define INA219_I2C_ADDR1 0x41 // Addr. 0x41 (fix A0 = 5V, A1 = GND) for battery + #define INA219_I2C_ADDR2 0x44 // Addr. 0x44 (fix A0 = GND, A1 = 5V) for solar panels #define INA219_I2C_ADDR3 0x45 // Addr. 0x45 (fix A0 = 5V, A1 = 5V) for generator // INA226 #define INA226_I2C_ADDR1 0x41 // Addr. 0x41 (fix A0 = 5V, A1 = GND) for battery @@ -119,6 +123,8 @@ #define OBP_SPI_DIN 11 #define SHOW_TIME 6000 // Show time in [ms] for logo and WiFi QR code #define FULL_REFRESH_TIME 600 // Refresh cycle time in [s][600...3600] for full display update (very important healcy function) + #define GxEPD_WIDTH 400 // Display width + #define GxEPD_HEIGHT 300 // Display height // SPI SD-Card #define SD_SPI_CS GPIO_NUM_10 #define SD_SPI_MOSI GPIO_NUM_40 diff --git a/lib/obp60task/OBP60Keypad.h b/lib/obp60task/OBP60Keypad.h index eafe3a2..d669ccb 100644 --- a/lib/obp60task/OBP60Keypad.h +++ b/lib/obp60task/OBP60Keypad.h @@ -58,7 +58,7 @@ void initKeys(CommonData &commonData) { commonData.keydata[5].h = height; } - #ifdef HARDWARE_V21 + #if defined HARDWARE_V20 || HARDWARE_V21 // Keypad functions for original OBP60 hardware int readKeypad(GwLog* logger, uint thSensitivity, bool use_syspage) { diff --git a/lib/obp60task/OBPDataOperations.cpp b/lib/obp60task/OBPDataOperations.cpp index 73908ac..c968e11 100644 --- a/lib/obp60task/OBPDataOperations.cpp +++ b/lib/obp60task/OBPDataOperations.cpp @@ -1,152 +1,345 @@ #include "OBPDataOperations.h" +//#include "BoatDataCalibration.h" // Functions lib for data instance calibration + +// --- Class CalibrationData --------------- +CalibrationData::CalibrationData(GwLog* log) +{ + logger = log; +} + +void CalibrationData::readConfig(GwConfigHandler* config) +// Initial load of calibration data into internal list +// This method is called once at init phase of to read the configuration values +{ + std::string instance; + double offset; + double slope; + double smooth; + + String calInstance = ""; + String calOffset = ""; + String calSlope = ""; + String calSmooth = ""; + + // Load user format configuration values + String lengthFormat = config->getString(config->lengthFormat); // [m|ft] + String distanceFormat = config->getString(config->distanceFormat); // [m|km|nm] + String speedFormat = config->getString(config->speedFormat); // [m/s|km/h|kn] + String windspeedFormat = config->getString(config->windspeedFormat); // [m/s|km/h|kn|bft] + String tempFormat = config->getString(config->tempFormat); // [K|C|F] + + // Read calibration settings for data instances + for (int i = 0; i < MAX_CALIBRATION_DATA; i++) { + calInstance = "calInstance" + String(i + 1); + calOffset = "calOffset" + String(i + 1); + calSlope = "calSlope" + String(i + 1); + calSmooth = "calSmooth" + String(i + 1); + + instance = std::string(config->getString(calInstance, "---").c_str()); + if (instance == "---") { + LOG_DEBUG(GwLog::LOG, "No calibration data for instance no. %d", i + 1); + continue; + } + + calibrationMap[instance] = { 0.0f, 1.0f, 1.0f, 0.0f, false }; + offset = (config->getString(calOffset, "")).toDouble(); + slope = (config->getString(calSlope, "")).toDouble(); + smooth = (config->getString(calSmooth, "")).toInt(); // user input is int; further math is done with double + + if (slope == 0.0) { + slope = 1.0; // eliminate adjustment if user selected "0" -> that would set the calibrated value to "0" + } + + // Convert calibration values from user input format to internal standard SI format + if (instance == "AWS" || instance == "TWS") { + if (windspeedFormat == "m/s") { + // No conversion needed + } else if (windspeedFormat == "km/h") { + offset /= 3.6; // Convert km/h to m/s + } else if (windspeedFormat == "kn") { + offset /= 1.94384; // Convert kn to m/s + } else if (windspeedFormat == "bft") { + offset *= 2 + (offset / 2); // Convert Bft to m/s (approx) -> to be improved + } + + } else if (instance == "AWA" || instance == "COG" || instance == "HDM" || instance == "HDT" || instance == "PRPOS" || instance == "RPOS" || instance == "TWA" || instance == "TWD") { + offset *= DEG_TO_RAD; // Convert deg to rad + + } else if (instance == "DBS" || instance == "DBT") { + if (lengthFormat == "m") { + // No conversion needed + } else if (lengthFormat == "ft") { + offset /= 3.28084; // Convert ft to m + } + + } else if (instance == "SOG" || instance == "STW") { + if (speedFormat == "m/s") { + // No conversion needed + } else if (speedFormat == "km/h") { + offset /= 3.6; // Convert km/h to m/s + } else if (speedFormat == "kn") { + offset /= 1.94384; // Convert kn to m/s + } + + } else if (instance == "WTemp") { + if (tempFormat == "K" || tempFormat == "C") { + // No conversion needed + } else if (tempFormat == "F") { + offset *= 9.0 / 5.0; // Convert °F to K + slope *= 9.0 / 5.0; // Convert °F to K + } + } + + // transform smoothing factor from [0.01..10] to [0.3..0.95] and invert for exponential smoothing formula + if (smooth <= 0) { + smooth = 0; + } else { + if (smooth > 10) { + smooth = 10; + } + smooth = 0.3 + ((smooth - 0.01) * (0.95 - 0.3) / (10 - 0.01)); + } + smooth = 1 - smooth; + + calibrationMap[instance].offset = offset; + calibrationMap[instance].slope = slope; + calibrationMap[instance].smooth = smooth; + calibrationMap[instance].isCalibrated = false; + LOG_DEBUG(GwLog::LOG, "Calibration data type added: %s, offset: %f, slope: %f, smoothing: %f", instance.c_str(), + calibrationMap[instance].offset, calibrationMap[instance].slope, calibrationMap[instance].smooth); + } + // LOG_DEBUG(GwLog::LOG, "All calibration data read"); +} + +// Handle calibrationMap and calibrate all boat data values +void CalibrationData::handleCalibration(BoatValueList* boatValueList) +{ + GwApi::BoatValue* bValue; + + for (const auto& cMap : calibrationMap) { + std::string instance = cMap.first.c_str(); + bValue = boatValueList->findValueOrCreate(String(instance.c_str())); + + calibrateInstance(bValue); + smoothInstance(bValue); + } +} + +// Calibrate single boat data value +// Return calibrated boat value or DBL_MAX, if no calibration was performed +bool CalibrationData::calibrateInstance(GwApi::BoatValue* boatDataValue) +{ + std::string instance = boatDataValue->getName().c_str(); + double offset = 0; + double slope = 1.0; + double dataValue = 0; + std::string format = ""; + + // we test this earlier, but for safety reasons ... + if (calibrationMap.find(instance) == calibrationMap.end()) { + LOG_DEBUG(GwLog::DEBUG, "BoatDataCalibration: %s not in calibration list", instance.c_str()); + return false; + } + + calibrationMap[instance].isCalibrated = false; // reset calibration flag until properly calibrated + + if (!boatDataValue->valid) { // no valid boat data value, so we don't want to apply calibration data + return false; + } + + offset = calibrationMap[instance].offset; + slope = calibrationMap[instance].slope; + dataValue = boatDataValue->value; + format = boatDataValue->getFormat().c_str(); + // LOG_DEBUG(GwLog::DEBUG, "BoatDataCalibration: %s: value: %f, format: %s", instance.c_str(), dataValue, format.c_str()); + + if (format == "formatWind") { // instance is of type angle + dataValue = (dataValue * slope) + offset; + // dataValue = WindUtils::toPI(dataValue); + dataValue = WindUtils::to2PI(dataValue); // we should call for format of [-180..180], but pages cannot display negative values properly yet + + } else if (format == "formatCourse") { // instance is of type direction + dataValue = (dataValue * slope) + offset; + dataValue = WindUtils::to2PI(dataValue); + + } else if (format == "kelvinToC") { // instance is of type temperature + dataValue = ((dataValue - 273.15) * slope) + offset + 273.15; + + } else { + dataValue = (dataValue * slope) + offset; + } + + + boatDataValue->value = dataValue; // update boat data value with calibrated value + calibrationMap[instance].value = dataValue; // store the calibrated value in the list + calibrationMap[instance].isCalibrated = true; + + // LOG_DEBUG(GwLog::DEBUG, "BoatDataCalibration: %s: Offset: %f, Slope: %f, Result: %f", instance.c_str(), offset, slope, calibrationMap[instance].value); + return true; +} + +// Smooth single boat data value +// Return smoothed boat value or DBL_MAX, if no smoothing was performed +bool CalibrationData::smoothInstance(GwApi::BoatValue* boatDataValue) +{ + std::string instance = boatDataValue->getName().c_str(); + double oldValue = 0; + double dataValue = boatDataValue->value; + double smoothFactor = 0; + + // we test this earlier, but for safety reason ... + if (calibrationMap.find(instance) == calibrationMap.end()) { + // LOG_DEBUG(GwLog::DEBUG, "BoatDataCalibration: %s not in calibration list", instance.c_str()); + return false; + } + + calibrationMap[instance].isCalibrated = false; // reset calibration flag until properly calibrated + + if (!boatDataValue->valid) { // no valid boat data value, so we don't need to do anything + return false; + } + + smoothFactor = calibrationMap[instance].smooth; + + if (lastValue.find(instance) != lastValue.end()) { + oldValue = lastValue[instance]; + dataValue = oldValue + (smoothFactor * (dataValue - oldValue)); // exponential smoothing algorithm + } + lastValue[instance] = dataValue; // store the new value for next cycle; first time, store only the current value and return + + boatDataValue->value = dataValue; // update boat data value with smoothed value + calibrationMap[instance].value = dataValue; // store the smoothed value in the list + calibrationMap[instance].isCalibrated = true; + + // LOG_DEBUG(GwLog::DEBUG, "BoatDataCalibration: %s: smooth: %f, oldValue: %f, result: %f", instance.c_str(), smoothFactor, oldValue, calibrationMap[instance].value); + + return true; +} +// --- End Class CalibrationData --------------- // --- Class HstryBuf --------------- -// Init history buffers for selected boat data -void HstryBuf::init(BoatValueList* boatValues, GwLog *log) { +HstryBuf::HstryBuf(const String& name, int size, BoatValueList* boatValues, GwLog* log) + : logger(log) + , boatDataName(name) +{ + hstryBuf.resize(size); + boatValue = boatValues->findValueOrCreate(name); +} - logger = log; - - int hstryUpdFreq = 1000; // Update frequency for history buffers in ms - int hstryMinVal = 0; // Minimum value for these history buffers - twdHstryMax = 6283; // Max value for wind direction (TWD, AWD) in rad [0...2*PI], shifted by 1000 for 3 decimals - twsHstryMax = 65000; // Max value for wind speed (TWS, AWS) in m/s [0..65], shifted by 1000 for 3 decimals - awdHstryMax = twdHstryMax; - awsHstryMax = twsHstryMax; - twdHstryMin = hstryMinVal; - twsHstryMin = hstryMinVal; - awdHstryMin = hstryMinVal; - awsHstryMin = hstryMinVal; - const double DBL_MAX = std::numeric_limits::max(); - - // Initialize history buffers with meta data - hstryBufList.twdHstry->setMetaData("TWD", "formatCourse", hstryUpdFreq, hstryMinVal, twdHstryMax); - hstryBufList.twsHstry->setMetaData("TWS", "formatKnots", hstryUpdFreq, hstryMinVal, twsHstryMax); - hstryBufList.awdHstry->setMetaData("AWD", "formatCourse", hstryUpdFreq, hstryMinVal, twdHstryMax); - hstryBufList.awsHstry->setMetaData("AWS", "formatKnots", hstryUpdFreq, hstryMinVal, twsHstryMax); - - // create boat values for history data types, if they don't exist yet - twdBVal = boatValues->findValueOrCreate(hstryBufList.twdHstry->getName()); - twsBVal = boatValues->findValueOrCreate(hstryBufList.twsHstry->getName()); - twaBVal = boatValues->findValueOrCreate("TWA"); - awdBVal = boatValues->findValueOrCreate(hstryBufList.awdHstry->getName()); - awsBVal = boatValues->findValueOrCreate(hstryBufList.awsHstry->getName()); - - if (!awdBVal->valid) { // AWD usually does not exist - awdBVal->setFormat(hstryBufList.awdHstry->getFormat()); - awdBVal->value = DBL_MAX; +void HstryBuf::init(const String& format, int updFreq, int mltplr, double minVal, double maxVal) +{ + hstryBuf.setMetaData(boatDataName, format, updFreq, mltplr, minVal, maxVal); + hstryMin = minVal; + hstryMax = maxVal; + if (!boatValue->valid) { + boatValue->setFormat(format); + boatValue->value = std::numeric_limits::max(); // mark current value invalid } +} + +void HstryBuf::add(double value) +{ + if (value >= hstryMin && value <= hstryMax) { + hstryBuf.add(value); + // LOG_DEBUG(GwLog::DEBUG, "HstryBuf::add: name: %s, value: %.3f", hstryBuf.getName(), value); + } +} + +void HstryBuf::handle(bool useSimuData, CommonData& common) +{ + // GwApi::BoatValue* tmpBVal; + std::unique_ptr tmpBVal; // Temp variable to get formatted and converted data value from OBP60Formatter + + // create temporary boat value for calibration purposes and retrieval of simulation value + // tmpBVal = new GwApi::BoatValue(boatDataName.c_str()); + tmpBVal = std::unique_ptr(new GwApi::BoatValue(boatDataName)); + tmpBVal->setFormat(boatValue->getFormat()); + tmpBVal->value = boatValue->value; + tmpBVal->valid = boatValue->valid; + + if (boatValue->valid) { + // Calibrate boat value before adding it to history buffer + //calibrationData.calibrateInstance(tmpBVal.get(), logger); + //add(tmpBVal->value); + add(boatValue->value); + + } else if (useSimuData) { // add simulated value to history buffer + double simSIValue = formatValue(tmpBVal.get(), common).value; // simulated value is generated at ; here: retreive SI value + add(simSIValue); + } else { + // here we will add invalid (DBL_MAX) value; this will mark periods of missing data in buffer together with a timestamp + } +} +// --- End Class HstryBuf --------------- + +// --- Class HstryBuffers --------------- +HstryBuffers::HstryBuffers(int size, BoatValueList* boatValues, GwLog* log) + : size(size) + , boatValueList(boatValues) + , logger(log) +{ // collect boat values for true wind calculation - awaBVal = boatValues->findValueOrCreate("AWA"); - hdtBVal = boatValues->findValueOrCreate("HDT"); - hdmBVal = boatValues->findValueOrCreate("HDM"); - varBVal = boatValues->findValueOrCreate("VAR"); - cogBVal = boatValues->findValueOrCreate("COG"); - sogBVal = boatValues->findValueOrCreate("SOG"); + // should all have been already created at true wind object initialization + // potentially to be moved to history buffer handling + awaBVal = boatValueList->findValueOrCreate("AWA"); + hdtBVal = boatValueList->findValueOrCreate("HDT"); + hdmBVal = boatValueList->findValueOrCreate("HDM"); + varBVal = boatValueList->findValueOrCreate("VAR"); + cogBVal = boatValueList->findValueOrCreate("COG"); + sogBVal = boatValueList->findValueOrCreate("SOG"); + awdBVal = boatValueList->findValueOrCreate("AWD"); } -// Handle history buffers for TWD, TWS, AWD, AWS -//void HstryBuf::handleHstryBuf(GwApi* api, BoatValueList* boatValues, bool useSimuData) { -void HstryBuf::handleHstryBuf(bool useSimuData) { - - static int16_t twd = 20; //initial value only relevant if we use simulation data - static uint16_t tws = 20; //initial value only relevant if we use simulation data - static double awd, aws, hdt = 20; //initial value only relevant if we use simulation data - GwApi::BoatValue *calBVal; // temp variable just for data calibration -> we don't want to calibrate the original data here - - LOG_DEBUG(GwLog::DEBUG,"obp60task handleHstryBuf: TWD_isValid? %d, twdBVal: %.1f, twaBVal: %.1f, twsBVal: %.1f", twdBVal->valid, twdBVal->value * RAD_TO_DEG, - twaBVal->value * RAD_TO_DEG, twsBVal->value * 3.6 / 1.852); - - if (twdBVal->valid) { - calBVal = new GwApi::BoatValue("TWD"); // temporary solution for calibration of history buffer values - calBVal->setFormat(twdBVal->getFormat()); - calBVal->value = twdBVal->value; - calBVal->valid = twdBVal->valid; - calibrationData.calibrateInstance(calBVal, logger); // Check if boat data value is to be calibrated - twd = static_cast(std::round(calBVal->value * 1000.0)); - if (twd >= twdHstryMin && twd <= twdHstryMax) { - hstryBufList.twdHstry->add(twd); - } - delete calBVal; - calBVal = nullptr; - } else if (useSimuData) { - twd += random(-20, 20); - twd = WindUtils::to360(twd); - hstryBufList.twdHstry->add(static_cast(DegToRad(twd) * 1000.0)); +// Create history buffer for boat data type +void HstryBuffers::addBuffer(const String& name) +{ + if (HstryBuffers::getBuffer(name) != nullptr) { // buffer for this data type already exists + return; + } + if (bufferParams.find(name) == bufferParams.end()) { // requested boat data type is not supported in list of + return; } - if (twsBVal->valid) { - calBVal = new GwApi::BoatValue("TWS"); // temporary solution for calibration of history buffer values - calBVal->setFormat(twsBVal->getFormat()); - calBVal->value = twsBVal->value; - calBVal->valid = twsBVal->valid; - calibrationData.calibrateInstance(calBVal, logger); // Check if boat data value is to be calibrated - tws = static_cast(std::round(calBVal->value * 1000)); - if (tws >= twsHstryMin && tws <= twsHstryMax) { - hstryBufList.twsHstry->add(tws); - } - delete calBVal; - calBVal = nullptr; - } else if (useSimuData) { - tws += random(-5000, 5000); // TWS value in m/s; expands to 3 decimals - tws = constrain(tws, 0, 25000); // Limit TWS to [0..25] m/s - hstryBufList.twsHstry->add(tws); - } + hstryBuffers[name] = std::unique_ptr(new HstryBuf(name, size, boatValueList, logger)); - if (awaBVal->valid) { - if (hdtBVal->valid) { - hdt = hdtBVal->value; // Use HDT if available - } else { - hdt = WindUtils::calcHDT(&hdmBVal->value, &varBVal->value, &cogBVal->value, &sogBVal->value); - } + // Initialize metadata for buffer + String valueFormat = bufferParams[name].format; // Data format of boat data type + // String valueFormat = boatValueList->findValueOrCreate(name)->getFormat().c_str(); // Unfortunately, format is not yet available during system initialization + int hstryUpdFreq = bufferParams[name].hstryUpdFreq; // Update frequency for history buffers in ms + int mltplr = bufferParams[name].mltplr; // default multiplier which transforms original value into buffer type format + double bufferMinVal = bufferParams[name].bufferMinVal; // Min value for this history buffer + double bufferMaxVal = bufferParams[name].bufferMaxVal; // Max value for this history buffer - awd = awaBVal->value + hdt; - awd = WindUtils::to2PI(awd); - calBVal = new GwApi::BoatValue("AWD"); // temporary solution for calibration of history buffer values - calBVal->value = awd; - calBVal->setFormat(awdBVal->getFormat()); - calBVal->valid = true; - calibrationData.calibrateInstance(calBVal, logger); // Check if boat data value is to be calibrated - awdBVal->value = calBVal->value; - awdBVal->valid = true; - awd = std::round(calBVal->value * 1000.0); - if (awd >= awdHstryMin && awd <= awdHstryMax) { - hstryBufList.awdHstry->add(static_cast(awd)); - } - delete calBVal; - calBVal = nullptr; - } else if (useSimuData) { - awd += random(-20, 20); - awd = WindUtils::to360(awd); - hstryBufList.awdHstry->add(static_cast(DegToRad(awd) * 1000.0)); - } - - if (awsBVal->valid) { - calBVal = new GwApi::BoatValue("AWS"); // temporary solution for calibration of history buffer values - calBVal->setFormat(awsBVal->getFormat()); - calBVal->value = awsBVal->value; - calBVal->valid = awsBVal->valid; - calibrationData.calibrateInstance(calBVal, logger); // Check if boat data value is to be calibrated - aws = std::round(calBVal->value * 1000); - if (aws >= awsHstryMin && aws <= awsHstryMax) { - hstryBufList.awsHstry->add(static_cast(aws)); - } - delete calBVal; - calBVal = nullptr; - } else if (useSimuData) { - aws += random(-5000, 5000); // TWS value in m/s; expands to 1 decimal - aws = constrain(aws, 0, 25000); // Limit TWS to [0..25] m/s - hstryBufList.awsHstry->add(aws); + hstryBuffers[name]->init(valueFormat, hstryUpdFreq, mltplr, bufferMinVal, bufferMaxVal); + LOG_DEBUG(GwLog::DEBUG, "HstryBuffers: new buffer added: name: %s, format: %s, multiplier: %d, min value: %.2f, max value: %.2f", name, valueFormat, mltplr, bufferMinVal, bufferMaxVal); +} + +// Handle all registered history buffers +void HstryBuffers::handleHstryBufs(bool useSimuData, CommonData& common) +{ + for (auto& bufMap : hstryBuffers) { + auto& buf = bufMap.second; + buf->handle(useSimuData, common); } } -// --- Class HstryBuf --------------- + +RingBuffer* HstryBuffers::getBuffer(const String& name) +{ + auto it = hstryBuffers.find(name); + if (it != hstryBuffers.end()) { + return &it->second->hstryBuf; + } + return nullptr; +} +// --- End Class HstryBuffers --------------- // --- Class WindUtils -------------- double WindUtils::to2PI(double a) { - a = fmod(a, 2 * M_PI); + a = fmod(a, M_TWOPI); if (a < 0.0) { - a += 2 * M_PI; + a += M_TWOPI; } return a; } @@ -162,18 +355,18 @@ double WindUtils::toPI(double a) double WindUtils::to360(double a) { - a = fmod(a, 360); + a = fmod(a, 360.0); if (a < 0.0) { - a += 360; + a += 360.0; } return a; } double WindUtils::to180(double a) { - a += 180; + a += 180.0; a = to360(a); - a -= 180; + a -= 180.0; return a; } @@ -205,14 +398,14 @@ void WindUtils::addPolar(const double* phi1, const double* r1, void WindUtils::calcTwdSA(const double* AWA, const double* AWS, const double* CTW, const double* STW, const double* HDT, - double* TWD, double* TWS, double* TWA) + double* TWD, double* TWS, double* TWA, double* AWD) { - double awd = *AWA + *HDT; - awd = to2PI(awd); + *AWD = *AWA + *HDT; + *AWD = to2PI(*AWD); double stw = -*STW; - addPolar(&awd, AWS, CTW, &stw, TWD, TWS); + addPolar(AWD, AWS, CTW, &stw, TWD, TWS); - // Normalize TWD and TWA to 0-360° + // Normalize TWD to [0..360°] (2PI) and TWA to [-180..180] (PI) *TWD = to2PI(*TWD); *TWA = toPI(*TWD - *HDT); } @@ -234,12 +427,12 @@ double WindUtils::calcHDT(const double* hdmVal, const double* varVal, const doub return hdt; } -bool WindUtils::calcTrueWind(const double* awaVal, const double* awsVal, +bool WindUtils::calcWinds(const double* awaVal, const double* awsVal, const double* cogVal, const double* stwVal, const double* sogVal, const double* hdtVal, - const double* hdmVal, const double* varVal, double* twdVal, double* twsVal, double* twaVal) + const double* hdmVal, const double* varVal, double* twdVal, double* twsVal, double* twaVal, double* awdVal) { double stw, hdt, ctw; - double twd, tws, twa; + double twd, tws, twa, awd; double minSogVal = 0.1; // SOG below this value (m/s) is assumed to be data noise from GPS sensor if (*hdtVal != DBL_MAX) { @@ -263,60 +456,81 @@ bool WindUtils::calcTrueWind(const double* awaVal, const double* awsVal, // If STW and SOG are not available, we cannot calculate true wind return false; } - // Serial.println("\ncalcTrueWind: HDT: " + String(hdt) + ", CTW: " + String(ctw) + ", STW: " + String(stw)); + // LOG_DEBUG(GwLog::DEBUG, "WindUtils:calcWinds: HDT: %.1f, CTW %.1f, STW %.1f", hdt, ctw, stw); if ((*awaVal == DBL_MAX) || (*awsVal == DBL_MAX)) { // Cannot calculate true wind without valid AWA, AWS; other checks are done earlier return false; } else { - calcTwdSA(awaVal, awsVal, &ctw, &stw, &hdt, &twd, &tws, &twa); + calcTwdSA(awaVal, awsVal, &ctw, &stw, &hdt, &twd, &tws, &twa, &awd); *twdVal = twd; *twsVal = tws; *twaVal = twa; + *awdVal = awd; return true; } } // Calculate true wind data and add to obp60task boat data list -bool WindUtils::addTrueWind(GwApi* api, BoatValueList* boatValues, GwLog* log) { +bool WindUtils::addWinds() +{ + double twd, tws, twa, awd, hdt; + bool twCalculated = false; + bool awdCalculated = false; - GwLog* logger = log; + double awaVal = awaBVal->valid ? awaBVal->value : DBL_MAX; + double awsVal = awsBVal->valid ? awsBVal->value : DBL_MAX; + double cogVal = cogBVal->valid ? cogBVal->value : DBL_MAX; + double stwVal = stwBVal->valid ? stwBVal->value : DBL_MAX; + double sogVal = sogBVal->valid ? sogBVal->value : DBL_MAX; + double hdtVal = hdtBVal->valid ? hdtBVal->value : DBL_MAX; + double hdmVal = hdmBVal->valid ? hdmBVal->value : DBL_MAX; + double varVal = varBVal->valid ? varBVal->value : DBL_MAX; + //LOG_DEBUG(GwLog::DEBUG, "WindUtils:addWinds: AWA %.1f, AWS %.1f, COG %.1f, STW %.1f, SOG %.2f, HDT %.1f, HDM %.1f, VAR %.1f", awaBVal->value * RAD_TO_DEG, awsBVal->value * 3.6 / 1.852, + // cogBVal->value * RAD_TO_DEG, stwBVal->value * 3.6 / 1.852, sogBVal->value * 3.6 / 1.852, hdtBVal->value * RAD_TO_DEG, hdmBVal->value * RAD_TO_DEG, varBVal->value * RAD_TO_DEG); - double awaVal, awsVal, cogVal, stwVal, sogVal, hdtVal, hdmVal, varVal; - double twd, tws, twa; - bool isCalculated = false; - - awaVal = awaBVal->valid ? awaBVal->value : DBL_MAX; - awsVal = awsBVal->valid ? awsBVal->value : DBL_MAX; - cogVal = cogBVal->valid ? cogBVal->value : DBL_MAX; - stwVal = stwBVal->valid ? stwBVal->value : DBL_MAX; - sogVal = sogBVal->valid ? sogBVal->value : DBL_MAX; - hdtVal = hdtBVal->valid ? hdtBVal->value : DBL_MAX; - hdmVal = hdmBVal->valid ? hdmBVal->value : DBL_MAX; - varVal = varBVal->valid ? varBVal->value : DBL_MAX; - LOG_DEBUG(GwLog::DEBUG,"obp60task addTrueWind: AWA %.1f, AWS %.1f, COG %.1f, STW %.1f, SOG %.2f, HDT %.1f, HDM %.1f, VAR %.1f", awaBVal->value * RAD_TO_DEG, awsBVal->value * 3.6 / 1.852, - cogBVal->value * RAD_TO_DEG, stwBVal->value * 3.6 / 1.852, sogBVal->value * 3.6 / 1.852, hdtBVal->value * RAD_TO_DEG, hdmBVal->value * RAD_TO_DEG, varBVal->value * RAD_TO_DEG); - - isCalculated = calcTrueWind(&awaVal, &awsVal, &cogVal, &stwVal, &sogVal, &hdtVal, &hdmVal, &varVal, &twd, &tws, &twa); - - if (isCalculated) { // Replace values only, if successfully calculated and not already available + // Check if TWD can be calculated from TWA and HDT/HDM + if (twaBVal->valid) { if (!twdBVal->valid) { + if (hdtVal != DBL_MAX) { + hdt = hdtVal; // Use HDT if available + } else { + hdt = calcHDT(&hdmVal, &varVal, &cogVal, &sogVal); + } + twd = twaBVal->value + hdt; + twd = to2PI(twd); twdBVal->value = twd; twdBVal->valid = true; } - if (!twsBVal->valid) { - twsBVal->value = tws; - twsBVal->valid = true; - } - if (!twaBVal->valid) { - twaBVal->value = twa; - twaBVal->valid = true; + + } else { + // Calculate true winds and AWD; if true winds exist, use at least AWD calculation + twCalculated = calcWinds(&awaVal, &awsVal, &cogVal, &stwVal, &sogVal, &hdtVal, &hdmVal, &varVal, &twd, &tws, &twa, &awd); + + if (twCalculated) { // Replace values only, if successfully calculated and not already available + if (!twdBVal->valid) { + twdBVal->value = twd; + twdBVal->valid = true; + } + if (!twsBVal->valid) { + twsBVal->value = tws; + twsBVal->valid = true; + } + if (!twaBVal->valid) { + //twaBVal->value = twa; + twaBVal->value = to2PI(twa); // convert to [0..360], because pages cannot display negative values properly yet + twaBVal->valid = true; + } + if (!awdBVal->valid) { + awdBVal->value = awd; + awdBVal->valid = true; + } } } - LOG_DEBUG(GwLog::DEBUG,"obp60task addTrueWind: isCalculated %d, TWD %.1f, TWA %.1f, TWS %.1f", isCalculated, twdBVal->value * RAD_TO_DEG, - twaBVal->value * RAD_TO_DEG, twsBVal->value * 3.6 / 1.852); + // LOG_DEBUG(GwLog::DEBUG, "WindUtils:addWinds: twCalculated %d, TWD %.1f, TWA %.1f, TWS %.2f kn, AWD: %.1f", twCalculated, twdBVal->value * RAD_TO_DEG, + // twaBVal->value * RAD_TO_DEG, twsBVal->value * 3.6 / 1.852, awdBVal->value * RAD_TO_DEG); - return isCalculated; + return twCalculated; } -// --- Class WindUtils -------------- +// --- End Class WindUtils -------------- \ No newline at end of file diff --git a/lib/obp60task/OBPDataOperations.h b/lib/obp60task/OBPDataOperations.h index 12158c1..9c5b783 100644 --- a/lib/obp60task/OBPDataOperations.h +++ b/lib/obp60task/OBPDataOperations.h @@ -1,69 +1,116 @@ +// Function lib for boat data calibration, history buffer handling, true wind calculation, and other operations on boat data #pragma once -#include #include "OBPRingBuffer.h" -#include "BoatDataCalibration.h" // Functions lib for data instance calibration +#include "Pagedata.h" #include "obp60task.h" -#include +#include +#include -typedef struct { - RingBuffer* twdHstry; - RingBuffer* twsHstry; - RingBuffer* awdHstry; - RingBuffer* awsHstry; -} tBoatHstryData; // Holds pointers to all history buffers for boat data +// Calibration of boat data values, when user setting available +// supported boat data types are: AWA, AWS, COG, DBS, DBT, HDM, HDT, PRPOS, RPOS, SOG, STW, TWA, TWS, TWD, WTemp +class CalibrationData { +private: + typedef struct { + double offset; // calibration offset + double slope; // calibration slope + double smooth; // smoothing factor + double value; // calibrated data value (for future use) + bool isCalibrated; // is data instance value calibrated? (for future use) + } tCalibrationData; + + std::unordered_map calibrationMap; // list of calibration data instances + std::unordered_map lastValue; // array for last smoothed values of boat data values + GwLog* logger; + + static constexpr int8_t MAX_CALIBRATION_DATA = 4; // maximum number of calibration data instances + +public: + CalibrationData(GwLog* log); + void readConfig(GwConfigHandler* config); + void handleCalibration(BoatValueList* boatValues); // Handle calibrationMap and calibrate all boat data values + bool calibrateInstance(GwApi::BoatValue* boatDataValue); // Calibrate single boat data value + bool smoothInstance(GwApi::BoatValue* boatDataValue); // Smooth single boat data value +}; class HstryBuf { private: - GwLog *logger; + RingBuffer hstryBuf; // Circular buffer to store history values + String boatDataName; + double hstryMin; + double hstryMax; + GwApi::BoatValue* boatValue; + GwLog* logger; - RingBuffer twdHstry; // Circular buffer to store true wind direction values - RingBuffer twsHstry; // Circular buffer to store true wind speed values (TWS) - RingBuffer awdHstry; // Circular buffer to store apparant wind direction values - RingBuffer awsHstry; // Circular buffer to store apparant xwind speed values (AWS) - int16_t twdHstryMin; // Min value for wind direction (TWD) in history buffer - int16_t twdHstryMax; // Max value for wind direction (TWD) in history buffer - uint16_t twsHstryMin; - uint16_t twsHstryMax; - int16_t awdHstryMin; - int16_t awdHstryMax; - uint16_t awsHstryMin; - uint16_t awsHstryMax; - - // boat values for buffers and for true wind calculation - GwApi::BoatValue *twdBVal, *twsBVal, *twaBVal, *awdBVal, *awsBVal; - GwApi::BoatValue *awaBVal, *hdtBVal, *hdmBVal, *varBVal, *cogBVal, *sogBVal; + friend class HstryBuffers; public: - tBoatHstryData hstryBufList; + HstryBuf(const String& name, int size, BoatValueList* boatValues, GwLog* log); + void init(const String& format, int updFreq, int mltplr, double minVal, double maxVal); + void add(double value); + void handle(bool useSimuData, CommonData& common); +}; - HstryBuf(){ - hstryBufList = {&twdHstry, &twsHstry, &awdHstry, &awsHstry}; // Generate history buffers of zero size +class HstryBuffers { +private: + std::map> hstryBuffers; + int size; // size of all history buffers + BoatValueList* boatValueList; + GwLog* logger; + GwApi::BoatValue *awaBVal, *hdtBVal, *hdmBVal, *varBVal, *cogBVal, *sogBVal, *awdBVal; // boat values for true wind calculation + + struct HistoryParams { + int hstryUpdFreq; // update frequency of history buffer (documentation only) + int mltplr; // specifies actual value precision being storable: + // [10000: 0 - 6.5535 | 1000: 0 - 65.535 | 100: 0 - 650.35 | 10: 0 - 6503.5 + double bufferMinVal; // minimum valid data value + double bufferMaxVal; // maximum valid data value + String format; // format of data type }; - - HstryBuf(int size) { - hstryBufList = {&twdHstry, &twsHstry, &awdHstry, &awsHstry}; - hstryBufList.twdHstry->resize(size); // store xWD values for /60 minutes history - hstryBufList.twsHstry->resize(size); - hstryBufList.awdHstry->resize(size); - hstryBufList.awsHstry->resize(size); + + // Define buffer parameters for supported boat data type + std::map bufferParams = { + { "AWA", { 1000, 10000, 0.0, M_TWOPI, "formatWind" } }, + { "AWD", { 1000, 10000, 0.0, M_TWOPI, "formatCourse" } }, + { "AWS", { 1000, 1000, 0.0, 65.0, "formatKnots" } }, + { "COG", { 1000, 10000, 0.0, M_TWOPI, "formatCourse" } }, + { "DBS", { 1000, 100, 0.0, 650.0, "formatDepth" } }, + { "DBT", { 1000, 100, 0.0, 650.0, "formatDepth" } }, + { "DPT", { 1000, 100, 0.0, 650.0, "formatDepth" } }, + { "HDM", { 1000, 10000, 0.0, M_TWOPI, "formatCourse" } }, + { "HDT", { 1000, 10000, 0.0, M_TWOPI, "formatCourse" } }, + { "ROT", { 1000, 10000, -M_PI / 180.0 * 99.0, M_PI / 180.0 * 99.0, "formatRot" } }, // min/max is -/+ 99 degrees for "rate of turn" + { "SOG", { 1000, 1000, 0.0, 65.0, "formatKnots" } }, + { "STW", { 1000, 1000, 0.0, 65.0, "formatKnots" } }, + { "TWA", { 1000, 10000, 0.0, M_TWOPI, "formatWind" } }, + { "TWD", { 1000, 10000, 0.0, M_TWOPI, "formatCourse" } }, + { "TWS", { 1000, 1000, 0.0, 65.0, "formatKnots" } }, + { "WTemp", { 1000, 100, 233.0, 650.0, "kelvinToC" } } // [-50..376] °C }; - void init(BoatValueList* boatValues, GwLog *log); - void handleHstryBuf(bool useSimuData); + +public: + HstryBuffers(int size, BoatValueList* boatValues, GwLog* log); + void addBuffer(const String& name); + void handleHstryBufs(bool useSimuData, CommonData& common); + RingBuffer* getBuffer(const String& name); }; class WindUtils { private: - GwApi::BoatValue *twdBVal, *twsBVal, *twaBVal; - GwApi::BoatValue *awaBVal, *awsBVal, *cogBVal, *stwBVal, *sogBVal, *hdtBVal, *hdmBVal, *varBVal; + GwApi::BoatValue *twaBVal, *twsBVal, *twdBVal; + GwApi::BoatValue *awaBVal, *awsBVal, *awdBVal, *cogBVal, *stwBVal, *sogBVal, *hdtBVal, *hdmBVal, *varBVal; static constexpr double DBL_MAX = std::numeric_limits::max(); + GwLog* logger; public: - WindUtils(BoatValueList* boatValues){ - twdBVal = boatValues->findValueOrCreate("TWD"); - twsBVal = boatValues->findValueOrCreate("TWS"); + WindUtils(BoatValueList* boatValues, GwLog* log) + : logger(log) + { twaBVal = boatValues->findValueOrCreate("TWA"); + twsBVal = boatValues->findValueOrCreate("TWS"); + twdBVal = boatValues->findValueOrCreate("TWD"); awaBVal = boatValues->findValueOrCreate("AWA"); awsBVal = boatValues->findValueOrCreate("AWS"); + awdBVal = boatValues->findValueOrCreate("AWD"); cogBVal = boatValues->findValueOrCreate("COG"); stwBVal = boatValues->findValueOrCreate("STW"); sogBVal = boatValues->findValueOrCreate("SOG"); @@ -71,6 +118,7 @@ public: hdmBVal = boatValues->findValueOrCreate("HDM"); varBVal = boatValues->findValueOrCreate("VAR"); }; + static double to2PI(double a); static double toPI(double a); static double to360(double a); @@ -82,10 +130,10 @@ public: double* phi, double* r); void calcTwdSA(const double* AWA, const double* AWS, const double* CTW, const double* STW, const double* HDT, - double* TWD, double* TWS, double* TWA); + double* TWD, double* TWS, double* TWA, double* AWD); static double calcHDT(const double* hdmVal, const double* varVal, const double* cogVal, const double* sogVal); - bool calcTrueWind(const double* awaVal, const double* awsVal, + bool calcWinds(const double* awaVal, const double* awsVal, const double* cogVal, const double* stwVal, const double* sogVal, const double* hdtVal, - const double* hdmVal, const double* varVal, double* twdVal, double* twsVal, double* twaVal); - bool addTrueWind(GwApi* api, BoatValueList* boatValues, GwLog *log); + const double* hdmVal, const double* varVal, double* twdVal, double* twsVal, double* twaVal, double* awdVal); + bool addWinds(); }; \ No newline at end of file diff --git a/lib/obp60task/OBPRingBuffer.h b/lib/obp60task/OBPRingBuffer.h index 4d13da6..970245e 100644 --- a/lib/obp60task/OBPRingBuffer.h +++ b/lib/obp60task/OBPRingBuffer.h @@ -1,11 +1,8 @@ #pragma once +#include "FreeRTOS.h" #include "GwSynchronized.h" -#include "WString.h" -#include "esp_heap_caps.h" -#include -#include -#include #include +#include template struct PSRAMAllocator { @@ -41,7 +38,6 @@ bool operator!=(const PSRAMAllocator&, const PSRAMAllocator&) { return fal template class RingBuffer { private: - // std::vector buffer; // THE buffer vector std::vector> buffer; // THE buffer vector, allocated in PSRAM size_t capacity; size_t head; // Points to the next insertion position @@ -51,49 +47,52 @@ private: bool is_Full; // Indicates that all buffer elements are used and ringing is in use T MIN_VAL; // lowest possible value of buffer of type T MAX_VAL; // highest possible value of buffer of type -> indicates invalid value in buffer + double dblMIN_VAL, dblMAX_VAL; // MIN_VAL, MAX_VAL in double format mutable SemaphoreHandle_t bufLocker; // metadata for buffer String dataName; // Name of boat data in buffer String dataFmt; // Format of boat data in buffer int updFreq; // Update frequency in milliseconds - T smallest; // Value range of buffer: smallest value; needs to be => MIN_VAL - T largest; // Value range of buffer: biggest value; needs to be < MAX_VAL, since MAX_VAL indicates invalid entries + double mltplr; // Multiplier which transforms original value into buffer type format + double smallest; // Value range of buffer: smallest value; needs to be => MIN_VAL + double largest; // Value range of buffer: biggest value; needs to be < MAX_VAL, since MAX_VAL indicates invalid entries void initCommon(); public: RingBuffer(); RingBuffer(size_t size); - void setMetaData(String name, String format, int updateFrequency, T minValue, T maxValue); // Set meta data for buffer - bool getMetaData(String& name, String& format, int& updateFrequency, T& minValue, T& maxValue); // Get meta data of buffer + void setMetaData(String name, String format, int updateFrequency, double multiplier, double minValue, double maxValue); // Set meta data for buffer + bool getMetaData(String& name, String& format, int& updateFrequency, double& multiplier, double& minValue, double& maxValue); // Get meta data of buffer bool getMetaData(String& name, String& format); String getName() const; // Get buffer name String getFormat() const; // Get buffer data format - void add(const T& value); // Add a new value to buffer - T get(size_t index) const; // Get value at specific position (0-based index from oldest to newest) - T getFirst() const; // Get the first (oldest) value in buffer - T getLast() const; // Get the last (newest) value in buffer - T getMin() const; // Get the lowest value in buffer - T getMin(size_t amount) const; // Get minimum value of the last values of buffer - T getMax() const; // Get the highest value in buffer - T getMax(size_t amount) const; // Get maximum value of the last values of buffer - T getMid() const; // Get mid value between and value in buffer - T getMid(size_t amount) const; // Get mid value between and value of the last values of buffer - T getMedian() const; // Get the median value in buffer - T getMedian(size_t amount) const; // Get the median value of the last values of buffer + void add(const double& value); // Add a new value to buffer + double get(size_t index) const; // Get value at specific position (0-based index from oldest to newest) + double getFirst() const; // Get the first (oldest) value in buffer + double getLast() const; // Get the last (newest) value in buffer + double getMin() const; // Get the lowest value in buffer + double getMin(size_t amount) const; // Get minimum value of the last values of buffer + double getMax() const; // Get the highest value in buffer + double getMax(size_t amount) const; // Get maximum value of the last values of buffer + double getMid() const; // Get mid value between and value in buffer + double getMid(size_t amount) const; // Get mid value between and value of the last values of buffer + double getMedian() const; // Get the median value in buffer + double getMedian(size_t amount) const; // Get the median value of the last values of buffer size_t getCapacity() const; // Get the buffer capacity (maximum size) size_t getCurrentSize() const; // Get the current number of elements in buffer size_t getFirstIdx() const; // Get the index of oldest value in buffer size_t getLastIdx() const; // Get the index of newest value in buffer bool isEmpty() const; // Check if buffer is empty bool isFull() const; // Check if buffer is full - T getMinVal() const; // Get lowest possible value for buffer - T getMaxVal() const; // Get highest possible value for buffer; used for unset/invalid buffer data + double getMinVal() const; // Get lowest possible value for buffer + double getMaxVal() const; // Get highest possible value for buffer; used for unset/invalid buffer data void clear(); // Clear buffer void resize(size_t size); // Delete buffer and set new size - T operator[](size_t index) const; // Operator[] for convenient access (same as get()) - std::vector getAllValues() const; // Get all current values as a vector + double operator[](size_t index) const; // Operator[] for convenient access (same as get()) + std::vector getAllValues() const; // Get all current values in native buffer format as a vector + std::vector getAllValues(size_t amount) const; // Get last values in native buffer format as a vector }; #include "OBPRingBuffer.tpp" \ No newline at end of file diff --git a/lib/obp60task/OBPRingBuffer.tpp b/lib/obp60task/OBPRingBuffer.tpp index 9174568..7d73f46 100644 --- a/lib/obp60task/OBPRingBuffer.tpp +++ b/lib/obp60task/OBPRingBuffer.tpp @@ -1,14 +1,21 @@ #include "OBPRingBuffer.h" +#include +#include +#include template -void RingBuffer::initCommon() { +void RingBuffer::initCommon() +{ MIN_VAL = std::numeric_limits::lowest(); MAX_VAL = std::numeric_limits::max(); + dblMIN_VAL = static_cast(MIN_VAL); + dblMAX_VAL = static_cast(MAX_VAL); dataName = ""; dataFmt = ""; updFreq = -1; - smallest = MIN_VAL; - largest = MAX_VAL; + mltplr = 1; + smallest = dblMIN_VAL; + largest = dblMAX_VAL; bufLocker = xSemaphoreCreateMutex(); } @@ -42,19 +49,20 @@ RingBuffer::RingBuffer(size_t size) // Specify meta data of buffer content template -void RingBuffer::setMetaData(String name, String format, int updateFrequency, T minValue, T maxValue) +void RingBuffer::setMetaData(String name, String format, int updateFrequency, double multiplier, double minValue, double maxValue) { GWSYNCHRONIZED(&bufLocker); dataName = name; dataFmt = format; updFreq = updateFrequency; - smallest = std::max(MIN_VAL, minValue); - largest = std::min(MAX_VAL, maxValue); + mltplr = multiplier; + smallest = std::max(dblMIN_VAL, minValue); + largest = std::min(dblMAX_VAL, maxValue); } // Get meta data of buffer content template -bool RingBuffer::getMetaData(String& name, String& format, int& updateFrequency, T& minValue, T& maxValue) +bool RingBuffer::getMetaData(String& name, String& format, int& updateFrequency, double& multiplier, double& minValue, double& maxValue) { if (dataName == "" || dataFmt == "" || updFreq == -1) { return false; // Meta data not set @@ -64,6 +72,7 @@ bool RingBuffer::getMetaData(String& name, String& format, int& updateFrequen name = dataName; format = dataFmt; updateFrequency = updFreq; + multiplier = mltplr; minValue = smallest; maxValue = largest; return true; @@ -99,13 +108,13 @@ String RingBuffer::getFormat() const // Add a new value to buffer template -void RingBuffer::add(const T& value) +void RingBuffer::add(const double& value) { GWSYNCHRONIZED(&bufLocker); if (value < smallest || value > largest) { buffer[head] = MAX_VAL; // Store MAX_VAL if value is out of range } else { - buffer[head] = value; + buffer[head] = static_cast(std::round(value * mltplr)); } last = head; @@ -117,63 +126,63 @@ void RingBuffer::add(const T& value) is_Full = true; } } - + // Serial.printf("Ringbuffer: value %.3f, multiplier: %.1f, buffer: %d\n", value, mltplr, buffer[head]); head = (head + 1) % capacity; } // Get value at specific position (0-based index from oldest to newest) template -T RingBuffer::get(size_t index) const +double RingBuffer::get(size_t index) const { GWSYNCHRONIZED(&bufLocker); if (isEmpty() || index < 0 || index >= count) { - return MAX_VAL; + return dblMAX_VAL; } size_t realIndex = (first + index) % capacity; - return buffer[realIndex]; + return static_cast(buffer[realIndex] / mltplr); } // Operator[] for convenient access (same as get()) template -T RingBuffer::operator[](size_t index) const +double RingBuffer::operator[](size_t index) const { return get(index); } // Get the first (oldest) value in the buffer template -T RingBuffer::getFirst() const +double RingBuffer::getFirst() const { if (isEmpty()) { - return MAX_VAL; + return dblMAX_VAL; } return get(0); } // Get the last (newest) value in the buffer template -T RingBuffer::getLast() const +double RingBuffer::getLast() const { if (isEmpty()) { - return MAX_VAL; + return dblMAX_VAL; } return get(count - 1); } // Get the lowest value in the buffer template -T RingBuffer::getMin() const +double RingBuffer::getMin() const { if (isEmpty()) { - return MAX_VAL; + return dblMAX_VAL; } - T minVal = MAX_VAL; - T value; + double minVal = dblMAX_VAL; + double value; for (size_t i = 0; i < count; i++) { value = get(i); - if (value < minVal && value != MAX_VAL) { + if (value < minVal && value != dblMAX_VAL) { minVal = value; } } @@ -182,19 +191,19 @@ T RingBuffer::getMin() const // Get minimum value of the last values of buffer template -T RingBuffer::getMin(size_t amount) const +double RingBuffer::getMin(size_t amount) const { if (isEmpty() || amount <= 0) { - return MAX_VAL; + return dblMAX_VAL; } if (amount > count) amount = count; - T minVal = MAX_VAL; - T value; + double minVal = dblMAX_VAL; + double value; for (size_t i = 0; i < amount; i++) { value = get(count - 1 - i); - if (value < minVal && value != MAX_VAL) { + if (value < minVal && value != dblMAX_VAL) { minVal = value; } } @@ -203,75 +212,81 @@ T RingBuffer::getMin(size_t amount) const // Get the highest value in the buffer template -T RingBuffer::getMax() const +double RingBuffer::getMax() const { if (isEmpty()) { - return MAX_VAL; + return dblMAX_VAL; } - T maxVal = MIN_VAL; - T value; + double maxVal = dblMIN_VAL; + double value; for (size_t i = 0; i < count; i++) { value = get(i); - if (value > maxVal && value != MAX_VAL) { + if (value > maxVal && value != dblMAX_VAL) { maxVal = value; } } + if (maxVal == dblMIN_VAL) { // no change of initial value -> buffer has only invalid values (MAX_VAL) + maxVal = dblMAX_VAL; + } return maxVal; } // Get maximum value of the last values of buffer template -T RingBuffer::getMax(size_t amount) const +double RingBuffer::getMax(size_t amount) const { if (isEmpty() || amount <= 0) { - return MAX_VAL; + return dblMAX_VAL; } if (amount > count) amount = count; - T maxVal = MIN_VAL; - T value; + double maxVal = dblMIN_VAL; + double value; for (size_t i = 0; i < amount; i++) { value = get(count - 1 - i); - if (value > maxVal && value != MAX_VAL) { + if (value > maxVal && value != dblMAX_VAL) { maxVal = value; } } + if (maxVal == dblMIN_VAL) { // no change of initial value -> buffer has only invalid values (MAX_VAL) + maxVal = dblMAX_VAL; + } return maxVal; } // Get mid value between and value in the buffer template -T RingBuffer::getMid() const +double RingBuffer::getMid() const { if (isEmpty()) { - return MAX_VAL; + return dblMAX_VAL; } - return (getMin() + getMax()) / static_cast(2); + return (getMin() + getMax()) / 2; } // Get mid value between and value of the last values of buffer template -T RingBuffer::getMid(size_t amount) const +double RingBuffer::getMid(size_t amount) const { if (isEmpty() || amount <= 0) { - return MAX_VAL; + return dblMAX_VAL; } if (amount > count) amount = count; - return (getMin(amount) + getMax(amount)) / static_cast(2); + return (getMin(amount) + getMax(amount)) / 2; } // Get the median value in the buffer template -T RingBuffer::getMedian() const +double RingBuffer::getMedian() const { if (isEmpty()) { - return MAX_VAL; + return dblMAX_VAL; } // Create a temporary vector with current valid elements @@ -287,20 +302,20 @@ T RingBuffer::getMedian() const if (count % 2 == 1) { // Odd number of elements - return temp[count / 2]; + return static_cast(temp[count / 2]); } else { // Even number of elements - return average of middle two // Note: For integer types, this truncates. For floating point, it's exact. - return (temp[count / 2 - 1] + temp[count / 2]) / 2; + return static_cast((temp[count / 2 - 1] + temp[count / 2]) / 2); } } // Get the median value of the last values of buffer template -T RingBuffer::getMedian(size_t amount) const +double RingBuffer::getMedian(size_t amount) const { if (isEmpty() || amount <= 0) { - return MAX_VAL; + return dblMAX_VAL; } if (amount > count) amount = count; @@ -310,7 +325,7 @@ T RingBuffer::getMedian(size_t amount) const temp.reserve(amount); for (size_t i = 0; i < amount; i++) { - temp.push_back(get(i)); + temp.push_back(get(count - 1 - i)); } // Sort to find median @@ -318,11 +333,11 @@ T RingBuffer::getMedian(size_t amount) const if (amount % 2 == 1) { // Odd number of elements - return temp[amount / 2]; + return static_cast(temp[amount / 2]); } else { // Even number of elements - return average of middle two // Note: For integer types, this truncates. For floating point, it's exact. - return (temp[amount / 2 - 1] + temp[amount / 2]) / 2; + return static_cast((temp[amount / 2 - 1] + temp[amount / 2]) / 2); } } @@ -370,16 +385,16 @@ bool RingBuffer::isFull() const // Get lowest possible value for buffer template -T RingBuffer::getMinVal() const +double RingBuffer::getMinVal() const { - return MIN_VAL; + return dblMIN_VAL; } // Get highest possible value for buffer; used for unset/invalid buffer data template -T RingBuffer::getMaxVal() const +double RingBuffer::getMaxVal() const { - return MAX_VAL; + return dblMAX_VAL; } // Clear buffer @@ -411,16 +426,37 @@ void RingBuffer::resize(size_t newSize) buffer.resize(newSize, MAX_VAL); } -// Get all current values as a vector +// Get all current values in native buffer format as a vector template -std::vector RingBuffer::getAllValues() const +std::vector RingBuffer::getAllValues() const { - std::vector result; + std::vector result; result.reserve(count); for (size_t i = 0; i < count; i++) { result.push_back(get(i)); } + return result; +} + +// Get last values in native buffer format as a vector +template +std::vector RingBuffer::getAllValues(size_t amount) const +{ + std::vector result; + + if (isEmpty() || amount <= 0) { + return result; + } + if (amount > count) + amount = count; + + result.reserve(amount); + + for (size_t i = 0; i < amount; i++) { + result.push_back(get(count - 1 - i)); + } + return result; } \ No newline at end of file diff --git a/lib/obp60task/OBPSensorTask.cpp b/lib/obp60task/OBPSensorTask.cpp index 31c754c..25d861b 100644 --- a/lib/obp60task/OBPSensorTask.cpp +++ b/lib/obp60task/OBPSensorTask.cpp @@ -49,8 +49,10 @@ void sensorTask(void *param){ // Init sensor stuff bool oneWire_ready = false; // 1Wire initialized and ready to use + bool iRTC_ready = false; // Software RTC initialized and ready to use bool RTC_ready = false; // DS1388 initialized and ready to use bool GPS_ready = false; // GPS initialized and ready to use + bool N2K_GPS_ready = false; // GPS time on N2K bus bool BME280_ready = false; // BME280 initialized and ready to use bool BMP280_ready = false; // BMP280 initialized and ready to use bool BMP180_ready = false; // BMP180 initialized and ready to use @@ -382,6 +384,7 @@ void sensorTask(void *param){ if (getLocalTime(&timeinfo)) { api->getLogger()->logDebug(GwLog::LOG,"NTP time: %04d-%02d-%02d %02d:%02d:%02d UTC", timeinfo.tm_year+1900, timeinfo.tm_mon+1, timeinfo.tm_mday, timeinfo.tm_hour, timeinfo.tm_min, timeinfo.tm_sec); rtc.setTimeStruct(timeinfo); + iRTC_ready = true; sensors.rtcValid = true; } else { api->getLogger()->logDebug(GwLog::LOG,"NTP time fetch failed!"); @@ -400,7 +403,7 @@ void sensorTask(void *param){ if (millis() > starttime0 + 100) { starttime0 = millis(); - // Send NMEA0183 GPS data on several bus systems all 100ms + // Send NMEA0183 GPS data on several bus systems (N2K an 0183) all 100ms if (GPS_ready == true && hdop->value <= hdopAccuracy) { SNMEA0183Msg NMEA0183Msg; @@ -412,9 +415,55 @@ void sensorTask(void *param){ } - // If RTC DS1388 ready, then copy GPS data to RTC all 5min - if(millis() > starttime11 + 5*60*1000){ + /* + Time set logic for RTC and N2K + ############################### + + iRTC = Software RTC updatetd with NTP via internet + RTC = RTC chip on PCB + GPS = GPS Receiver on PCB + N2K = GPS time on N2K od 183 bus + 0 = device not ready + 1 = device ready + X = independend + () = source for set time N2K + -> = set RTC via iRTC + <- = set RTC via GPS + + iRTC RTC GPS N2K + 0 0 0 (1) + 0 0 (1) (X) + 0 (1) 0 (X) + 0 1 <-(1) (X) + (1) 0 0 (X) + 1 0 (1) (X) + 1 ->(1) 0 (X) + 1 1 <-(1) (X) + + */ + + // If RTC DS1388 ready, then copy iRTC and GPS data to RTC all 1min + if(millis() > starttime11 + 1*60*1000){ starttime11 = millis(); + // Set RTC chip via iRTC (NTP) + if(iRTC_ready == true && RTC_ready == true && GPS_ready == false){ + GwApi::Status status; + api->getStatus(status); + // Check WiFi connection + if (status.wifiClientConnected) { + sensors.rtcTime = rtc.getTimeStruct(); // Get time from software RTC (iRTC) + DateTime now = DateTime( + sensors.rtcTime.tm_year + 1900, + sensors.rtcTime.tm_mon + 1, + sensors.rtcTime.tm_mday, + sensors.rtcTime.tm_hour, + sensors.rtcTime.tm_min, + sensors.rtcTime.tm_sec + ); + ds1388.adjust(now); + } + } + // Set RTC chip via internal GPS if(rtcOn == "DS1388" && RTC_ready == true && GPS_ready == true){ api->getBoatDataValues(3,valueList); if(gpsdays->valid && gpsseconds->valid && hdop->valid){ @@ -422,40 +471,33 @@ void sensorTask(void *param){ // sample input: date = "Dec 26 2009", time = "12:34:56" // ds1388.adjust(DateTime("Dec 26 2009", "12:34:56")); DateTime adjusttime(ts); - api->getLogger()->logDebug(GwLog::LOG,"Adjust RTC time: %04d/%02d/%02d %02d:%02d:%02d",adjusttime.year(), adjusttime.month(), adjusttime.day(), adjusttime.hour(), adjusttime.minute(), adjusttime.second()); + api->getLogger()->logDebug(GwLog::LOG,"Adjust RTC time via internal GPS: %04d/%02d/%02d %02d:%02d:%02d",adjusttime.year(), adjusttime.month(), adjusttime.day(), adjusttime.hour(), adjusttime.minute(), adjusttime.second()); // Adjust RTC time as unix time value ds1388.adjust(adjusttime); } - } + } } - // Send 1Wire data for all temperature sensors all 2s - if(millis() > starttime13 + 2000 && String(oneWireOn) == "DS18B20" && oneWire_ready == true){ - starttime13 = millis(); - float tempC; - ds18b20.requestTemperatures(); // Collect all temperature values (max.8) - for(int i=0;igetLogger()->logDebug(GwLog::DEBUG,"DS18B20-%1d Temp: %.1f",i,tempC); - SetN2kPGN130316(N2kMsg, 0, i, N2kts_OutsideTemperature, CToKelvin(tempC), N2kDoubleNA); - api->sendN2kMessage(N2kMsg); - } - } - } - loopCounter++; + // Set RTC chip via N2K or 183 in case the internal GPS is off (only one time) + if(N2K_GPS_ready == false && RTC_ready == true && GPS_ready == false){ + api->getBoatDataValues(3,valueList); + if(gpsdays->valid && gpsseconds->valid && hdop->valid){ + long ts = tNMEA0183Msg::daysToTime_t(gpsdays->value - (30*365+7))+floor(gpsseconds->value); // Adjusted to reference year 2000 (-30 years and 7 days for switch years) + // sample input: date = "Dec 26 2009", time = "12:34:56" + // ds1388.adjust(DateTime("Dec 26 2009", "12:34:56")); + DateTime adjusttime(ts); + api->getLogger()->logDebug(GwLog::LOG,"Adjust RTC time via N2K/183: %04d/%02d/%02d %02d:%02d:%02d",adjusttime.year(), adjusttime.month(), adjusttime.day(), adjusttime.hour(), adjusttime.minute(), adjusttime.second()); + // Adjust RTC time as unix time value + ds1388.adjust(adjusttime); + // N2K GPS time ready + N2K_GPS_ready = true; + } } - // Get current RTC date and time all 500ms + // Send RTC date and time to N2K all 500ms if (millis() > starttime12 + 500) { starttime12 = millis(); + // Send date and time from RTC chip if GPS not ready if (rtcOn == "DS1388" && RTC_ready) { DateTime dt = ds1388.now(); sensors.rtcTime.tm_year = dt.year() - 1900; // Save values in SensorData @@ -481,21 +523,62 @@ void sensorTask(void *param){ } // N2K sysTime is double in n2klib double sysTime = (dt.hour() * 3600) + (dt.minute() * 60) + dt.second(); - // WHY? isnan should always fail here - //if(!isnan(daysAt1970) && !isnan(sysTime)){ + if(!isnan(daysAt1970) && !isnan(sysTime)){ //api->getLogger()->logDebug(GwLog::LOG,"RTC time: %04d/%02d/%02d %02d:%02d:%02d",sensors.rtcTime.tm_year+1900,sensors.rtcTime.tm_mon, sensors.rtcTime.tm_mday, sensors.rtcTime.tm_hour, sensors.rtcTime.tm_min, sensors.rtcTime.tm_sec); //api->getLogger()->logDebug(GwLog::LOG,"Send PGN126992: %10d %10d",daysAt1970, (uint16_t)sysTime); SetN2kPGN126992(N2kMsg,0,daysAt1970,sysTime,N2ktimes_LocalCrystalClock); api->sendN2kMessage(N2kMsg); - // } + } + } + } + // Send date and time from software RTC (iRTC) + if (iRTC_ready == true && RTC_ready == false && GPS_ready == false) { + // Use internal RTC feature + sensors.rtcTime = rtc.getTimeStruct(); // Save software RTC values in SensorData + // TODO implement daysAt1970 and sysTime as methods of DateTime + const short daysOfYear[12] = {0,31,59,90,120,151,181,212,243,273,304,334}; + uint16_t switchYear = ((sensors.rtcTime.tm_year-1)-1968)/4 - ((sensors.rtcTime.tm_year-1)-1900)/100 + ((sensors.rtcTime.tm_year-1)-1600)/400; + long daysAt1970 = (sensors.rtcTime.tm_year-1970)*365 + switchYear + daysOfYear[sensors.rtcTime.tm_mon-1] + sensors.rtcTime.tm_mday-1; + // If switch year then add one day + if ((sensors.rtcTime.tm_mon > 2) && (sensors.rtcTime.tm_year % 4 == 0 && (sensors.rtcTime.tm_year % 100 != 0 || sensors.rtcTime.tm_year % 400 == 0))) { + daysAt1970 += 1; + } + // N2K sysTime is double in n2klib + double sysTime = (sensors.rtcTime.tm_hour * 3600) + (sensors.rtcTime.tm_min * 60) + sensors.rtcTime.tm_sec; + if(!isnan(daysAt1970) && !isnan(sysTime)){ + //api->getLogger()->logDebug(GwLog::LOG,"RTC time: %04d/%02d/%02d %02d:%02d:%02d",sensors.rtcTime.tm_year+1900,sensors.rtcTime.tm_mon, sensors.rtcTime.tm_mday, sensors.rtcTime.tm_hour, sensors.rtcTime.tm_min, sensors.rtcTime.tm_sec); + //api->getLogger()->logDebug(GwLog::LOG,"Send PGN126992: %10d %10d",daysAt1970, (uint16_t)sysTime); + SetN2kPGN126992(N2kMsg,0,daysAt1970,sysTime,N2ktimes_LocalCrystalClock); + api->sendN2kMessage(N2kMsg); } - } else if (sensors.rtcValid) { - // use internal rtc feature - sensors.rtcTime = rtc.getTimeStruct(); } } - // Send supply voltage value all 1s + // Send 1Wire data for all temperature sensors to N2K all 2s + if(millis() > starttime13 + 2000 && String(oneWireOn) == "DS18B20" && oneWire_ready == true){ + starttime13 = millis(); + float tempC; + ds18b20.requestTemperatures(); // Collect all temperature values (max.8) + for(int i=0;igetLogger()->logDebug(GwLog::DEBUG,"DS18B20-%1d Temp: %.1f",i,tempC); + SetN2kPGN130316(N2kMsg, 0, i, N2kts_OutsideTemperature, CToKelvin(tempC), N2kDoubleNA); + api->sendN2kMessage(N2kMsg); + } + } + } + loopCounter++; + } + + // Send supply voltage value to N2K all 1s if(millis() > starttime5 + 1000 && String(powsensor1) == "off"){ starttime5 = millis(); float rawVoltage = 0; // Default value @@ -565,7 +648,7 @@ void sensorTask(void *param){ #endif } - // Send data from environment sensor all 2s + // Send data from environment sensor to N2K all 2s if(millis() > starttime6 + 2000){ starttime6 = millis(); unsigned char TempSource = 2; // Inside temperature @@ -630,7 +713,7 @@ void sensorTask(void *param){ } } - // Send rotation angle all 500ms + // Send rotation angle to N2K all 500ms if(millis() > starttime7 + 500){ starttime7 = millis(); double rotationAngle=0; @@ -678,7 +761,7 @@ void sensorTask(void *param){ } } - // Send battery power value all 1s + // Send battery power value to N2K all 1s if(millis() > starttime8 + 1000 && (String(powsensor1) == "INA219" || String(powsensor1) == "INA226")){ starttime8 = millis(); if(String(powsensor1) == "INA226" && INA226_1_ready == true){ @@ -720,7 +803,7 @@ void sensorTask(void *param){ } } - // Send solar power value all 1s + // Send solar power value to N2K all 1s if(millis() > starttime9 + 1000 && (String(powsensor2) == "INA219" || String(powsensor2) == "INA226")){ starttime9 = millis(); if(String(powsensor2) == "INA226" && INA226_2_ready == true){ @@ -750,7 +833,7 @@ void sensorTask(void *param){ } } - // Send generator power value all 1s + // Send generator power value to N2K all 1s if(millis() > starttime10 + 1000 && (String(powsensor3) == "INA219" || String(powsensor3) == "INA226")){ starttime10 = millis(); if(String(powsensor3) == "INA226" && INA226_3_ready == true){ diff --git a/lib/obp60task/OBPcharts.cpp b/lib/obp60task/OBPcharts.cpp new file mode 100644 index 0000000..8ae38ec --- /dev/null +++ b/lib/obp60task/OBPcharts.cpp @@ -0,0 +1,807 @@ +// Function lib for display of boat data in various chart formats +#include "OBPcharts.h" +#include "OBPDataOperations.h" +#include "OBPRingBuffer.h" + +std::map Chart::dfltChrtDta = { + { "formatWind", { 60.0 * DEG_TO_RAD, 10.0 * DEG_TO_RAD } }, // default course range 60 degrees + { "formatCourse", { 60.0 * DEG_TO_RAD, 10.0 * DEG_TO_RAD } }, // default course range 60 degrees + { "formatKnots", { 7.71, 2.56 } }, // default speed range in m/s + { "formatDepth", { 15.0, 5.0 } }, // default depth range in m + { "kelvinToC", { 30.0, 5.0 } } // default temp range in °C/K +}; + +// --- Class Chart --------------- + +// Chart - object holding the actual chart, incl. data buffer and format definition +// Parameters: the history data buffer for the chart +// default range of chart, e.g. 30 = [0..30] +// common program data; required for logger and color data +// flag to indicate if simulation data is active +Chart::Chart(RingBuffer& dataBuf, double dfltRng, CommonData& common, bool useSimuData) + : dataBuf(dataBuf) + , dfltRng(dfltRng) + , commonData(&common) + , useSimuData(useSimuData) +{ + logger = commonData->logger; + fgColor = commonData->fgcolor; + bgColor = commonData->bgcolor; + + dWidth = getdisplay().width(); + dHeight = getdisplay().height(); + + dataBuf.getMetaData(dbName, dbFormat); + dbMIN_VAL = dataBuf.getMinVal(); + dbMAX_VAL = dataBuf.getMaxVal(); + bufSize = dataBuf.getCapacity(); + + // Initialize chart data format; shorter version of standard format indicator + if (dbFormat == "formatCourse" || dbFormat == "formatWind" || dbFormat == "formatRot") { + chrtDataFmt = WIND; // Chart is showing data of course / wind format + } else if (dbFormat == "formatRot") { + chrtDataFmt = ROTATION; // Chart is showing data of rotational format + } else if (dbFormat == "formatKnots") { + chrtDataFmt = SPEED; // Chart is showing data of speed or windspeed format + } else if (dbFormat == "formatDepth") { + chrtDataFmt = DEPTH; // Chart ist showing data of format + } else if (dbFormat == "kelvinToC") { + chrtDataFmt = TEMPERATURE; // Chart ist showing data of format + } else { + chrtDataFmt = OTHER; // Chart is showing any other data format + } + + // "0" value is the same for any data format but for user defined temperature format + zeroValue = 0.0; + if (chrtDataFmt == TEMPERATURE) { + tempFormat = commonData->config->getString(commonData->config->tempFormat); // [K|°C|°F] + if (tempFormat == "K") { + zeroValue = 0.0; + } else if (tempFormat == "C") { + zeroValue = 273.15; + } else if (tempFormat == "F") { + zeroValue = 255.37; + } + } + + // Read default range and range step for this chart type + if (dfltChrtDta.count(dbFormat)) { + dfltRng = dfltChrtDta[dbFormat].range; + rngStep = dfltChrtDta[dbFormat].step; + } else { + dfltRng = 15.0; + rngStep = 5.0; + } + + // Initialize chart range values + chrtMin = zeroValue; + chrtMax = chrtMin + dfltRng; + chrtMid = (chrtMin + chrtMax) / 2; + chrtRng = dfltRng; + recalcRngMid = true; // initialize and chart borders on first screen call + + LOG_DEBUG(GwLog::DEBUG, "Chart Init: dWidth: %d, dHeight: %d, timAxis: %d, valAxis: %d, cRoot {x,y}: %d, %d, dbname: %s, rngStep: %.4f, chrtDataFmt: %d", + dWidth, dHeight, timAxis, valAxis, cRoot.x, cRoot.y, dbName, rngStep, chrtDataFmt); +}; + +Chart::~Chart() +{ +} + +// Perform all actions to draw chart +// Parameters: : chart timeline direction: 'H' = horizontal, 'V' = vertical +// : chart size: [0] = full size, [1] = half size left/top, [2] half size right/bottom +// : chart timeline interval +// ; print data name on horizontal half chart [true|false] +// : print current boat data value [true|false] +// : current boat data value; used only for test on valid data +void Chart::showChrt(char chrtDir, int8_t chrtSz, const int8_t chrtIntv, bool prntName, bool showCurrValue, GwApi::BoatValue currValue) +{ + if (!setChartDimensions(chrtDir, chrtSz)) { + return; // wrong chart dimension parameters + } + + drawChrt(chrtDir, chrtIntv, currValue); + drawChrtTimeAxis(chrtDir, chrtSz, chrtIntv); + drawChrtValAxis(chrtDir, chrtSz, prntName); + + if (!bufDataValid) { // No valid data available + prntNoValidData(chrtDir); + return; + } + + if (showCurrValue) { // show latest value from history buffer; this should be the most current one + currValue.value = dataBuf.getLast(); + currValue.valid = currValue.value != dbMAX_VAL; + prntCurrValue(chrtDir, currValue); + } +} + +// define dimensions and start points for chart +bool Chart::setChartDimensions(const char direction, const int8_t size) +{ + if ((direction != HORIZONTAL && direction != VERTICAL) || (size < 0 || size > 2)) { + LOG_DEBUG(GwLog::ERROR, "obp60:setChartDimensions %s: wrong parameters", dataBuf.getName()); + return false; + } + + if (direction == HORIZONTAL) { + // horizontal chart timeline direction + timAxis = dWidth - 1; + switch (size) { + case 0: + valAxis = dHeight - top - bottom; + cRoot = { 0, top - 1 }; + break; + case 1: + valAxis = (dHeight - top - bottom) / 2 - hGap; + cRoot = { 0, top - 1 }; + break; + case 2: + valAxis = (dHeight - top - bottom) / 2 - hGap; + cRoot = { 0, top + (valAxis + hGap) + hGap - 1 }; + break; + } + + } else if (direction == VERTICAL) { + // vertical chart timeline direction + timAxis = dHeight - top - bottom; + switch (size) { + case 0: + valAxis = dWidth - 1; + cRoot = { 0, top - 1 }; + break; + case 1: + valAxis = dWidth / 2 - vGap; + cRoot = { 0, top - 1 }; + break; + case 2: + valAxis = dWidth / 2 - vGap; + cRoot = { dWidth / 2 + vGap - 1, top - 1 }; + break; + } + } + //LOG_DEBUG(GwLog::DEBUG, "obp60:setChartDimensions %s: direction: %c, size: %d, dWidth: %d, dHeight: %d, timAxis: %d, valAxis: %d, cRoot{%d, %d}, top: %d, bottom: %d, hGap: %d, vGap: %d", + // dataBuf.getName(), direction, size, dWidth, dHeight, timAxis, valAxis, cRoot.x, cRoot.y, top, bottom, hGap, vGap); + return true; +} + +// draw chart +void Chart::drawChrt(const char chrtDir, const int8_t chrtIntv, GwApi::BoatValue& currValue) +{ + double chrtScale; // Scale for data values in pixels per value + + getBufferStartNSize(chrtIntv); + + // LOG_DEBUG(GwLog::DEBUG, "Chart:drawChart: min: %.1f, mid: %.1f, max: %.1f, rng: %.1f", chrtMin, chrtMid, chrtMax, chrtRng); + calcChrtBorders(chrtMin, chrtMid, chrtMax, chrtRng); + chrtScale = double(valAxis) / chrtRng; // Chart scale: pixels per value step + // LOG_DEBUG(GwLog::DEBUG, "Chart:drawChart: min: %.1f, mid: %.1f, max: %.1f, rng: %.1f", chrtMin, chrtMid, chrtMax, chrtRng); + + // Do we have valid buffer data? + if (dataBuf.getMax() == dbMAX_VAL) { // only values in buffer -> no valid wind data available + bufDataValid = false; + return; + + } else if (currValue.valid || useSimuData) { // latest boat data valid or simulation mode + numNoData = 0; // reset data error counter + bufDataValid = true; + + } else { // currently no valid data + numNoData++; + bufDataValid = true; + + if (numNoData > THRESHOLD_NO_DATA) { // If more than 4 invalid values in a row, flag for invalid data + bufDataValid = false; + return; + } + } + + drawChartLines(chrtDir, chrtIntv, chrtScale); +} + +// Identify buffer size and buffer start position for chart +void Chart::getBufferStartNSize(const int8_t chrtIntv) +{ + count = dataBuf.getCurrentSize(); + currIdx = dataBuf.getLastIdx(); + numAddedBufVals = (currIdx - lastAddedIdx + bufSize) % bufSize; // Number of values added to buffer since last display + + if (chrtIntv != oldChrtIntv || count == 1) { + // new data interval selected by user; this is only x * 230 values instead of 240 seconds (4 minutes) per interval step + numBufVals = min(count, (timAxis - MIN_FREE_VALUES) * chrtIntv); // keep free or release MIN_FREE_VALUES on chart for plotting of new values + bufStart = max(0, count - numBufVals); + lastAddedIdx = currIdx; + oldChrtIntv = chrtIntv; + + } else { + numBufVals = numBufVals + numAddedBufVals; + lastAddedIdx = currIdx; + if (count == bufSize) { + bufStart = max(0, bufStart - numAddedBufVals); + } + } +} + +// check and adjust chart range and set range borders and range middle +void Chart::calcChrtBorders(double& rngMin, double& rngMid, double& rngMax, double& rng) +{ + if (chrtDataFmt == WIND || chrtDataFmt == ROTATION) { + + if (chrtDataFmt == ROTATION) { + // if chart data is of type 'rotation', we want to have always to be '0' + rngMid = 0; + + } else { // WIND: Chart data is of type 'course' or 'wind' + + // initialize if data buffer has just been started filling + if ((count == 1 && rngMid == 0) || rngMid == dbMAX_VAL) { + recalcRngMid = true; + } + + if (recalcRngMid) { + // Set rngMid + + rngMid = dataBuf.getMid(numBufVals); + + if (rngMid == dbMAX_VAL) { + rngMid = 0; + } else { + rngMid = std::round(rngMid / rngStep) * rngStep; // Set new center value; round to next value + + // Check if range between 'min' and 'max' is > 180° or crosses '0' + rngMin = dataBuf.getMin(numBufVals); + rngMax = dataBuf.getMax(numBufVals); + rng = (rngMax >= rngMin ? rngMax - rngMin : M_TWOPI - rngMin + rngMax); + rng = std::max(rng, dfltRng); // keep at least default chart range + + if (rng > M_PI) { // If wind range > 180°, adjust wndCenter to smaller wind range end + rngMid = WindUtils::to2PI(rngMid + M_PI); + } + } + recalcRngMid = false; // Reset flag for determination + + // LOG_DEBUG(GwLog::DEBUG, "calcChrtRange: rngMin: %.1f°, rngMid: %.1f°, rngMax: %.1f°, rng: %.1f°, rngStep: %.1f°", rngMin * RAD_TO_DEG, rngMid * RAD_TO_DEG, rngMax * RAD_TO_DEG, + // rng * RAD_TO_DEG, rngStep * RAD_TO_DEG); + } + } + + // check and adjust range between left, mid, and right chart limit + double halfRng = rng / 2.0; // we calculate with range between and edges + double tmpRng = getAngleRng(rngMid, numBufVals); + tmpRng = (tmpRng == dbMAX_VAL ? 0 : std::ceil(tmpRng / rngStep) * rngStep); + + // LOG_DEBUG(GwLog::DEBUG, "calcChrtBorders: tmpRng: %.1f°, halfRng: %.1f°", tmpRng * RAD_TO_DEG, halfRng * RAD_TO_DEG); + + if (tmpRng > halfRng) { // expand chart range to new value + halfRng = tmpRng; + } + + else if (tmpRng + rngStep < halfRng) { // Contract chart range for higher resolution if possible + halfRng = std::max(dfltRng / 2.0, tmpRng); + } + + rngMin = WindUtils::to2PI(rngMid - halfRng); + rngMax = (halfRng < M_PI ? rngMid + halfRng : rngMid + halfRng - (M_TWOPI / 360)); // if chart range is 360°, then make 1° smaller than + rngMax = WindUtils::to2PI(rngMax); + + rng = halfRng * 2.0; + + // LOG_DEBUG(GwLog::DEBUG, "calcChrtBorders: rngMin: %.1f°, rngMid: %.1f°, rngMax: %.1f°, tmpRng: %.1f°, rng: %.1f°, rngStep: %.1f°", rngMin * RAD_TO_DEG, rngMid * RAD_TO_DEG, rngMax * RAD_TO_DEG, + // tmpRng * RAD_TO_DEG, rng * RAD_TO_DEG, rngStep * RAD_TO_DEG); + + } else { // chart data is of any other type + + double currMinVal = dataBuf.getMin(numBufVals); + double currMaxVal = dataBuf.getMax(numBufVals); + + if (currMinVal == dbMAX_VAL || currMaxVal == dbMAX_VAL) { + return; // no valid data + } + + // check if current chart border have to be adjusted + if (currMinVal < rngMin || (currMinVal > (rngMin + rngStep))) { // decrease rngMin if required or increase if lowest value is higher than old rngMin + rngMin = std::floor(currMinVal / rngStep) * rngStep; // align low range to lowest buffer value and nearest range interval + } + if ((currMaxVal > rngMax) || (currMaxVal < (rngMax - rngStep))) { // increase rngMax if required or decrease if lowest value is lower than old rngMax + rngMax = std::ceil(currMaxVal / rngStep) * rngStep; + } + + // Chart range starts at least at '0' if minimum data value allows it + if (rngMin > zeroValue && dbMIN_VAL <= zeroValue) { + rngMin = zeroValue; + } + + // ensure minimum chart range in user format + if ((rngMax - rngMin) < dfltRng) { + rngMax = rngMin + dfltRng; + } + + rngMid = (rngMin + rngMax) / 2.0; + rng = rngMax - rngMin; + + // LOG_DEBUG(GwLog::DEBUG, "calcChrtRange-end: currMinVal: %.1f, currMaxVal: %.1f, rngMin: %.1f, rngMid: %.1f, rngMax: %.1f, rng: %.1f, rngStep: %.1f, zeroValue: %.1f, dbMIN_VAL: %.1f", + // currMinVal, currMaxVal, rngMin, rngMid, rngMax, rng, rngStep, zeroValue, dbMIN_VAL); + } +} + +// Draw chart graph +void Chart::drawChartLines(const char direction, const int8_t chrtIntv, const double chrtScale) +{ + double chrtVal; // Current data value + Pos point, prevPoint; // current and previous chart point + + for (int i = 0; i < (numBufVals / chrtIntv); i++) { + + chrtVal = dataBuf.get(bufStart + (i * chrtIntv)); // show the latest wind values in buffer; keep 1st value constant in a rolling buffer + + if (chrtVal == dbMAX_VAL) { + chrtPrevVal = dbMAX_VAL; + } else { + + point = setCurrentChartPoint(i, direction, chrtVal, chrtScale); + + // if (i >= (numBufVals / chrtIntv) - 5) // log chart data of 1 line (adjust for test purposes) + // LOG_DEBUG(GwLog::DEBUG, "PageWindPlot Chart: i: %d, chrtVal: %.2f, chrtMin: %.2f, {x,y} {%d,%d}", i, chrtVal, chrtMin, x, y); + + if ((i == 0) || (chrtPrevVal == dbMAX_VAL)) { + // just a dot for 1st chart point or after some invalid values + prevPoint = point; + + } else if (chrtDataFmt == WIND || chrtDataFmt == ROTATION) { + // cross borders check for degree values; shift values to [-PI..0..PI]; when crossing borders, range is 2x PI degrees + + double normCurrVal = WindUtils::to2PI(chrtVal - chrtMin); + double normPrevVal = WindUtils::to2PI(chrtPrevVal - chrtMin); + // Check if pixel positions are far apart (crossing chart boundary); happens when one value is near chrtMax and the other near chrtMin + bool crossedBorders = std::abs(normCurrVal - normPrevVal) > (chrtRng / 2.0); + + if (crossedBorders) { // If current value crosses chart borders compared to previous value, split line + // LOG_DEBUG(GwLog::DEBUG, "PageWindPlot Chart: crossedBorders: %d, chrtVal: %.2f, chrtPrevVal: %.2f", crossedBorders, chrtVal, chrtPrevVal); + bool wrappingFromHighToLow = normCurrVal < normPrevVal; // Determine which edge we're crossing + + if (direction == HORIZONTAL) { + int ySplit = wrappingFromHighToLow ? (cRoot.y + valAxis) : cRoot.y; + drawBoldLine(prevPoint.x, prevPoint.y, point.x, ySplit); + prevPoint.y = wrappingFromHighToLow ? cRoot.y : (cRoot.y + valAxis); + + } else { // vertical chart + int xSplit = wrappingFromHighToLow ? (cRoot.x + valAxis) : cRoot.x; + drawBoldLine(prevPoint.x, prevPoint.y, xSplit, point.y); + prevPoint.x = wrappingFromHighToLow ? cRoot.x : (cRoot.x + valAxis); + } + } + } + + if (chrtDataFmt == DEPTH) { + if (direction == HORIZONTAL) { // horizontal chart + drawBoldLine(point.x, point.y, point.x, cRoot.y + valAxis); + } else { // vertical chart + drawBoldLine(point.x, point.y, cRoot.x + valAxis, point.y); + } + } else { + drawBoldLine(prevPoint.x, prevPoint.y, point.x, point.y); + } + + chrtPrevVal = chrtVal; + prevPoint = point; + } + + // Reaching chart area top end + if (i >= timAxis - 1) { + oldChrtIntv = 0; // force reset of buffer start and number of values to show in next display loop + + if (chrtDataFmt == WIND) { // degree of course or wind + recalcRngMid = true; + LOG_DEBUG(GwLog::DEBUG, "PageWindPlot: chart end: timAxis: %d, i: %d, bufStart: %d, numBufVals: %d, recalcRngCntr: %d", timAxis, i, bufStart, numBufVals, recalcRngMid); + } + break; + } + + taskYIELD(); // we run for 50-150ms; be polite to other tasks with same priority + } +} + +// Set current chart point to draw +Pos Chart::setCurrentChartPoint(const int i, const char direction, const double chrtVal, const double chrtScale) +{ + Pos currentPoint; + + if (direction == HORIZONTAL) { + currentPoint.x = cRoot.x + i; // Position in chart area + + if (chrtDataFmt == WIND || chrtDataFmt == ROTATION) { // degree type value + currentPoint.y = cRoot.y + static_cast((WindUtils::to2PI(chrtVal - chrtMin) * chrtScale) + 0.5); // calculate chart point and round + } else if (chrtDataFmt == SPEED or chrtDataFmt == TEMPERATURE) { // speed or temperature data format -> print low values at bottom + currentPoint.y = cRoot.y + valAxis - static_cast(((chrtVal - chrtMin) * chrtScale) + 0.5); // calculate chart point and round + } else { // any other data format + currentPoint.y = cRoot.y + static_cast(((chrtVal - chrtMin) * chrtScale) + 0.5); // calculate chart point and round + } + + } else { // vertical chart + currentPoint.y = cRoot.y + timAxis - i; // Position in chart area + + if (chrtDataFmt == WIND || chrtDataFmt == ROTATION) { // degree type value + currentPoint.x = cRoot.x + static_cast((WindUtils::to2PI(chrtVal - chrtMin) * chrtScale) + 0.5); // calculate chart point and round + } else { + currentPoint.x = cRoot.x + static_cast(((chrtVal - chrtMin) * chrtScale) + 0.5); // calculate chart point and round + } + } + + return currentPoint; +} + +// chart time axis label + lines +void Chart::drawChrtTimeAxis(const char chrtDir, const int8_t chrtSz, const int8_t chrtIntv) +{ + float axSlots, intv, i; + char sTime[6]; + int timeRng = chrtIntv * 4; // chart time interval: [1] 4 min., [2] 8 min., [3] 12 min., [4] 16 min., [8] 32 min. + + getdisplay().setFont(&Ubuntu_Bold8pt8b); + getdisplay().setTextColor(fgColor); + + axSlots = 5; // number of axis labels + intv = timAxis / (axSlots - 1); // minutes per chart axis interval (interval is 1 less than axSlots) + i = timeRng; // Chart axis label start at -32, -16, -12, ... minutes + + if (chrtDir == HORIZONTAL) { + getdisplay().fillRect(0, cRoot.y, dWidth, 2, fgColor); + + for (float j = 0; j < timAxis - 1; j += intv) { // fill time axis with values but keep area free on right hand side for value label + + // draw text with appropriate offset + int tOffset = j == 0 ? 13 : -4; + snprintf(sTime, sizeof(sTime), "-%.0f", i); + drawTextCenter(cRoot.x + j + tOffset, cRoot.y - 8, sTime); + getdisplay().drawLine(cRoot.x + j, cRoot.y, cRoot.x + j, cRoot.y + 5, fgColor); // draw short vertical time mark + + i -= chrtIntv; + } + + } else { // vertical chart + + for (float j = intv; j < timAxis - 1; j += intv) { // don't print time label at upper and lower end of time axis + + i -= chrtIntv; // we start not at top chart position + snprintf(sTime, sizeof(sTime), "-%.0f", i); + getdisplay().drawLine(cRoot.x, cRoot.y + j, cRoot.x + valAxis, cRoot.y + j, fgColor); // Grid line + + if (chrtSz == FULL_SIZE) { // full size chart + getdisplay().fillRect(0, cRoot.y + j - 9, 32, 15, bgColor); // clear small area to remove potential chart lines + getdisplay().setCursor((4 - strlen(sTime)) * 7, cRoot.y + j + 3); // time value; print left screen; value right-formated + getdisplay().printf("%s", sTime); // Range value + } else if (chrtSz == HALF_SIZE_RIGHT) { // half size chart; right side + drawTextCenter(dWidth / 2, cRoot.y + j, sTime); // time value; print mid screen + } + } + } +} + +// chart value axis labels + lines +void Chart::drawChrtValAxis(const char chrtDir, const int8_t chrtSz, bool prntName) +{ + const GFXfont* font; + constexpr bool NO_LABEL = false; + constexpr bool LABEL = true; + + getdisplay().setTextColor(fgColor); + + if (chrtDir == HORIZONTAL) { + + if (chrtSz == FULL_SIZE) { + + font = &Ubuntu_Bold12pt8b; + + // print buffer data name on right hand side of time axis (max. size 5 characters) + getdisplay().setFont(font); + drawTextRalign(cRoot.x + timAxis, cRoot.y - 3, dbName.substring(0, 5)); + + if (chrtDataFmt == WIND) { + prntHorizChartThreeValueAxisLabel(font); + return; + } + + // for any other data formats print multiple axis value lines on full charts + prntHorizChartMultiValueAxisLabel(font); + return; + + } else { // half size chart -> just print edge values + middle chart line + + font = &Ubuntu_Bold10pt8b; + + if (prntName) { + // print buffer data name on right hand side of time axis (max. size 5 characters) + getdisplay().setFont(font); + drawTextRalign(cRoot.x + timAxis, cRoot.y - 3, dbName.substring(0, 5)); + } + + prntHorizChartThreeValueAxisLabel(font); + return; + } + + } else { // vertical chart + + if (chrtSz == FULL_SIZE) { + font = &Ubuntu_Bold12pt8b; + getdisplay().setFont(font); // use larger font + drawTextRalign(cRoot.x + (valAxis * 0.42), cRoot.y - 2, dbName.substring(0, 6)); // print buffer data name (max. size 5 characters) + + } else { + + font = &Ubuntu_Bold10pt8b; + } + + prntVerticChartThreeValueAxisLabel(font); + } +} + +// Print current data value +void Chart::prntCurrValue(const char direction, GwApi::BoatValue& currValue) +{ + const int xPosVal = (direction == HORIZONTAL) ? cRoot.x + (timAxis / 2) - 56 : cRoot.x + 32; + const int yPosVal = (direction == HORIZONTAL) ? cRoot.y + valAxis - 7 : cRoot.y + timAxis - 7; + + FormattedData frmtDbData = formatValue(&currValue, *commonData, NO_SIMUDATA); + String sdbValue = frmtDbData.svalue; // value as formatted string + String dbUnit = frmtDbData.unit; // Unit of value; limit length to 3 characters + + getdisplay().fillRect(xPosVal - 1, yPosVal - 35, 128, 41, bgColor); // Clear area for TWS value + getdisplay().drawRect(xPosVal, yPosVal - 34, 126, 40, fgColor); // Draw box for TWS value + getdisplay().setFont(&DSEG7Classic_BoldItalic16pt7b); + getdisplay().setCursor(xPosVal + 1, yPosVal); + getdisplay().print(sdbValue); // value + + getdisplay().setFont(&Ubuntu_Bold10pt8b); + getdisplay().setCursor(xPosVal + 76, yPosVal - 17); + getdisplay().print(dbName.substring(0, 3)); // Name, limited to 3 characters + + getdisplay().setFont(&Ubuntu_Bold8pt8b); + getdisplay().setCursor(xPosVal + 76, yPosVal + 0); + getdisplay().print(dbUnit); // Unit +} + +// print message for no valid data availabletemplate +void Chart::prntNoValidData(const char direction) +{ + Pos p; + + getdisplay().setFont(&Ubuntu_Bold10pt8b); + + if (direction == HORIZONTAL) { + p.x = cRoot.x + (timAxis / 2); + p.y = cRoot.y + (valAxis / 2) - 10; + } else { + p.x = cRoot.x + (valAxis / 2); + p.y = cRoot.y + (timAxis / 2) - 10; + } + + getdisplay().fillRect(p.x - 37, p.y - 10, 78, 24, bgColor); // Clear area for message + drawTextCenter(p.x, p.y, "No data"); + + LOG_DEBUG(GwLog::LOG, "Page chart <%s>: No valid data available", dbName); +} + +// Get maximum difference of last of dataBuf ringbuffer values to center chart; for angle data only +double Chart::getAngleRng(const double center, size_t amount) +{ + size_t count = dataBuf.getCurrentSize(); + + if (dataBuf.isEmpty() || amount <= 0) { + return dbMAX_VAL; + } + if (amount > count) + amount = count; + + double value = 0; + double range = 0; + double maxRng = dbMIN_VAL; + + // Start from the newest value (last) and go backwards x times + for (size_t i = 0; i < amount; i++) { + value = dataBuf.get(count - 1 - i); + + if (value == dbMAX_VAL) { + continue; // ignore invalid values + } + + range = abs(fmod((value - center + (M_TWOPI + M_PI)), M_TWOPI) - M_PI); + if (range > maxRng) + maxRng = range; + } + + if (maxRng > M_PI) { + maxRng = M_PI; + } + + return (maxRng != dbMIN_VAL ? maxRng : dbMAX_VAL); // Return range from to +} + + // print value axis label with only three values: top, mid, and bottom for vertical chart + void Chart::prntVerticChartThreeValueAxisLabel(const GFXfont* font) +{ + double cVal; + char sVal[7]; + + getdisplay().fillRect(cRoot.x, cRoot.y, valAxis, 2, fgColor); // top chart line + getdisplay().setFont(font); + + cVal = chrtMin; + cVal = convertValue(cVal, dbName, dbFormat, *commonData); // value (converted) + snprintf(sVal, sizeof(sVal), "%.0f", round(cVal)); + getdisplay().setCursor(cRoot.x, cRoot.y - 2); + getdisplay().printf("%s", sVal); // Range low end + + cVal = chrtMid; + cVal = convertValue(cVal, dbName, dbFormat, *commonData); // value (converted) + snprintf(sVal, sizeof(sVal), "%.0f", round(cVal)); + drawTextCenter(cRoot.x + (valAxis / 2), cRoot.y - 9, sVal); // Range mid end + + cVal = chrtMax; + cVal = convertValue(cVal, dbName, dbFormat, *commonData); // value (converted) + snprintf(sVal, sizeof(sVal), "%.0f", round(cVal)); + drawTextRalign(cRoot.x + valAxis - 2, cRoot.y - 2, sVal); // Range high end + + // draw vertical grid lines for each axis label + for (int j = 0; j <= valAxis; j += (valAxis / 2)) { + getdisplay().drawLine(cRoot.x + j, cRoot.y, cRoot.x + j, cRoot.y + timAxis, fgColor); + } +} + +// print value axis label with only three values: top, mid, and bottom for horizontal chart +void Chart::prntHorizChartThreeValueAxisLabel(const GFXfont* font) +{ + double axLabel; + double chrtMin, chrtMid, chrtMax; + int xOffset, yOffset; // offset for text position of x axis label for different font sizes + String sVal; + + if (font == &Ubuntu_Bold10pt8b) { + xOffset = 39; + yOffset = 16; + } else if (font == &Ubuntu_Bold12pt8b) { + xOffset = 51; + yOffset = 18; + } + getdisplay().setFont(font); + + // convert & round chart bottom+top label to next range step + chrtMin = convertValue(this->chrtMin, dbName, dbFormat, *commonData); + chrtMid = convertValue(this->chrtMid, dbName, dbFormat, *commonData); + chrtMax = convertValue(this->chrtMax, dbName, dbFormat, *commonData); + chrtMin = std::round(chrtMin * 100.0) / 100.0; + chrtMid = std::round(chrtMid * 100.0) / 100.0; + chrtMax = std::round(chrtMax * 100.0) / 100.0; + + // print top axis label + axLabel = (chrtDataFmt == SPEED || chrtDataFmt == TEMPERATURE) ? chrtMax : chrtMin; + sVal = formatLabel(axLabel); + getdisplay().fillRect(cRoot.x, cRoot.y + 2, xOffset + 3, yOffset, bgColor); // Clear small area to remove potential chart lines + drawTextRalign(cRoot.x + xOffset, cRoot.y + yOffset, sVal); // range value + + // print mid axis label + axLabel = chrtMid; + sVal = formatLabel(axLabel); + getdisplay().fillRect(cRoot.x, cRoot.y + (valAxis / 2) - 8, xOffset + 3, 16, bgColor); // Clear small area to remove potential chart lines + drawTextRalign(cRoot.x + xOffset, cRoot.y + (valAxis / 2) + 6, sVal); // range value + getdisplay().drawLine(cRoot.x + xOffset + 3, cRoot.y + (valAxis / 2), cRoot.x + timAxis, cRoot.y + (valAxis / 2), fgColor); + + // print bottom axis label + axLabel = (chrtDataFmt == SPEED || chrtDataFmt == TEMPERATURE) ? chrtMin : chrtMax; + sVal = formatLabel(axLabel); + getdisplay().fillRect(cRoot.x, cRoot.y + valAxis - 14, xOffset + 3, 15, bgColor); // Clear small area to remove potential chart lines + drawTextRalign(cRoot.x + xOffset, cRoot.y + valAxis, sVal); // range value + getdisplay().drawLine(cRoot.x + xOffset + 3, cRoot.y + valAxis, cRoot.x + timAxis, cRoot.y + valAxis, fgColor); +} + +// print value axis label with multiple axis lines for horizontal chart +void Chart::prntHorizChartMultiValueAxisLabel(const GFXfont* font) +{ + double chrtMin, chrtMax, chrtRng; + double axSlots, axIntv, axLabel; + int xOffset; // offset for text position of x axis label for different font sizes + String sVal; + + if (font == &Ubuntu_Bold10pt8b) { + xOffset = 38; + } else if (font == &Ubuntu_Bold12pt8b) { + xOffset = 50; + } + getdisplay().setFont(font); + + chrtMin = convertValue(this->chrtMin, dbName, dbFormat, *commonData); + // chrtMin = std::floor(chrtMin / rngStep) * rngStep; + chrtMin = std::round(chrtMin * 100.0) / 100.0; + chrtMax = convertValue(this->chrtMax, dbName, dbFormat, *commonData); + // chrtMax = std::ceil(chrtMax / rngStep) * rngStep; + chrtMax = std::round(chrtMax * 100.0) / 100.0; + chrtRng = std::round((chrtMax - chrtMin) * 100) / 100; + + axSlots = valAxis / static_cast(VALAXIS_STEP); // number of axis labels (and we want to have a double calculation, no integer) + axIntv = chrtRng / axSlots; + axLabel = chrtMin + axIntv; + // LOG_DEBUG(GwLog::DEBUG, "Chart::printHorizMultiValueAxisLabel: chrtRng: %.2f, th-chrtRng: %.2f, axSlots: %.2f, axIntv: %.2f, axLabel: %.2f, chrtMin: %.2f, chrtMid: %.2f, chrtMax: %.2f", chrtRng, this->chrtRng, axSlots, axIntv, axLabel, this->chrtMin, chrtMid, chrtMax); + + int loopStrt, loopEnd, loopStp; + if (chrtDataFmt == SPEED || chrtDataFmt == TEMPERATURE || chrtDataFmt == OTHER) { + // High value at top + loopStrt = valAxis - VALAXIS_STEP; + loopEnd = VALAXIS_STEP / 2; + loopStp = VALAXIS_STEP * -1; + } else { + // Low value at top + loopStrt = VALAXIS_STEP; + loopEnd = valAxis - (VALAXIS_STEP / 2); + loopStp = VALAXIS_STEP; + } + + for (int j = loopStrt; (loopStp > 0) ? (j < loopEnd) : (j > loopEnd); j += loopStp) { + sVal = formatLabel(axLabel); + getdisplay().fillRect(cRoot.x, cRoot.y + j - 11, xOffset + 3, 21, bgColor); // Clear small area to remove potential chart lines + drawTextRalign(cRoot.x + xOffset, cRoot.y + j + 7, sVal); // range value + getdisplay().drawLine(cRoot.x + xOffset + 3, cRoot.y + j, cRoot.x + timAxis, cRoot.y + j, fgColor); + + axLabel += axIntv; + } +} + +// Draw chart line with thickness of 2px +void Chart::drawBoldLine(const int16_t x1, const int16_t y1, const int16_t x2, const int16_t y2) +{ + int16_t dx = std::abs(x2 - x1); + int16_t dy = std::abs(y2 - y1); + + getdisplay().drawLine(x1, y1, x2, y2, fgColor); + + if (dx >= dy) { // line has horizontal tendency + getdisplay().drawLine(x1, y1 - 1, x2, y2 - 1, fgColor); + } else { // line has vertical tendency + getdisplay().drawLine(x1 - 1, y1, x2 - 1, y2, fgColor); + } +} + +// Convert and format current axis label to user defined format; helper function for easier handling of OBP60Formatter +String Chart::convNformatLabel(const double& label) +{ + GwApi::BoatValue tmpBVal(dbName); // temporary boat value for string formatter + String sVal; + + tmpBVal.setFormat(dbFormat); + tmpBVal.valid = true; + tmpBVal.value = label; + sVal = formatValue(&tmpBVal, *commonData, NO_SIMUDATA).svalue; // Formatted value as string including unit conversion and switching decimal places + if (sVal.length() > 0 && sVal[0] == '!') { + sVal = sVal.substring(1); // cut leading "!" created at OBPFormatter; doesn't work for other fonts than 7SEG + } + + return sVal; +} + +// Format current axis label for printing w/o data format conversion (has been done earlier) +String Chart::formatLabel(const double& label) +{ + char sVal[11]; + + if (dbFormat == "formatCourse" || dbFormat == "formatWind") { + // Format 3 numbers with prefix zero + snprintf(sVal, sizeof(sVal), "%03.0f", label); + + } else if (dbFormat == "formatRot") { + if (label > -10 && label < 10) { + snprintf(sVal, sizeof(sVal), "%3.2f", label); + } else { + snprintf(sVal, sizeof(sVal), "%3.0f", label); + } + } + + else { + if (label < 10) { + snprintf(sVal, sizeof(sVal), "%3.1f", label); + } else { + snprintf(sVal, sizeof(sVal), "%3.0f", label); + } + } + + return String(sVal); +} +// --- Class Chart --------------- diff --git a/lib/obp60task/OBPcharts.h b/lib/obp60task/OBPcharts.h new file mode 100644 index 0000000..fbdcddd --- /dev/null +++ b/lib/obp60task/OBPcharts.h @@ -0,0 +1,116 @@ +// Function lib for display of boat data in various graphical chart formats +#pragma once +#include "Pagedata.h" +#include "OBP60Extensions.h" + +struct Pos { + int x; + int y; +}; + +struct ChartProps { + double range; + double step; +}; + +template +class RingBuffer; +class GwLog; + +class Chart { +protected: + CommonData* commonData; + GwLog* logger; + + enum ChrtDataFormat { + WIND, + ROTATION, + SPEED, + DEPTH, + TEMPERATURE, + OTHER + }; + + static constexpr char HORIZONTAL = 'H'; + static constexpr char VERTICAL = 'V'; + static constexpr int8_t FULL_SIZE = 0; + static constexpr int8_t HALF_SIZE_LEFT = 1; + static constexpr int8_t HALF_SIZE_RIGHT = 2; + + static constexpr int8_t MIN_FREE_VALUES = 60; // free 60 values when chart line reaches chart end + static constexpr int8_t THRESHOLD_NO_DATA = 3; // max. seconds of invalid values in a row + static constexpr int8_t VALAXIS_STEP = 60; // pixels between two chart value axis labels + + static constexpr bool NO_SIMUDATA = true; // switch off simulation feature of function + + RingBuffer& dataBuf; // Buffer to display + //char chrtDir; // Chart timeline direction: 'H' = horizontal, 'V' = vertical + //int8_t chrtSz; // Chart size: [0] = full size, [1] = half size left/top, [2] half size right/bottom + double dfltRng; // Default range of chart, e.g. 30 = [0..30] + uint16_t fgColor; // color code for any screen writing + uint16_t bgColor; // color code for screen background + bool useSimuData; // flag to indicate if simulation data is active + String tempFormat; // user defined format for temperature + double zeroValue; // "0" SI value for temperature + + int dWidth; // Display width + int dHeight; // Display height + int top = 44; // chart gap at top of display (25 lines for standard gap + 19 lines for axis labels) + int bottom = 25; // chart gap at bottom of display to keep space for status line + int hGap = 11; // gap between 2 horizontal charts; actual gap is 2x + int vGap = 17; // gap between 2 vertical charts; actual gap is 2x + int timAxis, valAxis; // size of time and value chart axis + Pos cRoot; // start point of chart area + double chrtRng; // Range of buffer values from min to max value + double chrtMin; // Range low end value + double chrtMax; // Range high end value + double chrtMid; // Range mid value + double rngStep; // Defines the step of adjustment (e.g. 10 m/s) for value axis range + bool recalcRngMid = false; // Flag for re-calculation of mid value of chart for wind data types + + String dbName, dbFormat; // Name and format of data buffer + ChrtDataFormat chrtDataFmt; // Data format of chart boat data type + double dbMIN_VAL; // Lowest possible value of buffer of type + double dbMAX_VAL; // Highest possible value of buffer of type ; indicates invalid value in buffer + size_t bufSize; // History buffer size: 1.920 values for 32 min. history chart + int count; // current size of buffer + int numBufVals; // number of wind values available for current interval selection + int bufStart; // 1st data value in buffer to show + int numAddedBufVals; // Number of values added to buffer since last display + size_t currIdx; // Current index in TWD history buffer + size_t lastIdx; // Last index of TWD history buffer + size_t lastAddedIdx = 0; // Last index of TWD history buffer when new data was added + int numNoData; // Counter for multiple invalid data values in a row + bool bufDataValid = false; // Flag to indicate if buffer data is valid + int oldChrtIntv = 0; // remember recent user selection of data interval + + double chrtPrevVal; // Last data value in chart area + int x, y; // x and y coordinates for drawing + int prevX, prevY; // Last x and y coordinates for drawing + + bool setChartDimensions(const char direction, const int8_t size); //define dimensions and start points for chart + void drawChrt(const char chrtDir, const int8_t chrtIntv, GwApi::BoatValue& currValue); // Draw chart line + void getBufferStartNSize(const int8_t chrtIntv); // Identify buffer size and buffer start position for chart + void calcChrtBorders(double& rngMin, double& rngMid, double& rngMax, double& rng); // Calculate chart points for value axis and return range between and + void drawChartLines(const char direction, const int8_t chrtIntv, const double chrtScale); // Draw chart graph + Pos setCurrentChartPoint(const int i, const char direction, const double chrtVal, const double chrtScale); // Set current chart point to draw + void drawChrtTimeAxis(const char chrtDir, const int8_t chrtSz, const int8_t chrtIntv); // Draw time axis of chart, value and lines + void drawChrtValAxis(const char chrtDir, const int8_t chrtSz, bool prntLabel); // Draw value axis of chart, value and lines + void prntCurrValue(const char chrtDir, GwApi::BoatValue& currValue); // Add current boat data value to chart + void prntNoValidData(const char chrtDir); // print message for no valid data available + double getAngleRng(const double center, size_t amount); // Calculate range between chart center and edges + void prntVerticChartThreeValueAxisLabel(const GFXfont* font); // print value axis label with only three values: top, mid, and bottom for vertical chart + void prntHorizChartThreeValueAxisLabel(const GFXfont* font); // print value axis label with only three values: top, mid, and bottom for horizontal chart + void prntHorizChartMultiValueAxisLabel(const GFXfont* font); // print value axis label with multiple axis lines for horizontal chart + void drawBoldLine(const int16_t x1, const int16_t y1, const int16_t x2, const int16_t y2); // Draw chart line with thickness of 2px + String convNformatLabel(const double& label); // Convert and format current axis label to user defined format; helper function for easier handling of OBP60Formatter + String formatLabel(const double& label); // Format current axis label for printing w/o data format conversion (has been done earlier) + +public: + // Define default chart range and range step for each boat data type + static std::map dfltChrtDta; + + Chart(RingBuffer& dataBuf, double dfltRng, CommonData& common, bool useSimuData); // Chart object of data chart + ~Chart(); + void showChrt(char chrtDir, int8_t chrtSz, const int8_t chrtIntv, bool prntName, bool showCurrValue, GwApi::BoatValue currValue); // Perform all actions to draw chart +}; diff --git a/lib/obp60task/PageAutopilot.cpp b/lib/obp60task/PageAutopilot.cpp new file mode 100644 index 0000000..6cbf299 --- /dev/null +++ b/lib/obp60task/PageAutopilot.cpp @@ -0,0 +1,263 @@ +#if defined BOARD_OBP60S3 || defined BOARD_OBP40S3 + +#include "Pagedata.h" +#include "OBP60Extensions.h" + +// These constants have to match the declaration below in : +// PageDescription registerPageAutopilot( +// {"HDM","HDT", "COG", "STW", "SOG", "DBT","XTE", "DTW", "BTW"}, // Bus values we need in the page +const int HowManyValues = 9; + +const int AverageValues = 4; + +const int ShowHDM = 0; +const int ShowHDT = 1; +const int ShowCOG = 2; +const int ShowSTW = 3; +const int ShowSOG = 4; +const int ShowDBT = 5; +const int ShowXTE = 6; +const int ShowDTW = 7; +const int ShowBTW = 8; + +const int Compass_X0 = 200; // X center point of compass band +const int Compass_Y0 = 220; // Y position of compass lines +const int Compass_LineLength = 22; // Length of compass lines +const float Compass_LineDelta = 8.0;// Compass band: 1deg = 5 Pixels, 10deg = 50 Pixels + +class PageAutopilot : public Page +{ + int WhichDataCompass = ShowHDM; // Start value + int WhichDataDisplay = ShowHDM; // Start value + + public: + PageAutopilot(CommonData &common){ + commonData = &common; + common.logger->logDebug(GwLog::LOG,"Instantiate PageAutopilot"); + } + + virtual void setupKeys(){ + Page::setupKeys(); + commonData->keydata[0].label = "CMP"; + commonData->keydata[1].label = "SRC"; + } + + virtual int handleKey(int key){ + // Code for keylock + + if ( key == 1 ) { + WhichDataCompass += 1; + if ( WhichDataCompass > ShowCOG) + WhichDataCompass = ShowHDM; + return 0; + } + if ( key == 2 ) { + WhichDataDisplay += 1; + if ( WhichDataDisplay > ShowDBT) + WhichDataDisplay = ShowHDM; + } + + if(key == 11){ + commonData->keylock = !commonData->keylock; + return 0; // Commit the key + } + return key; + } + + int displayPage(PageData &pageData){ + GwConfigHandler *config = commonData->config; + GwLog *logger = commonData->logger; + + // Old values for hold function + static String OldDataText[HowManyValues] = {"", "", "","", "", "","", "", ""}; + static String OldDataUnits[HowManyValues] = {"", "", "","", "", "","", "", ""}; + + // Get config data + String lengthformat = config->getString(config->lengthFormat); + // bool simulation = config->getBool(config->useSimuData); + bool holdvalues = config->getBool(config->holdvalues); + String flashLED = config->getString(config->flashLED); + String backlightMode = config->getString(config->backlight); + + GwApi::BoatValue *bvalue; + String DataName[HowManyValues]; + double DataValue[HowManyValues]; + bool DataValid[HowManyValues]; + String DataText[HowManyValues]; + String DataUnits[HowManyValues]; + String DataFormat[HowManyValues]; + FormattedData TheFormattedData; + + for (int i = 0; i < HowManyValues; i++){ + bvalue = pageData.values[i]; + TheFormattedData = formatValue(bvalue, *commonData); + DataName[i] = xdrDelete(bvalue->getName()); + DataName[i] = DataName[i].substring(0, 6); // String length limit for value name + DataUnits[i] = formatValue(bvalue, *commonData).unit; + DataText[i] = TheFormattedData.svalue; // Formatted value as string including unit conversion and switching decimal places + DataValue[i] = TheFormattedData.value; // Value as double in SI unit + DataValid[i] = bvalue->valid; + DataFormat[i] = bvalue->getFormat(); // Unit of value + LOG_DEBUG(GwLog::LOG,"Drawing at PageAutopilot: %d %s %f %s %s", i, DataName[i], DataValue[i], DataFormat[i], DataText[i] ); + } + + // Optical warning by limit violation (unused) + if(String(flashLED) == "Limit Violation"){ + setBlinkingLED(false); + setFlashLED(false); + } + + if (bvalue == NULL) return PAGE_OK; // WTF why this statement? + + //*********************************************************** + + // Set display in partial refresh mode + getdisplay().setPartialWindow(0, 0, getdisplay().width(), getdisplay().height()); // Set partial update + getdisplay().setTextColor(commonData->fgcolor); + + // Horizontal line 2 pix top & bottom + // Print data on top half + getdisplay().fillRect(0, 130, 400, 2, commonData->fgcolor); + getdisplay().setFont(&Ubuntu_Bold20pt8b); + getdisplay().setCursor(10, 70); + getdisplay().print(DataName[WhichDataDisplay]); // Page name + // Show unit + getdisplay().setFont(&Ubuntu_Bold12pt8b); + getdisplay().setCursor(10, 120); + getdisplay().print(DataUnits[WhichDataDisplay]); + getdisplay().setCursor(190, 120); + getdisplay().setFont(&DSEG7Classic_BoldItalic42pt7b); + + if(holdvalues == false){ + getdisplay().print(DataText[WhichDataDisplay]); // Real value as formated string + } + else{ + getdisplay().print(OldDataText[WhichDataDisplay]); // Old value as formated string + } + if(DataValid[WhichDataDisplay] == true){ + OldDataText[WhichDataDisplay] = DataText[WhichDataDisplay]; // Save the old value + OldDataUnits[WhichDataDisplay] = DataUnits[WhichDataDisplay]; // Save the old unit + } + + // Now draw compass band + // Get the data + double TheAngle = DataValue[WhichDataCompass]; + static double AvgAngle = 0; + AvgAngle = ( AvgAngle * AverageValues + TheAngle ) / (AverageValues + 1 ); + + int TheTrend = round( ( TheAngle - AvgAngle) * 180.0 / M_PI ); + + static const int bsize = 30; + char buffer[bsize+1]; + buffer[0]=0; + + getdisplay().setFont(&Ubuntu_Bold16pt8b); + getdisplay().setCursor(10, Compass_Y0-60); + getdisplay().print(DataName[WhichDataCompass]); // Page name + + + // Draw compass base line and pointer + getdisplay().fillRect(0, Compass_Y0, 400, 3, commonData->fgcolor); + getdisplay().fillTriangle(Compass_X0,Compass_Y0-40,Compass_X0-10,Compass_Y0-80,Compass_X0+10,Compass_Y0-80,commonData->fgcolor); + // Draw trendlines + for ( int i = 1; i < abs(TheTrend) / 2; i++){ + int x1; + if ( TheTrend < 0 ) + x1 = Compass_X0 + 20 * i; + else + x1 = Compass_X0 - 20 * ( i + 1 ); + + getdisplay().fillRect(x1, Compass_Y0 -55, 10, 6, commonData->fgcolor); + } + // Central line + satellite lines + double NextSector = round(TheAngle / ( M_PI / 9 )) * ( M_PI / 9 ); // Get the next 20degree value + double Offset = - ( NextSector - TheAngle); // Offest of the center line compared to TheAngle in Radian + + int Delta_X = int ( Offset * 180.0 / M_PI * Compass_LineDelta ); + for ( int i = 0; i <=4; i++ ){ + int x0; + x0 = Compass_X0 + Delta_X + 2 * i * 5 * Compass_LineDelta; + getdisplay().fillRect(x0-2, Compass_Y0 - 2 * Compass_LineLength, 5, 2 * Compass_LineLength, commonData->fgcolor); + x0 = Compass_X0 + Delta_X + ( 2 * i + 1 ) * 5 * Compass_LineDelta; + getdisplay().fillRect(x0-1, Compass_Y0 - Compass_LineLength, 3, Compass_LineLength, commonData->fgcolor); + + x0 = Compass_X0 + Delta_X - 2 * i * 5 * Compass_LineDelta; + getdisplay().fillRect(x0-2, Compass_Y0 - 2 * Compass_LineLength, 5, 2 * Compass_LineLength, commonData->fgcolor); + x0 = Compass_X0 + Delta_X - ( 2 * i + 1 ) * 5 * Compass_LineDelta; + getdisplay().fillRect(x0-1, Compass_Y0 - Compass_LineLength, 3, Compass_LineLength, commonData->fgcolor); + } + + getdisplay().fillRect(0, Compass_Y0, 400, 3, commonData->fgcolor); + // Add the numbers to the compass band + int x0; + float AngleToDisplay = NextSector * 180.0 / M_PI; + + x0 = Compass_X0 + Delta_X; + getdisplay().setFont(&DSEG7Classic_BoldItalic16pt7b); + + do { + getdisplay().setCursor(x0 - 40, Compass_Y0 + 40); + snprintf(buffer,bsize,"%03.0f", AngleToDisplay); + getdisplay().print(buffer); + AngleToDisplay += 20; + if ( AngleToDisplay >= 360.0 ) + AngleToDisplay -= 360.0; + x0 -= 4 * 5 * Compass_LineDelta; + } while ( x0 >= 0 - 60 ); + + AngleToDisplay = NextSector * 180.0 / M_PI - 20; + if ( AngleToDisplay < 0 ) + AngleToDisplay += 360.0; + + x0 = Compass_X0 + Delta_X + 4 * 5 * Compass_LineDelta; + do { + getdisplay().setCursor(x0 - 40, Compass_Y0 + 40); + snprintf(buffer,bsize,"%03.0f", AngleToDisplay); + // Quick and dirty way to prevent wrapping text in next line + if ( ( x0 - 40 ) > 380 ) + buffer[0] = 0; + else if ( ( x0 - 40 ) > 355 ) + buffer[1] = 0; + else if ( ( x0 - 40 ) > 325 ) + buffer[2] = 0; + + getdisplay().print(buffer); + + AngleToDisplay -= 20; + if ( AngleToDisplay < 0 ) + AngleToDisplay += 360.0; + x0 += 4 * 5 * Compass_LineDelta; + } while (x0 < ( 400 - 20 -40 ) ); + + // static int x_test = 320; + // x_test += 2; + + // snprintf(buffer,bsize,"%03d", x_test); + // getdisplay().setCursor(x_test, Compass_Y0 - 60); + // getdisplay().print(buffer); + // if ( x_test > 390) + // x_test = 320; + + return PAGE_UPDATE; + }; + +}; + +static Page *createPage(CommonData &common){ + return new PageAutopilot(common); +}/** + * with the code below we make this page known to the PageTask + * we give it a type (name) that can be selected in the config + * we define which function is to be called + * and we provide the number of user parameters we expect + * this will be number of BoatValue pointers in pageData.values + */ +PageDescription registerPageAutopilot( + "Autopilot", // Page name + createPage, // Action + 0, // Number of bus values depends on selection in Web configuration + {"HDM","HDT", "COG", "STW", "SOG", "DBT","XTE", "DTW", "BTW"}, // Bus values we need in the page + true // Show display header on/off +); + +#endif diff --git a/lib/obp60task/PageClock.cpp b/lib/obp60task/PageClock.cpp index a0be7d7..3c5a63f 100644 --- a/lib/obp60task/PageClock.cpp +++ b/lib/obp60task/PageClock.cpp @@ -4,91 +4,298 @@ #include "OBP60Extensions.h" /* - * TODO mode: race timer: keys - * - prepare: set countdown to 5min - * reset: abort current countdown and start over with 5min preparation - * - 5min: key press - * - 4min: key press to sync - * - 1min: buzzer signal - * - start: buzzer signal for start + * PageClock: Clock page with + * - Analog mode (mode == 'A') + * - Digital mode (mode == 'D') + * - Countdown timer mode (mode == 'T') + * - Keys in mode analog and digital clock: + * K1: MODE (A/D/T) + * K2: POS (select field: HH / MM / SS) + * K3: + * K4: + * K5: TZ (Local/UTC) * + * Regatta timer mode: + * - Format HH:MM:SS (24h, leading zeros) + * - Keys in timer mode: + * K1: MODE (A/D/T) + * K2: POS (select field: HH / MM / SS) + * K3: + (increment selected field) + * K4: - (decrement selected field) + * K5: RUN (start/stop countdown) + * - Selection marker: line under active field (width 2px, not wider than digits) + * - Editing only possible when timer is not running + * - When page is left, running timer continues in background using RTC time + * (on re-entry, remaining time is recalculated from RTC) */ class PageClock : public Page { -bool simulation = false; -int simtime; -bool keylock = false; -char source = 'R'; // time source (R)TC | (G)PS | (N)TP -char mode = 'A'; // display mode (A)nalog | (D)igital | race (T)imer -char tz = 'L'; // time zone (L)ocal | (U)TC -double timezone = 0; // there are timezones with non int offsets, e.g. 5.5 or 5.75 -double homelat; -double homelon; -bool homevalid = false; // homelat and homelon are valid + bool simulation = false; + int simtime; + bool keylock = false; +#ifdef BOARD_OBP60S3 + char source = 'G'; // Time source (R)TC | (G)PS | (N)TP +#endif +#ifdef BOARD_OBP40S3 + char source = 'R'; // time source (R)TC | (G)PS | (N)TP +#endif + char mode = 'A'; // Display mode (A)nalog | (D)igital | race (T)imer + char tz = 'L'; // Time zone (L)ocal | (U)TC + double timezone = 0; // There are timezones with non int offsets, e.g. 5.5 or 5.75 + double homelat; + double homelon; + bool homevalid = false; // Homelat and homelon are valid - public: - PageClock(CommonData &common){ + // Timer state (static so it survives page switches) + static bool timerInitialized; + static bool timerRunning; + static int timerHours; + static int timerMinutes; + static int timerSeconds; + // Preset seconds for sync button (default 4 minutes) + static const int timerPresetSeconds = 4 * 60; + // Initial timer setting at start (so we can restore it) + static int timerStartHours; + static int timerStartMinutes; + static int timerStartSeconds; + static int selectedField; // 0 = hours, 1 = minutes, 2 = seconds + static bool showSelectionMarker; + static time_t timerEndEpoch; // Absolute end time based on RTC + + void setupTimerDefaults() + { + if (!timerInitialized) { + timerInitialized = true; + timerRunning = false; + timerHours = 0; + timerMinutes = 0; + timerSeconds = 0; + timerStartHours = 0; + timerStartMinutes = 0; + timerStartSeconds = 0; + selectedField = 0; + showSelectionMarker = true; + timerEndEpoch = 0; + } + } + + // Limiter for overrun settings values + static int clamp(int value, int minVal, int maxVal) + { + if (value < minVal) return maxVal; + if (value > maxVal) return minVal; + return value; + } + + void incrementSelected() + { + if (selectedField == 0) { + timerHours = clamp(timerHours + 1, 0, 23); + } else if (selectedField == 1) { + timerMinutes = clamp(timerMinutes + 1, 0, 59); + } else { + timerSeconds = clamp(timerSeconds + 1, 0, 59); + } + } + + void decrementSelected() + { + if (selectedField == 0) { + timerHours = clamp(timerHours - 1, 0, 23); + } else if (selectedField == 1) { + timerMinutes = clamp(timerMinutes - 1, 0, 59); + } else { + timerSeconds = clamp(timerSeconds - 1, 0, 59); + } + } + + int totalTimerSeconds() const + { + return timerHours * 3600 + timerMinutes * 60 + timerSeconds; + } + +public: + PageClock(CommonData& common) + { commonData = &common; - common.logger->logDebug(GwLog::LOG,"Instantiate PageClock"); + common.logger->logDebug(GwLog::LOG, "Instantiate PageClock"); simulation = common.config->getBool(common.config->useSimuData); timezone = common.config->getString(common.config->timeZone).toDouble(); homelat = common.config->getString(common.config->homeLAT).toDouble(); homelon = common.config->getString(common.config->homeLON).toDouble(); homevalid = homelat >= -180.0 and homelat <= 180 and homelon >= -90.0 and homelon <= 90.0; simtime = 38160; // time value 11:36 + setupTimerDefaults(); } - virtual void setupKeys(){ + virtual void setupKeys() + { Page::setupKeys(); - commonData->keydata[0].label = "SRC"; - commonData->keydata[1].label = "MODE"; - commonData->keydata[4].label = "TZ"; + + if (mode == 'T') { + // Timer mode: MODE, POS, +, -, RUN + commonData->keydata[0].label = "MODE"; + commonData->keydata[1].label = "POS"; + // K3: '+' while editing, 'SYNC' while running to set a preset countdown + commonData->keydata[2].label = timerRunning ? "SYNC" : "+"; + commonData->keydata[3].label = "-"; + commonData->keydata[4].label = timerRunning ? "RESET" : "START"; + } else { + // Clock modes: like original + commonData->keydata[0].label = "MODE"; + commonData->keydata[1].label = "SRC"; + commonData->keydata[4].label = "TZ"; + } } // Key functions - virtual int handleKey(int key){ - // Time source + virtual int handleKey(int key) + { + setupTimerDefaults(); + + // Keylock function + if (key == 11) { // Code for keylock + keylock = !keylock; // Toggle keylock + return 0; // Commit the key + } + + if (mode == 'T') { + // Timer mode key handling + + // MODE (K1): cycle display mode A/D/T + if (key == 1) { + switch (mode) { + case 'A': mode = 'D'; break; + case 'D': mode = 'T'; break; + case 'T': mode = 'A'; break; + default: mode = 'A'; break; + } + setupKeys(); + return 0; + } + + // POS (K2): select field HH / MM / SS (only if timer not running) + if (key == 2 && !timerRunning) { + selectedField = (selectedField + 1) % 3; + showSelectionMarker = true; + return 0; + } + + // + (K3): increment selected field (only if timer not running) + if (key == 3 && !timerRunning) { + incrementSelected(); + return 0; + } + if (key == 3 && timerRunning) { + // When timer is running, K3 acts as a synchronization button: + // set remaining countdown to the preset value (e.g. 4 minutes). + if (commonData->data.rtcValid) { + int preset = timerPresetSeconds; + // update start-setting so STOP will restore this preset + timerStartHours = preset / 3600; + timerStartMinutes = (preset % 3600) / 60; + timerStartSeconds = preset % 60; + + struct tm rtcCopy = commonData->data.rtcTime; + time_t nowEpoch = mktime(&rtcCopy); + timerEndEpoch = nowEpoch + preset; + + // Update visible timer fields immediately + timerHours = timerStartHours; + timerMinutes = timerStartMinutes; + timerSeconds = timerStartSeconds; +// commonData->keydata[4].label = "RESET"; + } + return 0; + } + + // - (K4): decrement selected field (only if timer not running) + if (key == 4 && !timerRunning) { + decrementSelected(); + return 0; + } + if (key == 4 && timerRunning) { // No action if timer running + return 0; + } + + // RUN (K5): start/stop timer + if (key == 5) { + if (!timerRunning) { + // Start timer if a non-zero duration is set + int total = totalTimerSeconds(); + if (total > 0 && commonData->data.rtcValid) { + // Remember initial timer setting at start + timerStartHours = timerHours; + timerStartMinutes = timerMinutes; + timerStartSeconds = timerSeconds; + + struct tm rtcCopy = commonData->data.rtcTime; + time_t nowEpoch = mktime(&rtcCopy); + timerEndEpoch = nowEpoch + total; + timerRunning = true; + showSelectionMarker = false; + } + } else { + // Stop timer: restore initial start setting + timerHours = timerStartHours; + timerMinutes = timerStartMinutes; + timerSeconds = timerStartSeconds; + timerRunning = false; + showSelectionMarker = true; + // marker will become visible again only after POS press + } + return 0; + } + + // In timer mode, other keys are passed through + return key; + } + + // Clock (A/D) modes key handling – like original PageClock + + // MODE (K1) if (key == 1) { - if (source == 'G') { - source = 'R'; - } else { - source = 'G'; + switch (mode) { + case 'A': mode = 'D'; break; + case 'D': mode = 'T'; break; + case 'T': mode = 'A'; break; + default: mode = 'A'; break; } + setupKeys(); return 0; } + + // Time source (K2) if (key == 2) { - if (mode == 'A') { - mode = 'D'; - } else if (mode == 'D') { - mode = 'T'; - } else { - mode = 'A'; - } - return 0; - } - // Time zone: Local / UTC - if (key == 5) { - if (tz == 'L') { - tz = 'U'; - } else { - tz = 'L'; + switch (source) { + case 'G': source = 'R'; break; + case 'R': source = 'G'; break; + default: source = 'G'; break; } return 0; } - // Keylock function - if(key == 11){ // Code for keylock - keylock = !keylock; // Toggle keylock - return 0; // Commit the key + // Time zone: Local / UTC (K5) + if (key == 5) { + switch (tz) { + case 'L': tz = 'U'; break; + case 'U': tz = 'L'; break; + default: tz = 'L'; break; + } + return 0; } + return key; } - int displayPage(PageData &pageData) + int displayPage(PageData& pageData) { - GwConfigHandler *config = commonData->config; - GwLog *logger = commonData->logger; + GwConfigHandler* config = commonData->config; + GwLog* logger = commonData->logger; + + setupTimerDefaults(); + setupKeys(); // Ensure correct key labels for current mode static String svalue1old = ""; static String unit1old = ""; @@ -112,58 +319,57 @@ bool homevalid = false; // homelat and homelon are valid String backlightMode = config->getString(config->backlight); // Get boat values for GPS time - GwApi::BoatValue *bvalue1 = pageData.values[0]; // First element in list (only one value by PageOneValue) + GwApi::BoatValue* bvalue1 = pageData.values[0]; // First element in list String name1 = bvalue1->getName().c_str(); // Value name name1 = name1.substring(0, 6); // String length limit for value name - if(simulation == false){ + if (simulation == false) { value1 = bvalue1->value; // Value as double in SI unit - } - else{ + } else { value1 = simtime++; // Simulation data for time value 11:36 in seconds } // Other simulation data see OBP60Formatter.cpp - bool valid1 = bvalue1->valid; // Valid information - String svalue1 = formatValue(bvalue1, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places + bool valid1 = bvalue1->valid; // Valid information + String svalue1 = formatValue(bvalue1, *commonData).svalue; // Formatted value String unit1 = formatValue(bvalue1, *commonData).unit; // Unit of value - if(valid1 == true){ + if (valid1 == true) { svalue1old = svalue1; // Save old value unit1old = unit1; // Save old unit } // Get boat values for GPS date - GwApi::BoatValue *bvalue2 = pageData.values[1]; // Second element in list (only one value by PageOneValue) + GwApi::BoatValue* bvalue2 = pageData.values[1]; // Second element in list String name2 = bvalue2->getName().c_str(); // Value name name2 = name2.substring(0, 6); // String length limit for value name value2 = bvalue2->value; // Value as double in SI unit - bool valid2 = bvalue2->valid; // Valid information - String svalue2 = formatValue(bvalue2, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places + bool valid2 = bvalue2->valid; // Valid informationgetdisplay().print("RTC"); + String svalue2 = formatValue(bvalue2, *commonData).svalue; // Formatted value String unit2 = formatValue(bvalue2, *commonData).unit; // Unit of value - if(valid2 == true){ + if (valid2 == true) { svalue2old = svalue2; // Save old value unit2old = unit2; // Save old unit } - // Get boat values for HDOP date - GwApi::BoatValue *bvalue3 = pageData.values[2]; // Third element in list (only one value by PageOneValue) + // Get boat values for HDOP + GwApi::BoatValue* bvalue3 = pageData.values[2]; // Third element in list String name3 = bvalue3->getName().c_str(); // Value name name3 = name3.substring(0, 6); // String length limit for value name value3 = bvalue3->value; // Value as double in SI unit - bool valid3 = bvalue3->valid; // Valid information - String svalue3 = formatValue(bvalue3, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places + bool valid3 = bvalue3->valid; // Valid information + String svalue3 = formatValue(bvalue3, *commonData).svalue; // Formatted value String unit3 = formatValue(bvalue3, *commonData).unit; // Unit of value - if(valid3 == true){ + if (valid3 == true) { svalue3old = svalue3; // Save old value unit3old = unit3; // Save old unit } // Optical warning by limit violation (unused) - if(String(flashLED) == "Limit Violation"){ + if (String(flashLED) == "Limit Violation") { setBlinkingLED(false); setFlashLED(false); } // Logging boat values - if (bvalue1 == NULL) return PAGE_OK; // WTF why this statement? - LOG_DEBUG(GwLog::LOG,"Drawing at PageClock, %s:%f, %s:%f", name1.c_str(), value1, name2.c_str(), value2); + if (bvalue1 == NULL) return PAGE_OK; + LOG_DEBUG(GwLog::LOG, "Drawing at PageClock, %s:%f, %s:%f", name1.c_str(), value1, name2.c_str(), value2); // Draw page //*********************************************************** @@ -174,290 +380,463 @@ bool homevalid = false; // homelat and homelon are valid getdisplay().setTextColor(commonData->fgcolor); time_t tv = mktime(&commonData->data.rtcTime) + timezone * 3600; - struct tm *local_tm = localtime(&tv); + struct tm* local_tm = localtime(&tv); - // Show values GPS date - getdisplay().setFont(&Ubuntu_Bold8pt8b); - getdisplay().setCursor(10, 65); - if (holdvalues == false) { - if (source == 'G') { - // GPS value - getdisplay().print(svalue2); - } else if (commonData->data.rtcValid) { - // RTC value - if (tz == 'L') { - getdisplay().print(formatDate(dateformat, local_tm->tm_year + 1900, local_tm->tm_mon + 1, local_tm->tm_mday)); - } - else { - getdisplay().print(formatDate(dateformat, commonData->data.rtcTime.tm_year + 1900, commonData->data.rtcTime.tm_mon + 1, commonData->data.rtcTime.tm_mday)); - } - } else { - getdisplay().print("---"); + if (mode == 'T') { + // REGATTA TIMER MODE: countdown timer HH:MM:SS in the center with 7-segment font + //******************************************************************************* + + int dispH = timerHours; + int dispM = timerMinutes; + int dispS = timerSeconds; + + // Update remaining time if timer is running (based on RTC) + if (timerRunning && commonData->data.rtcValid) { + struct tm rtcCopy = commonData->data.rtcTime; + time_t nowEpoch = mktime(&rtcCopy); + time_t remaining = timerEndEpoch - nowEpoch; + if(remaining <= 5 && remaining != 0){ + // Short pre buzzer alarm (100% power) + setBuzzerPower(100); + buzzer(TONE2, 75); + setBuzzerPower(config->getInt(config->buzzerPower)); + } + if (remaining <= 0) { + remaining = 0; + timerRunning = false; + commonData->keydata[3].label = "-"; + commonData->keydata[4].label = "START"; + showSelectionMarker = true; + // Buzzer alarm (100% power) + setBuzzerPower(100); + buzzer(TONE2, 800); + setBuzzerPower(config->getInt(config->buzzerPower)); + + // When countdown is finished, restore the initial start time + timerHours = timerStartHours; + timerMinutes = timerStartMinutes; + timerSeconds = timerStartSeconds; + } + else{ + commonData->keydata[3].label = ""; + commonData->keydata[4].label = "RESET"; + } + int rem = static_cast(remaining); + dispH = rem / 3600; + rem -= dispH * 3600; + dispM = rem / 60; + dispS = rem % 60; } + + char buf[9]; // "HH:MM:SS" + snprintf(buf, sizeof(buf), "%02d:%02d:%02d", dispH, dispM, dispS); + String timeStr = String(buf); + + // Clear central area and draw large digital time + getdisplay().fillRect(0, 110, getdisplay().width(), 80, commonData->bgcolor); + + getdisplay().setFont(&DSEG7Classic_BoldItalic30pt7b); + + // Determine widths for digits and colon to position selection underline exactly + int16_t x0, y0; + uint16_t wDigit, hDigit; + uint16_t wColon, hColon; + + getdisplay().getTextBounds("00", 0, 0, &x0, &y0, &wDigit, &hDigit); + getdisplay().getTextBounds(":", 0, 0, &x0, &y0, &wColon, &hColon); + + uint16_t totalWidth = 3 * wDigit + 2 * wColon; + + int16_t baseX = (static_cast(getdisplay().width()) - static_cast(totalWidth)) / 2; + int16_t centerY = 150; + + // Draw time string centered + int16_t x1b, y1b; + uint16_t wb, hb; + getdisplay().getTextBounds(timeStr, 0, 0, &x1b, &y1b, &wb, &hb); + int16_t textX = (static_cast(getdisplay().width()) - static_cast(wb)) / 2; + int16_t textY = centerY + hb / 2; + + //getdisplay().setCursor(textX, textY); // horzontal jitter + getdisplay().setCursor(47, textY); // static X position + getdisplay().print(timeStr); + + // Selection marker (only visible when not running and POS pressed) + if (!timerRunning && showSelectionMarker) { + int16_t selX = baseX - 8; // Hours start + if (selectedField == 1) { + selX = baseX + wDigit + wColon; // Minutes start + } else if (selectedField == 2) { + selX = baseX + 2 * wDigit + 2 * wColon + 12; // Seconds start + } + + int16_t underlineY = centerY + hb / 2 + 5; + //getdisplay().fillRect(selX, underlineY, wDigit, 6, commonData->fgcolor); + getdisplay().fillRoundRect(selX, underlineY, wDigit, 6, 2, commonData->fgcolor); + } + + // Page label + getdisplay().setFont(&Ubuntu_Bold16pt8b); + getdisplay().setCursor(100, 70); + getdisplay().print("Regatta Timer"); + + } else if (mode == 'D') { + // DIGITAL CLOCK MODE: large 7-segment time based on GPS/RTC + //********************************************************** + + int hour24 = 0; + int minute24 = 0; + int second24 = 0; + + if (source == 'R' && commonData->data.rtcValid) { + time_t tv2 = mktime(&commonData->data.rtcTime); + if (tz == 'L') { + tv2 += static_cast(timezone * 3600); + } + struct tm* tm2 = localtime(&tv2); + hour24 = tm2->tm_hour; + minute24 = tm2->tm_min; + second24 = tm2->tm_sec; + } else { + double t = value1; + if (tz == 'L') { + t += timezone * 3600; + } + if (t >= 86400) t -= 86400; + if (t < 0) t += 86400; + hour24 = static_cast(t / 3600.0); + int rest = static_cast(t) - hour24 * 3600; + minute24 = rest / 60; + second24 = rest % 60; + } + + char buf[9]; // "HH:MM:SS" + snprintf(buf, sizeof(buf), "%02d:%02d:%02d", hour24, minute24, second24); + String timeStr = String(buf); + + getdisplay().fillRect(0, 110, getdisplay().width(), 80, commonData->bgcolor); + + getdisplay().setFont(&DSEG7Classic_BoldItalic30pt7b); + + int16_t x1b, y1b; + uint16_t wb, hb; + getdisplay().getTextBounds(timeStr, 0, 0, &x1b, &y1b, &wb, &hb); + + int16_t x = (static_cast(getdisplay().width()) - static_cast(wb)) / 2; + int16_t y = 150 + hb / 2; + + //getdisplay().setCursor(x, y); // horizontal jitter + getdisplay().setCursor(47, y); // static X position + getdisplay().print(timeStr); // Display actual time + + // Small indicators: timezone and source + getdisplay().setFont(&Ubuntu_Bold8pt8b); + + getdisplay().setCursor(47, 110); + if (source == 'G') { + getdisplay().print("GPS"); + } else { + getdisplay().print("RTC"); + } + + getdisplay().setCursor(47 + 40, 110); + if (holdvalues == false) { + getdisplay().print(tz == 'L' ? "LOT" : "UTC"); + } else { + getdisplay().print(unit2old); // date unit + } + + // Page label + getdisplay().setFont(&Ubuntu_Bold16pt8b); + getdisplay().setCursor(100, 70); + getdisplay().print("Digital Clock"); + } else { - getdisplay().print(svalue2old); - } - getdisplay().setFont(&Ubuntu_Bold12pt8b); - getdisplay().setCursor(10, 95); - getdisplay().print("Date"); // Name + // ANALOG CLOCK MODE (mode == 'A') + //******************************** - // Horizintal separator left - getdisplay().fillRect(0, 149, 60, 3, commonData->fgcolor); - - // Show values GPS time - getdisplay().setFont(&Ubuntu_Bold8pt8b); - getdisplay().setCursor(10, 250); - if (holdvalues == false) { - if (source == 'G') { - getdisplay().print(svalue1); // Value - } - else if (commonData->data.rtcValid) { - if (tz == 'L') { - getdisplay().print(formatTime('s', local_tm->tm_hour, local_tm->tm_min, local_tm->tm_sec)); - } - else { - getdisplay().print(formatTime('s', commonData->data.rtcTime.tm_hour, commonData->data.rtcTime.tm_min, commonData->data.rtcTime.tm_sec)); - } + // Show values GPS date + getdisplay().setFont(&Ubuntu_Bold8pt8b); + getdisplay().setCursor(10, 65); + if (holdvalues == false) { + if (source == 'G') { + // GPS value + getdisplay().print(svalue2); + } else if (commonData->data.rtcValid) { + // RTC value + if (tz == 'L') { + getdisplay().print(formatDate(dateformat, local_tm->tm_year + 1900, local_tm->tm_mon + 1, local_tm->tm_mday)); + } else { + getdisplay().print(formatDate(dateformat, commonData->data.rtcTime.tm_year + 1900, commonData->data.rtcTime.tm_mon + 1, commonData->data.rtcTime.tm_mday)); + } + } else { + getdisplay().print("---"); + } } else { - getdisplay().print("---"); + getdisplay().print(svalue2old); } - } - else { - getdisplay().print(svalue1old); - } - getdisplay().setFont(&Ubuntu_Bold12pt8b); - getdisplay().setCursor(10, 220); - getdisplay().print("Time"); // Name + getdisplay().setFont(&Ubuntu_Bold12pt8b); + getdisplay().setCursor(10, 95); + getdisplay().print("Date"); // Name - // Show values sunrise - String sunrise = "---"; - if ((valid1 and valid2 and valid3 == true) or (homevalid and commonData->data.rtcValid)) { - sunrise = String(commonData->sundata.sunriseHour) + ":" + String(commonData->sundata.sunriseMinute + 100).substring(1); - svalue5old = sunrise; - } else if (simulation) { - sunrise = String("06:42"); - } + // Horizontal separator left + getdisplay().fillRect(0, 149, 60, 3, commonData->fgcolor); - getdisplay().setFont(&Ubuntu_Bold8pt8b); - getdisplay().setCursor(335, 65); - if(holdvalues == false) getdisplay().print(sunrise); // Value - else getdisplay().print(svalue5old); - getdisplay().setFont(&Ubuntu_Bold12pt8b); - getdisplay().setCursor(335, 95); - getdisplay().print("SunR"); // Name + // Show values GPS time (small text bottom left) + getdisplay().setFont(&Ubuntu_Bold8pt8b); + getdisplay().setCursor(10, 250); + if (holdvalues == false) { + if (source == 'G') { + getdisplay().print(svalue1); // Value + } else if (commonData->data.rtcValid) { + if (tz == 'L') { + getdisplay().print(formatTime('s', local_tm->tm_hour, local_tm->tm_min, local_tm->tm_sec)); + } else { + getdisplay().print(formatTime('s', commonData->data.rtcTime.tm_hour, commonData->data.rtcTime.tm_min, commonData->data.rtcTime.tm_sec)); + } + } else { + getdisplay().print("---"); + } + } else { + getdisplay().print(svalue1old); + } + getdisplay().setFont(&Ubuntu_Bold12pt8b); + getdisplay().setCursor(10, 220); + getdisplay().print("Time"); // Name - // Horizintal separator right - getdisplay().fillRect(340, 149, 80, 3, commonData->fgcolor); + // Show values sunrise + String sunrise = "---"; + if ((valid1 and valid2 and valid3 == true) or (homevalid and commonData->data.rtcValid)) { + sunrise = String(commonData->sundata.sunriseHour) + ":" + String(commonData->sundata.sunriseMinute + 100).substring(1); + svalue5old = sunrise; + } else if (simulation) { + sunrise = String("06:42"); + } - // Show values sunset - String sunset = "---"; - if ((valid1 and valid2 and valid3 == true) or (homevalid and commonData->data.rtcValid)) { - sunset = String(commonData->sundata.sunsetHour) + ":" + String(commonData->sundata.sunsetMinute + 100).substring(1); - svalue6old = sunset; - } else if (simulation) { - sunset = String("21:03"); - } + getdisplay().setFont(&Ubuntu_Bold8pt8b); + getdisplay().setCursor(335, 65); + if (holdvalues == false) getdisplay().print(sunrise); // Value + else getdisplay().print(svalue5old); + getdisplay().setFont(&Ubuntu_Bold12pt8b); + getdisplay().setCursor(335, 95); + getdisplay().print("SunR"); // Name - getdisplay().setFont(&Ubuntu_Bold8pt8b); - getdisplay().setCursor(335, 250); - if(holdvalues == false) getdisplay().print(sunset); // Value - else getdisplay().print(svalue6old); - getdisplay().setFont(&Ubuntu_Bold12pt8b); - getdisplay().setCursor(335, 220); - getdisplay().print("SunS"); // Name + // Horizontal separator right + getdisplay().fillRect(340, 149, 80, 3, commonData->fgcolor); -//******************************************************************************************* + // Show values sunset + String sunset = "---"; + if ((valid1 and valid2 and valid3 == true) or (homevalid and commonData->data.rtcValid)) { + sunset = String(commonData->sundata.sunsetHour) + ":" + String(commonData->sundata.sunsetMinute + 100).substring(1); + svalue6old = sunset; + } else if (simulation) { + sunset = String("21:03"); + } - // Draw clock - int rInstrument = 110; // Radius of clock - float pi = 3.141592; + getdisplay().setFont(&Ubuntu_Bold8pt8b); + getdisplay().setCursor(335, 250); + if (holdvalues == false) getdisplay().print(sunset); // Value + else getdisplay().print(svalue6old); + getdisplay().setFont(&Ubuntu_Bold12pt8b); + getdisplay().setCursor(335, 220); + getdisplay().print("SunS"); // Name + + int rInstrument = 110; // Radius of clock + float pi = 3.141592; - getdisplay().fillCircle(200, 150, rInstrument + 10, commonData->fgcolor); // Outer circle - getdisplay().fillCircle(200, 150, rInstrument + 7, commonData->bgcolor); // Outer circle + getdisplay().fillCircle(200, 150, rInstrument + 10, commonData->fgcolor); // Outer circle + getdisplay().fillCircle(200, 150, rInstrument + 7, commonData->bgcolor); // Outer circle - for(int i=0; i<360; i=i+1) - { - // Scaling values - float x = 200 + (rInstrument-30)*sin(i/180.0*pi); // x-coordinate dots - float y = 150 - (rInstrument-30)*cos(i/180.0*pi); // y-coordinate cots - const char *ii = ""; - switch (i) + for (int i = 0; i < 360; i = i + 1) { - case 0: ii="12"; break; - case 30 : ii=""; break; - case 60 : ii=""; break; - case 90 : ii="3"; break; - case 120 : ii=""; break; - case 150 : ii=""; break; - case 180 : ii="6"; break; - case 210 : ii=""; break; - case 240 : ii=""; break; - case 270 : ii="9"; break; - case 300 : ii=""; break; - case 330 : ii=""; break; - default: break; + // Scaling values + float x = 200 + (rInstrument - 30) * sin(i / 180.0 * pi); // x-coordinate dots + float y = 150 - (rInstrument - 30) * cos(i / 180.0 * pi); // y-coordinate dots + const char* ii = ""; + switch (i) + { + case 0: ii = "12"; break; + case 90: ii = "3"; break; + case 180: ii = "6"; break; + case 270: ii = "9"; break; + default: break; + } + + // Print text centered on position x, y + int16_t x1c, y1c; // Return values of getTextBounds + uint16_t wc, hc; // Return values of getTextBounds + getdisplay().getTextBounds(ii, int(x), int(y), &x1c, &y1c, &wc, &hc); // Calc width of new string + getdisplay().setCursor(x - wc / 2, y + hc / 2); + if (i % 90 == 0) { + getdisplay().setFont(&Ubuntu_Bold12pt8b); + getdisplay().print(ii); + } + + // Draw sub scale with dots + float sinx = 0; + float cosx = 0; + if (i % 6 == 0) { + float x1d = 200 + rInstrument * sin(i / 180.0 * pi); + float y1d = 150 - rInstrument * cos(i / 180.0 * pi); + getdisplay().fillCircle((int)x1d, (int)y1d, 2, commonData->fgcolor); + sinx = sin(i / 180.0 * pi); + cosx = cos(i / 180.0 * pi); + } + + // Draw sub scale with lines (two triangles) + if (i % 30 == 0) { + float dx = 2; // Line thickness = 2*dx+1 + float xx1 = -dx; + float xx2 = +dx; + float yy1 = -(rInstrument - 10); + float yy2 = -(rInstrument + 10); + getdisplay().fillTriangle(200 + (int)(cosx * xx1 - sinx * yy1), 150 + (int)(sinx * xx1 + cosx * yy1), + 200 + (int)(cosx * xx2 - sinx * yy1), 150 + (int)(sinx * xx2 + cosx * yy1), + 200 + (int)(cosx * xx1 - sinx * yy2), 150 + (int)(sinx * xx1 + cosx * yy2), commonData->fgcolor); + getdisplay().fillTriangle(200 + (int)(cosx * xx2 - sinx * yy1), 150 + (int)(sinx * xx2 + cosx * yy1), + 200 + (int)(cosx * xx1 - sinx * yy2), 150 + (int)(sinx * xx1 + cosx * yy2), + 200 + (int)(cosx * xx2 - sinx * yy2), 150 + (int)(sinx * xx2 + cosx * yy2), commonData->fgcolor); + } } - // Print text centered on position x, y - int16_t x1, y1; // Return values of getTextBounds - uint16_t w, h; // Return values of getTextBounds - getdisplay().getTextBounds(ii, int(x), int(y), &x1, &y1, &w, &h); // Calc width of new string - getdisplay().setCursor(x-w/2, y+h/2); - if(i % 30 == 0){ - getdisplay().setFont(&Ubuntu_Bold12pt8b); - getdisplay().print(ii); - } - - // Draw sub scale with dots - float sinx = 0; - float cosx = 0; - if(i % 6 == 0){ - float x1c = 200 + rInstrument*sin(i/180.0*pi); - float y1c = 150 - rInstrument*cos(i/180.0*pi); - getdisplay().fillCircle((int)x1c, (int)y1c, 2, commonData->fgcolor); - sinx=sin(i/180.0*pi); - cosx=cos(i/180.0*pi); - } - - // Draw sub scale with lines (two triangles) - if(i % 30 == 0){ - float dx=2; // Line thickness = 2*dx+1 - float xx1 = -dx; - float xx2 = +dx; - float yy1 = -(rInstrument-10); - float yy2 = -(rInstrument+10); - getdisplay().fillTriangle(200+(int)(cosx*xx1-sinx*yy1),150+(int)(sinx*xx1+cosx*yy1), - 200+(int)(cosx*xx2-sinx*yy1),150+(int)(sinx*xx2+cosx*yy1), - 200+(int)(cosx*xx1-sinx*yy2),150+(int)(sinx*xx1+cosx*yy2),commonData->fgcolor); - getdisplay().fillTriangle(200+(int)(cosx*xx2-sinx*yy1),150+(int)(sinx*xx2+cosx*yy1), - 200+(int)(cosx*xx1-sinx*yy2),150+(int)(sinx*xx1+cosx*yy2), - 200+(int)(cosx*xx2-sinx*yy2),150+(int)(sinx*xx2+cosx*yy2),commonData->fgcolor); - } - } - - // Print Unit in clock - getdisplay().setFont(&Ubuntu_Bold12pt8b); - getdisplay().setCursor(175, 110); - if(holdvalues == false){ - getdisplay().print(tz == 'L' ? "LOT" : "UTC"); - } - else{ - getdisplay().print(unit2old); // date unit - } - - getdisplay().setFont(&Ubuntu_Bold8pt8b); - getdisplay().setCursor(185, 190); - if (source == 'G') { - getdisplay().print("GPS"); - } else { - getdisplay().print("RTC"); - } - - // Clock values - double hour = 0; - double minute = 0; - if (source == 'R') { - if (tz == 'L') { - time_t tv = mktime(&commonData->data.rtcTime) + timezone * 3600; - struct tm *local_tm = localtime(&tv); - minute = local_tm->tm_min; - hour = local_tm->tm_hour; + // Print Unit in clock + getdisplay().setFont(&Ubuntu_Bold12pt8b); + getdisplay().setCursor(175, 110); + if (holdvalues == false) { + getdisplay().print(tz == 'L' ? "LOT" : "UTC"); } else { - minute = commonData->data.rtcTime.tm_min; - hour = commonData->data.rtcTime.tm_hour; + getdisplay().print(unit2old); // date unit } - hour += minute / 60; - } else { - if (tz == 'L') { - value1 += timezone * 3600; + + getdisplay().setFont(&Ubuntu_Bold8pt8b); + getdisplay().setCursor(185, 190); + if (source == 'G') { + getdisplay().print("GPS"); + } else { + getdisplay().print("RTC"); } - if (value1 > 86400) {value1 -= 86400;} - if (value1 < 0) {value1 += 86400;} - hour = (value1 / 3600.0); - // minute = (hour - int(hour)) * 3600.0 / 60.0; // Analog minute pointer smooth moving - minute = int((hour - int(hour)) * 3600.0 / 60.0); // Jumping minute pointer from minute to minute - } - if (hour > 12) { - hour -= 12.0; - } - LOG_DEBUG(GwLog::DEBUG,"... PageClock, value1: %f hour: %f minute:%f", value1, hour, minute); - // Draw hour pointer - float startwidth = 8; // Start width of pointer - if(valid1 == true || (source == 'R' && commonData->data.rtcValid) || holdvalues == true || simulation == true){ - float sinx=sin(hour * 30.0 * pi / 180); // Hour - float cosx=cos(hour * 30.0 * pi / 180); - // Normal pointer - // Pointer as triangle with center base 2*width - float xx1 = -startwidth; - float xx2 = startwidth; - float yy1 = -startwidth; - float yy2 = -(rInstrument * 0.5); - getdisplay().fillTriangle(200+(int)(cosx*xx1-sinx*yy1),150+(int)(sinx*xx1+cosx*yy1), - 200+(int)(cosx*xx2-sinx*yy1),150+(int)(sinx*xx2+cosx*yy1), - 200+(int)(cosx*0-sinx*yy2),150+(int)(sinx*0+cosx*yy2),commonData->fgcolor); - // Inverted pointer - // Pointer as triangle with center base 2*width - float endwidth = 2; // End width of pointer - float ix1 = endwidth; - float ix2 = -endwidth; - float iy1 = -(rInstrument * 0.5); - float iy2 = -endwidth; - getdisplay().fillTriangle(200+(int)(cosx*ix1-sinx*iy1),150+(int)(sinx*ix1+cosx*iy1), - 200+(int)(cosx*ix2-sinx*iy1),150+(int)(sinx*ix2+cosx*iy1), - 200+(int)(cosx*0-sinx*iy2),150+(int)(sinx*0+cosx*iy2),commonData->fgcolor); - } + // Clock values + double hour = 0; + double minute = 0; + if (source == 'R') { + if (tz == 'L') { + time_t tv2 = mktime(&commonData->data.rtcTime) + timezone * 3600; + struct tm* local_tm2 = localtime(&tv2); + minute = local_tm2->tm_min; + hour = local_tm2->tm_hour; + } else { + minute = commonData->data.rtcTime.tm_min; + hour = commonData->data.rtcTime.tm_hour; + } + hour += minute / 60; + } else { + if (tz == 'L') { + value1 += timezone * 3600; + } + if (value1 > 86400) { value1 -= 86400; } + if (value1 < 0) { value1 += 86400; } + hour = (value1 / 3600.0); + // minute = (hour - int(hour)) * 3600.0 / 60.0; // Analog minute pointer smooth moving + minute = int((hour - int(hour)) * 3600.0 / 60.0); // Jumping minute pointer from minute to minute + } + if (hour > 12) { + hour -= 12.0; + } + LOG_DEBUG(GwLog::DEBUG, "... PageClock, value1: %f hour: %f minute:%f", value1, hour, minute); - // Draw minute pointer - startwidth = 8; // Start width of pointer - if(valid1 == true || (source == 'R' && commonData->data.rtcValid) || holdvalues == true || simulation == true){ - float sinx=sin(minute * 6.0 * pi / 180); // Minute - float cosx=cos(minute * 6.0 * pi / 180); - // Normal pointer - // Pointer as triangle with center base 2*width - float xx1 = -startwidth; - float xx2 = startwidth; - float yy1 = -startwidth; - float yy2 = -(rInstrument - 15); - getdisplay().fillTriangle(200+(int)(cosx*xx1-sinx*yy1),150+(int)(sinx*xx1+cosx*yy1), - 200+(int)(cosx*xx2-sinx*yy1),150+(int)(sinx*xx2+cosx*yy1), - 200+(int)(cosx*0-sinx*yy2),150+(int)(sinx*0+cosx*yy2),commonData->fgcolor); - // Inverted pointer - // Pointer as triangle with center base 2*width - float endwidth = 2; // End width of pointer - float ix1 = endwidth; - float ix2 = -endwidth; - float iy1 = -(rInstrument - 15); - float iy2 = -endwidth; - getdisplay().fillTriangle(200+(int)(cosx*ix1-sinx*iy1),150+(int)(sinx*ix1+cosx*iy1), - 200+(int)(cosx*ix2-sinx*iy1),150+(int)(sinx*ix2+cosx*iy1), - 200+(int)(cosx*0-sinx*iy2),150+(int)(sinx*0+cosx*iy2),commonData->fgcolor); - } + // Draw hour pointer + float startwidth = 8; // Start width of pointer + if (valid1 == true || (source == 'R' && commonData->data.rtcValid) || holdvalues == true || simulation == true) { + float sinx = sin(hour * 30.0 * pi / 180); // Hour + float cosx = cos(hour * 30.0 * pi / 180); + // Normal pointer + // Pointer as triangle with center base 2*width + float xx1 = -startwidth; + float xx2 = startwidth; + float yy1 = -startwidth; + float yy2 = -(rInstrument * 0.5); + getdisplay().fillTriangle(200 + (int)(cosx * xx1 - sinx * yy1), 150 + (int)(sinx * xx1 + cosx * yy1), + 200 + (int)(cosx * xx2 - sinx * yy1), 150 + (int)(sinx * xx2 + cosx * yy1), + 200 + (int)(cosx * 0 - sinx * yy2), 150 + (int)(sinx * 0 + cosx * yy2), commonData->fgcolor); + // Inverted pointer + // Pointer as triangle with center base 2*width + float endwidth = 2; // End width of pointer + float ix1 = endwidth; + float ix2 = -endwidth; + float iy1 = -(rInstrument * 0.5); + float iy2 = -endwidth; + getdisplay().fillTriangle(200 + (int)(cosx * ix1 - sinx * iy1), 150 + (int)(sinx * ix1 + cosx * iy1), + 200 + (int)(cosx * ix2 - sinx * iy1), 150 + (int)(sinx * ix2 + cosx * iy1), + 200 + (int)(cosx * 0 - sinx * iy2), 150 + (int)(sinx * 0 + cosx * iy2), commonData->fgcolor); + } - // Center circle - getdisplay().fillCircle(200, 150, startwidth + 6, commonData->bgcolor); - getdisplay().fillCircle(200, 150, startwidth + 4, commonData->fgcolor); + // Draw minute pointer + startwidth = 8; // Start width of pointer + if (valid1 == true || (source == 'R' && commonData->data.rtcValid) || holdvalues == true || simulation == true) { + float sinx = sin(minute * 6.0 * pi / 180); // Minute + float cosx = cos(minute * 6.0 * pi / 180); + // Normal pointer + // Pointer as triangle with center base 2*width + float xx1 = -startwidth; + float xx2 = startwidth; + float yy1 = -startwidth; + float yy2 = -(rInstrument - 15); + getdisplay().fillTriangle(200 + (int)(cosx * xx1 - sinx * yy1), 150 + (int)(sinx * xx1 + cosx * yy1), + 200 + (int)(cosx * xx2 - sinx * yy1), 150 + (int)(sinx * xx2 + cosx * yy1), + 200 + (int)(cosx * 0 - sinx * yy2), 150 + (int)(sinx * 0 + cosx * yy2), commonData->fgcolor); + // Inverted pointer + // Pointer as triangle with center base 2*width + float endwidth = 2; // End width of pointer + float ix1 = endwidth; + float ix2 = -endwidth; + float iy1 = -(rInstrument - 15); + float iy2 = -endwidth; + getdisplay().fillTriangle(200 + (int)(cosx * ix1 - sinx * iy1), 150 + (int)(sinx * ix1 + cosx * iy1), + 200 + (int)(cosx * ix2 - sinx * iy1), 150 + (int)(sinx * ix2 + cosx * iy1), + 200 + (int)(cosx * 0 - sinx * iy2), 150 + (int)(sinx * 0 + cosx * iy2), commonData->fgcolor); + } + + // Center circle + getdisplay().fillCircle(200, 150, startwidth + 6, commonData->bgcolor); + getdisplay().fillCircle(200, 150, startwidth + 4, commonData->fgcolor); + } return PAGE_UPDATE; }; }; -static Page *createPage(CommonData &common){ +// Static member definitions +bool PageClock::timerInitialized = false; +bool PageClock::timerRunning = false; +int PageClock::timerHours = 0; +int PageClock::timerMinutes = 0; +int PageClock::timerSeconds = 0; +int PageClock::timerStartHours = 0; +int PageClock::timerStartMinutes = 0; +int PageClock::timerStartSeconds = 0; +int PageClock::selectedField = 0; +bool PageClock::showSelectionMarker = true; +time_t PageClock::timerEndEpoch = 0; + +static Page* createPage(CommonData& common) +{ return new PageClock(common); } /** * with the code below we make this page known to the PageTask * we give it a type (name) that can be selected in the config * we define which function is to be called - * and we provide the number of user parameters we expect (0 here) - * and will will provide the names of the fixed values we need + * we provide the number of user parameters we expect (0 here) + * and we provide the names of the fixed values we need */ PageDescription registerPageClock( - "Clock", // Page name - createPage, // Action - 0, // Number of bus values depends on selection in Web configuration + "Clock", // Page name + createPage, // Action + 0, // Number of bus values depends on selection in Web configuration {"GPST", "GPSD", "HDOP"}, // Bus values we need in the page - true // Show display header on/off + true // Show display header on/off ); #endif + diff --git a/lib/obp60task/PageCompass.cpp b/lib/obp60task/PageCompass.cpp index db98c87..12281e9 100644 --- a/lib/obp60task/PageCompass.cpp +++ b/lib/obp60task/PageCompass.cpp @@ -17,10 +17,10 @@ const int ShowSTW = 3; const int ShowSOG = 4; const int ShowDBS = 5; -const int Compass_X0 = 200; // center point of compass band -const int Compass_Y0 = 220; // position of compass lines -const int Compass_LineLength = 22; // length of compass lines -const float Compass_LineDelta = 8.0;// compass band: 1deg = 5 Pixels, 10deg = 50 Pixels +const int Compass_X0 = 200; // X center point of compass band +const int Compass_Y0 = 220; // Y position of compass lines +const int Compass_LineLength = 22; // Length of compass lines +const float Compass_LineDelta = 8.0;// Compass band: 1deg = 5 Pixels, 10deg = 50 Pixels class PageCompass : public Page { diff --git a/lib/obp60task/PageDigitalOut.cpp b/lib/obp60task/PageDigitalOut.cpp new file mode 100644 index 0000000..464a069 --- /dev/null +++ b/lib/obp60task/PageDigitalOut.cpp @@ -0,0 +1,152 @@ +#if defined BOARD_OBP60S3 || defined BOARD_OBP40S3 + +#include // PCF8574 modules from Horter +#include "Pagedata.h" +#include "OBP60Extensions.h" + +#include "images/OBP_400x300.xbm" // OBP Logo +#ifdef BOARD_OBP60S3 +#include "images/OBP60_400x300.xbm" // MFD with logo +#endif +#ifdef BOARD_OBP40S3 +#include "images/OBP40_400x300.xbm" // MFD with logo +#endif + +class PageDigitalOut : public Page +{ + +// Status values +bool button1 = false; +bool button2 = false; +bool button3 = false; +bool button4 = false; +bool button5 = false; + + public: + PageDigitalOut(CommonData &common){ + commonData = &common; + common.logger->logDebug(GwLog::LOG,"Instantiate PageDigitalOut"); + } + + // Set botton labels + virtual void setupKeys(){ + Page::setupKeys(); + commonData->keydata[0].label = "1"; + commonData->keydata[1].label = "2"; + commonData->keydata[2].label = "3"; + commonData->keydata[3].label = "4"; + commonData->keydata[4].label = "5"; + } + + virtual int handleKey(int key){ + // Code for keylock + if(key == 11){ + commonData->keylock = !commonData->keylock; + return 0; // Commit the key + } + // Code for button 1 + if(key == 1){ + button1 = !button1; + setPCF8574PortPinModul1(0, button1 ? 0 : 1); // Attention! Inverse logic for PCF8574 + return 0; // Commit the key + } + // Code for button 2 + if(key == 2){ + button2 = !button2; + setPCF8574PortPinModul1(1, button2 ? 0 : 1); // Attention! Inverse logic for PCF8574 + return 0; // Commit the key + } + // Code for button 3 + if(key == 3){ + button3 = !button3; + setPCF8574PortPinModul1(2, button3 ? 0 : 1); // Attention! Inverse logic for PCF8574 + return 0; // Commit the key + } + // Code for button 4 + if(key == 4){ + button4 = !button4; + setPCF8574PortPinModul1(3, button4 ? 0 : 1); // Attention! Inverse logic for PCF8574 + return 0; // Commit the key + } + // Code for button 5 + if(key == 5){ + button5 = !button5; + setPCF8574PortPinModul1(4, button5 ? 0 : 1); // Attention! Inverse logic for PCF8574 + return 0; // Commit the key + } + return key; + } + + int displayPage(PageData &pageData){ + GwConfigHandler *config = commonData->config; + GwLog *logger = commonData->logger; + + // Get config data + String lengthformat = config->getString(config->lengthFormat); + bool simulation = config->getBool(config->useSimuData); + bool holdvalues = config->getBool(config->holdvalues); + String flashLED = config->getString(config->flashLED); + String backlightMode = config->getString(config->backlight); + String name1 = config->getString(config->mod1Out1); + String name2 = config->getString(config->mod1Out2); + String name3 = config->getString(config->mod1Out3); + String name4 = config->getString(config->mod1Out4); + String name5 = config->getString(config->mod1Out5); + + // Optical warning by limit violation (unused) + if(String(flashLED) == "Limit Violation"){ + setBlinkingLED(false); + setFlashLED(false); + } + + // Logging boat values + LOG_DEBUG(GwLog::LOG,"Drawing at PageDigitalOut"); + + // Draw page + //*********************************************************** + + // Set display in partial refresh mode + getdisplay().setPartialWindow(0, 0, getdisplay().width(), getdisplay().height()); // Set partial update + getdisplay().setTextColor(commonData->fgcolor); + getdisplay().setFont(&Ubuntu_Bold12pt8b); + // Write text + getdisplay().setCursor(100, 50 + 8); + getdisplay().print(name1); + getdisplay().setCursor(100, 100 + 8); + getdisplay().print(name2); + getdisplay().setCursor(100, 150 + 8); + getdisplay().print(name3); + getdisplay().setCursor(100,200 + 8); + getdisplay().print(name4); + getdisplay().setCursor(100, 250 + 8); + getdisplay().print(name5); + // Draw bottons + drawButtonCenter(50, 50, 40, 27, "1", commonData->fgcolor, commonData->bgcolor, button1); + drawButtonCenter(50, 100, 40, 27, "2", commonData->fgcolor, commonData->bgcolor, button2); + drawButtonCenter(50, 150, 40, 27, "3", commonData->fgcolor, commonData->bgcolor, button3); + drawButtonCenter(50, 200, 40, 27, "4", commonData->fgcolor, commonData->bgcolor, button4); + drawButtonCenter(50, 250, 40, 27, "5", commonData->fgcolor, commonData->bgcolor, button5); + + return PAGE_UPDATE; + }; +}; + +static Page* createPage(CommonData &common){ + return new PageDigitalOut(common); +} + +/** + * with the code below we make this page known to the PageTask + * we give it a type (name) that can be selected in the config + * we define which function is to be called + * and we provide the number of user parameters we expect + * this will be number of BoatValue pointers in pageData.values + */ +PageDescription registerPageDigitalOut( + "DigitalOut", // Page name + createPage, // Action + 0, // Number of bus values depends on selection in Web configuration + true // Show display header on/off +); + +#endif diff --git a/lib/obp60task/PageFourValues.cpp b/lib/obp60task/PageFourValues.cpp index b7526c0..cb9de68 100644 --- a/lib/obp60task/PageFourValues.cpp +++ b/lib/obp60task/PageFourValues.cpp @@ -2,7 +2,6 @@ #include "Pagedata.h" #include "OBP60Extensions.h" -#include "BoatDataCalibration.h" class PageFourValues : public Page { @@ -46,7 +45,6 @@ class PageFourValues : public Page GwApi::BoatValue *bvalue1 = pageData.values[0]; // First element in list (only one value by PageOneValue) String name1 = xdrDelete(bvalue1->getName()); // Value name name1 = name1.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue1, logger); // Check if boat data value is to be calibrated double value1 = bvalue1->value; // Value as double in SI unit bool valid1 = bvalue1->valid; // Valid information String svalue1 = formatValue(bvalue1, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -56,7 +54,6 @@ class PageFourValues : public Page GwApi::BoatValue *bvalue2 = pageData.values[1]; // Second element in list String name2 = xdrDelete(bvalue2->getName()); // Value name name2 = name2.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue2, logger); // Check if boat data value is to be calibrated double value2 = bvalue2->value; // Value as double in SI unit bool valid2 = bvalue2->valid; // Valid information String svalue2 = formatValue(bvalue2, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -66,7 +63,6 @@ class PageFourValues : public Page GwApi::BoatValue *bvalue3 = pageData.values[2]; // Third element in list String name3 = xdrDelete(bvalue3->getName()); // Value name name3 = name3.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue3, logger); // Check if boat data value is to be calibrated double value3 = bvalue3->value; // Value as double in SI unit bool valid3 = bvalue3->valid; // Valid information String svalue3 = formatValue(bvalue3, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -76,7 +72,6 @@ class PageFourValues : public Page GwApi::BoatValue *bvalue4 = pageData.values[3]; // Fourth element in list String name4 = xdrDelete(bvalue4->getName()); // Value name name4 = name4.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue4, logger); // Check if boat data value is to be calibrated double value4 = bvalue4->value; // Value as double in SI unit bool valid4 = bvalue4->valid; // Valid information String svalue4 = formatValue(bvalue4, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places diff --git a/lib/obp60task/PageFourValues2.cpp b/lib/obp60task/PageFourValues2.cpp index e608409..730e14b 100644 --- a/lib/obp60task/PageFourValues2.cpp +++ b/lib/obp60task/PageFourValues2.cpp @@ -2,7 +2,6 @@ #include "Pagedata.h" #include "OBP60Extensions.h" -#include "BoatDataCalibration.h" class PageFourValues2 : public Page { @@ -46,7 +45,6 @@ class PageFourValues2 : public Page GwApi::BoatValue *bvalue1 = pageData.values[0]; // First element in list (only one value by PageOneValue) String name1 = xdrDelete(bvalue1->getName()); // Value name name1 = name1.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue1, logger); // Check if boat data value is to be calibrated double value1 = bvalue1->value; // Value as double in SI unit bool valid1 = bvalue1->valid; // Valid information String svalue1 = formatValue(bvalue1, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -56,7 +54,6 @@ class PageFourValues2 : public Page GwApi::BoatValue *bvalue2 = pageData.values[1]; // Second element in list (only one value by PageOneValue) String name2 = xdrDelete(bvalue2->getName()); // Value name name2 = name2.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue2, logger); // Check if boat data value is to be calibrated double value2 = bvalue2->value; // Value as double in SI unit bool valid2 = bvalue2->valid; // Valid information String svalue2 = formatValue(bvalue2, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -66,7 +63,6 @@ class PageFourValues2 : public Page GwApi::BoatValue *bvalue3 = pageData.values[2]; // Second element in list (only one value by PageOneValue) String name3 = xdrDelete(bvalue3->getName()); // Value name name3 = name3.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue3, logger); // Check if boat data value is to be calibrated double value3 = bvalue3->value; // Value as double in SI unit bool valid3 = bvalue3->valid; // Valid information String svalue3 = formatValue(bvalue3, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -76,7 +72,6 @@ class PageFourValues2 : public Page GwApi::BoatValue *bvalue4 = pageData.values[3]; // Second element in list (only one value by PageOneValue) String name4 = xdrDelete(bvalue4->getName()); // Value name name4 = name4.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue4, logger); // Check if boat data value is to be calibrated double value4 = bvalue4->value; // Value as double in SI unit bool valid4 = bvalue4->valid; // Valid information String svalue4 = formatValue(bvalue4, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places diff --git a/lib/obp60task/PageNavigation.cpp b/lib/obp60task/PageNavigation.cpp new file mode 100644 index 0000000..bd4adf1 --- /dev/null +++ b/lib/obp60task/PageNavigation.cpp @@ -0,0 +1,508 @@ +#if defined BOARD_OBP60S3 || defined BOARD_OBP40S3 + +#include "Pagedata.h" +#include "OBP60Extensions.h" +#include "NetworkClient.h" // Network connection +#include "ImageDecoder.h" // Image decoder for navigation map + +#include "Logo_OBP_400x300_sw.h" + +// Defines for reading of navigation map +#define JSON_BUFFER 30000 // Max buffer size for JSON content (30 kB picture + values) +NetworkClient net(JSON_BUFFER); // Define network client +ImageDecoder decoder; // Define image decoder + +class PageNavigation : public Page +{ +// Values for buttons +bool firstRun = true; // Detect the first page run +int zoom = 15; // Default zoom level +bool showValues = false; // Show values HDT, SOG, DBT in navigation map + + private: + uint8_t* imageBackupData = nullptr; + int imageBackupWidth = 0; + int imageBackupHeight = 0; + size_t imageBackupSize = 0; + bool hasImageBackup = false; + + public: + PageNavigation(CommonData &common){ + commonData = &common; + common.logger->logDebug(GwLog::LOG,"Instantiate PageNavigation"); + imageBackupData = (uint8_t*)heap_caps_malloc((GxEPD_WIDTH * GxEPD_HEIGHT), MALLOC_CAP_SPIRAM); + } + + // Set botton labels + virtual void setupKeys(){ + Page::setupKeys(); + commonData->keydata[0].label = "ZOOM -"; + commonData->keydata[1].label = "ZOOM +"; + commonData->keydata[4].label = "VALUES"; + } + + virtual int handleKey(int key){ + // Code for keylock + if(key == 11){ + commonData->keylock = !commonData->keylock; + return 0; // Commit the key + } + // Code for zoom - + if(key == 1){ + zoom --; // Zoom - + if(zoom <7){ + zoom = 7; + } + return 0; // Commit the key + } + // Code for zoom - + if(key == 2){ + zoom ++; // Zoom + + if(zoom >17){ + zoom = 17; + } + return 0; // Commit the key + } + if(key == 5){ + showValues = !showValues; // Toggle show values + return 0; // Commit the key + } + return key; + } + + int displayPage(PageData &pageData){ + GwConfigHandler *config = commonData->config; + GwLog *logger = commonData->logger; + + // Get config data + String lengthformat = config->getString(config->lengthFormat); + bool simulation = config->getBool(config->useSimuData); + bool holdvalues = config->getBool(config->holdvalues); + String flashLED = config->getString(config->flashLED); + String backlightMode = config->getString(config->backlight); + String mapsource = config->getString(config->mapsource); + String ipAddress = config->getString(config->ipAddress); + int localPort = config->getInt(config->localPort); + String mapType = config->getString(config->maptype); + int zoomLevel = config->getInt(config->zoomlevel); + bool grid = config->getBool(config->grid); + String orientation = config->getString(config->orientation); + int refreshDistance = config->getInt(config->refreshDistance); + bool showValuesMap = config->getBool(config->showvalues); + bool ownHeading = config->getBool(config->ownheading); + + if(firstRun == true){ + zoom = zoomLevel; // Over write zoom level with setup value + showValues = showValuesMap; // Over write showValues with setup value + firstRun = false; // Restet variable + } + + // Local variables + String server = "norbert-walter.dnshome.de"; + int port = 80; + int mType = 1; + int dType = 1; + int mapRot = 0; + int symbolRot = 0; + int mapGrid = 0; + + + // Old values for hold function + static double value1old = 0; + static String svalue1old = ""; + static String unit1old = ""; + static double value2old = 0; + static String svalue2old = ""; + static String unit2old = ""; + static double value3old = 0; // Deg + static String svalue3old = ""; + static String unit3old = ""; + static double value4old = 0; + static String svalue4old = ""; + static String unit4old = ""; + static double value5old = 0; + static String svalue5old = ""; + static String unit5old = ""; + static double value6old = 0; + static String svalue6old = ""; + static String unit6old = ""; + + static double latitude = 0; + static double latitudeold = 0; + static double longitude = 0; + static double longitudeold = 0; + static double trueHeading = 0; + static double magneticHeading = 0; + static double speedOverGround = 0; + static double depthBelowTransducer = 0; + static int lostCounter = 0; // Counter for connection lost to the map server (increment by each page refresh) + int imgWidth = 0; + int imgHeight = 0; + + // Get boat values #1 Latitude + GwApi::BoatValue *bvalue1 = pageData.values[0]; // First element in list (only one value by PageOneValue) + String name1 = xdrDelete(bvalue1->getName()); // Value name + name1 = name1.substring(0, 6); // String length limit for value name + double value1 = bvalue1->value; // Value as double in SI unit + bool valid1 = bvalue1->valid; // Valid information + String svalue1 = formatValue(bvalue1, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places + String unit1 = formatValue(bvalue1, *commonData).unit; // Unit of value + + // Get boat values #2 Longitude + GwApi::BoatValue *bvalue2 = pageData.values[1]; // Second element in list (only one value by PageOneValue) + String name2 = xdrDelete(bvalue2->getName()); // Value name + name2 = name2.substring(0, 6); // String length limit for value name + double value2 = bvalue2->value; // Value as double in SI unit + bool valid2 = bvalue2->valid; // Valid information + String svalue2 = formatValue(bvalue2, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places + String unit2 = formatValue(bvalue2, *commonData).unit; // Unit of value + + // Get boat values #3 HDT + GwApi::BoatValue *bvalue3 = pageData.values[2]; // Second element in list (only one value by PageOneValue) + String name3 = xdrDelete(bvalue3->getName()); // Value name + name3 = name3.substring(0, 6); // String length limit for value name + double value3 = bvalue3->value; // Value as double in SI unit + bool valid3 = bvalue3->valid; // Valid information + String svalue3 = formatValue(bvalue3, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places + String unit3 = formatValue(bvalue3, *commonData).unit; // Unit of value + + // Get boat values #4 HDM + GwApi::BoatValue *bvalue4 = pageData.values[3]; // Second element in list (only one value by PageOneValue) + String name4 = xdrDelete(bvalue4->getName()); // Value name + name4 = name4.substring(0, 6); // String length limit for value name + double value4 = bvalue4->value; // Value as double in SI unit + bool valid4 = bvalue4->valid; // Valid information + String svalue4 = formatValue(bvalue4, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places + String unit4 = formatValue(bvalue4, *commonData).unit; // Unit of value + + // Get boat values #5 SOG + GwApi::BoatValue *bvalue5 = pageData.values[4]; // Second element in list (only one value by PageOneValue) + String name5 = xdrDelete(bvalue5->getName()); // Value name + name5 = name5.substring(0, 6); // String length limit for value name + double value5 = bvalue5->value; // Value as double in SI unit + bool valid5 = bvalue5->valid; // Valid information + String svalue5 = formatValue(bvalue5, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places + String unit5 = formatValue(bvalue5, *commonData).unit; // Unit of value + + // Get boat values #6 DBT + GwApi::BoatValue *bvalue6 = pageData.values[5]; // Second element in list (only one value by PageOneValue) + String name6 = xdrDelete(bvalue6->getName()); // Value name + name6 = name6.substring(0, 6); // String length limit for value name + double value6 = bvalue6->value; // Value as double in SI unit + bool valid6 = bvalue6->valid; // Valid information + String svalue6 = formatValue(bvalue6, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places + String unit6 = formatValue(bvalue6, *commonData).unit; // Unit of value + + // Optical warning by limit violation (unused) + if(String(flashLED) == "Limit Violation"){ + setBlinkingLED(false); + setFlashLED(false); + } + + // Logging boat values + if (bvalue1 == NULL) return PAGE_OK; // WTF why this statement? + LOG_DEBUG(GwLog::LOG,"Drawing at PageNavigation, %s: %f, %s: %f, %s: %f, %s: %f, %s: %f, %s: %f", name1.c_str(), value1, name2.c_str(), value2, name3.c_str(), value3, name4.c_str(), value4, name5.c_str(), value5, name6.c_str(), value6); + + // Set variables + //*********************************************************** + + // Latitude + if(valid1){ + latitude = value1; + latitudeold = value1; + value3old = value1; + } + else{ + latitude = value1old; + } + // Longitude + if(valid2){ + longitude = value2; + longitudeold = value2; + value2old = value2; + } + else{ + longitude = value2old; + } + // HDT value (True Heading, GPS) + if(valid3){ + trueHeading = (value3 * 360) / (2 * PI); + value3old = trueHeading; + } + else{ + trueHeading = value3old; + } + // HDM value (Magnetic Heading) + if(valid4){ + magneticHeading = (value4 * 360) / (2 * PI); + value4old = magneticHeading; + } + else{ + speedOverGround = value4old; + } + // SOG value (Speed Over Ground) + if(valid5){ + speedOverGround = value5; + value5old = value5; + } + else{ + speedOverGround = value5old; + } + // DBT value (Depth Below Transducer) + if(valid6){ + depthBelowTransducer = value6; + value6old = value6; + } + else{ + depthBelowTransducer = value6old; + } + + // Prepare config values for URL + //*********************************************************** + + // Server settings + if(mapsource == "OBP Service"){ + server = "norbert-walter.dnshome.de"; + port = 80; + } + else if(mapsource == "Local Service"){ + server = String(ipAddress); + port = localPort; + } + else{ + server = "norbert-walter.dnshome.de"; + port = 80; + } + + // Type of navigation map + if(mapType == "Open Street Map"){ + mType = 1; // Map type + dType = 1; // Dithering type + } + else if(mapType == "Google Street"){ + mType = 3; + dType = 2; + } + else if(mapType == "Open Topo Map"){ + mType = 5; + dType = 2; + } + else if(mapType == "Stadimaps Toner"){ + mType = 7; + dType = 1; + } + else if(mapType == "Free Nautical Chart"){ + mType = 9; + dType = 1; + } + else{ + mType = 1; + dType = 1; + } + + // Map grid on/off + if(grid == true){ + mapGrid = 1; + } + else{ + mapGrid = 0; + } + + // Map orientation + if(orientation == "North Direction"){ + mapRot = 0; + // If true heading available then use HDT oterwise HDM + if(valid3 == true){ + symbolRot = trueHeading; + } + else{ + symbolRot = magneticHeading; + } + } + else if(orientation == "Travel Direction"){ + // If true heading available then use HDT oterwise HDM + if(valid3 == true){ + mapRot = trueHeading; + symbolRot = trueHeading; + } + else{ + mapRot = magneticHeading; + symbolRot = magneticHeading; + } + } + else{ + mapRot = 0; + // If true heading available then use HDT oterwise HDM + if(valid3 == true){ + symbolRot = trueHeading; + } + else{ + symbolRot = magneticHeading; + } + } + + // Load navigation map + //*********************************************************** + + // URL to OBP Maps Converter + // For more details see: https://github.com/norbert-walter/maps-converter + String url = String("http://") + server + ":" + port + // OBP Server + String("/get_image_json?") + // Service: Output B&W picture as JSON (Base64 + gzip) + "zoom=" + zoom + // Default zoom level: 15 + "&lat=" + String(latitude, 6) + // Latitude + "&lon=" + String(longitude, 6) + // Longitude + "&mrot=" + mapRot + // Rotation angle navigation map in degree + "&mtype=" + mType + // Default Map: Open Street Map + "&dtype=" + dType + // Dithering type: Atkinson dithering + "&width=400" + // With navigation map + "&height=250" + // Height navigation map + "&cutout=0" + // No picture cutouts + "&tab=0" + // No tab size + "&border=2" + // Border line size: 2 pixel + "&symbol=2" + // Symbol: Triangle + "&srot=" + symbolRot + // Symbol rotation angle + "&ssize=15" + // Symbole size: 15 pixel + "&grid=" + mapGrid // Show grid: On + ; + + // Draw page + //*********************************************************** + + // ############### Draw Navigation Map ################ + + // Set display in partial refresh mode + getdisplay().setPartialWindow(0, 0, getdisplay().width(), getdisplay().height()); // Set partial update + getdisplay().setTextColor(commonData->fgcolor); + + // If a network connection to URL then load the navigation map + if (net.fetchAndDecompressJson(url)) { + + auto& json = net.json(); // Extract JSON content + int numPix = json["number_pixels"] | 0; // Read number of pixels + imgWidth = json["width"] | 0; // Read width of image + imgHeight = json["height"] | 0; // Read height og image + + const char* b64src = json["picture_base64"].as(); // Read picture as Base64 content + size_t b64len = strlen(b64src); // Calculate length of Base64 content + // Copy Base64 content in PSRAM + char* b64 = (char*) heap_caps_malloc(b64len + 1, MALLOC_CAP_SPIRAM); // Allcate PSRAM for Base64 content + if (!b64) { + LOG_DEBUG(GwLog::ERROR,"Error PageNavigation: PSRAM alloc base64 failed"); + return PAGE_UPDATE; + } + memcpy(b64, b64src, b64len + 1); // Copy Base64 content in PSRAM + + // Set image buffer in PSRAM + //size_t imgSize = getdisplay().width() * getdisplay().height(); + size_t imgSize = numPix; // Calculate image size + uint8_t* imageData = (uint8_t*) heap_caps_malloc(imgSize, MALLOC_CAP_SPIRAM); // Allocate PSRAM for image + if (!imageData) { + LOG_DEBUG(GwLog::ERROR,"Error PageNavigation: PPSRAM alloc image buffer failed"); + free(b64); + return PAGE_UPDATE; + } + + // Decode Base64 content to image + size_t decodedSize = 0; + decoder.decodeBase64(b64, imageData, imgSize, decodedSize); + + // Copy actual navigation man to ackup map + imageBackupWidth = imgWidth; + imageBackupHeight = imgHeight; + imageBackupSize = imgSize; + if (decodedSize > 0) { + memcpy(imageBackupData, imageData, decodedSize); + imageBackupSize = decodedSize; + } + hasImageBackup = true; + lostCounter = 0; + + // Show image (navigation map) + getdisplay().drawBitmap(0, 25, imageData, imgWidth, imgHeight, commonData->fgcolor); + + // Clean PSRAM + free(b64); + free(imageData); + } + // If no network connection then use backup navigation map + else{ + // Show backup image (backup navigation map) + if (hasImageBackup) { + getdisplay().drawBitmap(0, 25, imageBackupData, imageBackupWidth, imageBackupHeight, commonData->fgcolor); + } + + // Show info: Connection lost when 5 page refreshes has a connection lost to the map server + // Short connection losts are uncritical + if(lostCounter >= 5){ + getdisplay().setFont(&Ubuntu_Bold12pt8b); + getdisplay().fillRect(200, 250 , 200, 25, commonData->fgcolor); // Black rect + getdisplay().fillRect(202, 252 , 196, 21, commonData->bgcolor); // White rect + getdisplay().setCursor(210, 270); + getdisplay().print("Map server lost"); + } + + lostCounter++; // Increment lost counter + } + + + // ############### Draw Values ################ + getdisplay().setFont(&Ubuntu_Bold12pt8b); + + // Show zoom level + getdisplay().fillRect(355, 25 , 45, 25, commonData->fgcolor); // Black rect + getdisplay().fillRect(357, 27 , 41, 21, commonData->bgcolor); // White rect + getdisplay().setCursor(364, 45); + getdisplay().print(zoom); + // If true heading available then use HDT oterwise HDM + if(showValues == true){ + // Frame + getdisplay().fillRect(0, 25 , 130, 65, commonData->fgcolor); // Black rect + getdisplay().fillRect(2, 27 , 126, 61, commonData->bgcolor); // White rect + if(valid3 == true){ + // HDT + getdisplay().setCursor(10, 45); + getdisplay().print(name3); + getdisplay().setCursor(70, 45); + getdisplay().print(svalue3); + } + else{ + // HDM + getdisplay().setCursor(10, 45); + getdisplay().print(name4); + getdisplay().setCursor(70, 45); + getdisplay().print(svalue4); + } + // SOG + getdisplay().setCursor(10, 65); + getdisplay().print(name5); + getdisplay().setCursor(70, 65); + getdisplay().print(svalue5); + // DBT + getdisplay().setCursor(10, 85); + getdisplay().print(name6); + getdisplay().setCursor(70, 85); + getdisplay().print(svalue6); + } + + return PAGE_UPDATE; + }; +}; + +static Page *createPage(CommonData &common){ + return new PageNavigation(common); +}/** + * with the code below we make this page known to the PageTask + * we give it a type (name) that can be selected in the config + * we define which function is to be called + * and we provide the number of user parameters we expect + * this will be number of BoatValue pointers in pageData.values + */ +PageDescription registerPageNavigation( + "Navigation", // Page name + createPage, // Action + 0, // Number of bus values depends on selection in Web configuration + {"LAT","LON","HDT","HDM","SOG","DBT"}, // Bus values we need in the page + true // Show display header on/off +); + +#endif diff --git a/lib/obp60task/PageOneValue.cpp b/lib/obp60task/PageOneValue.cpp index 6f33597..78cc6e6 100644 --- a/lib/obp60task/PageOneValue.cpp +++ b/lib/obp60task/PageOneValue.cpp @@ -2,113 +2,304 @@ #include "Pagedata.h" #include "OBP60Extensions.h" -#include "BoatDataCalibration.h" +#include "OBPDataOperations.h" +#include "OBPcharts.h" -class PageOneValue : public Page -{ - public: - PageOneValue(CommonData &common){ - commonData = &common; - common.logger->logDebug(GwLog::LOG,"Instantiate PageOneValue"); +class PageOneValue : public Page { +private: + GwLog* logger; + + enum PageMode { + VALUE, + BOTH, + CHART + }; + enum DisplayMode { + FULL, + HALF + }; + + static constexpr char HORIZONTAL = 'H'; + static constexpr char VERTICAL = 'V'; + static constexpr int8_t FULL_SIZE = 0; + static constexpr int8_t HALF_SIZE_TOP = 1; + static constexpr int8_t HALF_SIZE_BOTTOM = 2; + + static constexpr bool PRNT_NAME = true; + static constexpr bool NO_PRNT_NAME = false; + static constexpr bool PRNT_VALUE = true; + static constexpr bool NO_PRNT_VALUE = false; + + int width; // Screen width + int height; // Screen height + + bool keylock = false; // Keylock + PageMode pageMode = VALUE; // Page display mode + int8_t dataIntv = 1; // Update interval for wind history chart: + // (1)|(2)|(3)|(4)|(8) x 240 seconds for 4, 8, 12, 16, 32 min. history chart + + // String lengthformat; + bool useSimuData; + bool holdValues; + String flashLED; + String backlightMode; + String tempFormat; + + // Old values for hold function + String sValue1Old = ""; + String unit1Old = ""; + + // Data buffer pointer (owned by HstryBuffers) + RingBuffer* dataHstryBuf = nullptr; + std::unique_ptr dataChart; // Chart object + + // display data value in display [FULL|HALF] + void showData(GwApi::BoatValue* bValue1, DisplayMode mode) + { + int nameXoff, nameYoff, unitXoff, unitYoff, value1Xoff, value1Yoff; + const GFXfont *nameFnt, *unitFnt, *valueFnt1, *valueFnt2, *valueFnt3; + + if (mode == FULL) { // full size data display + nameXoff = 0; + nameYoff = 0; + nameFnt = &Ubuntu_Bold32pt8b; + unitXoff = 0; + unitYoff = 0; + unitFnt = &Ubuntu_Bold20pt8b; + value1Xoff = 0; + value1Yoff = 0; + valueFnt1 = &Ubuntu_Bold20pt8b; + valueFnt2 = &Ubuntu_Bold32pt8b; + valueFnt3 = &DSEG7Classic_BoldItalic60pt7b; + } else { // half size data and chart display + nameXoff = -10; + nameYoff = -34; + nameFnt = &Ubuntu_Bold20pt8b; + unitXoff = -295; + unitYoff = -119; + unitFnt = &Ubuntu_Bold12pt8b; + valueFnt1 = &Ubuntu_Bold12pt8b; + value1Xoff = 153; + value1Yoff = -119; + valueFnt2 = &Ubuntu_Bold20pt8b; + valueFnt3 = &DSEG7Classic_BoldItalic42pt7b; + } + + String name1 = xdrDelete(bValue1->getName()); // Value name + name1 = name1.substring(0, 6); // String length limit for value name + double value1 = bValue1->value; // Value as double in SI unit + bool valid1 = bValue1->valid; // Valid information + String sValue1 = formatValue(bValue1, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places + String unit1 = formatValue(bValue1, *commonData).unit; // Unit of value + + // Show name + getdisplay().setTextColor(commonData->fgcolor); + getdisplay().setFont(nameFnt); + getdisplay().setCursor(20 + nameXoff, 100 + nameYoff); + getdisplay().print(name1); // name + + // Show unit + getdisplay().setFont(unitFnt); + getdisplay().setCursor(305 + unitXoff, 240 + unitYoff); + + if (holdValues) { + getdisplay().print(unit1Old); // name + } else { + getdisplay().print(unit1); // name + } + + // Switch font depending on value format and adjust position + if (bValue1->getFormat() == "formatLatitude" || bValue1->getFormat() == "formatLongitude") { + getdisplay().setFont(valueFnt1); + getdisplay().setCursor(20 + value1Xoff, 180 + value1Yoff); + } else if (bValue1->getFormat() == "formatTime" || bValue1->getFormat() == "formatDate") { + getdisplay().setFont(valueFnt2); + getdisplay().setCursor(20 + value1Xoff, 200 + value1Yoff); + } else { + getdisplay().setFont(valueFnt3); + getdisplay().setCursor(20 + value1Xoff, 240 + value1Yoff); + } + + // Show bus data + if (!holdValues || useSimuData) { + getdisplay().print(sValue1); // Real value as formated string + } else { + getdisplay().print(sValue1Old); // Old value as formated string + } + + if (valid1 == true) { + sValue1Old = sValue1; // Save the old value + unit1Old = unit1; // Save the old unit + } } - virtual int handleKey(int key){ - // Code for keylock - if(key == 11){ +public: + PageOneValue(CommonData& common) + { + commonData = &common; + logger = commonData->logger; + LOG_DEBUG(GwLog::LOG, "Instantiate PageOneValue"); + + width = getdisplay().width(); // Screen width + height = getdisplay().height(); // Screen height + + // Get config data + // lengthformat = commonData->config->getString(commonData->config->lengthFormat); + useSimuData = commonData->config->getBool(commonData->config->useSimuData); + holdValues = commonData->config->getBool(commonData->config->holdvalues); + flashLED = commonData->config->getString(commonData->config->flashLED); + backlightMode = commonData->config->getString(commonData->config->backlight); + tempFormat = commonData->config->getString(commonData->config->tempFormat); // [K|°C|°F] + } + + virtual void setupKeys() + { + Page::setupKeys(); + +#if defined BOARD_OBP60S3 + constexpr int ZOOM_KEY = 4; +#elif defined BOARD_OBP40S3 + constexpr int ZOOM_KEY = 1; +#endif + + if (dataHstryBuf) { // show "Mode" key only if chart-supported boat data type is available + commonData->keydata[0].label = "MODE"; + if (pageMode != VALUE) { // show "ZOOM" key only if chart is visible + commonData->keydata[ZOOM_KEY].label = "ZOOM"; + } else { + commonData->keydata[ZOOM_KEY].label = ""; + } + } else { + commonData->keydata[0].label = ""; + commonData->keydata[ZOOM_KEY].label = ""; + } + } + + // Key functions + virtual int handleKey(int key) + { + if (dataHstryBuf) { // if boat data type supports charts + + // Set page mode: value | value/half chart | full chart + if (key == 1) { + switch (pageMode) { + case VALUE: + pageMode = BOTH; + break; + case BOTH: + pageMode = CHART; + break; + case CHART: + pageMode = VALUE; + break; + } + setupKeys(); // Adjust key definition depending on and chart-supported boat data type + return 0; // Commit the key + } + + // Set time frame to show for chart +#if defined BOARD_OBP60S3 + if (key == 5 && pageMode != VALUE) { +#elif defined BOARD_OBP40S3 + if (key == 2 && pageMode != VALUE) { +#endif + if (dataIntv == 1) { + dataIntv = 2; + } else if (dataIntv == 2) { + dataIntv = 3; + } else if (dataIntv == 3) { + dataIntv = 4; + } else if (dataIntv == 4) { + dataIntv = 8; + } else { + dataIntv = 1; + } + return 0; // Commit the key + } + } + + // Keylock function + if (key == 11) { // Code for keylock commonData->keylock = !commonData->keylock; - return 0; // Commit the key + return 0; // Commit the key } return key; } - int displayPage(PageData &pageData){ - GwConfigHandler *config = commonData->config; - GwLog *logger = commonData->logger; - - // Old values for hold function - static String svalue1old = ""; - static String unit1old = ""; - - // Get config data - String lengthformat = config->getString(config->lengthFormat); - // bool simulation = config->getBool(config->useSimuData); - bool holdvalues = config->getBool(config->holdvalues); - String flashLED = config->getString(config->flashLED); - String backlightMode = config->getString(config->backlight); - - // Get boat values - GwApi::BoatValue *bvalue1 = pageData.values[0]; // First element in list (only one value by PageOneValue) - String name1 = xdrDelete(bvalue1->getName()); // Value name - name1 = name1.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue1, logger); // Check if boat data value is to be calibrated - double value1 = bvalue1->value; // Value as double in SI unit - bool valid1 = bvalue1->valid; // Valid information - String svalue1 = formatValue(bvalue1, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places - String unit1 = formatValue(bvalue1, *commonData).unit; // Unit of value - - // Optical warning by limit violation (unused) - if(String(flashLED) == "Limit Violation"){ + virtual void displayNew(PageData& pageData) + { +#ifdef BOARD_OBP60S3 + // Clear optical warning + if (flashLED == "Limit Violation") { setBlinkingLED(false); - setFlashLED(false); + setFlashLED(false); + } +#endif + // buffer initialization will fail, if page is default page, because is not executed at system start for default page + if (!dataChart) { // Create chart objects if they don't exist + + GwApi::BoatValue* bValue1 = pageData.values[0]; // Page boat data element + String bValName1 = bValue1->getName(); // Value name + String bValFormat = bValue1->getFormat(); // Value format + + dataHstryBuf = pageData.hstryBuffers->getBuffer(bValName1); + + if (dataHstryBuf) { + dataChart.reset(new Chart(*dataHstryBuf, Chart::dfltChrtDta[bValFormat].range, *commonData, useSimuData)); + LOG_DEBUG(GwLog::DEBUG, "PageOneValue: Created chart objects for %s", bValName1); + } else { + LOG_DEBUG(GwLog::DEBUG, "PageOneValue: No chart objects available for %s", bValName1); + } } - // Logging boat values - if (bvalue1 == NULL) return PAGE_OK; // WTF why this statement? - LOG_DEBUG(GwLog::LOG,"Drawing at PageOneValue, %s: %f", name1.c_str(), value1); + setupKeys(); // Adjust key definition depending on and chart-supported boat data type + } + + int displayPage(PageData& pageData) + { + LOG_DEBUG(GwLog::LOG, "Display PageOneValue"); + + // Get boat value for page + GwApi::BoatValue* bValue1 = pageData.values[0]; // Page boat data element + + // Optical warning by limit violation (unused) + if (String(flashLED) == "Limit Violation") { + setBlinkingLED(false); + setFlashLED(false); + } + + if (bValue1 == NULL) + return PAGE_OK; // no data, no page to display + + LOG_DEBUG(GwLog::DEBUG, "PageOneValue: printing %s, %.3f", bValue1->getName().c_str(), bValue1->value); // Draw page //*********************************************************** - /// Set display in partial refresh mode - getdisplay().setPartialWindow(0, 0, getdisplay().width(), getdisplay().height()); // Set partial update + getdisplay().setPartialWindow(0, 0, width, height); // Set partial update - // Show name - getdisplay().setTextColor(commonData->fgcolor); - getdisplay().setFont(&Ubuntu_Bold32pt8b); - getdisplay().setCursor(20, 100); - getdisplay().print(name1); // Page name + if (pageMode == VALUE || dataHstryBuf == nullptr) { + // show only data value; ignore other pageMode options if no chart supported boat data history buffer is available + showData(bValue1, FULL); - // Show unit - getdisplay().setFont(&Ubuntu_Bold20pt8b); - getdisplay().setCursor(270, 100); - if(holdvalues == false){ - getdisplay().print(unit1); // Unit - } - else{ - getdisplay().print(unit1old); - } + } else if (pageMode == CHART) { // show only data chart + if (dataChart) { + dataChart->showChrt(HORIZONTAL, FULL_SIZE, dataIntv, PRNT_NAME, PRNT_VALUE, *bValue1); + } - // Switch font if format for any values - if(bvalue1->getFormat() == "formatLatitude" || bvalue1->getFormat() == "formatLongitude"){ - getdisplay().setFont(&Ubuntu_Bold20pt8b); - getdisplay().setCursor(20, 180); - } - else if(bvalue1->getFormat() == "formatTime" || bvalue1->getFormat() == "formatDate"){ - getdisplay().setFont(&Ubuntu_Bold32pt8b); - getdisplay().setCursor(20, 200); - } - else{ - getdisplay().setFont(&DSEG7Classic_BoldItalic60pt7b); - getdisplay().setCursor(20, 240); - } - - // Show bus data - if(holdvalues == false){ - getdisplay().print(svalue1); // Real value as formated string - } - else{ - getdisplay().print(svalue1old); // Old value as formated string - } - if(valid1 == true){ - svalue1old = svalue1; // Save the old value - unit1old = unit1; // Save the old unit + } else if (pageMode == BOTH) { // show data value and chart + showData(bValue1, HALF); + if (dataChart) { + dataChart->showChrt(HORIZONTAL, HALF_SIZE_BOTTOM, dataIntv, NO_PRNT_NAME, NO_PRNT_VALUE, *bValue1); + } } return PAGE_UPDATE; }; }; -static Page* createPage(CommonData &common){ +static Page* createPage(CommonData& common) +{ return new PageOneValue(common); } @@ -120,10 +311,10 @@ static Page* createPage(CommonData &common){ * this will be number of BoatValue pointers in pageData.values */ PageDescription registerPageOneValue( - "OneValue", // Page name - createPage, // Action - 1, // Number of bus values depends on selection in Web configuration - true // Show display header on/off + "OneValue", // Page name + createPage, // Action + 1, // Number of bus values depends on selection in Web configuration + true // Show display header on/off ); #endif diff --git a/lib/obp60task/PageRudderPosition.cpp b/lib/obp60task/PageRudderPosition.cpp index 22b5f91..6a8695f 100644 --- a/lib/obp60task/PageRudderPosition.cpp +++ b/lib/obp60task/PageRudderPosition.cpp @@ -2,7 +2,6 @@ #include "Pagedata.h" #include "OBP60Extensions.h" -#include "BoatDataCalibration.h" class PageRudderPosition : public Page { @@ -41,7 +40,6 @@ public: GwApi::BoatValue *bvalue1 = pageData.values[0]; // First element in list String name1 = bvalue1->getName().c_str(); // Value name name1 = name1.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue1, logger); // Check if boat data value is to be calibrated value1 = bvalue1->value; // Raw value without unit convertion bool valid1 = bvalue1->valid; // Valid information String svalue1 = formatValue(bvalue1, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places diff --git a/lib/obp60task/PageSixValues.cpp b/lib/obp60task/PageSixValues.cpp index af735f2..b75f307 100644 --- a/lib/obp60task/PageSixValues.cpp +++ b/lib/obp60task/PageSixValues.cpp @@ -2,7 +2,6 @@ #include "Pagedata.h" #include "OBP60Extensions.h" -#include "BoatDataCalibration.h" const int SixValues_x1 = 5; const int SixValues_DeltaX = 200; @@ -57,7 +56,6 @@ class PageSixValues : public Page bvalue = pageData.values[i]; DataName[i] = xdrDelete(bvalue->getName()); DataName[i] = DataName[i].substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue, logger); // Check if boat data value is to be calibrated DataValue[i] = bvalue->value; // Value as double in SI unit DataValid[i] = bvalue->valid; DataText[i] = formatValue(bvalue, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places diff --git a/lib/obp60task/PageThreeValues.cpp b/lib/obp60task/PageThreeValues.cpp index 996e2bc..7c5324f 100644 --- a/lib/obp60task/PageThreeValues.cpp +++ b/lib/obp60task/PageThreeValues.cpp @@ -2,7 +2,6 @@ #include "Pagedata.h" #include "OBP60Extensions.h" -#include "BoatDataCalibration.h" class PageThreeValues : public Page { @@ -44,7 +43,6 @@ class PageThreeValues : public Page GwApi::BoatValue *bvalue1 = pageData.values[0]; // First element in list (only one value by PageOneValue) String name1 = xdrDelete(bvalue1->getName()); // Value name name1 = name1.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue1, logger); // Check if boat data value is to be calibrated double value1 = bvalue1->value; // Value as double in SI unit bool valid1 = bvalue1->valid; // Valid information String svalue1 = formatValue(bvalue1, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -54,7 +52,6 @@ class PageThreeValues : public Page GwApi::BoatValue *bvalue2 = pageData.values[1]; // Second element in list String name2 = xdrDelete(bvalue2->getName()); // Value name name2 = name2.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue2, logger); // Check if boat data value is to be calibrated double value2 = bvalue2->value; // Value as double in SI unit bool valid2 = bvalue2->valid; // Valid information String svalue2 = formatValue(bvalue2, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -64,7 +61,6 @@ class PageThreeValues : public Page GwApi::BoatValue *bvalue3 = pageData.values[2]; // Third element in list String name3 = xdrDelete(bvalue3->getName()); // Value name name3 = name3.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue3, logger); // Check if boat data value is to be calibrated double value3 = bvalue3->value; // Value as double in SI unit bool valid3 = bvalue3->valid; // Valid information String svalue3 = formatValue(bvalue3, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places diff --git a/lib/obp60task/PageTwoValues.cpp b/lib/obp60task/PageTwoValues.cpp index eaa59d4..5990656 100644 --- a/lib/obp60task/PageTwoValues.cpp +++ b/lib/obp60task/PageTwoValues.cpp @@ -2,177 +2,331 @@ #include "Pagedata.h" #include "OBP60Extensions.h" -#include "BoatDataCalibration.h" +#include "OBPDataOperations.h" +#include "OBPcharts.h" -class PageTwoValues : public Page -{ - public: - PageTwoValues(CommonData &common){ - commonData = &common; - common.logger->logDebug(GwLog::LOG,"Instantiate PageTwoValue"); +class PageTwoValues : public Page { +private: + GwLog* logger; + + enum PageMode { + VALUES, + VAL1_CHART, + VAL2_CHART, + CHARTS + }; + enum DisplayMode { + FULL, + HALF + }; + + static constexpr char HORIZONTAL = 'H'; + static constexpr char VERTICAL = 'V'; + static constexpr int8_t FULL_SIZE = 0; + static constexpr int8_t HALF_SIZE_TOP = 1; + static constexpr int8_t HALF_SIZE_BOTTOM = 2; + + static constexpr bool PRNT_NAME = true; + static constexpr bool NO_PRNT_NAME = false; + static constexpr bool PRNT_VALUE = true; + static constexpr bool NO_PRNT_VALUE = false; + + static constexpr int YOFFSET = 130; // y offset for display of 2nd boat value + + int width; // Screen width + int height; // Screen height + + bool keylock = false; // Keylock + PageMode pageMode = VALUES; // Page display mode + int8_t dataIntv = 1; // Update interval for wind history chart: + // (1)|(2)|(3)|(4)|(8) x 240 seconds for 4, 8, 12, 16, 32 min. history chart + + // String lengthformat; + bool useSimuData; + bool holdValues; + String flashLED; + String backlightMode; + String tempFormat; + + // Data buffer pointer (owned by HstryBuffers) + static constexpr int NUMVALUES = 2; // two data values in this page + RingBuffer* dataHstryBuf[NUMVALUES] = { nullptr }; + std::unique_ptr dataChart[NUMVALUES]; // Chart object + + // Old values for hold function + String sValueOld[NUMVALUES] = { "", "" }; + String unitOld[NUMVALUES] = { "", "" }; + + // display data values in display [FULL|HALF] + void showData(const std::vector& bValue, DisplayMode mode) + { + getdisplay().setTextColor(commonData->fgcolor); + + int numValues = bValue.size(); // do we have to handle 1 or 2 values? + + for (int i = 0; i < numValues; i++) { + int yOffset = YOFFSET * i; + String name = xdrDelete(bValue[i]->getName()); // Value name + name = name.substring(0, 6); // String length limit for value name + double value = bValue[i]->value; // Value as double in SI unit + bool valid = bValue[i]->valid; // Valid information + String sValue = formatValue(bValue[i], *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places + String unit = formatValue(bValue[i], *commonData).unit; // Unit of value + + // Show name + getdisplay().setFont(&Ubuntu_Bold20pt8b); + getdisplay().setCursor(20, 75 + yOffset); + getdisplay().print(name); // name + + // Show unit + getdisplay().setFont(&Ubuntu_Bold12pt8b); + getdisplay().setCursor(20, 125 + yOffset); + + if (holdValues) { + getdisplay().print(unitOld[i]); // name + } else { + getdisplay().print(unit); // name + } + + // Switch font depending on value format and adjust position + if (bValue[i]->getFormat() == "formatLatitude" || bValue[i]->getFormat() == "formatLongitude") { + getdisplay().setFont(&Ubuntu_Bold20pt8b); + getdisplay().setCursor(50, 125 + yOffset); + } else if (bValue[i]->getFormat() == "formatTime" || bValue[i]->getFormat() == "formatDate") { + getdisplay().setFont(&Ubuntu_Bold20pt8b); + getdisplay().setCursor(170, 105 + yOffset); + } else { // Default font for other formats + getdisplay().setFont(&DSEG7Classic_BoldItalic42pt7b); + getdisplay().setCursor(180, 125 + yOffset); + } + + // Show bus data + if (!holdValues || useSimuData) { + getdisplay().print(sValue); // Real value as formated string + } else { + getdisplay().print(sValueOld[i]); // Old value as formated string + } + + if (valid == true) { + sValueOld[i] = sValue; // Save the old value + unitOld[i] = unit; // Save the old unit + } + } + + if (numValues == 2 && mode == FULL) { // print line only, if we want to show 2 data values + getdisplay().fillRect(0, 145, width, 3, commonData->fgcolor); // Horizontal line 3 pix + } } - virtual int handleKey(int key){ - // Code for keylock - if(key == 11){ +public: + PageTwoValues(CommonData& common) + { + commonData = &common; + logger = commonData->logger; + LOG_DEBUG(GwLog::LOG, "Instantiate PageTwoValues"); + + width = getdisplay().width(); // Screen width + height = getdisplay().height(); // Screen height + + // Get config data + // lengthformat = commonData->config->getString(commonData->config->lengthFormat); + useSimuData = commonData->config->getBool(commonData->config->useSimuData); + holdValues = commonData->config->getBool(commonData->config->holdvalues); + flashLED = commonData->config->getString(commonData->config->flashLED); + backlightMode = commonData->config->getString(commonData->config->backlight); + tempFormat = commonData->config->getString(commonData->config->tempFormat); // [K|°C|°F] + } + + virtual void setupKeys() + { + Page::setupKeys(); + +#if defined BOARD_OBP60S3 + constexpr int ZOOM_KEY = 4; +#elif defined BOARD_OBP40S3 + constexpr int ZOOM_KEY = 1; +#endif + + if (dataHstryBuf[0] || dataHstryBuf[1]) { // show "Mode" key only if at least 1 chart supported boat data type is available + commonData->keydata[0].label = "MODE"; + if (pageMode != VALUES) { // show "ZOOM" key only if chart is visible + commonData->keydata[ZOOM_KEY].label = "ZOOM"; + } else { + commonData->keydata[ZOOM_KEY].label = ""; + } + } else { + commonData->keydata[0].label = ""; + commonData->keydata[ZOOM_KEY].label = ""; + } + } + + // Key functions + virtual int handleKey(int key) + { + if (dataHstryBuf[0] || dataHstryBuf[1]) { // if at least 1 boat data type supports charts + + // Set page mode: value | value/half chart | full charts + if (key == 1) { + switch (pageMode) { + + case VALUES: + + if (dataHstryBuf[0]) { + pageMode = VAL1_CHART; + } else if (dataHstryBuf[1]) { + pageMode = VAL2_CHART; + } + break; + + case VAL1_CHART: + + if (dataHstryBuf[1]) { + pageMode = VAL2_CHART; + } else { + pageMode = CHARTS; + } + break; + + case VAL2_CHART: + pageMode = CHARTS; + break; + + case CHARTS: + pageMode = VALUES; + break; + } + setupKeys(); // Adjust key definition depending on and chart-supported boat data type + return 0; // Commit the key + } + + // Set time frame to show for chart +#if defined BOARD_OBP60S3 + if (key == 5 && pageMode != VALUES) { +#elif defined BOARD_OBP40S3 + if (key == 2 && pageMode != VALUES) { +#endif + if (dataIntv == 1) { + dataIntv = 2; + } else if (dataIntv == 2) { + dataIntv = 3; + } else if (dataIntv == 3) { + dataIntv = 4; + } else if (dataIntv == 4) { + dataIntv = 8; + } else { + dataIntv = 1; + } + return 0; // Commit the key + } + } + + // Keylock function + if (key == 11) { // Code for keylock commonData->keylock = !commonData->keylock; - return 0; // Commit the key + return 0; // Commit the key } return key; } - int displayPage(PageData &pageData){ - GwConfigHandler *config = commonData->config; - GwLog *logger = commonData->logger; - - // Old values for hold function - static String svalue1old = ""; - static String unit1old = ""; - static String svalue2old = ""; - static String unit2old = ""; - - // Get config data - String lengthformat = config->getString(config->lengthFormat); - // bool simulation = config->getBool(config->useSimuData); - bool holdvalues = config->getBool(config->holdvalues); - String flashLED = config->getString(config->flashLED); - String backlightMode = config->getString(config->backlight); - - // Get boat values #1 - GwApi::BoatValue *bvalue1 = pageData.values[0]; // First element in list (only one value by PageOneValue) - String name1 = xdrDelete(bvalue1->getName()); // Value name - name1 = name1.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue1, logger); // Check if boat data value is to be calibrated - double value1 = bvalue1->value; // Value as double in SI unit - bool valid1 = bvalue1->valid; // Valid information - String svalue1 = formatValue(bvalue1, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places - String unit1 = formatValue(bvalue1, *commonData).unit; // Unit of value - - // Get boat values #2 - GwApi::BoatValue *bvalue2 = pageData.values[1]; // Second element in list - String name2 = xdrDelete(bvalue2->getName()); // Value name - name2 = name2.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue2, logger); // Check if boat data value is to be calibrated - double value2 = bvalue2->value; // Value as double in SI unit - bool valid2 = bvalue2->valid; // Valid information - String svalue2 = formatValue(bvalue2, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places - String unit2 = formatValue(bvalue2, *commonData).unit; // Unit of value - - // Optical warning by limit violation (unused) - if(String(flashLED) == "Limit Violation"){ + virtual void displayNew(PageData& pageData) + { +#ifdef BOARD_OBP60S3 + // Clear optical warning + if (flashLED == "Limit Violation") { setBlinkingLED(false); - setFlashLED(false); + setFlashLED(false); + } +#endif + // buffer initialization will fail, if page is default page, because is not executed at system start for default page + for (int i = 0; i < NUMVALUES; i++) { + if (!dataChart[i]) { // Create chart objects if they don't exist + + GwApi::BoatValue* bValue = pageData.values[i]; // Page boat data element + String bValName = bValue->getName(); // Value name + String bValFormat = bValue->getFormat(); // Value format + + dataHstryBuf[i] = pageData.hstryBuffers->getBuffer(bValName); + + if (dataHstryBuf[i]) { + dataChart[i].reset(new Chart(*dataHstryBuf[i], Chart::dfltChrtDta[bValFormat].range, *commonData, useSimuData)); + LOG_DEBUG(GwLog::DEBUG, "PageTwoValues: Created chart object%d for %s", i, bValName.c_str()); + } else { + LOG_DEBUG(GwLog::DEBUG, "PageTwoValues: No chart object available for %s", bValName.c_str()); + } + } } - // Logging boat values - if (bvalue1 == NULL) return PAGE_OK; // WTF why this statement? - LOG_DEBUG(GwLog::LOG,"Drawing at PageTwoValues, %s: %f, %s: %f", name1.c_str(), value1, name2.c_str(), value2); + setupKeys(); // Adjust key definition depending on and chart-supported boat data type + } + + int displayPage(PageData& pageData) + { + LOG_DEBUG(GwLog::LOG, "Display PageTwoValues"); + + // Get boat values for page + std::vector bValue; + bValue.push_back(pageData.values[0]); // Page boat data element 1 + bValue.push_back(pageData.values[1]); // Page boat data element 2 + + // Optical warning by limit violation (unused) + if (String(flashLED) == "Limit Violation") { + setBlinkingLED(false); + setFlashLED(false); + } + + if (bValue[0] == NULL && bValue[1] == NULL) + return PAGE_OK; // no data, no page to display + + LOG_DEBUG(GwLog::DEBUG, "PageTwoValues: printing #1: %s, %.3f, #2: %s, %.3f", + bValue[0]->getName().c_str(), bValue[0]->value, bValue[1]->getName().c_str(), bValue[1]->value); // Draw page //*********************************************************** - // Set display in partial refresh mode - getdisplay().setPartialWindow(0, 0, getdisplay().width(), getdisplay().height()); // Set partial update + getdisplay().setPartialWindow(0, 0, width, height); // Set partial update - // ############### Value 1 ################ + if (pageMode == VALUES || (dataHstryBuf[0] == nullptr && dataHstryBuf[1] == nullptr)) { + // show only data value; ignore other pageMode options if no chart supported boat data history buffer is available + showData(bValue, FULL); - // Show name - getdisplay().setTextColor(commonData->fgcolor); - getdisplay().setFont(&Ubuntu_Bold20pt8b); - getdisplay().setCursor(20, 80); - getdisplay().print(name1); // Page name + } else if (pageMode == VAL1_CHART) { // show data value 1 and chart + showData({ bValue[0] }, HALF); + if (dataChart[0]) { + dataChart[0]->showChrt(HORIZONTAL, HALF_SIZE_BOTTOM, dataIntv, NO_PRNT_NAME, NO_PRNT_VALUE, *bValue[0]); + } - // Show unit - getdisplay().setFont(&Ubuntu_Bold12pt8b); - getdisplay().setCursor(20, 130); - if(holdvalues == false){ - getdisplay().print(unit1); // Unit - } - else{ - getdisplay().print(unit1old); - } + } else if (pageMode == VAL2_CHART) { // show data value 2 and chart + showData({ bValue[1] }, HALF); + if (dataChart[1]) { + dataChart[1]->showChrt(HORIZONTAL, HALF_SIZE_BOTTOM, dataIntv, NO_PRNT_NAME, NO_PRNT_VALUE, *bValue[1]); + } - // Switch font if format for any values - if(bvalue1->getFormat() == "formatLatitude" || bvalue1->getFormat() == "formatLongitude"){ - getdisplay().setFont(&Ubuntu_Bold20pt8b); - getdisplay().setCursor(50, 130); - } - else if(bvalue1->getFormat() == "formatTime" || bvalue1->getFormat() == "formatDate"){ - getdisplay().setFont(&Ubuntu_Bold20pt8b); - getdisplay().setCursor(170, 105); - } - else{ - getdisplay().setFont(&DSEG7Classic_BoldItalic42pt7b); - getdisplay().setCursor(180, 130); - } - - // Show bus data - if(holdvalues == false){ - getdisplay().print(svalue1); // Real value as formated string - } - else{ - getdisplay().print(svalue1old); // Old value as formated string - } - if(valid1 == true){ - svalue1old = svalue1; // Save the old value - unit1old = unit1; // Save the old unit - } - - // ############### Horizontal Line ################ - - // Horizontal line 3 pix - getdisplay().fillRect(0, 145, 400, 3, commonData->fgcolor); - - // ############### Value 2 ################ - - // Show name - getdisplay().setFont(&Ubuntu_Bold20pt8b); - getdisplay().setCursor(20, 190); - getdisplay().print(name2); // Page name - - // Show unit - getdisplay().setFont(&Ubuntu_Bold12pt8b); - getdisplay().setCursor(20, 240); - if(holdvalues == false){ - getdisplay().print(unit2); // Unit - } - else{ - getdisplay().print(unit2old); - } - - // Switch font if format for any values - if(bvalue2->getFormat() == "formatLatitude" || bvalue2->getFormat() == "formatLongitude"){ - getdisplay().setFont(&Ubuntu_Bold20pt8b); - getdisplay().setCursor(50, 240); - } - else if(bvalue2->getFormat() == "formatTime" || bvalue2->getFormat() == "formatDate"){ - getdisplay().setFont(&Ubuntu_Bold20pt8b); - getdisplay().setCursor(170, 215); - } - else{ - getdisplay().setFont(&DSEG7Classic_BoldItalic42pt7b); - getdisplay().setCursor(180, 240); - } - - // Show bus data - if(holdvalues == false){ - getdisplay().print(svalue2); // Real value as formated string - } - else{ - getdisplay().print(svalue2old); // Old value as formated string - } - if(valid2 == true){ - svalue2old = svalue2; // Save the old value - unit2old = unit2; // Save the old unit + } else if (pageMode == CHARTS) { // show both data charts + if (dataChart[0]) { + if (dataChart[1]) { + dataChart[0]->showChrt(HORIZONTAL, HALF_SIZE_TOP, dataIntv, PRNT_NAME, PRNT_VALUE, *bValue[0]); + } else { + dataChart[0]->showChrt(HORIZONTAL, FULL_SIZE, dataIntv, PRNT_NAME, PRNT_VALUE, *bValue[0]); + } + } + if (dataChart[1]) { + if (dataChart[0]) { + dataChart[1]->showChrt(HORIZONTAL, HALF_SIZE_BOTTOM, dataIntv, PRNT_NAME, PRNT_VALUE, *bValue[1]); + } else { + dataChart[1]->showChrt(HORIZONTAL, FULL_SIZE, dataIntv, PRNT_NAME, PRNT_VALUE, *bValue[1]); + } + } } return PAGE_UPDATE; }; }; -static Page *createPage(CommonData &common){ +static Page* createPage(CommonData& common) +{ return new PageTwoValues(common); } + /** * with the code below we make this page known to the PageTask * we give it a type (name) that can be selected in the config @@ -181,10 +335,10 @@ static Page *createPage(CommonData &common){ * this will be number of BoatValue pointers in pageData.values */ PageDescription registerPageTwoValues( - "TwoValues", // Page name - createPage, // Action - 2, // Number of bus values depends on selection in Web configuration - true // Show display header on/off + "TwoValues", // Page name + createPage, // Action + 2, // Number of bus values depends on selection in Web configuration + true // Show display header on/off ); #endif diff --git a/lib/obp60task/PageWind.cpp b/lib/obp60task/PageWind.cpp index 226b430..242a365 100644 --- a/lib/obp60task/PageWind.cpp +++ b/lib/obp60task/PageWind.cpp @@ -3,7 +3,6 @@ #include "Pagedata.h" #include "OBP60Extensions.h" #include "N2kMessages.h" -#include "BoatDataCalibration.h" #define front_width 120 #define front_height 162 @@ -324,7 +323,6 @@ public: } String name1 = bvalue1->getName().c_str(); // Value name name1 = name1.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue1, logger); // Check if boat data value is to be calibrated double value1 = bvalue1->value; // Value as double in SI unit // bool valid1 = bvalue1->valid; // Valid information String svalue1 = formatValue(bvalue1, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -338,7 +336,6 @@ public: } String name2 = bvalue2->getName().c_str(); // Value name name2 = name2.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue2, logger); // Check if boat data value is to be calibrated double value2 = bvalue2->value; // Value as double in SI unit // bool valid2 = bvalue2->valid; // Valid information if (simulation) { diff --git a/lib/obp60task/PageWindPlot.cpp b/lib/obp60task/PageWindPlot.cpp index 98e1a71..da948c2 100644 --- a/lib/obp60task/PageWindPlot.cpp +++ b/lib/obp60task/PageWindPlot.cpp @@ -2,97 +2,76 @@ #include "Pagedata.h" #include "OBP60Extensions.h" -#include "OBPRingBuffer.h" #include "OBPDataOperations.h" -#include "BoatDataCalibration.h" -#include - -static const double radToDeg = 180.0 / M_PI; // Conversion factor from radians to degrees - -// Get maximum difference of last of TWD ringbuffer values to center chart; returns "0" if data is not valid -int getCntr(const RingBuffer& windDirHstry, size_t amount) -{ - const int MAX_VAL = windDirHstry.getMaxVal(); - size_t count = windDirHstry.getCurrentSize(); - - if (windDirHstry.isEmpty() || amount <= 0) { - return 0; - } - if (amount > count) - amount = count; - - uint16_t midWndDir, minWndDir, maxWndDir = 0; - int wndCenter = 0; - - midWndDir = windDirHstry.getMid(amount); - if (midWndDir != MAX_VAL) { - midWndDir = midWndDir / 1000.0 * radToDeg; - wndCenter = int((midWndDir + (midWndDir >= 0 ? 5 : -5)) / 10) * 10; // Set new center value; round to nearest 10 degree value - minWndDir = windDirHstry.getMin(amount) / 1000.0 * radToDeg; - maxWndDir = windDirHstry.getMax(amount) / 1000.0 * radToDeg; - if ((maxWndDir - minWndDir) > 180 && !(minWndDir > maxWndDir)) { // if wind range is > 180 and no 0° crossover, adjust wndCenter to smaller wind range end - wndCenter = WindUtils::to360(wndCenter + 180); - } - } - - return wndCenter; -} - -// Get maximum difference of last of TWD ringbuffer values to center chart -int getRng(const RingBuffer& windDirHstry, int center, size_t amount) -{ - int minVal = windDirHstry.getMinVal(); - const int MAX_VAL = windDirHstry.getMaxVal(); - size_t count = windDirHstry.getCurrentSize(); - - if (windDirHstry.isEmpty() || amount <= 0) { - return MAX_VAL; - } - if (amount > count) - amount = count; - - int value = 0; - int rng = 0; - int maxRng = minVal; - // Start from the newest value (last) and go backwards x times - for (size_t i = 0; i < amount; i++) { - value = windDirHstry.get(count - 1 - i); - - if (value == MAX_VAL) { - continue; // ignore invalid values - } - - value = value / 1000.0 * radToDeg; - rng = abs(((value - center + 540) % 360) - 180); - if (rng > maxRng) - maxRng = rng; - } - if (maxRng > 180) { - maxRng = 180; - } - - return (maxRng != minVal ? maxRng : MAX_VAL); -} +#include "OBPcharts.h" // **************************************************************** class PageWindPlot : public Page { +private: + GwLog* logger; + + enum ChartMode { + DIRECTION, + SPEED, + BOTH + }; + + static constexpr char HORIZONTAL = 'H'; + static constexpr char VERTICAL = 'V'; + static constexpr int8_t FULL_SIZE = 0; + static constexpr int8_t HALF_SIZE_LEFT = 1; + static constexpr int8_t HALF_SIZE_RIGHT = 2; + + static constexpr bool PRNT_NAME = true; + static constexpr bool NO_PRNT_NAME = false; + static constexpr bool PRNT_VALUE = true; + static constexpr bool NO_PRNT_VALUE = false; + + int width; // Screen width + int height; // Screen height + bool keylock = false; // Keylock - char chrtMode = 'D'; // Chart mode: 'D' for TWD, 'S' for TWS, 'B' for both - bool showTruW = true; // Show true wind or apparant wind in chart area + ChartMode chrtMode = DIRECTION; + bool showTruW = true; // Show true wind or apparent wind in chart area bool oldShowTruW = false; // remember recent user selection of wind data type - int dataIntv = 1; // Update interval for wind history chart: - // (1)|(2)|(3)|(4)|(8) x 240 seconds for 4, 8, 12, 16, 32 min. history chart + int8_t dataIntv = 1; // Update interval for wind history chart: + // (1)|(2)|(3)|(4)|(8) x 240 seconds for 4, 8, 12, 16, 32 min. history chart bool useSimuData; + // bool holdValues; String flashLED; String backlightMode; +#ifdef BOARD_OBP40S3 + String wndSrc; // Wind source true/apparent wind - preselection for OBP40 +#endif + + // Data buffers pointers (owned by HstryBuffers) + RingBuffer* twdHstry = nullptr; + RingBuffer* twsHstry = nullptr; + RingBuffer* awdHstry = nullptr; + RingBuffer* awsHstry = nullptr; + + // Chart objects + std::unique_ptr twdChart, awdChart; // Chart object for wind direction + std::unique_ptr twsChart, awsChart; // Chart object for wind speed + + // Active charts and values + Chart* wdChart = nullptr; + Chart* wsChart = nullptr; + GwApi::BoatValue* wdBVal = nullptr; + GwApi::BoatValue* wsBVal = nullptr; + public: PageWindPlot(CommonData& common) { commonData = &common; - common.logger->logDebug(GwLog::LOG, "Instantiate PageWindPlot"); + logger = commonData->logger; + LOG_DEBUG(GwLog::LOG, "Instantiate PageWindPlot"); + + width = getdisplay().width(); // Screen width + height = getdisplay().height(); // Screen height // Get config data useSimuData = common.config->getBool(common.config->useSimuData); @@ -100,31 +79,32 @@ public: flashLED = common.config->getString(common.config->flashLED); backlightMode = common.config->getString(common.config->backlight); + oldShowTruW = !showTruW; // makes wind source being initialized at initial page call } virtual void setupKeys() { Page::setupKeys(); - // commonData->keydata[0].label = "MODE"; + commonData->keydata[0].label = "MODE"; #if defined BOARD_OBP60S3 commonData->keydata[1].label = "SRC"; - commonData->keydata[4].label = "INTV"; + commonData->keydata[4].label = "ZOOM"; #elif defined BOARD_OBP40S3 - commonData->keydata[1].label = "INTV"; + commonData->keydata[1].label = "ZOOM"; #endif } // Key functions virtual int handleKey(int key) { - // Set chart mode TWD | TWS -> to be implemented + // Set chart mode if (key == 1) { - if (chrtMode == 'D') { - chrtMode = 'S'; - } else if (chrtMode == 'S') { - chrtMode = 'B'; + if (chrtMode == DIRECTION) { + chrtMode = SPEED; + } else if (chrtMode == SPEED) { + chrtMode = BOTH; } else { - chrtMode = 'D'; + chrtMode = DIRECTION; } return 0; // Commit the key } @@ -163,350 +143,109 @@ public: return key; } - virtual void displayNew(PageData &pageData){ + virtual void displayNew(PageData& pageData) + { +#ifdef BOARD_OBP60S3 + // Clear optical warning + if (flashLED == "Limit Violation") { + setBlinkingLED(false); + setFlashLED(false); + } +#endif #ifdef BOARD_OBP40S3 - String wndSrc; // Wind source true/apparant wind - preselection for OBP40 - + // we can only initialize user defined wind source here, because "pageData" is not available at object instantiation wndSrc = commonData->config->getString("page" + String(pageData.pageNumber) + "wndsrc"); - if (wndSrc =="True wind") { + if (wndSrc == "True wind") { showTruW = true; } else { - showTruW = false; // Wind source is apparant wind + showTruW = false; // Wind source is apparent wind } - commonData->logger->logDebug(GwLog::LOG,"New PageWindPlot: wind source=%s", wndSrc); + oldShowTruW = !showTruW; // Force chart update in displayPage #endif - oldShowTruW = !showTruW; // makes wind source being initialized at initial page call + + if (!twdChart) { // Create true wind charts if they don't exist + twdHstry = pageData.hstryBuffers->getBuffer("TWD"); + twsHstry = pageData.hstryBuffers->getBuffer("TWS"); + + if (twdHstry) { + twdChart.reset(new Chart(*twdHstry, Chart::dfltChrtDta["formatCourse"].range, *commonData, useSimuData)); + } + if (twsHstry) { + twsChart.reset(new Chart(*twsHstry, Chart::dfltChrtDta["formatKnots"].range, *commonData, useSimuData)); + } + } + + if (!awdChart) { // Create apparent wind charts if they don't exist + awdHstry = pageData.hstryBuffers->getBuffer("AWD"); + awsHstry = pageData.hstryBuffers->getBuffer("AWS"); + + if (awdHstry) { + awdChart.reset(new Chart(*awdHstry, Chart::dfltChrtDta["formatCourse"].range, *commonData, useSimuData)); + } + if (awsHstry) { + awsChart.reset(new Chart(*awsHstry, Chart::dfltChrtDta["formatKnots"].range, *commonData, useSimuData)); + } + if (twdHstry && twsHstry && awdHstry && awsHstry) { + LOG_DEBUG(GwLog::DEBUG, "PageWindPlot: Created wind charts"); + } else { + LOG_DEBUG(GwLog::DEBUG, "PageWindPlot: Some/all chart objects for wind data missing"); + } + } } int displayPage(PageData& pageData) { - GwConfigHandler* config = commonData->config; - GwLog* logger = commonData->logger; - - static RingBuffer* wdHstry; // Wind direction data buffer - static RingBuffer* wsHstry; // Wind speed data buffer - static String wdName, wdFormat; // Wind direction name and format - static String wsName, wsFormat; // Wind speed name and format - static int16_t wdMAX_VAL; // Max. value of wd history buffer, indicating invalid values - float wsValue; // Wind speed value in chart area - String wsUnit; // Wind speed unit in chart area - static GwApi::BoatValue* wsBVal = new GwApi::BoatValue("TWS"); // temp BoatValue for wind speed unit identification; required by OBP60Formater - - // current boat data values; TWD/AWD only for validation test - const int numBoatData = 2; - GwApi::BoatValue* bvalue; - bool BDataValid[numBoatData]; - - static bool isInitialized = false; // Flag to indicate that page is initialized - static bool wndDataValid = false; // Flag to indicate if wind data is valid - static int numNoData; // Counter for multiple invalid data values in a row - - static int width; // Screen width - static int height; // Screen height - static int xCenter; // Center of screen in x direction - static const int yOffset = 48; // Offset for y coordinates of chart area - static int cHeight; // height of chart area - static int bufSize; // History buffer size: 1.920 values for 32 min. history chart - static int intvBufSize; // Buffer size used for currently selected time interval - int count; // current size of buffer - static int numWndVals; // number of wind values available for current interval selection - static int bufStart; // 1st data value in buffer to show - int numAddedBufVals; // Number of values added to buffer since last display - size_t currIdx; // Current index in TWD history buffer - static size_t lastIdx; // Last index of TWD history buffer - static size_t lastAddedIdx = 0; // Last index of TWD history buffer when new data was added - static int oldDataIntv; // remember recent user selection of data interval - - static int wndCenter; // chart wind center value position - static int wndLeft; // chart wind left value position - static int wndRight; // chart wind right value position - static int chrtRng; // Range of wind values from mid wind value to min/max wind value in degrees - int diffRng; // Difference between mid and current wind value - static const int dfltRng = 60; // Default range for chart - int midWndDir; // New value for wndCenter after chart start / shift - - int x, y; // x and y coordinates for drawing - static int prevX, prevY; // Last x and y coordinates for drawing - static float chrtScl; // Scale for wind values in pixels per degree - int chrtVal; // Current wind value - static int chrtPrevVal; // Last wind value in chart area for check if value crosses 180 degree line - LOG_DEBUG(GwLog::LOG, "Display PageWindPlot"); - ulong timer = millis(); - - if (!isInitialized) { - width = getdisplay().width(); - height = getdisplay().height(); - xCenter = width / 2; - cHeight = height - yOffset - 22; - numNoData = 0; - bufStart = 0; - oldDataIntv = 0; - wsValue = 0; - numAddedBufVals, currIdx, lastIdx = 0; - wndCenter = INT_MAX; - midWndDir = 0; - diffRng = dfltRng; - chrtRng = dfltRng; - - isInitialized = true; // Set flag to indicate that page is now initialized - } - - // read boat data values; TWD only for validation test, TWS for display of current value - for (int i = 0; i < numBoatData; i++) { - bvalue = pageData.values[i]; - BDataValid[i] = bvalue->valid; - } - - // Optical warning by limit violation (unused) - if (String(flashLED) == "Limit Violation") { - setBlinkingLED(false); - setFlashLED(false); - } + // ulong pageTime = millis(); if (showTruW != oldShowTruW) { + + // Switch active charts based on showTruW if (showTruW) { - wdHstry = pageData.boatHstry->hstryBufList.twdHstry; - wsHstry = pageData.boatHstry->hstryBufList.twsHstry; + wdChart = twdChart.get(); + wsChart = twsChart.get(); + wdBVal = pageData.values[0]; + wsBVal = pageData.values[1]; } else { - wdHstry = pageData.boatHstry->hstryBufList.awdHstry; - wsHstry = pageData.boatHstry->hstryBufList.awsHstry; + wdChart = awdChart.get(); + wsChart = awsChart.get(); + wdBVal = pageData.values[2]; + wsBVal = pageData.values[3]; } - wdHstry->getMetaData(wdName, wdFormat); - wsHstry->getMetaData(wsName, wsFormat); - wdMAX_VAL = wdHstry->getMaxVal(); - bufSize = wdHstry->getCapacity(); - wsBVal->setFormat(wsHstry->getFormat()); - lastAddedIdx = wdHstry->getLastIdx(); oldShowTruW = showTruW; } - - // Identify buffer size and buffer start position for chart - count = wdHstry->getCurrentSize(); - currIdx = wdHstry->getLastIdx(); - numAddedBufVals = (currIdx - lastAddedIdx + bufSize) % bufSize; // Number of values added to buffer since last display - if (dataIntv != oldDataIntv || count == 1) { - // new data interval selected by user; this is only x * 230 values instead of 240 seconds (4 minutes) per interval step - intvBufSize = cHeight * dataIntv; - numWndVals = min(count, (cHeight - 60) * dataIntv); - bufStart = max(0, count - numWndVals); - lastAddedIdx = currIdx; - oldDataIntv = dataIntv; - } else { - numWndVals = numWndVals + numAddedBufVals; - lastAddedIdx = currIdx; - if (count == bufSize) { - bufStart = max(0, bufStart - numAddedBufVals); - } - } - // LOG_DEBUG(GwLog::DEBUG,"PSRAM Size: %d kByte; free: %d Byte", ESP.getPsramSize()/1024, ESP.getFreePsram()); - LOG_DEBUG(GwLog::DEBUG, "PageWindPlot Dataset: count: %d, xWD: %.1f, xWS: %.2f, xWD_valid? %d, intvBufSize: %d, numWndVals: %d, bufStart: %d, numAddedBufVals: %d, lastIdx: %d, wind source: %s", - count, wdHstry->getLast() / 1000.0 * radToDeg, wsHstry->getLast() / 1000.0 * 1.94384, BDataValid[0], intvBufSize, numWndVals, bufStart, numAddedBufVals, wdHstry->getLastIdx(), - showTruW ? "True" : "App"); - - // Set wndCenter from 1st real buffer value - if (wndCenter == INT_MAX || (wndCenter == 0 && count == 1)) { - wndCenter = getCntr(*wdHstry, numWndVals); - LOG_DEBUG(GwLog::DEBUG, "PageWindPlot Range Init: count: %d, xWD: %.1f, wndCenter: %d, diffRng: %d, chrtRng: %d, Min: %.0f, Max: %.0f", count, wdHstry->getLast() / 1000.0 * radToDeg, - wndCenter, diffRng, chrtRng, wdHstry->getMin(numWndVals) / 1000.0 * radToDeg, wdHstry->getMax(numWndVals) / 1000.0 * radToDeg); - } else { - // check and adjust range between left, center, and right chart limit - diffRng = getRng(*wdHstry, wndCenter, numWndVals); - diffRng = (diffRng == wdMAX_VAL ? 0 : diffRng); - if (diffRng > chrtRng) { - chrtRng = int((diffRng + (diffRng >= 0 ? 9 : -1)) / 10) * 10; // Round up to next 10 degree value - } else if (diffRng + 10 < chrtRng) { // Reduce chart range for higher resolution if possible - chrtRng = max(dfltRng, int((diffRng + (diffRng >= 0 ? 9 : -1)) / 10) * 10); - LOG_DEBUG(GwLog::DEBUG, "PageWindPlot Range adjust: wndCenter: %d, diffRng: %d, chrtRng: %d, Min: %.0f, Max: %.0f", wndCenter, diffRng, chrtRng, - wdHstry->getMin(numWndVals) / 1000.0 * radToDeg, wdHstry->getMax(numWndVals) / 1000.0 * radToDeg); - } - } - chrtScl = float(width) / float(chrtRng) / 2.0; // Chart scale: pixels per degree - wndLeft = wndCenter - chrtRng; - if (wndLeft < 0) - wndLeft += 360; - wndRight = (chrtRng < 180 ? wndCenter + chrtRng : wndCenter + chrtRng - 1); - if (wndRight >= 360) - wndRight -= 360; + LOG_DEBUG(GwLog::DEBUG, "PageWindPlot: draw with data %s: %.2f, %s: %.2f", wdBVal->getName().c_str(), wdBVal->value, wsBVal->getName().c_str(), wsBVal->value); // Draw page - //*********************************************************************** + //*********************************************************** // Set display in partial refresh mode getdisplay().setPartialWindow(0, 0, width, height); // Set partial update getdisplay().setTextColor(commonData->fgcolor); - // chart lines - getdisplay().fillRect(0, yOffset, width, 2, commonData->fgcolor); - getdisplay().fillRect(xCenter, yOffset, 1, cHeight, commonData->fgcolor); - - // chart labels - char sWndLbl[4]; // char buffer for Wind angle label - getdisplay().setFont(&Ubuntu_Bold12pt8b); - getdisplay().setCursor(xCenter - 88, yOffset - 3); - getdisplay().print(wdName); // Wind data name - snprintf(sWndLbl, 4, "%03d", (wndCenter < 0) ? (wndCenter + 360) : wndCenter); - drawTextCenter(xCenter, yOffset - 11, sWndLbl); - getdisplay().drawCircle(xCenter + 25, yOffset - 17, 2, commonData->fgcolor); // symbol - getdisplay().drawCircle(xCenter + 25, yOffset - 17, 3, commonData->fgcolor); // symbol - getdisplay().setCursor(1, yOffset - 3); - snprintf(sWndLbl, 4, "%03d", (wndLeft < 0) ? (wndLeft + 360) : wndLeft); - getdisplay().print(sWndLbl); // Wind left value - getdisplay().drawCircle(46, yOffset - 17, 2, commonData->fgcolor); // symbol - getdisplay().drawCircle(46, yOffset - 17, 3, commonData->fgcolor); // symbol - getdisplay().setCursor(width - 50, yOffset - 3); - snprintf(sWndLbl, 4, "%03d", (wndRight < 0) ? (wndRight + 360) : wndRight); - getdisplay().print(sWndLbl); // Wind right value - getdisplay().drawCircle(width - 5, yOffset - 17, 2, commonData->fgcolor); // symbol - getdisplay().drawCircle(width - 5, yOffset - 17, 3, commonData->fgcolor); // symbol - - if (wdHstry->getMax() == wdMAX_VAL) { - // only values in buffer -> no valid wind data available - wndDataValid = false; - } else if (!BDataValid[0] && !useSimuData) { - // currently no valid xWD data available and no simulation mode - numNoData++; - wndDataValid = true; - if (numNoData > 3) { - // If more than 4 invalid values in a row, send message - wndDataValid = false; - } - } else { - numNoData = 0; // reset data error counter - wndDataValid = true; // At least some wind data available - } - // Draw wind values in chart - //*********************************************************************** - if (wndDataValid) { - for (int i = 0; i < (numWndVals / dataIntv); i++) { - chrtVal = static_cast(wdHstry->get(bufStart + (i * dataIntv))); // show the latest wind values in buffer; keep 1st value constant in a rolling buffer - if (chrtVal == wdMAX_VAL) { - chrtPrevVal = wdMAX_VAL; - } else { - chrtVal = static_cast((chrtVal / 1000.0 * radToDeg) + 0.5); // Convert to degrees and round - x = ((chrtVal - wndLeft + 360) % 360) * chrtScl; - y = yOffset + cHeight - i; // Position in chart area - - if (i >= (numWndVals / dataIntv) - 1) // log chart data of 1 line (adjust for test purposes) - LOG_DEBUG(GwLog::DEBUG, "PageWindPlot Chart: i: %d, chrtVal: %d, bufStart: %d, count: %d, linesToShow: %d", i, chrtVal, bufStart, count, (numWndVals / dataIntv)); - - if ((i == 0) || (chrtPrevVal == wdMAX_VAL)) { - // just a dot for 1st chart point or after some invalid values - prevX = x; - prevY = y; - } else { - // cross borders check; shift values to [-180..0..180]; when crossing borders, range is 2x 180 degrees - int wndLeftDlt = -180 - ((wndLeft >= 180) ? (wndLeft - 360) : wndLeft); - int chrtVal180 = ((chrtVal + wndLeftDlt + 180) % 360 + 360) % 360 - 180; - int chrtPrevVal180 = ((chrtPrevVal + wndLeftDlt + 180) % 360 + 360) % 360 - 180; - if (((chrtPrevVal180 >= -180) && (chrtPrevVal180 < -90) && (chrtVal180 > 90)) || ((chrtPrevVal180 <= 179) && (chrtPrevVal180 > 90) && chrtVal180 <= -90)) { - // If current value crosses chart borders compared to previous value, split line - int xSplit = (((chrtPrevVal180 > 0 ? wndRight : wndLeft) - wndLeft + 360) % 360) * chrtScl; - getdisplay().drawLine(prevX, prevY, xSplit, y, commonData->fgcolor); - getdisplay().drawLine(prevX, prevY - 1, ((xSplit != prevX) ? xSplit : xSplit - 1), ((xSplit != prevX) ? y - 1 : y), commonData->fgcolor); - prevX = (((chrtVal180 > 0 ? wndRight : wndLeft) - wndLeft + 360) % 360) * chrtScl; - } - } - - // Draw line with 2 pixels width + make sure vertical line are drawn correctly - getdisplay().drawLine(prevX, prevY, x, y, commonData->fgcolor); - getdisplay().drawLine(prevX, prevY - 1, ((x != prevX) ? x : x - 1), ((x != prevX) ? y - 1 : y), commonData->fgcolor); - chrtPrevVal = chrtVal; - prevX = x; - prevY = y; - } - // Reaching chart area top end - if (i >= (cHeight - 1)) { - oldDataIntv = 0; // force reset of buffer start and number of values to show in next display loop - - int minWndDir = wdHstry->getMin(numWndVals) / 1000.0 * radToDeg; - int maxWndDir = wdHstry->getMax(numWndVals) / 1000.0 * radToDeg; - LOG_DEBUG(GwLog::DEBUG, "PageWindPlot FreeTop: Minimum: %d, Maximum: %d, OldwndCenter: %d", minWndDir, maxWndDir, wndCenter); - // if (((minWndDir - wndCenter >= 0) && (minWndDir - wndCenter < 180)) || ((maxWndDir - wndCenter <= 0) && (maxWndDir - wndCenter >=180))) { - if ((wndRight > wndCenter && (minWndDir >= wndCenter && minWndDir <= wndRight)) || (wndRight <= wndCenter && (minWndDir >= wndCenter || minWndDir <= wndRight)) || (wndLeft < wndCenter && (maxWndDir <= wndCenter && maxWndDir >= wndLeft)) || (wndLeft >= wndCenter && (maxWndDir <= wndCenter || maxWndDir >= wndLeft))) { - // Check if all wind value are left or right of center value -> optimize chart center - wndCenter = getCntr(*wdHstry, numWndVals); - } - LOG_DEBUG(GwLog::DEBUG, "PageWindPlot FreeTop: cHeight: %d, bufStart: %d, numWndVals: %d, wndCenter: %d", cHeight, bufStart, numWndVals, wndCenter); - break; - } + if (chrtMode == DIRECTION) { + if (wdChart) { + wdChart->showChrt(VERTICAL, FULL_SIZE, dataIntv, PRNT_NAME, PRNT_VALUE, *wdBVal); } - // Print wind speed value - int currentZone; - static int lastZone = 0; - static bool flipTws = false; - int xPosTws; - static const int yPosTws = yOffset + 40; - - xPosTws = flipTws ? 20 : width - 145; - currentZone = (y >= yPosTws - 38) && (y <= yPosTws + 6) && (x >= xPosTws - 4) && (x <= xPosTws + 146) ? 1 : 0; // Define current zone for TWS value - if (currentZone != lastZone) { - // Only flip when x moves to a different zone - if ((y >= yPosTws - 38) && (y <= yPosTws + 6) && (x >= xPosTws - 4) && (x <= xPosTws + 146)) { - flipTws = !flipTws; - xPosTws = flipTws ? 20 : width - 145; - } + } else if (chrtMode == SPEED) { + if (wsChart) { + wsChart->showChrt(HORIZONTAL, FULL_SIZE, dataIntv, PRNT_NAME, PRNT_VALUE, *wsBVal); } - lastZone = currentZone; - wsValue = wsHstry->getLast(); - wsBVal->value = wsValue / 1000.0; // temp variable to retreive data unit from OBP60Formater - wsBVal->valid = (static_cast(wsValue) != wsHstry->getMinVal()); - String swsValue = formatValue(wsBVal, *commonData).svalue; // value (string) - wsUnit = formatValue(wsBVal, *commonData).unit; // Unit of value - getdisplay().fillRect(xPosTws - 4, yPosTws - 38, 142, 44, commonData->bgcolor); // Clear area for TWS value - getdisplay().setFont(&DSEG7Classic_BoldItalic16pt7b); - getdisplay().setCursor(xPosTws, yPosTws); - getdisplay().print(swsValue); // Value -/* if (!wsBVal->valid) { - getdisplay().print("--.-"); - } else { - wsValue = wsValue / 1000.0 * 1.94384; // Wind speed value in knots - if (wsValue < 10.0) { - getdisplay().printf("!%3.1f", wsValue); // Value, round to 1 decimal - } else { - getdisplay().printf("%4.1f", wsValue); // Value, round to 1 decimal - } - } */ - getdisplay().setFont(&Ubuntu_Bold12pt8b); - getdisplay().setCursor(xPosTws + 82, yPosTws - 14); - getdisplay().print(wsName); // Name - getdisplay().setFont(&Ubuntu_Bold8pt8b); - getdisplay().setCursor(xPosTws + 82, yPosTws + 1); - getdisplay().print(wsUnit); // Unit - - } else { - // No valid data available - LOG_DEBUG(GwLog::LOG, "PageWindPlot: No valid data available"); - getdisplay().setFont(&Ubuntu_Bold10pt8b); - getdisplay().fillRect(xCenter - 33, height / 2 - 20, 66, 24, commonData->bgcolor); // Clear area for message - drawTextCenter(xCenter, height / 2 - 10, "No data"); + } else if (chrtMode == BOTH) { + if (wdChart) { + wdChart->showChrt(VERTICAL, HALF_SIZE_LEFT, dataIntv, PRNT_NAME, PRNT_VALUE, *wdBVal); + } + if (wsChart) { + wsChart->showChrt(VERTICAL, HALF_SIZE_RIGHT, dataIntv, PRNT_NAME, PRNT_VALUE, *wsBVal); + } } - // chart Y axis labels; print at last to overwrite potential chart lines in label area - int yPos; - int chrtLbl; - getdisplay().setFont(&Ubuntu_Bold8pt8b); - for (int i = 1; i <= 3; i++) { - yPos = yOffset + (i * 60); - getdisplay().fillRect(0, yPos, width, 1, commonData->fgcolor); - getdisplay().fillRect(0, yPos - 8, 24, 16, commonData->bgcolor); // Clear small area to remove potential chart lines - getdisplay().setCursor(1, yPos + 4); - if (count >= intvBufSize) { - // Calculate minute value for label - chrtLbl = ((i - 1 + (prevY < yOffset + 30)) * dataIntv) * -1; // change label if last data point is more than 30 lines (= seconds) from chart line - } else { - int j = 3 - i; - chrtLbl = (int((((numWndVals / dataIntv) - 50) * dataIntv / 60) + 1) - (j * dataIntv)) * -1; // 50 lines left below last chart line - } - getdisplay().printf("%3d", chrtLbl); // Wind value label - } - - LOG_DEBUG(GwLog::DEBUG, "PageWindPlot time: %ld", millis() - timer); + // LOG_DEBUG(GwLog::DEBUG, "PageWindPlot: page time %ldms", millis() - pageTime); return PAGE_UPDATE; - }; + } }; static Page* createPage(CommonData& common) @@ -523,7 +262,7 @@ PageDescription registerPageWindPlot( "WindPlot", // Page name createPage, // Action 0, // Number of bus values depends on selection in Web configuration - { "TWD", "AWD" }, // Bus values we need in the page + { "TWD", "TWS", "AWD", "AWS" }, // Bus values we need in the page true // Show display header on/off ); diff --git a/lib/obp60task/PageWindRose.cpp b/lib/obp60task/PageWindRose.cpp index c4ab0e0..427e64b 100644 --- a/lib/obp60task/PageWindRose.cpp +++ b/lib/obp60task/PageWindRose.cpp @@ -2,7 +2,6 @@ #include "Pagedata.h" #include "OBP60Extensions.h" -#include "BoatDataCalibration.h" class PageWindRose : public Page { @@ -52,7 +51,6 @@ public: GwApi::BoatValue *bvalue1 = pageData.values[0]; // First element in list (only one value by PageOneValue) String name1 = xdrDelete(bvalue1->getName()); // Value name name1 = name1.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue1, logger); // Check if boat data value is to be calibrated double value1 = bvalue1->value; // Value as double in SI unit bool valid1 = bvalue1->valid; // Valid information value1 = formatValue(bvalue1, *commonData).value;// Format only nesaccery for simulation data for pointer @@ -67,7 +65,6 @@ public: GwApi::BoatValue *bvalue2 = pageData.values[1]; // Second element in list String name2 = xdrDelete(bvalue2->getName()); // Value name name2 = name2.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue2, logger); // Check if boat data value is to be calibrated double value2 = bvalue2->value; // Value as double in SI unit bool valid2 = bvalue2->valid; // Valid information String svalue2 = formatValue(bvalue2, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -81,7 +78,6 @@ public: GwApi::BoatValue *bvalue3 = pageData.values[2]; // Third element in list String name3 = xdrDelete(bvalue3->getName()); // Value name name3 = name3.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue3, logger); // Check if boat data value is to be calibrated double value3 = bvalue3->value; // Value as double in SI unit bool valid3 = bvalue3->valid; // Valid information String svalue3 = formatValue(bvalue3, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -95,7 +91,6 @@ public: GwApi::BoatValue *bvalue4 = pageData.values[3]; // Fourth element in list String name4 = xdrDelete(bvalue4->getName()); // Value name name4 = name4.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue4, logger); // Check if boat data value is to be calibrated double value4 = bvalue4->value; // Value as double in SI unit bool valid4 = bvalue4->valid; // Valid information String svalue4 = formatValue(bvalue4, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -109,7 +104,6 @@ public: GwApi::BoatValue *bvalue5 = pageData.values[4]; // Fifth element in list String name5 = xdrDelete(bvalue5->getName()); // Value name name5 = name5.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue5, logger); // Check if boat data value is to be calibrated double value5 = bvalue5->value; // Value as double in SI unit bool valid5 = bvalue5->valid; // Valid information String svalue5 = formatValue(bvalue5, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -123,7 +117,6 @@ public: GwApi::BoatValue *bvalue6 = pageData.values[5]; // Sixth element in list String name6 = xdrDelete(bvalue6->getName()); // Value name name6 = name6.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue6, logger); // Check if boat data value is to be calibrated double value6 = bvalue6->value; // Value as double in SI unit bool valid6 = bvalue6->valid; // Valid information String svalue6 = formatValue(bvalue6, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places diff --git a/lib/obp60task/PageWindRoseFlex.cpp b/lib/obp60task/PageWindRoseFlex.cpp index 69ad611..d3526e0 100644 --- a/lib/obp60task/PageWindRoseFlex.cpp +++ b/lib/obp60task/PageWindRoseFlex.cpp @@ -2,13 +2,11 @@ #include "Pagedata.h" #include "OBP60Extensions.h" -#include "BoatDataCalibration.h" class PageWindRoseFlex : public Page { int16_t lp = 80; // Pointer length char source = 'A'; // data source (A)pparent | (T)rue -String ssource="App."; // String for Data Source public: PageWindRoseFlex(CommonData &common){ @@ -26,10 +24,8 @@ public: // Code for set source if(source == 'A'){ source = 'T'; - ssource = "True"; // String to display } else { source = 'A'; - ssource = "App."; // String to display } } return key; // Commit the key @@ -82,7 +78,6 @@ public: } String name1 = bvalue1->getName().c_str(); // Value name name1 = name1.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue1, logger); // Check if boat data value is to be calibrated double value1 = bvalue1->value; // Value as double in SI unit bool valid1 = bvalue1->valid; // Valid information String svalue1 = formatValue(bvalue1, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -100,7 +95,6 @@ public: } String name2 = bvalue2->getName().c_str(); // Value name name2 = name2.substring(0, 6); // String length limit for value name - calibrationData.calibrateInstance(bvalue2, logger); // Check if boat data value is to be calibrated double value2 = bvalue2->value; // Value as double in SI unit bool valid2 = bvalue2->valid; // Valid information if (simulation) { @@ -125,7 +119,6 @@ public: else{ name3font=Ubuntu_Bold12pt8b; } - calibrationData.calibrateInstance(bvalue3, logger); // Check if boat data value is to be calibrated double value3 = bvalue3->value; // Value as double in SI unit bool valid3 = bvalue3->valid; // Valid information String svalue3 = formatValue(bvalue3, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -145,7 +138,6 @@ public: else{ name4font=Ubuntu_Bold12pt8b; } - calibrationData.calibrateInstance(bvalue4, logger); // Check if boat data value is to be calibrated double value4 = bvalue4->value; // Value as double in SI unit bool valid4 = bvalue4->valid; // Valid information String svalue4 = formatValue(bvalue4, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -165,7 +157,6 @@ public: else{ name5font=Ubuntu_Bold12pt8b; } - calibrationData.calibrateInstance(bvalue5, logger); // Check if boat data value is to be calibrated double value5 = bvalue5->value; // Value as double in SI unit bool valid5 = bvalue5->valid; // Valid information String svalue5 = formatValue(bvalue5, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -185,7 +176,6 @@ public: else{ name6font=Ubuntu_Bold8pt8b; } - calibrationData.calibrateInstance(bvalue6, logger); // Check if boat data value is to be calibrated double value6 = bvalue6->value; // Value as double in SI unit bool valid6 = bvalue6->valid; // Valid information String svalue6 = formatValue(bvalue6, *commonData).svalue; // Formatted value as string including unit conversion and switching decimal places @@ -381,12 +371,22 @@ public: } // Center circle - getdisplay().fillCircle(200, 150, startwidth + 6, commonData->bgcolor); - getdisplay().fillCircle(200, 150, startwidth + 4, commonData->fgcolor); + getdisplay().fillCircle(200, 150, startwidth + 8, commonData->bgcolor); + getdisplay().fillCircle(200, 150, startwidth + 6, commonData->fgcolor); + getdisplay().fillCircle(200, 150, startwidth + 4, commonData->bgcolor); + getdisplay().setFont(&Ubuntu_Bold10pt8b); + if (source=='A'){ + getdisplay().setCursor(193, 155); + } + else { + getdisplay().setCursor(195, 156); + } + getdisplay().print({source}); + //******************************************************************************************* - // Show value6 (=fourth user-configured parameter) and ssource, so that they do not collide with the wind pointer + // Show value6 (=fourth user-configured parameter) if ( cos(value1) > 0){ //pointer points upwards getdisplay().setFont(&DSEG7Classic_BoldItalic16pt7b); @@ -401,13 +401,6 @@ if ( cos(value1) > 0){ else{ getdisplay().print(unit6old); // Unit } - if (sin(value1)>0){ - getdisplay().setCursor(160, 130); - } - else{ - getdisplay().setCursor(220, 130); - } - getdisplay().print(ssource); // true or app. } else{ // pointer points downwards @@ -423,13 +416,6 @@ else{ else{ getdisplay().print(unit6old); // Unit } - if (sin(value1)>0){ - getdisplay().setCursor(160, 200); - } - else{ - getdisplay().setCursor(220, 200); - } - getdisplay().print(ssource); //true or app. } return PAGE_UPDATE; diff --git a/lib/obp60task/Pagedata.h b/lib/obp60task/Pagedata.h index 3f56a7c..1cef664 100644 --- a/lib/obp60task/Pagedata.h +++ b/lib/obp60task/Pagedata.h @@ -4,19 +4,20 @@ #include #include #include "LedSpiTask.h" -#include "OBPDataOperations.h" #define MAX_PAGE_NUMBER 10 // Max number of pages for show data typedef std::vector ValueList; +class HstryBuffers; + typedef struct{ GwApi *api; String pageName; uint8_t pageNumber; // page number in sequence of visible pages //the values will always contain the user defined values first ValueList values; - HstryBuf* boatHstry; + HstryBuffers* hstryBuffers; // list of all boat history buffers } PageData; // Sensor data structure (only for extended sensors, not for NMEA bus sensors) @@ -50,7 +51,7 @@ typedef struct{ double rotationAngle = 0; // Rotation angle in radiant bool validRotAngle = false; // Valid flag magnet present for rotation sensor struct tm rtcTime; // UTC time from internal RTC - bool rtcValid = false; + bool rtcValid = false; // Internal RTC chip int sunsetHour = 0; int sunsetMinute = 0; int sunriseHour = 0; @@ -195,10 +196,16 @@ String formatLongitude(double lon); // Structure for formatted boat values typedef struct{ - double value; - String svalue; - String unit; + double value; // SI value of boat data value + double cvalue; // value converted to target unit + String svalue; // value converted to target unit and formatted + String unit; // target value unit } FormattedData; // Formatter for boat values FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata); +FormattedData formatValue(GwApi::BoatValue *value, CommonData &commondata, bool ignoreSimuDataSetting); + +// Helper method for conversion of any data value from SI to user defined format (defined in OBP60Formatter) +double convertValue(const double &value, const String &format, CommonData &commondata); +double convertValue(const double &value, const String &name, const String &format, CommonData &commondata); diff --git a/lib/obp60task/config_obp40.json b/lib/obp60task/config_obp40.json index bd92fb5..a009976 100644 --- a/lib/obp60task/config_obp40.json +++ b/lib/obp60task/config_obp40.json @@ -260,7 +260,7 @@ "label": "Calculate True Wind", "type": "boolean", "default": "false", - "description": "If not available, calculate true wind data from appearant wind and other boat data", + "description": "If not available, calculate true wind data from apparent wind and other boat data", "category": "OBP40 Settings", "capabilities": { "obp40": "true" @@ -708,6 +708,61 @@ "obp40": "true" } }, + { + "name": "mod1Out1", + "label": "Name1", + "type": "string", + "default": "text1", + "description": "Button name", + "category": "OBP60 IO-Modul1", + "capabilities": { + "obp40":"true" + } + }, + { + "name": "mod1Out2", + "label": "Name2", + "type": "string", + "default": "text2", + "description": "Button name", + "category": "OBP60 IO-Modul1", + "capabilities": { + "obp40":"true" + } + }, + { + "name": "mod1Out3", + "label": "Name3", + "type": "string", + "default": "text3", + "description": "Button name", + "category": "OBP60 IO-Modul1", + "capabilities": { + "obp40":"true" + } + }, + { + "name": "mod1Out4", + "label": "Name4", + "type": "string", + "default": "text4", + "description": "Button name", + "category": "OBP60 IO-Modul1", + "capabilities": { + "obp40":"true" + } + }, + { + "name": "mod1Out5", + "label": "Name5", + "type": "string", + "default": "text5", + "description": "Button name", + "category": "OBP60 IO-Modul1", + "capabilities": { + "obp40":"true" + } + }, { "name": "tSensitivity", "label": "Touch Sensitivity [%]", @@ -755,8 +810,10 @@ "AWA", "AWS", "COG", + "DBS", "DBT", "HDM", + "HDT", "PRPOS", "RPOS", "SOG", @@ -782,7 +839,7 @@ "obp40":"true" }, "condition": [ - { "calInstance1": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance1": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -790,13 +847,13 @@ "label": "Data Instance 1 Calibration Slope", "type": "number", "default": "1.00", - "description": "Slope for data instance 1", + "description": "Slope for data instance 1, Default: 1(!)", "category": "OBP40 Calibrations", "capabilities": { "obp40":"true" }, "condition": [ - { "calInstance1": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance1": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -813,7 +870,7 @@ "obp40":"true" }, "condition": [ - { "calInstance1": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance1": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -827,8 +884,10 @@ "AWA", "AWS", "COG", + "DBS", "DBT", "HDM", + "HDT", "PRPOS", "RPOS", "SOG", @@ -854,7 +913,7 @@ "obp40":"true" }, "condition": [ - { "calInstance2": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance2": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -862,13 +921,13 @@ "label": "Data Instance 2 Calibration Slope", "type": "number", "default": "1.00", - "description": "Slope for data instance 2", + "description": "Slope for data instance 2; Default: 1(!)", "category": "OBP40 Calibrations", "capabilities": { "obp40":"true" }, "condition": [ - { "calInstance2": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance2": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -885,7 +944,7 @@ "obp40":"true" }, "condition": [ - { "calInstance2": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance2": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -899,8 +958,10 @@ "AWA", "AWS", "COG", + "DBS", "DBT", "HDM", + "HDT", "PRPOS", "RPOS", "SOG", @@ -926,7 +987,7 @@ "obp40":"true" }, "condition": [ - { "calInstance3": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance3": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -934,13 +995,13 @@ "label": "Data Instance 3 Calibration Slope", "type": "number", "default": "1.00", - "description": "Slope for data instance 3", + "description": "Slope for data instance 3, Default: 1(!)", "category": "OBP40 Calibrations", "capabilities": { "obp40":"true" }, "condition": [ - { "calInstance3": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance3": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -957,9 +1018,222 @@ "obp40":"true" }, "condition": [ - { "calInstance3": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance3": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, + { + "name": "calInstance4", + "label": "Calibration Data Instance 4", + "type": "list", + "default": "---", + "description": "Data instance for calibration", + "list": [ + "---", + "AWA", + "AWS", + "COG", + "DBS", + "DBT", + "HDM", + "HDT", + "PRPOS", + "RPOS", + "SOG", + "STW", + "TWA", + "TWS", + "TWD", + "WTemp" + ], + "category": "OBP40 Calibrations", + "capabilities": { + "obp40": "true" + } + }, + { + "name": "calOffset4", + "label": "Data Instance 4 Calibration Offset", + "type": "number", + "default": "0.00", + "description": "Offset for data instance 4", + "category": "OBP40 Calibrations", + "capabilities": { + "obp40":"true" + }, + "condition": [ + { "calInstance4": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + ] + }, + { + "name": "calSlope4", + "label": "Data Instance 4 Calibration Slope", + "type": "number", + "default": "1.00", + "description": "Slope for data instance 4, Default: 1(!)", + "category": "OBP40 Calibrations", + "capabilities": { + "obp40":"true" + }, + "condition": [ + { "calInstance4": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + ] + }, + { + "name": "calSmooth4", + "label": "Data Instance 4 Smoothing", + "type": "number", + "default": "0", + "check": "checkMinMax", + "min": 0, + "max": 10, + "description": "Smoothing factor [0..10]; 0 = no smoothing", + "category": "OBP40 Calibrations", + "capabilities": { + "obp40":"true" + }, + "condition": [ + { "calInstance4": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + ] + }, + { + "name": "mapsource", + "label": "Map Source", + "type": "list", + "default": "OBP Service", + "description": "Type of map source, cloud service or local service", + "list": [ + "OBP Service", + "Local Service" + ], + "category": "OBP40 Navigation", + "capabilities": { + "obp40":"true" + } + }, + { + "name": "ipAddress", + "label": "IP Address", + "type": "string", + "default": "192.168.15.10", + "check": "checkIpAddress", + "description": "IP address for local map service e.g. 192.168.15.10\nor an MDNS name like Raspi.local", + "category": "OBP40 Navigation", + "capabilities": { + "obp40":"true" + }, + "condition": [ + { "mapsource": ["Local Service"] } + ] + }, + { + "name": "localPort", + "label": "Port", + "type": "number", + "default": "8080", + "check":"checkPort", + "description": "TCP port for local map server", + "category": "OBP40 Navigation", + "capabilities": { + "obp40":"true" + }, + "condition": [ + { "mapsource": ["Local Service"] } + ] + }, + { + "name": "maptype", + "label": "Map Type", + "type": "list", + "default": "Open Street Map", + "description": "Type of base navigation map with sea marks overlay", + "list": [ + "Open Street Map", + "Google Street", + "Open Topo Map", + "Stadimaps Toner", + "Free Nautical Chart" + ], + "category": "OBP40 Navigation", + "capabilities": { + "obp40":"true" + } + }, + { + "name": "refreshDistance", + "label": "Refresh Distance [m]", + "type": "number", + "default": "15", + "check": "checkMinMax", + "min": 1, + "max": 50, + "description": "Refresh distance between updates [1..50 m], 15 m = default", + "category": "OBP40 Navigation", + "capabilities": { + "obp40":"true" + } + }, + { + "name": "zoomlevel", + "label": "Default Zoom Level", + "type": "number", + "default": "15", + "check": "checkMinMax", + "min": 7, + "max": 17, + "description": "Start zoom level for map [7..17]; 15 = default", + "category": "OBP40 Navigation", + "capabilities": { + "obp40":"true" + } + }, + { + "name": "orientation", + "label": "Map Orientation", + "type": "list", + "default": "North Dirirection", + "description": "Map orientation for navigation", + "list": [ + "North Direction", + "Travel Direction" + ], + "category": "OBP40 Navigation", + "capabilities": { + "obp40":"true" + } + }, + { + "name": "grid", + "label": "Show Grid", + "type": "boolean", + "default": "false", + "description": "Show the grid for latutude and longitude", + "category": "OBP40 Navigation", + "capabilities": { + "obp40": "true" + } + }, + { + "name": "showvalues", + "label": "Show Values", + "type": "boolean", + "default": "false", + "description": "Show boat data values in the left upper map corner", + "category": "OBP40 Navigation", + "capabilities": { + "obp40": "true" + } + }, + { + "name": "ownheading", + "label": "Alternativ Heading", + "type": "boolean", + "default": "false", + "description": "Calculating an alternative travel direction for\na better and calmer map orientation", + "category": "OBP40 Navigation", + "capabilities": { + "obp40": "true" + } + }, { "name": "display", "label": "Display Mode", @@ -1127,9 +1401,9 @@ "type": "number", "default": "50", "check": "checkMinMax", - "min": 20, + "min": 5, "max": 100, - "description": "Backlight brightness [20...100%]", + "description": "Backlight brightness [5...100%]", "category": "OBP40 Display", "capabilities": { "obp40": "false" @@ -1285,12 +1559,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -1579,7 +1855,7 @@ "description": "Wind source for page 1: [true|apparent]", "list": [ "True wind", - "Apparant wind" + "Apparent wind" ], "category": "OBP40 Page 1", "capabilities": { @@ -1614,12 +1890,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -1900,7 +2178,7 @@ "description": "Wind source for page 2: [true|apparent]", "list": [ "True wind", - "Apparant wind" + "Apparent wind" ], "category": "OBP40 Page 2", "capabilities": { @@ -1934,12 +2212,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -2212,7 +2492,7 @@ "description": "Wind source for page 3: [true|apparent]", "list": [ "True wind", - "Apparant wind" + "Apparent wind" ], "category": "OBP40 Page 3", "capabilities": { @@ -2245,12 +2525,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -2515,7 +2797,7 @@ "description": "Wind source for page 4: [true|apparent]", "list": [ "True wind", - "Apparant wind" + "Apparent wind" ], "category": "OBP40 Page 4", "capabilities": { @@ -2547,12 +2829,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -2809,7 +3093,7 @@ "description": "Wind source for page 5: [true|apparent]", "list": [ "True wind", - "Apparant wind" + "Apparent wind" ], "category": "OBP40 Page 5", "capabilities": { @@ -2840,12 +3124,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -3094,7 +3380,7 @@ "description": "Wind source for page 6: [true|apparent]", "list": [ "True wind", - "Apparant wind" + "Apparent wind" ], "category": "OBP40 Page 6", "capabilities": { @@ -3124,12 +3410,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -3370,7 +3658,7 @@ "description": "Wind source for page 7: [true|apparent]", "list": [ "True wind", - "Apparant wind" + "Apparent wind" ], "category": "OBP40 Page 7", "capabilities": { @@ -3399,12 +3687,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -3637,7 +3927,7 @@ "description": "Wind source for page 8: [true|apparent]", "list": [ "True wind", - "Apparant wind" + "Apparent wind" ], "category": "OBP40 Page 8", "capabilities": { @@ -3665,12 +3955,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -3895,7 +4187,7 @@ "description": "Wind source for page 9: [true|apparent]", "list": [ "True wind", - "Apparant wind" + "Apparent wind" ], "category": "OBP40 Page 9", "capabilities": { @@ -3922,12 +4214,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -4144,7 +4438,7 @@ "description": "Wind source for page 10: [true|apparent]", "list": [ "True wind", - "Apparant wind" + "Apparent wind" ], "category": "OBP40 Page 10", "capabilities": { diff --git a/lib/obp60task/config.json b/lib/obp60task/config_obp60.json similarity index 90% rename from lib/obp60task/config.json rename to lib/obp60task/config_obp60.json index 5534391..f447a89 100644 --- a/lib/obp60task/config.json +++ b/lib/obp60task/config_obp60.json @@ -59,7 +59,7 @@ "name": "homeLAT", "label": "Home latitude", "type": "number", - "default": "", + "default": "0.00000", "check": "checkMinMax", "min": -90.0, "max": 90.0, @@ -73,7 +73,7 @@ "name": "homeLON", "label": "Home longitude", "type": "number", - "default": "", + "default": "0.00000", "check": "checkMinMax", "min": -180.0, "max": 180.0, @@ -260,7 +260,7 @@ "label": "Calculate True Wind", "type": "boolean", "default": "false", - "description": "If not available, calculate true wind data from appearant wind and other boat data", + "description": "If not available, calculate true wind data from apparent wind and other boat data", "category": "OBP60 Settings", "capabilities": { "obp60": "true" @@ -697,6 +697,61 @@ "obp60":"true" } }, + { + "name": "mod1Out1", + "label": "Name1", + "type": "string", + "default": "text1", + "description": "Button name", + "category": "OBP60 IO-Modul1", + "capabilities": { + "obp60":"true" + } + }, + { + "name": "mod1Out2", + "label": "Name2", + "type": "string", + "default": "text2", + "description": "Button name", + "category": "OBP60 IO-Modul1", + "capabilities": { + "obp60":"true" + } + }, + { + "name": "mod1Out3", + "label": "Name3", + "type": "string", + "default": "text3", + "description": "Button name", + "category": "OBP60 IO-Modul1", + "capabilities": { + "obp60":"true" + } + }, + { + "name": "mod1Out4", + "label": "Name4", + "type": "string", + "default": "text4", + "description": "Button name", + "category": "OBP60 IO-Modul1", + "capabilities": { + "obp60":"true" + } + }, + { + "name": "mod1Out5", + "label": "Name5", + "type": "string", + "default": "text5", + "description": "Button name", + "category": "OBP60 IO-Modul1", + "capabilities": { + "obp60":"true" + } + }, { "name": "tSensitivity", "label": "Touch Sensitivity [%]", @@ -744,8 +799,10 @@ "AWA", "AWS", "COG", + "DBS", "DBT", "HDM", + "HDT", "PRPOS", "RPOS", "SOG", @@ -771,7 +828,7 @@ "obp60":"true" }, "condition": [ - { "calInstance1": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance1": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -779,13 +836,13 @@ "label": "Data Instance 1 Calibration Slope", "type": "number", "default": "1.00", - "description": "Slope for data instance 1", + "description": "Slope for data instance 1; Default: 1(!)", "category": "OBP60 Calibrations", "capabilities": { "obp60":"true" }, "condition": [ - { "calInstance1": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance1": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -802,7 +859,7 @@ "obp60":"true" }, "condition": [ - { "calInstance1": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance1": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -816,8 +873,10 @@ "AWA", "AWS", "COG", + "DBS", "DBT", "HDM", + "HDT", "PRPOS", "RPOS", "SOG", @@ -843,7 +902,7 @@ "obp60":"true" }, "condition": [ - { "calInstance2": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance2": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -851,13 +910,13 @@ "label": "Data Instance 2 Calibration Slope", "type": "number", "default": "1.00", - "description": "Slope for data instance 2", + "description": "Slope for data instance 2; Default: 1(!)", "category": "OBP60 Calibrations", "capabilities": { "obp60":"true" }, "condition": [ - { "calInstance2": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance2": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -874,7 +933,7 @@ "obp60":"true" }, "condition": [ - { "calInstance2": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance2": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -888,8 +947,10 @@ "AWA", "AWS", "COG", + "DBS", "DBT", "HDM", + "HDT", "PRPOS", "RPOS", "SOG", @@ -915,7 +976,7 @@ "obp60":"true" }, "condition": [ - { "calInstance3": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance3": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -923,13 +984,13 @@ "label": "Data Instance 3 Calibration Slope", "type": "number", "default": "1.00", - "description": "Slope for data instance 3", + "description": "Slope for data instance 3; Default: 1(!)", "category": "OBP60 Calibrations", "capabilities": { "obp60":"true" }, "condition": [ - { "calInstance3": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance3": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, { @@ -946,9 +1007,222 @@ "obp60":"true" }, "condition": [ - { "calInstance3": ["AWA", "AWS", "COG", "DBT", "HDM", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + { "calInstance3": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } ] }, + { + "name": "calInstance4", + "label": "Calibration Data Instance 4", + "type": "list", + "default": "---", + "description": "Data instance for calibration", + "list": [ + "---", + "AWA", + "AWS", + "COG", + "DBS", + "DBT", + "HDM", + "HDT", + "PRPOS", + "RPOS", + "SOG", + "STW", + "TWA", + "TWS", + "TWD", + "WTemp" + ], + "category": "OBP60 Calibrations", + "capabilities": { + "obp60":"true" + } + }, + { + "name": "calOffset4", + "label": "Data Instance 4 Calibration Offset", + "type": "number", + "default": "0.00", + "description": "Offset for data instance 4", + "category": "OBP60 Calibrations", + "capabilities": { + "obp60":"true" + }, + "condition": [ + { "calInstance4": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + ] + }, + { + "name": "calSlope4", + "label": "Data Instance 4 Calibration Slope", + "type": "number", + "default": "1.00", + "description": "Slope for data instance 3; Default: 1(!)", + "category": "OBP60 Calibrations", + "capabilities": { + "obp60":"true" + }, + "condition": [ + { "calInstance4": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + ] + }, + { + "name": "calSmooth4", + "label": "Data Instance 4 Smoothing", + "type": "number", + "default": "0", + "check": "checkMinMax", + "min": 0, + "max": 10, + "description": "Smoothing factor [0..10]; 0 = no smoothing", + "category": "OBP60 Calibrations", + "capabilities": { + "obp60":"true" + }, + "condition": [ + { "calInstance4": ["AWA", "AWS", "COG", "DBS", "DBT", "HDM", "HDT", "PRPOS", "RPOS", "SOG", "STW", "TWA", "TWS", "TWD", "WTemp" ] } + ] + }, + { + "name": "mapsource", + "label": "Map Source", + "type": "list", + "default": "OBP Service", + "description": "Type of map source, cloud service or local service", + "list": [ + "OBP Service", + "Local Service" + ], + "category": "OBP60 Navigation", + "capabilities": { + "obp60":"true" + } + }, + { + "name": "ipAddress", + "label": "IP Address", + "type": "string", + "default": "192.168.15.10", + "check": "checkIpAddress", + "description": "IP address for local map service e.g. 192.168.15.10\nor an MDNS name like Raspi.local", + "category": "OBP60 Navigation", + "capabilities": { + "obp60":"true" + }, + "condition": [ + { "mapsource": ["Local Service"] } + ] + }, + { + "name": "localPort", + "label": "Port", + "type": "number", + "default": "8080", + "check":"checkPort", + "description": "TCP port for local map server", + "category": "OBP60 Navigation", + "capabilities": { + "obp60":"true" + }, + "condition": [ + { "mapsource": ["Local Service"] } + ] + }, + { + "name": "maptype", + "label": "Map Type", + "type": "list", + "default": "Open Street Map", + "description": "Type of base navigation map with sea marks overlay", + "list": [ + "Open Street Map", + "Google Street", + "Open Topo Map", + "Stadimaps Toner", + "Free Nautical Chart" + ], + "category": "OBP60 Navigation", + "capabilities": { + "obp60":"true" + } + }, + { + "name": "refreshDistance", + "label": "Refresh Distance [m]", + "type": "number", + "default": "15", + "check": "checkMinMax", + "min": 1, + "max": 50, + "description": "Refresh distance between updates [1..50 m], 15 m = default", + "category": "OBP60 Navigation", + "capabilities": { + "obp60":"true" + } + }, + { + "name": "zoomlevel", + "label": "Default Zoom Level", + "type": "number", + "default": "15", + "check": "checkMinMax", + "min": 7, + "max": 17, + "description": "Start zoom level for map [7..17]; 15 = default", + "category": "OBP60 Navigation", + "capabilities": { + "obp60":"true" + } + }, + { + "name": "orientation", + "label": "Map Orientation", + "type": "list", + "default": "North Dirirection", + "description": "Map orientation for navigation", + "list": [ + "North Direction", + "Travel Direction" + ], + "category": "OBP60 Navigation", + "capabilities": { + "obp60":"true" + } + }, + { + "name": "grid", + "label": "Show Grid", + "type": "boolean", + "default": "false", + "description": "Show the grid for latutude and longitude", + "category": "OBP60 Navigation", + "capabilities": { + "obp60": "true" + } + }, + { + "name": "showvalues", + "label": "Show Values", + "type": "boolean", + "default": "false", + "description": "Show boat data values in the left upper map corner", + "category": "OBP60 Navigation", + "capabilities": { + "obp60": "true" + } + }, + { + "name": "ownheading", + "label": "Alternativ Heading", + "type": "boolean", + "default": "false", + "description": "Calculating an alternative travel direction for\na better and calmer map orientation", + "category": "OBP60 Navigation", + "capabilities": { + "obp60": "true" + } + }, { "name": "display", "label": "Display Mode", @@ -1115,9 +1389,9 @@ "type": "number", "default": "50", "check": "checkMinMax", - "min": 20, + "min": 5, "max": 100, - "description": "Backlight brightness [20...100%]", + "description": "Backlight brightness [5...100%]", "category": "OBP60 Display", "capabilities": { "obp60":"true" @@ -1261,12 +1535,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -1560,12 +1836,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -1851,12 +2129,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -2134,12 +2414,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -2409,12 +2691,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -2676,12 +2960,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -2935,12 +3221,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -3186,12 +3474,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -3429,12 +3719,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", @@ -3664,12 +3956,14 @@ "Battery2", "Clock", "Compass", + "DigitalOut", "DST810", "Fluid", "FourValues", "FourValues2", "Generator", "KeelPosition", + "Navigation", "OneValue", "RollPitch", "RudderPosition", diff --git a/lib/obp60task/extra_task.py b/lib/obp60task/extra_task.py index 28e9980..66ee3b1 100644 --- a/lib/obp60task/extra_task.py +++ b/lib/obp60task/extra_task.py @@ -1,12 +1,21 @@ # PlatformIO extra script for obp60task +import subprocess + +patching = False + epdtype = "unknown" pcbvers = "unknown" for x in env["BUILD_FLAGS"]: - if x.startswith("-D HARDWARE_"): + if not x.startswith('-D'): + continue + opt = x[2:].strip() + if opt.startswith("HARDWARE_"): pcbvers = x.split('_')[1] - if x.startswith("-D DISPLAY_"): + elif opt.startswith("DISPLAY_"): epdtype = x.split('_')[1] + elif opt == 'ENABLE_PATCHES': + patching = True propfilename = os.path.join(env["PROJECT_LIBDEPS_DIR"], env["PIOENV"], "GxEPD2/library.properties") properties = {} @@ -28,3 +37,20 @@ except: env["CPPDEFINES"].extend([("BOARD", env["BOARD"]), ("EPDTYPE", epdtype), ("PCBVERS", pcbvers), ("GXEPD2VERS", gxepd2vers)]) print("added hardware info to CPPDEFINES") + +if patching: + # apply patches to gateway code + print("applying gateway patches") + patchdir = os.path.join(os.path.dirname(script), "patches") + if not os.path.isdir(patchdir): + print("patchdir not found, no patches applied") + else: + patchfiles = [f for f in os.listdir(patchdir)] + for p in patchfiles: + patch = os.path.join(patchdir, p) + print(f"applying {patch}") + res = subprocess.run(["git", "apply", patch], capture_output=True, text=True) + if res.returncode != 0: + print(res.stderr) + else: + print("no patches found") diff --git a/lib/obp60task/gen_set.py b/lib/obp60task/gen_set.py index 9d1b0ff..97ca0cf 100755 --- a/lib/obp60task/gen_set.py +++ b/lib/obp60task/gen_set.py @@ -157,7 +157,7 @@ def create_json(device, no_of_pages, pagedata): "description": f"Wind source for page {page_no}: [true|apparent]", "list": [ "True wind", - "Apparant wind" + "Apparent wind" ], "category": category, "capabilities": capabilities, diff --git a/lib/obp60task/obp60task.cpp b/lib/obp60task/obp60task.cpp index f6d1695..d9d601d 100644 --- a/lib/obp60task/obp60task.cpp +++ b/lib/obp60task/obp60task.cpp @@ -12,7 +12,6 @@ #include // GxEPD2 lib for b/w E-Ink displays #include "OBP60Extensions.h" // Functions lib for extension board #include "OBP60Keypad.h" // Functions for keypad -#include "BoatDataCalibration.h" // Functions lib for data instance calibration #include "OBPDataOperations.h" // Functions lib for data operations such as true wind calculation #ifdef BOARD_OBP40S3 @@ -147,7 +146,6 @@ void keyboardTask(void *param){ vTaskDelete(NULL); } -// Scorgan: moved class declaration to header file to make class available to other functions // --- Class BoatValueList -------------- bool BoatValueList::addValueToList(GwApi::BoatValue *v){ for (int i=0;igetLogger(); GwConfigHandler *config=api->getConfig(); -#ifdef HARDWARE_V21 +#if defined HARDWARE_V20 || HARDWARE_V21 startLedTask(api); #endif PageList allPages; @@ -339,7 +343,7 @@ void OBP60Task(GwApi *api){ commonData.logger=logger; commonData.config=config; -#ifdef HARDWARE_V21 +#if defined HARDWARE_V20 || HARDWARE_V21 // Keyboard coordinates for page footer initKeys(commonData); #endif @@ -430,13 +434,12 @@ void OBP60Task(GwApi *api){ #endif LOG_DEBUG(GwLog::LOG,"...done"); - int lastPage=pageNumber; + int lastPage=-1; // initialize with an impiossible value, so we can detect wether we are during startup and no page has been displayed yet BoatValueList boatValues; //all the boat values for the api query - HstryBuf hstryBufList(1920); // Create ring buffers for history storage of some boat data (1920 seconds = 32 minutes) - WindUtils trueWind(&boatValues); // Create helper object for true wind calculation - //commonData.distanceformat=config->getString(xxx); - //add all necessary data to common data + HstryBuffers hstryBufferList(1920, &boatValues, logger); // Create empty list of boat data history buffers (1.920 values = seconds = 32 min.) + WindUtils trueWind(&boatValues, logger); // Create helper object for true wind calculation + CalibrationData calibrationDataList(logger); // all boat data types which are supposed to be calibrated //fill the page data from config numPages=config->getInt(config->visiblePages,1); @@ -477,21 +480,26 @@ void OBP60Task(GwApi *api){ LOG_DEBUG(GwLog::DEBUG,"added fixed value %s to page %d",value->getName().c_str(),i); pages[i].parameters.values.push_back(value); } - // Add boat history data to page parameters - pages[i].parameters.boatHstry = &hstryBufList; + + // Read the specified boat data types of relevant pages and create a history buffer for each type + if (pages[i].parameters.pageName == "OneValue" || pages[i].parameters.pageName == "TwoValues" || pages[i].parameters.pageName == "WindPlot") { + for (auto pVal : pages[i].parameters.values) { + hstryBufferList.addBuffer(pVal->getName()); + } + } + // Add list of history buffers to page parameters + pages[i].parameters.hstryBuffers = &hstryBufferList; + } + // add out of band system page (always available) Page *syspage = allPages.pages[0]->creator(commonData); - // Read all calibration data settings from config - calibrationData.readConfig(config, logger); - - // Check user settings for true wind calculation + // Read user settings from config file bool calcTrueWnds = api->getConfig()->getBool(api->getConfig()->calcTrueWnds, false); bool useSimuData = api->getConfig()->getBool(api->getConfig()->useSimuData, false); - - // Initialize history buffer for certain boat data - hstryBufList.init(&boatValues, logger); + // Read user calibration data settings from config file + calibrationDataList.readConfig(config); // Display screenshot handler for HTTP request // http://192.168.15.1/api/user/OBP60Task/screenshot @@ -523,7 +531,7 @@ void OBP60Task(GwApi *api){ commonData.backlight.mode = backlightMapping(config->getConfigItem(config->backlight,true)->asString()); commonData.backlight.color = colorMapping(config->getConfigItem(config->blColor,true)->asString()); - commonData.backlight.brightness = 2.55 * uint(config->getConfigItem(config->blBrightness,true)->asInt()); + commonData.backlight.brightness = uint(config->getConfigItem(config->blBrightness,true)->asInt()); commonData.powermode = api->getConfig()->getConfigItem(api->getConfig()->powerMode,true)->asString(); bool uvoltage = config->getConfigItem(config->underVoltage, true)->asBoolean(); @@ -650,7 +658,7 @@ void OBP60Task(GwApi *api){ // if(String(backlight) == "Control by Key"){ if(keyboardMessage == 6){ LOG_DEBUG(GwLog::LOG,"Toggle Backlight LED"); - toggleBacklightLED(commonData.backlight.brightness, commonData.backlight.color); + stepsBacklightLED(commonData.backlight.brightness, commonData.backlight.color); } } #ifdef BOARD_OBP40S3 @@ -806,10 +814,10 @@ void OBP60Task(GwApi *api){ api->getStatus(commonData.status); if (calcTrueWnds) { - trueWind.addTrueWind(api, &boatValues, logger); + trueWind.addWinds(); // calculate true wind data from apparent wind values } - // Handle history buffers for TWD, TWS for wind plot page and other usage - hstryBufList.handleHstryBuf(useSimuData); + calibrationDataList.handleCalibration(&boatValues); // Process calibration for all boat data in + hstryBufferList.handleHstryBufs(useSimuData, commonData); // Handle history buffers for certain boat data for windplot page and other usage // Clear display // getdisplay().fillRect(0, 0, getdisplay().width(), getdisplay().height(), commonData.bgcolor); @@ -846,8 +854,10 @@ void OBP60Task(GwApi *api){ } else{ if (lastPage != pageNumber){ - pages[lastPage].page->leavePage(pages[lastPage].parameters); // call page cleanup code - if (hasFRAM) fram.write(FRAM_PAGE_NO, pageNumber); // remember new page for device restart + if (lastPage != -1){ // skip cleanup if we are during startup, and no page has been displayed yet. + pages[lastPage].page->leavePage(pages[lastPage].parameters); // call page cleanup code + if (hasFRAM) fram.write(FRAM_PAGE_NO, pageNumber); // remember new page for device restart + } currentPage->setupKeys(); currentPage->displayNew(pages[pageNumber].parameters); lastPage = pageNumber; diff --git a/lib/obp60task/platformio.ini b/lib/obp60task/platformio.ini index 7b8e2e1..dc510f2 100644 --- a/lib/obp60task/platformio.ini +++ b/lib/obp60task/platformio.ini @@ -16,12 +16,16 @@ board_build.variants_dir = variants board = obp60_s3_n16r8 #ESP32-S3 N16R8, 16MB flash, 8MB PSRAM, production series #board_build.partitions = default_8MB.csv #ESP32-S3 N8, 8MB flash board_build.partitions = default_16MB.csv #ESP32-S3 N16, 16MB flash +custom_config = lib/obp60task/config_obp60.json +custom_script = lib/obp60task/extra_task.py framework = arduino lib_deps = ${basedeps.lib_deps} Wire SPI ESP32time + HTTPClient + WiFiClientSecure esphome/AsyncTCP-esphome@2.0.1 robtillaart/PCF8574@0.3.9 adafruit/Adafruit Unified Sensor @ 1.1.13 @@ -56,6 +60,7 @@ build_flags= # -D DISPLAY_GYE042A87 #alternativ E-Ink display from Genyo Optical, R10 2.2 ohm - medium # -D DISPLAY_SE0420NQ04 #alternativ E-Ink display from SID Technology, R10 2.2 ohm - bad (burn in effects) # -D DISPLAY_ZJY400300-042CAAMFGN #alternativ E-Ink display from ZZE Technology, R10 2.2 ohm - very good +# -D ENABLE_PATCHES #enable patching of gateway code ${env.build_flags} #CONFIG_ESP_TASK_WDT_TIMEOUT_S = 10 #Task Watchdog timeout period (seconds) [1...60] 5 default upload_port = /dev/ttyACM0 #OBP60 download via USB-C direct @@ -68,7 +73,8 @@ platform = espressif32@6.8.1 board_build.variants_dir = variants board = obp40_s3_n8r8 #ESP32-S3 N8R8, 8MB flash, 8MB PSRAM, OBP60 clone (CrowPanel 4.2) board_build.partitions = default_8MB.csv #ESP32-S3 N8, 8MB flash -custom_config = config_obp40.json +custom_config = lib/obp60task/config_obp40.json +custom_script = lib/obp60task/extra_task.py framework = arduino lib_deps = ${basedeps.lib_deps} @@ -76,6 +82,8 @@ lib_deps = SPI SD ESP32time + HTTPClient + WiFiClientSecure esphome/AsyncTCP-esphome@2.0.1 robtillaart/PCF8574@0.3.9 adafruit/Adafruit Unified Sensor @ 1.1.13 @@ -103,8 +111,9 @@ build_flags= -D HARDWARE_V10 #OBP40 hardware revision V1.0 SKU:DIE07300S V1.1 (CrowPanel 4.2) -D DISPLAY_GDEY042T81 #new E-Ink display from Good Display (Waveshare), R10 2.2 ohm - good (contast lost by shunshine) #-D DISPLAY_ZJY400300-042CAAMFGN #alternativ E-Ink display from ZZE Technology, R10 2.2 ohm - very good - #-D LIPO_ACCU_1200 #Hardware extension, LiPo accu 3,7V 1200mAh - #-D VOLTAGE_SENSOR #Hardware extension, LiPo voltage sensor with two resistors + -D LIPO_ACCU_1200 #Hardware extension, LiPo accu 3,7V 1200mAh + -D VOLTAGE_SENSOR #Hardware extension, LiPo voltage sensor with two resistors + #-D ENABLE_PATCHES #enable patching of gateway code ${env.build_flags} upload_port = /dev/ttyUSB0 #OBP40 download via external USB/Serail converter upload_protocol = esptool #firmware upload via USB OTG seriell, by first upload need to set the ESP32-S3 in the upload mode with shortcut GND to Pin27 diff --git a/lib/obp60task/puff.c b/lib/obp60task/puff.c new file mode 100644 index 0000000..d759825 --- /dev/null +++ b/lib/obp60task/puff.c @@ -0,0 +1,840 @@ +/* + * puff.c + * Copyright (C) 2002-2013 Mark Adler + * For conditions of distribution and use, see copyright notice in puff.h + * version 2.3, 21 Jan 2013 + * + * puff.c is a simple inflate written to be an unambiguous way to specify the + * deflate format. It is not written for speed but rather simplicity. As a + * side benefit, this code might actually be useful when small code is more + * important than speed, such as bootstrap applications. For typical deflate + * data, zlib's inflate() is about four times as fast as puff(). zlib's + * inflate compiles to around 20K on my machine, whereas puff.c compiles to + * around 4K on my machine (a PowerPC using GNU cc). If the faster decode() + * function here is used, then puff() is only twice as slow as zlib's + * inflate(). + * + * All dynamically allocated memory comes from the stack. The stack required + * is less than 2K bytes. This code is compatible with 16-bit int's and + * assumes that long's are at least 32 bits. puff.c uses the short data type, + * assumed to be 16 bits, for arrays in order to conserve memory. The code + * works whether integers are stored big endian or little endian. + * + * In the comments below are "Format notes" that describe the inflate process + * and document some of the less obvious aspects of the format. This source + * code is meant to supplement RFC 1951, which formally describes the deflate + * format: + * + * http://www.zlib.org/rfc-deflate.html + */ + +/* + * Change history: + * + * 1.0 10 Feb 2002 - First version + * 1.1 17 Feb 2002 - Clarifications of some comments and notes + * - Update puff() dest and source pointers on negative + * errors to facilitate debugging deflators + * - Remove longest from struct huffman -- not needed + * - Simplify offs[] index in construct() + * - Add input size and checking, using longjmp() to + * maintain easy readability + * - Use short data type for large arrays + * - Use pointers instead of long to specify source and + * destination sizes to avoid arbitrary 4 GB limits + * 1.2 17 Mar 2002 - Add faster version of decode(), doubles speed (!), + * but leave simple version for readability + * - Make sure invalid distances detected if pointers + * are 16 bits + * - Fix fixed codes table error + * - Provide a scanning mode for determining size of + * uncompressed data + * 1.3 20 Mar 2002 - Go back to lengths for puff() parameters [Gailly] + * - Add a puff.h file for the interface + * - Add braces in puff() for else do [Gailly] + * - Use indexes instead of pointers for readability + * 1.4 31 Mar 2002 - Simplify construct() code set check + * - Fix some comments + * - Add FIXLCODES #define + * 1.5 6 Apr 2002 - Minor comment fixes + * 1.6 7 Aug 2002 - Minor format changes + * 1.7 3 Mar 2003 - Added test code for distribution + * - Added zlib-like license + * 1.8 9 Jan 2004 - Added some comments on no distance codes case + * 1.9 21 Feb 2008 - Fix bug on 16-bit integer architectures [Pohland] + * - Catch missing end-of-block symbol error + * 2.0 25 Jul 2008 - Add #define to permit distance too far back + * - Add option in TEST code for puff to write the data + * - Add option in TEST code to skip input bytes + * - Allow TEST code to read from piped stdin + * 2.1 4 Apr 2010 - Avoid variable initialization for happier compilers + * - Avoid unsigned comparisons for even happier compilers + * 2.2 25 Apr 2010 - Fix bug in variable initializations [Oberhumer] + * - Add const where appropriate [Oberhumer] + * - Split if's and ?'s for coverage testing + * - Break out test code to separate file + * - Move NIL to puff.h + * - Allow incomplete code only if single code length is 1 + * - Add full code coverage test to Makefile + * 2.3 21 Jan 2013 - Check for invalid code length codes in dynamic blocks + */ + +#include /* for setjmp(), longjmp(), and jmp_buf */ +#include "puff.h" /* prototype for puff() */ + +#define local static /* for local function definitions */ + +/* + * Maximums for allocations and loops. It is not useful to change these -- + * they are fixed by the deflate format. + */ +#define MAXBITS 15 /* maximum bits in a code */ +#define MAXLCODES 286 /* maximum number of literal/length codes */ +#define MAXDCODES 30 /* maximum number of distance codes */ +#define MAXCODES (MAXLCODES+MAXDCODES) /* maximum codes lengths to read */ +#define FIXLCODES 288 /* number of fixed literal/length codes */ + +/* input and output state */ +struct state { + /* output state */ + unsigned char *out; /* output buffer */ + unsigned long outlen; /* available space at out */ + unsigned long outcnt; /* bytes written to out so far */ + + /* input state */ + const unsigned char *in; /* input buffer */ + unsigned long inlen; /* available input at in */ + unsigned long incnt; /* bytes read so far */ + int bitbuf; /* bit buffer */ + int bitcnt; /* number of bits in bit buffer */ + + /* input limit error return state for bits() and decode() */ + jmp_buf env; +}; + +/* + * Return need bits from the input stream. This always leaves less than + * eight bits in the buffer. bits() works properly for need == 0. + * + * Format notes: + * + * - Bits are stored in bytes from the least significant bit to the most + * significant bit. Therefore bits are dropped from the bottom of the bit + * buffer, using shift right, and new bytes are appended to the top of the + * bit buffer, using shift left. + */ +local int bits(struct state *s, int need) +{ + long val; /* bit accumulator (can use up to 20 bits) */ + + /* load at least need bits into val */ + val = s->bitbuf; + while (s->bitcnt < need) { + if (s->incnt == s->inlen) + longjmp(s->env, 1); /* out of input */ + val |= (long)(s->in[s->incnt++]) << s->bitcnt; /* load eight bits */ + s->bitcnt += 8; + } + + /* drop need bits and update buffer, always zero to seven bits left */ + s->bitbuf = (int)(val >> need); + s->bitcnt -= need; + + /* return need bits, zeroing the bits above that */ + return (int)(val & ((1L << need) - 1)); +} + +/* + * Process a stored block. + * + * Format notes: + * + * - After the two-bit stored block type (00), the stored block length and + * stored bytes are byte-aligned for fast copying. Therefore any leftover + * bits in the byte that has the last bit of the type, as many as seven, are + * discarded. The value of the discarded bits are not defined and should not + * be checked against any expectation. + * + * - The second inverted copy of the stored block length does not have to be + * checked, but it's probably a good idea to do so anyway. + * + * - A stored block can have zero length. This is sometimes used to byte-align + * subsets of the compressed data for random access or partial recovery. + */ +local int stored(struct state *s) +{ + unsigned len; /* length of stored block */ + + /* discard leftover bits from current byte (assumes s->bitcnt < 8) */ + s->bitbuf = 0; + s->bitcnt = 0; + + /* get length and check against its one's complement */ + if (s->incnt + 4 > s->inlen) + return 2; /* not enough input */ + len = s->in[s->incnt++]; + len |= s->in[s->incnt++] << 8; + if (s->in[s->incnt++] != (~len & 0xff) || + s->in[s->incnt++] != ((~len >> 8) & 0xff)) + return -2; /* didn't match complement! */ + + /* copy len bytes from in to out */ + if (s->incnt + len > s->inlen) + return 2; /* not enough input */ + if (s->out != NIL) { + if (s->outcnt + len > s->outlen) + return 1; /* not enough output space */ + while (len--) + s->out[s->outcnt++] = s->in[s->incnt++]; + } + else { /* just scanning */ + s->outcnt += len; + s->incnt += len; + } + + /* done with a valid stored block */ + return 0; +} + +/* + * Huffman code decoding tables. count[1..MAXBITS] is the number of symbols of + * each length, which for a canonical code are stepped through in order. + * symbol[] are the symbol values in canonical order, where the number of + * entries is the sum of the counts in count[]. The decoding process can be + * seen in the function decode() below. + */ +struct huffman { + short *count; /* number of symbols of each length */ + short *symbol; /* canonically ordered symbols */ +}; + +/* + * Decode a code from the stream s using huffman table h. Return the symbol or + * a negative value if there is an error. If all of the lengths are zero, i.e. + * an empty code, or if the code is incomplete and an invalid code is received, + * then -10 is returned after reading MAXBITS bits. + * + * Format notes: + * + * - The codes as stored in the compressed data are bit-reversed relative to + * a simple integer ordering of codes of the same lengths. Hence below the + * bits are pulled from the compressed data one at a time and used to + * build the code value reversed from what is in the stream in order to + * permit simple integer comparisons for decoding. A table-based decoding + * scheme (as used in zlib) does not need to do this reversal. + * + * - The first code for the shortest length is all zeros. Subsequent codes of + * the same length are simply integer increments of the previous code. When + * moving up a length, a zero bit is appended to the code. For a complete + * code, the last code of the longest length will be all ones. + * + * - Incomplete codes are handled by this decoder, since they are permitted + * in the deflate format. See the format notes for fixed() and dynamic(). + */ +#ifdef SLOW +local int decode(struct state *s, const struct huffman *h) +{ + int len; /* current number of bits in code */ + int code; /* len bits being decoded */ + int first; /* first code of length len */ + int count; /* number of codes of length len */ + int index; /* index of first code of length len in symbol table */ + + code = first = index = 0; + for (len = 1; len <= MAXBITS; len++) { + code |= bits(s, 1); /* get next bit */ + count = h->count[len]; + if (code - count < first) /* if length len, return symbol */ + return h->symbol[index + (code - first)]; + index += count; /* else update for next length */ + first += count; + first <<= 1; + code <<= 1; + } + return -10; /* ran out of codes */ +} + +/* + * A faster version of decode() for real applications of this code. It's not + * as readable, but it makes puff() twice as fast. And it only makes the code + * a few percent larger. + */ +#else /* !SLOW */ +local int decode(struct state *s, const struct huffman *h) +{ + int len; /* current number of bits in code */ + int code; /* len bits being decoded */ + int first; /* first code of length len */ + int count; /* number of codes of length len */ + int index; /* index of first code of length len in symbol table */ + int bitbuf; /* bits from stream */ + int left; /* bits left in next or left to process */ + short *next; /* next number of codes */ + + bitbuf = s->bitbuf; + left = s->bitcnt; + code = first = index = 0; + len = 1; + next = h->count + 1; + while (1) { + while (left--) { + code |= bitbuf & 1; + bitbuf >>= 1; + count = *next++; + if (code - count < first) { /* if length len, return symbol */ + s->bitbuf = bitbuf; + s->bitcnt = (s->bitcnt - len) & 7; + return h->symbol[index + (code - first)]; + } + index += count; /* else update for next length */ + first += count; + first <<= 1; + code <<= 1; + len++; + } + left = (MAXBITS+1) - len; + if (left == 0) + break; + if (s->incnt == s->inlen) + longjmp(s->env, 1); /* out of input */ + bitbuf = s->in[s->incnt++]; + if (left > 8) + left = 8; + } + return -10; /* ran out of codes */ +} +#endif /* SLOW */ + +/* + * Given the list of code lengths length[0..n-1] representing a canonical + * Huffman code for n symbols, construct the tables required to decode those + * codes. Those tables are the number of codes of each length, and the symbols + * sorted by length, retaining their original order within each length. The + * return value is zero for a complete code set, negative for an over- + * subscribed code set, and positive for an incomplete code set. The tables + * can be used if the return value is zero or positive, but they cannot be used + * if the return value is negative. If the return value is zero, it is not + * possible for decode() using that table to return an error--any stream of + * enough bits will resolve to a symbol. If the return value is positive, then + * it is possible for decode() using that table to return an error for received + * codes past the end of the incomplete lengths. + * + * Not used by decode(), but used for error checking, h->count[0] is the number + * of the n symbols not in the code. So n - h->count[0] is the number of + * codes. This is useful for checking for incomplete codes that have more than + * one symbol, which is an error in a dynamic block. + * + * Assumption: for all i in 0..n-1, 0 <= length[i] <= MAXBITS + * This is assured by the construction of the length arrays in dynamic() and + * fixed() and is not verified by construct(). + * + * Format notes: + * + * - Permitted and expected examples of incomplete codes are one of the fixed + * codes and any code with a single symbol which in deflate is coded as one + * bit instead of zero bits. See the format notes for fixed() and dynamic(). + * + * - Within a given code length, the symbols are kept in ascending order for + * the code bits definition. + */ +local int construct(struct huffman *h, const short *length, int n) +{ + int symbol; /* current symbol when stepping through length[] */ + int len; /* current length when stepping through h->count[] */ + int left; /* number of possible codes left of current length */ + short offs[MAXBITS+1]; /* offsets in symbol table for each length */ + + /* count number of codes of each length */ + for (len = 0; len <= MAXBITS; len++) + h->count[len] = 0; + for (symbol = 0; symbol < n; symbol++) + (h->count[length[symbol]])++; /* assumes lengths are within bounds */ + if (h->count[0] == n) /* no codes! */ + return 0; /* complete, but decode() will fail */ + + /* check for an over-subscribed or incomplete set of lengths */ + left = 1; /* one possible code of zero length */ + for (len = 1; len <= MAXBITS; len++) { + left <<= 1; /* one more bit, double codes left */ + left -= h->count[len]; /* deduct count from possible codes */ + if (left < 0) + return left; /* over-subscribed--return negative */ + } /* left > 0 means incomplete */ + + /* generate offsets into symbol table for each length for sorting */ + offs[1] = 0; + for (len = 1; len < MAXBITS; len++) + offs[len + 1] = offs[len] + h->count[len]; + + /* + * put symbols in table sorted by length, by symbol order within each + * length + */ + for (symbol = 0; symbol < n; symbol++) + if (length[symbol] != 0) + h->symbol[offs[length[symbol]]++] = symbol; + + /* return zero for complete set, positive for incomplete set */ + return left; +} + +/* + * Decode literal/length and distance codes until an end-of-block code. + * + * Format notes: + * + * - Compressed data that is after the block type if fixed or after the code + * description if dynamic is a combination of literals and length/distance + * pairs terminated by and end-of-block code. Literals are simply Huffman + * coded bytes. A length/distance pair is a coded length followed by a + * coded distance to represent a string that occurs earlier in the + * uncompressed data that occurs again at the current location. + * + * - Literals, lengths, and the end-of-block code are combined into a single + * code of up to 286 symbols. They are 256 literals (0..255), 29 length + * symbols (257..285), and the end-of-block symbol (256). + * + * - There are 256 possible lengths (3..258), and so 29 symbols are not enough + * to represent all of those. Lengths 3..10 and 258 are in fact represented + * by just a length symbol. Lengths 11..257 are represented as a symbol and + * some number of extra bits that are added as an integer to the base length + * of the length symbol. The number of extra bits is determined by the base + * length symbol. These are in the static arrays below, lens[] for the base + * lengths and lext[] for the corresponding number of extra bits. + * + * - The reason that 258 gets its own symbol is that the longest length is used + * often in highly redundant files. Note that 258 can also be coded as the + * base value 227 plus the maximum extra value of 31. While a good deflate + * should never do this, it is not an error, and should be decoded properly. + * + * - If a length is decoded, including its extra bits if any, then it is + * followed a distance code. There are up to 30 distance symbols. Again + * there are many more possible distances (1..32768), so extra bits are added + * to a base value represented by the symbol. The distances 1..4 get their + * own symbol, but the rest require extra bits. The base distances and + * corresponding number of extra bits are below in the static arrays dist[] + * and dext[]. + * + * - Literal bytes are simply written to the output. A length/distance pair is + * an instruction to copy previously uncompressed bytes to the output. The + * copy is from distance bytes back in the output stream, copying for length + * bytes. + * + * - Distances pointing before the beginning of the output data are not + * permitted. + * + * - Overlapped copies, where the length is greater than the distance, are + * allowed and common. For example, a distance of one and a length of 258 + * simply copies the last byte 258 times. A distance of four and a length of + * twelve copies the last four bytes three times. A simple forward copy + * ignoring whether the length is greater than the distance or not implements + * this correctly. You should not use memcpy() since its behavior is not + * defined for overlapped arrays. You should not use memmove() or bcopy() + * since though their behavior -is- defined for overlapping arrays, it is + * defined to do the wrong thing in this case. + */ +local int codes(struct state *s, + const struct huffman *lencode, + const struct huffman *distcode) +{ + int symbol; /* decoded symbol */ + int len; /* length for copy */ + unsigned dist; /* distance for copy */ + static const short lens[29] = { /* Size base for length codes 257..285 */ + 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 15, 17, 19, 23, 27, 31, + 35, 43, 51, 59, 67, 83, 99, 115, 131, 163, 195, 227, 258}; + static const short lext[29] = { /* Extra bits for length codes 257..285 */ + 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, + 3, 3, 3, 3, 4, 4, 4, 4, 5, 5, 5, 5, 0}; + static const short dists[30] = { /* Offset base for distance codes 0..29 */ + 1, 2, 3, 4, 5, 7, 9, 13, 17, 25, 33, 49, 65, 97, 129, 193, + 257, 385, 513, 769, 1025, 1537, 2049, 3073, 4097, 6145, + 8193, 12289, 16385, 24577}; + static const short dext[30] = { /* Extra bits for distance codes 0..29 */ + 0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, + 7, 7, 8, 8, 9, 9, 10, 10, 11, 11, + 12, 12, 13, 13}; + + /* decode literals and length/distance pairs */ + do { + symbol = decode(s, lencode); + if (symbol < 0) + return symbol; /* invalid symbol */ + if (symbol < 256) { /* literal: symbol is the byte */ + /* write out the literal */ + if (s->out != NIL) { + if (s->outcnt == s->outlen) + return 1; + s->out[s->outcnt] = symbol; + } + s->outcnt++; + } + else if (symbol > 256) { /* length */ + /* get and compute length */ + symbol -= 257; + if (symbol >= 29) + return -10; /* invalid fixed code */ + len = lens[symbol] + bits(s, lext[symbol]); + + /* get and check distance */ + symbol = decode(s, distcode); + if (symbol < 0) + return symbol; /* invalid symbol */ + dist = dists[symbol] + bits(s, dext[symbol]); +#ifndef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR + if (dist > s->outcnt) + return -11; /* distance too far back */ +#endif + + /* copy length bytes from distance bytes back */ + if (s->out != NIL) { + if (s->outcnt + len > s->outlen) + return 1; + while (len--) { + s->out[s->outcnt] = +#ifdef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR + dist > s->outcnt ? + 0 : +#endif + s->out[s->outcnt - dist]; + s->outcnt++; + } + } + else + s->outcnt += len; + } + } while (symbol != 256); /* end of block symbol */ + + /* done with a valid fixed or dynamic block */ + return 0; +} + +/* + * Process a fixed codes block. + * + * Format notes: + * + * - This block type can be useful for compressing small amounts of data for + * which the size of the code descriptions in a dynamic block exceeds the + * benefit of custom codes for that block. For fixed codes, no bits are + * spent on code descriptions. Instead the code lengths for literal/length + * codes and distance codes are fixed. The specific lengths for each symbol + * can be seen in the "for" loops below. + * + * - The literal/length code is complete, but has two symbols that are invalid + * and should result in an error if received. This cannot be implemented + * simply as an incomplete code since those two symbols are in the "middle" + * of the code. They are eight bits long and the longest literal/length\ + * code is nine bits. Therefore the code must be constructed with those + * symbols, and the invalid symbols must be detected after decoding. + * + * - The fixed distance codes also have two invalid symbols that should result + * in an error if received. Since all of the distance codes are the same + * length, this can be implemented as an incomplete code. Then the invalid + * codes are detected while decoding. + */ +local int fixed(struct state *s) +{ + static int virgin = 1; + static short lencnt[MAXBITS+1], lensym[FIXLCODES]; + static short distcnt[MAXBITS+1], distsym[MAXDCODES]; + static struct huffman lencode, distcode; + + /* build fixed huffman tables if first call (may not be thread safe) */ + if (virgin) { + int symbol; + short lengths[FIXLCODES]; + + /* construct lencode and distcode */ + lencode.count = lencnt; + lencode.symbol = lensym; + distcode.count = distcnt; + distcode.symbol = distsym; + + /* literal/length table */ + for (symbol = 0; symbol < 144; symbol++) + lengths[symbol] = 8; + for (; symbol < 256; symbol++) + lengths[symbol] = 9; + for (; symbol < 280; symbol++) + lengths[symbol] = 7; + for (; symbol < FIXLCODES; symbol++) + lengths[symbol] = 8; + construct(&lencode, lengths, FIXLCODES); + + /* distance table */ + for (symbol = 0; symbol < MAXDCODES; symbol++) + lengths[symbol] = 5; + construct(&distcode, lengths, MAXDCODES); + + /* do this just once */ + virgin = 0; + } + + /* decode data until end-of-block code */ + return codes(s, &lencode, &distcode); +} + +/* + * Process a dynamic codes block. + * + * Format notes: + * + * - A dynamic block starts with a description of the literal/length and + * distance codes for that block. New dynamic blocks allow the compressor to + * rapidly adapt to changing data with new codes optimized for that data. + * + * - The codes used by the deflate format are "canonical", which means that + * the actual bits of the codes are generated in an unambiguous way simply + * from the number of bits in each code. Therefore the code descriptions + * are simply a list of code lengths for each symbol. + * + * - The code lengths are stored in order for the symbols, so lengths are + * provided for each of the literal/length symbols, and for each of the + * distance symbols. + * + * - If a symbol is not used in the block, this is represented by a zero as the + * code length. This does not mean a zero-length code, but rather that no + * code should be created for this symbol. There is no way in the deflate + * format to represent a zero-length code. + * + * - The maximum number of bits in a code is 15, so the possible lengths for + * any code are 1..15. + * + * - The fact that a length of zero is not permitted for a code has an + * interesting consequence. Normally if only one symbol is used for a given + * code, then in fact that code could be represented with zero bits. However + * in deflate, that code has to be at least one bit. So for example, if + * only a single distance base symbol appears in a block, then it will be + * represented by a single code of length one, in particular one 0 bit. This + * is an incomplete code, since if a 1 bit is received, it has no meaning, + * and should result in an error. So incomplete distance codes of one symbol + * should be permitted, and the receipt of invalid codes should be handled. + * + * - It is also possible to have a single literal/length code, but that code + * must be the end-of-block code, since every dynamic block has one. This + * is not the most efficient way to create an empty block (an empty fixed + * block is fewer bits), but it is allowed by the format. So incomplete + * literal/length codes of one symbol should also be permitted. + * + * - If there are only literal codes and no lengths, then there are no distance + * codes. This is represented by one distance code with zero bits. + * + * - The list of up to 286 length/literal lengths and up to 30 distance lengths + * are themselves compressed using Huffman codes and run-length encoding. In + * the list of code lengths, a 0 symbol means no code, a 1..15 symbol means + * that length, and the symbols 16, 17, and 18 are run-length instructions. + * Each of 16, 17, and 18 are followed by extra bits to define the length of + * the run. 16 copies the last length 3 to 6 times. 17 represents 3 to 10 + * zero lengths, and 18 represents 11 to 138 zero lengths. Unused symbols + * are common, hence the special coding for zero lengths. + * + * - The symbols for 0..18 are Huffman coded, and so that code must be + * described first. This is simply a sequence of up to 19 three-bit values + * representing no code (0) or the code length for that symbol (1..7). + * + * - A dynamic block starts with three fixed-size counts from which is computed + * the number of literal/length code lengths, the number of distance code + * lengths, and the number of code length code lengths (ok, you come up with + * a better name!) in the code descriptions. For the literal/length and + * distance codes, lengths after those provided are considered zero, i.e. no + * code. The code length code lengths are received in a permuted order (see + * the order[] array below) to make a short code length code length list more + * likely. As it turns out, very short and very long codes are less likely + * to be seen in a dynamic code description, hence what may appear initially + * to be a peculiar ordering. + * + * - Given the number of literal/length code lengths (nlen) and distance code + * lengths (ndist), then they are treated as one long list of nlen + ndist + * code lengths. Therefore run-length coding can and often does cross the + * boundary between the two sets of lengths. + * + * - So to summarize, the code description at the start of a dynamic block is + * three counts for the number of code lengths for the literal/length codes, + * the distance codes, and the code length codes. This is followed by the + * code length code lengths, three bits each. This is used to construct the + * code length code which is used to read the remainder of the lengths. Then + * the literal/length code lengths and distance lengths are read as a single + * set of lengths using the code length codes. Codes are constructed from + * the resulting two sets of lengths, and then finally you can start + * decoding actual compressed data in the block. + * + * - For reference, a "typical" size for the code description in a dynamic + * block is around 80 bytes. + */ +local int dynamic(struct state *s) +{ + int nlen, ndist, ncode; /* number of lengths in descriptor */ + int index; /* index of lengths[] */ + int err; /* construct() return value */ + short lengths[MAXCODES]; /* descriptor code lengths */ + short lencnt[MAXBITS+1], lensym[MAXLCODES]; /* lencode memory */ + short distcnt[MAXBITS+1], distsym[MAXDCODES]; /* distcode memory */ + struct huffman lencode, distcode; /* length and distance codes */ + static const short order[19] = /* permutation of code length codes */ + {16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15}; + + /* construct lencode and distcode */ + lencode.count = lencnt; + lencode.symbol = lensym; + distcode.count = distcnt; + distcode.symbol = distsym; + + /* get number of lengths in each table, check lengths */ + nlen = bits(s, 5) + 257; + ndist = bits(s, 5) + 1; + ncode = bits(s, 4) + 4; + if (nlen > MAXLCODES || ndist > MAXDCODES) + return -3; /* bad counts */ + + /* read code length code lengths (really), missing lengths are zero */ + for (index = 0; index < ncode; index++) + lengths[order[index]] = bits(s, 3); + for (; index < 19; index++) + lengths[order[index]] = 0; + + /* build huffman table for code lengths codes (use lencode temporarily) */ + err = construct(&lencode, lengths, 19); + if (err != 0) /* require complete code set here */ + return -4; + + /* read length/literal and distance code length tables */ + index = 0; + while (index < nlen + ndist) { + int symbol; /* decoded value */ + int len; /* last length to repeat */ + + symbol = decode(s, &lencode); + if (symbol < 0) + return symbol; /* invalid symbol */ + if (symbol < 16) /* length in 0..15 */ + lengths[index++] = symbol; + else { /* repeat instruction */ + len = 0; /* assume repeating zeros */ + if (symbol == 16) { /* repeat last length 3..6 times */ + if (index == 0) + return -5; /* no last length! */ + len = lengths[index - 1]; /* last length */ + symbol = 3 + bits(s, 2); + } + else if (symbol == 17) /* repeat zero 3..10 times */ + symbol = 3 + bits(s, 3); + else /* == 18, repeat zero 11..138 times */ + symbol = 11 + bits(s, 7); + if (index + symbol > nlen + ndist) + return -6; /* too many lengths! */ + while (symbol--) /* repeat last or zero symbol times */ + lengths[index++] = len; + } + } + + /* check for end-of-block code -- there better be one! */ + if (lengths[256] == 0) + return -9; + + /* build huffman table for literal/length codes */ + err = construct(&lencode, lengths, nlen); + if (err && (err < 0 || nlen != lencode.count[0] + lencode.count[1])) + return -7; /* incomplete code ok only for single length 1 code */ + + /* build huffman table for distance codes */ + err = construct(&distcode, lengths + nlen, ndist); + if (err && (err < 0 || ndist != distcode.count[0] + distcode.count[1])) + return -8; /* incomplete code ok only for single length 1 code */ + + /* decode data until end-of-block code */ + return codes(s, &lencode, &distcode); +} + +/* + * Inflate source to dest. On return, destlen and sourcelen are updated to the + * size of the uncompressed data and the size of the deflate data respectively. + * On success, the return value of puff() is zero. If there is an error in the + * source data, i.e. it is not in the deflate format, then a negative value is + * returned. If there is not enough input available or there is not enough + * output space, then a positive error is returned. In that case, destlen and + * sourcelen are not updated to facilitate retrying from the beginning with the + * provision of more input data or more output space. In the case of invalid + * inflate data (a negative error), the dest and source pointers are updated to + * facilitate the debugging of deflators. + * + * puff() also has a mode to determine the size of the uncompressed output with + * no output written. For this dest must be (unsigned char *)0. In this case, + * the input value of *destlen is ignored, and on return *destlen is set to the + * size of the uncompressed output. + * + * The return codes are: + * + * 2: available inflate data did not terminate + * 1: output space exhausted before completing inflate + * 0: successful inflate + * -1: invalid block type (type == 3) + * -2: stored block length did not match one's complement + * -3: dynamic block code description: too many length or distance codes + * -4: dynamic block code description: code lengths codes incomplete + * -5: dynamic block code description: repeat lengths with no first length + * -6: dynamic block code description: repeat more than specified lengths + * -7: dynamic block code description: invalid literal/length code lengths + * -8: dynamic block code description: invalid distance code lengths + * -9: dynamic block code description: missing end-of-block code + * -10: invalid literal/length or distance code in fixed or dynamic block + * -11: distance is too far back in fixed or dynamic block + * + * Format notes: + * + * - Three bits are read for each block to determine the kind of block and + * whether or not it is the last block. Then the block is decoded and the + * process repeated if it was not the last block. + * + * - The leftover bits in the last byte of the deflate data after the last + * block (if it was a fixed or dynamic block) are undefined and have no + * expected values to check. + */ +int puff(unsigned char *dest, /* pointer to destination pointer */ + unsigned long *destlen, /* amount of output space */ + const unsigned char *source, /* pointer to source data pointer */ + unsigned long *sourcelen) /* amount of input available */ +{ + struct state s; /* input/output state */ + int last, type; /* block information */ + int err; /* return value */ + + /* initialize output state */ + s.out = dest; + s.outlen = *destlen; /* ignored if dest is NIL */ + s.outcnt = 0; + + /* initialize input state */ + s.in = source; + s.inlen = *sourcelen; + s.incnt = 0; + s.bitbuf = 0; + s.bitcnt = 0; + + /* return if bits() or decode() tries to read past available input */ + if (setjmp(s.env) != 0) /* if came back here via longjmp() */ + err = 2; /* then skip do-loop, return error */ + else { + /* process blocks until last block or error */ + do { + last = bits(&s, 1); /* one if last block */ + type = bits(&s, 2); /* block type 0..3 */ + err = type == 0 ? + stored(&s) : + (type == 1 ? + fixed(&s) : + (type == 2 ? + dynamic(&s) : + -1)); /* type == 3, invalid */ + if (err != 0) + break; /* return with error */ + } while (!last); + } + + /* update the lengths and return */ + if (err <= 0) { + *destlen = s.outcnt; + *sourcelen = s.incnt; + } + return err; +} diff --git a/lib/obp60task/puff.h b/lib/obp60task/puff.h new file mode 100644 index 0000000..e23a245 --- /dev/null +++ b/lib/obp60task/puff.h @@ -0,0 +1,35 @@ +/* puff.h + Copyright (C) 2002-2013 Mark Adler, all rights reserved + version 2.3, 21 Jan 2013 + + This software is provided 'as-is', without any express or implied + warranty. In no event will the author be held liable for any damages + arising from the use of this software. + + Permission is granted to anyone to use this software for any purpose, + including commercial applications, and to alter it and redistribute it + freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. + 2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + 3. This notice may not be removed or altered from any source distribution. + + Mark Adler madler@alumni.caltech.edu + */ + + +/* + * See puff.c for purpose and usage. + */ +#ifndef NIL +# define NIL ((unsigned char *)0) /* for no output option */ +#endif + +int puff(unsigned char *dest, /* pointer to destination pointer */ + unsigned long *destlen, /* amount of output space */ + const unsigned char *source, /* pointer to source data pointer */ + unsigned long *sourcelen); /* amount of input available */ diff --git a/lib/obp60task/run_install_tools b/lib/obp60task/run_install_tools index 9c4667e..c46c10c 100644 --- a/lib/obp60task/run_install_tools +++ b/lib/obp60task/run_install_tools @@ -8,6 +8,6 @@ # Install tools echo "Installing tools" -cd /workspace/esp32-nmea2000 +cd /workspaces/esp32-nmea2000 pip3 install -U esptool pip3 install platformio diff --git a/lib/sensors/GwSensor.cpp b/lib/sensors/GwSensor.cpp index d0d580b..abdb508 100644 --- a/lib/sensors/GwSensor.cpp +++ b/lib/sensors/GwSensor.cpp @@ -3,7 +3,7 @@ This code is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. + version 2 of the License, or (at your option) any later version. This code 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 diff --git a/lib/sensors/GwSensor.h b/lib/sensors/GwSensor.h index 3077360..6bc611f 100644 --- a/lib/sensors/GwSensor.h +++ b/lib/sensors/GwSensor.h @@ -3,7 +3,7 @@ This code is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. + version 2 of the License, or (at your option) any later version. This code 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 @@ -93,6 +93,7 @@ class GwSensorConfig{ } bool readConfig(T* s,GwConfigHandler *cfg){ if (s == nullptr) return false; + if (prefix != s->prefix) return false; configReader(s,cfg); return s->ok; } diff --git a/lib/serial/GwSerial.cpp b/lib/serial/GwSerial.cpp index b23c52f..ed469f9 100644 --- a/lib/serial/GwSerial.cpp +++ b/lib/serial/GwSerial.cpp @@ -66,18 +66,8 @@ GwSerial::~GwSerial() if (lock != nullptr) vSemaphoreDelete(lock); } -String GwSerial::getMode(){ - switch (type){ - case GWSERIAL_TYPE_UNI: - return "UNI"; - case GWSERIAL_TYPE_BI: - return "BI"; - case GWSERIAL_TYPE_RX: - return "RX"; - case GWSERIAL_TYPE_TX: - return "TX"; - } - return "UNKNOWN"; +int GwSerial::getType() { + return type; } bool GwSerial::isInitialized() { return initialized; } diff --git a/lib/serial/GwSerial.h b/lib/serial/GwSerial.h index 1932878..ae2ca1f 100644 --- a/lib/serial/GwSerial.h +++ b/lib/serial/GwSerial.h @@ -42,7 +42,7 @@ class GwSerial : public GwChannelInterface{ virtual Stream *getStream(bool partialWrites); bool getAvailableWrite(){return availableWrite;} virtual void begin(unsigned long baud, uint32_t config=SERIAL_8N1, int8_t rxPin=-1, int8_t txPin=-1)=0; - virtual String getMode() override; + virtual int getType() override; friend GwSerialStream; }; @@ -122,6 +122,7 @@ template setError(serial,logger); }; + }; diff --git a/lib/socketserver/GwSocketServer.cpp b/lib/socketserver/GwSocketServer.cpp index 185e3a4..0e0b79e 100644 --- a/lib/socketserver/GwSocketServer.cpp +++ b/lib/socketserver/GwSocketServer.cpp @@ -185,4 +185,4 @@ int GwSocketServer::numClients() } GwSocketServer::~GwSocketServer() { -} \ No newline at end of file +} diff --git a/lib/socketserver/GwTcpClient.cpp b/lib/socketserver/GwTcpClient.cpp index 2792300..a2c68eb 100644 --- a/lib/socketserver/GwTcpClient.cpp +++ b/lib/socketserver/GwTcpClient.cpp @@ -291,4 +291,4 @@ void GwTcpClient::setResolved(IPAddress addr, bool valid){ GwTcpClient::ResolvedAddress GwTcpClient::getResolved(){ GWSYNCHRONIZED(locker); return resolvedAddress; -} \ No newline at end of file +} diff --git a/lib/socketserver/GwUdpReader.cpp b/lib/socketserver/GwUdpReader.cpp index 612eb10..29d854e 100644 --- a/lib/socketserver/GwUdpReader.cpp +++ b/lib/socketserver/GwUdpReader.cpp @@ -6,7 +6,6 @@ #include "GwSocketHelper.h" #include "GWWifi.h" - GwUdpReader::GwUdpReader(const GwConfigHandler *config, GwLog *logger, int minId) { this->config = config; diff --git a/lib/socketserver/GwUdpWriter.cpp b/lib/socketserver/GwUdpWriter.cpp index c91880e..ef0020c 100644 --- a/lib/socketserver/GwUdpWriter.cpp +++ b/lib/socketserver/GwUdpWriter.cpp @@ -200,4 +200,4 @@ size_t GwUdpWriter::sendToClients(const char *buf, int source,bool partial) GwUdpWriter::~GwUdpWriter() { -} \ No newline at end of file +} diff --git a/lib/spitask/GWDMS22B.cpp b/lib/spitask/GWDMS22B.cpp index fca345e..0447fb2 100644 --- a/lib/spitask/GWDMS22B.cpp +++ b/lib/spitask/GWDMS22B.cpp @@ -3,7 +3,7 @@ This code is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. + version 2 of the License, or (at your option) any later version. This code 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 diff --git a/lib/spitask/GWDMS22B.h b/lib/spitask/GWDMS22B.h index de53804..29a0b1b 100644 --- a/lib/spitask/GWDMS22B.h +++ b/lib/spitask/GWDMS22B.h @@ -3,7 +3,7 @@ This code is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. + version 2 of the License, or (at your option) any later version. This code 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 diff --git a/lib/spitask/GwSpiSensor.h b/lib/spitask/GwSpiSensor.h index c12a410..ec21afe 100644 --- a/lib/spitask/GwSpiSensor.h +++ b/lib/spitask/GwSpiSensor.h @@ -3,7 +3,7 @@ This code is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. + version 2 of the License, or (at your option) any later version. This code 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 diff --git a/lib/spitask/GwSpiTask.cpp b/lib/spitask/GwSpiTask.cpp index a5dda8a..54f9f3d 100644 --- a/lib/spitask/GwSpiTask.cpp +++ b/lib/spitask/GwSpiTask.cpp @@ -3,7 +3,7 @@ This code is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. + version 2 of the License, or (at your option) any later version. This code 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 diff --git a/lib/spitask/GwSpiTask.h b/lib/spitask/GwSpiTask.h index 0714a31..b42b462 100644 --- a/lib/spitask/GwSpiTask.h +++ b/lib/spitask/GwSpiTask.h @@ -3,7 +3,7 @@ This code is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. + version 2 of the License, or (at your option) any later version. This code 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 diff --git a/lib/xdrmappings/GwXDRMappings.cpp b/lib/xdrmappings/GwXDRMappings.cpp index 28f88c2..211d394 100644 --- a/lib/xdrmappings/GwXDRMappings.cpp +++ b/lib/xdrmappings/GwXDRMappings.cpp @@ -431,7 +431,8 @@ GwXDRFoundMapping GwXDRMappings::getMapping(String xName,String xType,String xUn } return selectMapping(&(it->second),instance,n183Key.c_str()); } -GwXDRFoundMapping GwXDRMappings::getMapping(GwXDRCategory category,int selector,int field,int instance){ +GwXDRFoundMapping GwXDRMappings::getMapping(double value,GwXDRCategory category,int selector,int field,int instance){ + if (value == N2kDoubleNA) return GwXDRFoundMapping(); //do not add to unknown mappings unsigned long n2kKey=GwXDRMappingDef::n2kKey(category,selector,field); auto it=n2kMap.find(n2kKey); if (it == n2kMap.end()){ diff --git a/lib/xdrmappings/GwXDRMappings.h b/lib/xdrmappings/GwXDRMappings.h index 198a729..21eb9c3 100644 --- a/lib/xdrmappings/GwXDRMappings.h +++ b/lib/xdrmappings/GwXDRMappings.h @@ -244,7 +244,7 @@ class GwXDRMappings{ //get the mappings //the returned mapping will exactly contain one mapping def GwXDRFoundMapping getMapping(String xName,String xType,String xUnit); - GwXDRFoundMapping getMapping(GwXDRCategory category,int selector,int field=0,int instance=-1); + GwXDRFoundMapping getMapping(double value,GwXDRCategory category,int selector,int field=0,int instance=-1); String getXdrEntry(String mapping, double value,int instance=0); const char * getUnMapped(); const GwXDRType * findType(const String &typeString, const String &unitString) const; diff --git a/platformio.ini b/platformio.ini index df144b8..341083c 100644 --- a/platformio.ini +++ b/platformio.ini @@ -18,7 +18,7 @@ extra_configs= [basedeps] lib_deps = - ttlappalainen/NMEA2000-library @ 4.22.0 + ttlappalainen_NMEA2000=https://github.com/wellenvogel/NMEA2000.git#20251126 ttlappalainen/NMEA0183 @ 1.10.1 ArduinoJson @ 6.18.5 AsyncTCP-esphome @ 2.0.1 @@ -29,6 +29,18 @@ lib_deps = WiFi Update +[devdeps] +lib_deps= + ttlappalainen_NMEA2000=symlink://../NMEA2000 + ttlappalainen/NMEA0183 @ 1.10.1 + ArduinoJson @ 6.18.5 + AsyncTCP-esphome @ 2.0.1 + ottowinter/ESPAsyncWebServer-esphome@2.0.1 + FS + Preferences + ESPmDNS + WiFi + Update [env] platform = espressif32 @ 6.8.1 framework = arduino @@ -67,6 +79,17 @@ lib_deps = adafruit/Adafruit BusIO @ 1.14.5 adafruit/Adafruit Unified Sensor @ 1.1.13 +[env:m5stack-atom-dev] +board = m5stack-atom +lib_deps = + ${devdeps.lib_deps} + fastled/FastLED @ 3.6.0 + +build_flags = + -D BOARD_M5ATOM + ${env.build_flags} +upload_port = /dev/esp32 +upload_protocol = esptool [env:m5stack-atom] board = m5stack-atom lib_deps = ${env.lib_deps} @@ -185,3 +208,14 @@ build_flags = ${env.build_flags} upload_port = /dev/esp32 upload_protocol = esptool + +[env:s3devkitm-generic] +extends = sensors +board = esp32-s3-devkitm-1 +lib_deps = + ${env.lib_deps} + ${sensors.lib_deps} +build_flags = + ${env.build_flags} +upload_port = /dev/esp32 +upload_protocol = esptool diff --git a/post.py b/post.py index 8fe2f27..a09635f 100644 --- a/post.py +++ b/post.py @@ -2,6 +2,7 @@ Import("env", "projenv") import os import glob import shutil +import re print("##post script running") HDROFFSET=288 @@ -39,6 +40,7 @@ def post(source,target,env): appoffset=env.subst("$ESP32_APP_OFFSET") firmware=env.subst("$BUILD_DIR/${PROGNAME}.bin") (fwname,version)=getFirmwareInfo(firmware) + fwname=re.sub(r"[^0-9A-Za-z_.-]*","",fwname) print("found fwname=%s, fwversion=%s"%(fwname,version)) python=env.subst("$PYTHONEXE") print("base=%s,esptool=%s,appoffset=%s,uploaderflags=%s"%(base,esptool,appoffset,uploaderflags)) @@ -70,10 +72,12 @@ def post(source,target,env): print("running %s"%" ".join(cmd)) env.Execute(" ".join(cmd),"#testpost") ofversion="-"+version - versionedFile=os.path.join(outdir,"%s%s-update.bin"%(base,ofversion)) + versionedFile=os.path.join(outdir,"%s%s-update.bin"%(fwname,ofversion)) shutil.copyfile(firmware,versionedFile) - versioneOutFile=os.path.join(outdir,"%s%s-all.bin"%(base,ofversion)) + print(f"wrote {versionedFile}") + versioneOutFile=os.path.join(outdir,"%s%s-all.bin"%(fwname,ofversion)) shutil.copyfile(outfile,versioneOutFile) + print(f"wrote {versioneOutFile}") env.AddPostAction( "$BUILD_DIR/${PROGNAME}.bin", post diff --git a/src/main.cpp b/src/main.cpp index 6daaa51..44c715f 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -3,7 +3,7 @@ This code is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. + version 2 of the License, or (at your option) any later version. This code 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 @@ -72,9 +72,9 @@ const unsigned long HEAP_REPORT_TIME=2000; //set to 0 to disable heap reporting #define MAX_NMEA2000_MESSAGE_SEASMART_SIZE 500 #define MAX_NMEA0183_MESSAGE_SIZE MAX_NMEA2000_MESSAGE_SEASMART_SIZE //assert length of firmware name and version -CASSERT(strlen(FIRMWARE_TYPE) <= 32, "environment name (FIRMWARE_TYPE) must not exceed 32 chars"); -CASSERT(strlen(VERSION) <= 32, "VERSION must not exceed 32 chars"); -CASSERT(strlen(IDF_VERSION) <= 32,"IDF_VERSION must not exceed 32 chars"); +CASSERT(strlen(FIRMWARE_TYPE) <= 31, "environment name (FIRMWARE_TYPE) must not exceed 32 chars"); +CASSERT(strlen(VERSION) <= 31, "VERSION must not exceed 32 chars"); +CASSERT(strlen(IDF_VERSION) <= 31,"IDF_VERSION must not exceed 32 chars"); //https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/app_image_format.html //and removed the bugs in the doc... __attribute__((section(".rodata_custom_desc"))) esp_app_desc_t custom_app_desc = { diff --git a/tools/gen3byte.py b/tools/gen3byte.py new file mode 100755 index 0000000..2d84518 --- /dev/null +++ b/tools/gen3byte.py @@ -0,0 +1,32 @@ +#! /usr/bin/env python3 +#generate 3 byte codes for the RGB bytes +#refer to https://controllerstech.com/ws2812-leds-using-spi/ +ONE_BIT='110' +ZERO_BIT='100' + +currentStr='' + +def checkAndPrint(curr): + if len(curr) >= 8: + print("0b%s,"%curr[0:8],end='') + return curr[8:] + return curr +first=True + +print("uint8_t colorTo3Byte[256][3]=") +print("{") +for i in range(0,256): + if not first: + print("},") + first=False + print("{/*%02d*/"%i,end='') + mask=0x80 + for b in range(0,8): + if (i & mask) != 0: + currentStr+=ONE_BIT + else: + currentStr+=ZERO_BIT + mask=mask >> 1 + currentStr=checkAndPrint(currentStr) +print("}") +print("};") diff --git a/tools/getPgnType.py b/tools/getPgnType.py new file mode 100755 index 0000000..edbdbb2 --- /dev/null +++ b/tools/getPgnType.py @@ -0,0 +1,29 @@ +#! /usr/bin/env python3 +import sys +import json + +def err(txt): + print(txt,file=sys.stderr) + sys.exit(1) + +HDR=''' +PGNM_Fast=0 +PGNM_Single=1 +PGNM_ISO=2 +PGN_MODES={ +''' +FOOTER=''' + } +''' +with open(sys.argv[1],"r") as ih: + data=json.load(ih) + pgns=data.get('PGNs') + if pgns is None: + err("no pgns") + print(HDR) + for p in pgns: + t=p['Type'] + pgn=p['PGN'] + if t and pgn: + print(f" {pgn}: PGNM_{t},") + print(FOOTER) \ No newline at end of file diff --git a/tools/sendDelay.py b/tools/sendDelay.py new file mode 100755 index 0000000..ab91737 --- /dev/null +++ b/tools/sendDelay.py @@ -0,0 +1,19 @@ +#! /usr/bin/env python3 +import sys +import os +import time + +def usage(): + print(f"usage: {sys.argv[0]} file delay") + sys.exit(1) + +if len(sys.argv) < 3: + usage() + +delay=float(sys.argv[2]) +fn=sys.argv[1] +with open (fn,"r") as fh: + for line in fh: + print(line,end="",flush=True) + time.sleep(delay) + diff --git a/tools/sendN2K.py b/tools/sendN2K.py new file mode 100755 index 0000000..e5c55db --- /dev/null +++ b/tools/sendN2K.py @@ -0,0 +1,793 @@ +#! /usr/bin/env python3 +import re +import sys +import os +import datetime +import getopt +import time + +###generated with getPgnType.py from canboat pgns.json +PGNM_Fast=0 +PGNM_Single=1 +PGNM_ISO=2 +PGN_MODES={ + + 59392: PGNM_Single, + 59904: PGNM_Single, + 60160: PGNM_Single, + 60416: PGNM_Single, + 60416: PGNM_Single, + 60416: PGNM_Single, + 60416: PGNM_Single, + 60416: PGNM_Single, + 60928: PGNM_Single, + 61184: PGNM_Single, + 61184: PGNM_Single, + 61184: PGNM_Single, + 65001: PGNM_Single, + 65002: PGNM_Single, + 65003: PGNM_Single, + 65004: PGNM_Single, + 65005: PGNM_Single, + 65006: PGNM_Single, + 65007: PGNM_Single, + 65008: PGNM_Single, + 65009: PGNM_Single, + 65010: PGNM_Single, + 65011: PGNM_Single, + 65012: PGNM_Single, + 65013: PGNM_Single, + 65014: PGNM_Single, + 65015: PGNM_Single, + 65016: PGNM_Single, + 65017: PGNM_Single, + 65018: PGNM_Single, + 65019: PGNM_Single, + 65020: PGNM_Single, + 65021: PGNM_Single, + 65022: PGNM_Single, + 65023: PGNM_Single, + 65024: PGNM_Single, + 65025: PGNM_Single, + 65026: PGNM_Single, + 65027: PGNM_Single, + 65028: PGNM_Single, + 65029: PGNM_Single, + 65030: PGNM_Single, + 65240: PGNM_ISO, + 65280: PGNM_Single, + 65284: PGNM_Single, + 65285: PGNM_Single, + 65285: PGNM_Single, + 65286: PGNM_Single, + 65286: PGNM_Single, + 65287: PGNM_Single, + 65287: PGNM_Single, + 65288: PGNM_Single, + 65289: PGNM_Single, + 65290: PGNM_Single, + 65292: PGNM_Single, + 65293: PGNM_Single, + 65293: PGNM_Single, + 65302: PGNM_Single, + 65305: PGNM_Single, + 65305: PGNM_Single, + 65305: PGNM_Single, + 65305: PGNM_Single, + 65305: PGNM_Single, + 65309: PGNM_Single, + 65312: PGNM_Single, + 65340: PGNM_Single, + 65341: PGNM_Single, + 65345: PGNM_Single, + 65350: PGNM_Single, + 65359: PGNM_Single, + 65360: PGNM_Single, + 65361: PGNM_Single, + 65371: PGNM_Single, + 65374: PGNM_Single, + 65379: PGNM_Single, + 65408: PGNM_Single, + 65409: PGNM_Single, + 65410: PGNM_Single, + 65420: PGNM_Single, + 65480: PGNM_Single, + 126208: PGNM_Fast, + 126208: PGNM_Fast, + 126208: PGNM_Fast, + 126208: PGNM_Fast, + 126208: PGNM_Fast, + 126208: PGNM_Fast, + 126208: PGNM_Fast, + 126464: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126720: PGNM_Fast, + 126983: PGNM_Fast, + 126984: PGNM_Fast, + 126985: PGNM_Fast, + 126986: PGNM_Fast, + 126987: PGNM_Fast, + 126988: PGNM_Fast, + 126992: PGNM_Single, + 126993: PGNM_Single, + 126996: PGNM_Fast, + 126998: PGNM_Fast, + 127233: PGNM_Fast, + 127237: PGNM_Fast, + 127245: PGNM_Single, + 127250: PGNM_Single, + 127251: PGNM_Single, + 127252: PGNM_Single, + 127257: PGNM_Single, + 127258: PGNM_Single, + 127488: PGNM_Single, + 127489: PGNM_Fast, + 127490: PGNM_Fast, + 127491: PGNM_Fast, + 127493: PGNM_Single, + 127494: PGNM_Fast, + 127495: PGNM_Fast, + 127496: PGNM_Fast, + 127497: PGNM_Fast, + 127498: PGNM_Fast, + 127500: PGNM_Single, + 127501: PGNM_Single, + 127502: PGNM_Single, + 127503: PGNM_Fast, + 127504: PGNM_Fast, + 127505: PGNM_Single, + 127506: PGNM_Fast, + 127507: PGNM_Fast, + 127508: PGNM_Single, + 127509: PGNM_Fast, + 127510: PGNM_Fast, + 127511: PGNM_Single, + 127512: PGNM_Single, + 127513: PGNM_Fast, + 127514: PGNM_Single, + 127744: PGNM_Single, + 127745: PGNM_Single, + 127746: PGNM_Single, + 127750: PGNM_Single, + 127751: PGNM_Single, + 128000: PGNM_Single, + 128001: PGNM_Single, + 128002: PGNM_Single, + 128003: PGNM_Single, + 128006: PGNM_Single, + 128007: PGNM_Single, + 128008: PGNM_Single, + 128259: PGNM_Single, + 128267: PGNM_Single, + 128275: PGNM_Fast, + 128520: PGNM_Fast, + 128538: PGNM_Fast, + 128768: PGNM_Single, + 128769: PGNM_Single, + 128776: PGNM_Single, + 128777: PGNM_Single, + 128778: PGNM_Single, + 128780: PGNM_Single, + 129025: PGNM_Single, + 129026: PGNM_Single, + 129027: PGNM_Single, + 129028: PGNM_Single, + 129029: PGNM_Fast, + 129033: PGNM_Single, + 129038: PGNM_Fast, + 129039: PGNM_Fast, + 129040: PGNM_Fast, + 129041: PGNM_Fast, + 129044: PGNM_Fast, + 129045: PGNM_Fast, + 129283: PGNM_Single, + 129284: PGNM_Fast, + 129285: PGNM_Fast, + 129291: PGNM_Single, + 129301: PGNM_Fast, + 129302: PGNM_Fast, + 129538: PGNM_Fast, + 129539: PGNM_Single, + 129540: PGNM_Fast, + 129541: PGNM_Fast, + 129542: PGNM_Fast, + 129545: PGNM_Fast, + 129546: PGNM_Single, + 129547: PGNM_Fast, + 129549: PGNM_Fast, + 129550: PGNM_Fast, + 129551: PGNM_Fast, + 129556: PGNM_Fast, + 129792: PGNM_Fast, + 129793: PGNM_Fast, + 129794: PGNM_Fast, + 129795: PGNM_Fast, + 129796: PGNM_Fast, + 129797: PGNM_Fast, + 129798: PGNM_Fast, + 129799: PGNM_Fast, + 129800: PGNM_Fast, + 129801: PGNM_Fast, + 129802: PGNM_Fast, + 129803: PGNM_Fast, + 129804: PGNM_Fast, + 129805: PGNM_Fast, + 129806: PGNM_Fast, + 129807: PGNM_Fast, + 129808: PGNM_Fast, + 129808: PGNM_Fast, + 129809: PGNM_Fast, + 129810: PGNM_Fast, + 130052: PGNM_Fast, + 130053: PGNM_Fast, + 130054: PGNM_Fast, + 130060: PGNM_Fast, + 130061: PGNM_Fast, + 130064: PGNM_Fast, + 130065: PGNM_Fast, + 130066: PGNM_Fast, + 130067: PGNM_Fast, + 130068: PGNM_Fast, + 130069: PGNM_Fast, + 130070: PGNM_Fast, + 130071: PGNM_Fast, + 130072: PGNM_Fast, + 130073: PGNM_Fast, + 130074: PGNM_Fast, + 130306: PGNM_Single, + 130310: PGNM_Single, + 130311: PGNM_Single, + 130312: PGNM_Single, + 130313: PGNM_Single, + 130314: PGNM_Single, + 130315: PGNM_Single, + 130316: PGNM_Single, + 130320: PGNM_Fast, + 130321: PGNM_Fast, + 130322: PGNM_Fast, + 130323: PGNM_Fast, + 130324: PGNM_Fast, + 130330: PGNM_Fast, + 130560: PGNM_Single, + 130561: PGNM_Fast, + 130562: PGNM_Fast, + 130563: PGNM_Fast, + 130564: PGNM_Fast, + 130565: PGNM_Fast, + 130566: PGNM_Fast, + 130567: PGNM_Fast, + 130569: PGNM_Fast, + 130570: PGNM_Fast, + 130571: PGNM_Fast, + 130572: PGNM_Fast, + 130573: PGNM_Fast, + 130574: PGNM_Fast, + 130576: PGNM_Single, + 130577: PGNM_Fast, + 130578: PGNM_Fast, + 130579: PGNM_Single, + 130580: PGNM_Fast, + 130581: PGNM_Fast, + 130582: PGNM_Single, + 130583: PGNM_Fast, + 130584: PGNM_Fast, + 130585: PGNM_Single, + 130586: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130816: PGNM_Fast, + 130817: PGNM_Fast, + 130817: PGNM_Fast, + 130818: PGNM_Fast, + 130819: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130820: PGNM_Fast, + 130821: PGNM_Fast, + 130821: PGNM_Fast, + 130822: PGNM_Fast, + 130823: PGNM_Fast, + 130824: PGNM_Fast, + 130824: PGNM_Fast, + 130825: PGNM_Fast, + 130827: PGNM_Fast, + 130828: PGNM_Fast, + 130831: PGNM_Fast, + 130832: PGNM_Fast, + 130833: PGNM_Fast, + 130834: PGNM_Fast, + 130835: PGNM_Fast, + 130836: PGNM_Fast, + 130836: PGNM_Fast, + 130837: PGNM_Fast, + 130837: PGNM_Fast, + 130838: PGNM_Fast, + 130839: PGNM_Fast, + 130840: PGNM_Fast, + 130842: PGNM_Fast, + 130842: PGNM_Fast, + 130842: PGNM_Fast, + 130843: PGNM_Fast, + 130843: PGNM_Fast, + 130845: PGNM_Fast, + 130845: PGNM_Fast, + 130846: PGNM_Fast, + 130846: PGNM_Fast, + 130847: PGNM_Fast, + 130850: PGNM_Fast, + 130850: PGNM_Fast, + 130850: PGNM_Fast, + 130851: PGNM_Fast, + 130856: PGNM_Fast, + 130860: PGNM_Fast, + 130880: PGNM_Fast, + 130881: PGNM_Fast, + 130944: PGNM_Fast, + + } + + + + +def logError(fmt,*args,keep=False): + print("ERROR:" +fmt%(args),file=sys.stderr) + if not keep: + sys.exit(1) + +def dataToSep(data,maxbytes=None): + pd=None + dl=int(len(data)/2) + if maxbytes is not None and maxbytes < dl: + dl=maxbytes + for p in range(0,dl): + i=2*p + if pd is None: + pd=data[i:i+2] + else: + pd+=","+data[i:i+2] + return pd +class Format: + F_PLAIN=0 + N_PLAIN='plain' + F_ACT=1 + N_ACT='actisense' + F_PASS=2 + N_PASS='pass' + F_SEASMART=3 + N_SEASMART="seasmart" + def __init__(self,name,key,merge=True): + self.key=key + self.name=name + self.merge=merge + +class CanFrame: + DUMP_PAT=re.compile(r'\(([^)]*)\) *([^ ]*) *([^#]*)#(.*)') + + def __init__(self,ts,pgn,src=1,dst=255,prio=1,dev=None,hdr=None,data=None): + self.pgn=pgn + self.mode=PGN_MODES.get(pgn) + self.ts=ts + self.src=src + self.dst=dst + self.data=data + self.prio=prio + self.sequence=None + self.frame=None + self.len=8 + self.dev=dev + self.hdr=hdr + if self.mode == PGNM_Fast and data is not None and len(self.data) >= 2: + fb=int(data[0:2],16) + self.frame=fb & 0x1f + self.sequence=fb >> 5 + + def key(self): + if self.sequence is None or self.pgn == 0: + return None + return f"{self.pgn}-{self.sequence}-{self.src}" + def getFPNum(self,bytes=False): + if self.frame != 0: + return None + if len(self.data) < 4: + return None + numbytes=int(self.data[2:4],16) + if bytes: + return numbytes + frames=int((numbytes-6-1)/7)+1+1 if numbytes > 6 else 1 + return frames + + def _formatTs(self): + dt=datetime.datetime.fromtimestamp(self.ts,tz=datetime.UTC) + return dt.strftime("%F-%T.")+dt.strftime("%f")[0:3] + + def __str__(self): + return f"{self._formatTs()},{self.prio},{self.pgn},{self.src},{self.dst},{self.len},{dataToSep(self.data)}" + + def printOut(self,format:Format): + if format.key == Format.F_PASS: + return f"({self.ts:.6f}) {self.dev} {self.hdr}#{self.data}" + else: + return str(self) + + + @classmethod + def fromDump(cls,line:str): + '''(1658058069.867835) can0 09F80103#ACAF6C20B79AAC06''' + if line is None or line == '': + return None + match=cls.DUMP_PAT.search(line) + if match is None: + logError("no dump pattern in line %s",line,keep=True) + return + ts=match[1] + data=match[4] + hdr=match[3] + hdrval=int(hdr,16) + #see candump2analyzer + src=hdrval & 0xff + prio=(hdrval >> 26) & 0x7 + PF=(hdrval >> 16) & 0xff + PS=(hdrval >> 8) & 0xff + RDP=(hdrval >> 24) & 3 + pgn=0 + if PF < 240: + dst=PS + pgn=(RDP << 16) + (PF << 8) + else: + dst=0xff + pgn=(RDP << 16) + (PF << 8)+PS + return CanFrame(float(ts),pgn,src=src,dst=dst,prio=prio,data=data,dev=match[2],hdr=hdr) + +class MultiFrame(CanFrame): + def __init__(self,firstFrame: CanFrame): + super().__init__(firstFrame.ts,firstFrame.pgn, + src=firstFrame.src,dst=firstFrame.dst,prio=firstFrame.prio, + dev=firstFrame.dev,hdr=firstFrame.hdr) + self.data="" + self.numFrames=firstFrame.getFPNum(bytes=False) + self.len=firstFrame.getFPNum(bytes=True) + self.finished=False + self.addFrame(firstFrame) + + def addFrame(self,frame:CanFrame): + if self.finished: + return False + if frame.frame is None: + return False + if frame.frame == 0: + self.data+=frame.data[4:] + else: + self.data+=frame.data[2:] + if frame.frame >= (self.numFrames-1): + self.finished=True + return True + + def __str__(self): + return f"{self._formatTs()},{self.prio},{self.pgn},{self.src},{self.dst},{self.len},{dataToSep(self.data,self.len)}" + +def usage(): + print(f"usage: {sys.argv[0]} [-q] [-p pgn,pgn,...] [-w waitsec] [ -f plain|actisense] file",file=sys.stderr) + sys.exit(1) + + + + +FORMATS=[ + Format(Format.N_PLAIN,Format.F_PLAIN), + Format(Format.N_ACT,Format.F_ACT), + Format(Format.N_PASS,Format.F_PASS,False), + Format(Format.N_SEASMART,Format.F_SEASMART) +] + +MAX_ACT=400 +ACT_ESC=0x10 +ACT_START=0x2 +ACT_N2K=0x93 +ACT_END=0x3 + +class ActBuffer: + def __init__(self): + self.buf=bytearray(MAX_ACT) + self.sum=0 + self.idx=0 + self.clear() + def clear(self): + self.sum=0 + self.idx=2 + self.buf[0:2]=(ACT_ESC,ACT_START) + def add(self,val): + #TODO: len check? + val=val & 0xff + self.buf[self.idx]=val + self.sum = (self.sum + val) & 0xff + self.idx+=1 + if val == ACT_ESC: + self.buf[self.idx]=ACT_ESC + self.idx+=1 + def finalize(self): + self.sum=self.sum % 256 + self.sum = 256 - self.sum if self.sum != 0 else 0 + self.add(self.sum) + self.buf[self.idx]=ACT_ESC + self.idx+=1 + self.buf[self.idx]=ACT_END + self.idx+=1 + +actBuffer=ActBuffer() + + +LB=b'0000000000000' +B_STAR=0x2a +class SeasmartBuffer: + def __init__(self): + self.buf=bytearray(500) + self.idx=0 + self.clear() + def clear(self): + self.idx=0 + def addB(self,bv,mlen=None): + l=len(bv) + if mlen is not None and mlen < l: + l=mlen + self.buf[self.idx:self.idx+l]=memoryview(bv)[0:l] + else: + self.buf[self.idx:self.idx+l]=bv + self.idx+=l + def addVal(self,val,blen=2): + hs=hex(val)[2:].encode() + if len(hs) != blen: + hs=(LB+hs)[-blen:] + self.addB(hs) + + def finalize(self): + sum=0 + self.buf[self.idx]=B_STAR + self.idx+=1 + for b in memoryview(self.buf)[1:]: + if b == B_STAR: + break + sum ^= b + sum = sum & 0xff + self.addVal(sum) + self.addB(b'\x0d\x0a') + +seasmartBuffer=SeasmartBuffer() + +def send_act(frame_like:CanFrame,quiet,stream): + try: + actBuffer.clear() + actBuffer.add(ACT_N2K) + actBuffer.add(frame_like.len+11) + actBuffer.add(frame_like.prio) + pgn=frame_like.pgn + actBuffer.add(pgn) + pgn = pgn >> 8 + actBuffer.add(pgn) + pgn = pgn >> 8; + actBuffer.add(pgn) + actBuffer.add(frame_like.dst) + actBuffer.add(frame_like.src) + #Time + ts=int(frame_like.ts) + actBuffer.add(ts>>24) + actBuffer.add(ts>>16) + actBuffer.add(ts>>8) + actBuffer.add(ts) + + actBuffer.add(frame_like.len) + for i in range(0,frame_like.len*2,2): + actBuffer.add(int(frame_like.data[i:i+2],16)) + actBuffer.finalize() + written=stream.write(memoryview(actBuffer.buf)[0:actBuffer.idx]) + if (written != actBuffer.idx): + if not quiet: + logError(f"actisense not all bytes written {written}/{actBuffer.idx} for pgn={frame_like.pgn} ts={frame_like.ts}",keep=True) + stream.flush() + return True + except Exception as e: + if not quiet: + print(f"Error writing actisense for pgn {frame_like.pgn}, idx={actBuffer.idx}: {e}",file=sys.stderr) + return False + +BK=b',' +def send_seasmart(frame_like:CanFrame,quiet,stream): + try: + seasmartBuffer.clear() + seasmartBuffer.addB(b'$PCDIN,') + seasmartBuffer.addVal(frame_like.pgn,6) + seasmartBuffer.addB(BK) + seasmartBuffer.addVal(int(frame_like.ts),8) + seasmartBuffer.addB(BK) + seasmartBuffer.addVal(frame_like.src) + seasmartBuffer.addB(BK) + seasmartBuffer.addB(frame_like.data.encode(),mlen=frame_like.len*2) + seasmartBuffer.finalize() + written=stream.write(memoryview(seasmartBuffer.buf)[0:seasmartBuffer.idx]) + if (written != seasmartBuffer.idx): + if not quiet: + raise Exception(f"seasmart not all bytes written {written}/{seasmartBuffer.idx} for pgn={frame_like.pgn} ts={frame_like.ts}") + stream.flush() + return True + except Exception as e: + if not quiet: + logError(f"writing seasmart for pgn {frame_like.pgn}, idx={seasmartBuffer.idx}: {e}",keep=True) + return False + +class Counters: + C_OK=1 + C_FAIL=2 + C_FRAME=3 + TITLES={ + C_OK:'OK', + C_FAIL:'FAIL', + C_FRAME:'FRAMES' + } + def __init__(self): + self.counters={} + for i in self.TITLES.keys(): + self.counters[i]=0 + def add(self,idx:int): + if idx not in self.TITLES.keys(): + return + self.counters[idx]+=1 + def __str__(self): + rt=None + for i in self.TITLES.keys(): + v=f"{self.TITLES[i]}:{self.counters[i]}" + if rt is None: + rt=v + else: + rt+=","+v + return rt + +def writeOut(frame:CanFrame,format:Format,quiet:bool,counters:Counters): + rt=False + if format.key == Format.F_ACT: + rt= send_act(frame,quiet,sys.stdout.buffer) + elif format.key == Format.F_SEASMART: + rt= send_seasmart(frame,quiet,sys.stdout.buffer) + else: + print(frame.printOut(format)) + rt=True + counters.add(Counters.C_OK if rt else Counters.C_FAIL) + return rt + +def findFormat(name:str)->Format: + for f in FORMATS: + if f.name == name: + return f + return None + +if __name__ == '__main__': + try: + opts,args=getopt.getopt(sys.argv[1:],"hp:qw:f:") + except getopt.GetoptError as e: + logError(e) + pgnlist=[] + quiet=False + delay=0.0 + format=findFormat(Format.N_PLAIN) + for o,a in opts: + if o == '-h': + usage() + elif o == '-q': + quiet=True + elif o == '-p': + pgns=(int(x) for x in a.split(",")) + pgnlist.extend(pgns) + elif o == '-w': + delay=float(a) + elif o == '-f': + format=findFormat(a) + if format is None: + logError(f"invalid format {a}, allowed {','.join(x.name for x in FORMATS)}") + if len(args) < 1: + usage() + hasFilter=len(pgnlist) > 0 + if not quiet and hasFilter: + print(f"PGNs: {','.join(str(x) for x in pgnlist)}",file=sys.stderr) + counters=Counters() + with open (args[0],"r") as fh: + buffer={} + lnr=0 + for line in fh: + lnr+=1 + frame=CanFrame.fromDump(line) + if frame is None: + continue + if hasFilter and not frame.pgn in pgnlist: + continue + counters.add(Counters.C_FRAME) + if frame.sequence is None or not format.merge: + writeOut(frame,format,quiet,counters=counters) + if delay > 0: + time.sleep(delay) + else: + key=frame.key() + mf=buffer.get(key) + mustDelete=False + if mf is None: + if frame.frame != 0: + if not quiet: + print(f"floating multi frame in line {lnr}: {frame}",file=sys.stderr) + continue + mf=MultiFrame(frame) + if not mf.finished: + buffer[key]=mf + else: + mf.addFrame(frame) + mustDelete=True + if mf.finished: + writeOut(mf,format,quiet,counters=counters) + if mustDelete: + del buffer[key] + if delay > 0: + time.sleep(delay) + if not quiet: + print(f"STATISTICS: {counters}",file=sys.stderr) + \ No newline at end of file diff --git a/webinstall/build.yaml b/webinstall/build.yaml index 0fcca66..0234010 100644 --- a/webinstall/build.yaml +++ b/webinstall/build.yaml @@ -53,16 +53,16 @@ types: - value: M5_ENV3#grv# key: true resource: qmp69881#grv#1,sht3x#grv#1 -# - label: "M5 ENV4" -# type: checkbox -# key: m5env4#grv# -# target: define -# url: "https://docs.m5stack.com/en/unit/ENV%E2%85%A3%20Unit" -# description: "M5 sensor module temperature, humidity, pressure" -# values: -# - value: M5_ENV4#grv# -# key: true -# resource: bmp280#grv#1,sht3x#grv#1 + - label: "M5 ENV4" + type: checkbox + key: m5env4#grv# + target: define + url: "https://docs.m5stack.com/en/unit/ENV%E2%85%A3%20Unit" + description: "M5 sensor module temperature, humidity, pressure" + values: + - value: M5_ENV4#grv# + key: true + resource: bmp280#grv#1,sht4x#grv#1 - type: checkbox label: SHT3X-1 description: "SHT30 temperature and humidity sensor 0x44" @@ -179,6 +179,11 @@ types: description: "M5 Gps Unit" url: "https://docs.m5stack.com/en/unit/gps" resource: serial + - label: "Gps Unit v1.1" + value: M5_GPSV11_UNIT#grv# + description: "M5 Gps Unit v1.1" + url: "https://docs.m5stack.com/en/unit/Unit-GPS%20v1.1" + resource: serial - label: "RS232/RS422" value: SERIAL_GROOVE_232#grv# description: "Generic RS232/RS422 Unit (bidirectional)" @@ -234,6 +239,46 @@ types: - 37 - 38 + - &gpiopinvs3 + - {label: unset,value:} + - {label: "0: boot mode control",value: 0} + - 1 + - 2 + - {label: "3: JTAG control", value: 3} + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + - 11 + - 12 + - 13 + - 14 + - 17 + - 18 + - 19 + - 20 + - 21 + - 33 + - 34 + - 35 + - 36 + - 37 + - 38 + - 39 + - 40 + - 41 + - 42 + - 43 + - 44 + - {label: "45: strapping pin", value: 45} + - {label: "46: strapping pin", value: 46} + - 47 + - 48 + + - &gpioinput type: dropdown resource: "gpio:" @@ -275,12 +320,39 @@ types: - &protogpio - {label: unset,value:} - - PPIN19 - - PPIN21 - - PPIN22 - - PPIN23 - - PPIN25 - - PPIN33 + - {label: "PPIN19(left-2,gpio 19)", value: PPIN19} + - {label: "PPIN21(right-1,gpio 21)", value: PPIN21} + - {label: "PPIN22(left-1,gpio 22)", value: PPIN22} + - {label: "PPIN23(left-3,gpio 23)", value: PPIN23} + - {label: "PPIN25(right-2,gpio 25)", value: PPIN25} + - {label: "PPIN33(left-4,gpio 33)", value: PPIN33} + + - &protogpios3 + - {label: unset,value:} + - {label: "PPIN19(left-2,gpio 6)", value: PPIN19} + - {label: "PPIN21(right-1,gpio 39)", value: PPIN21} + - {label: "PPIN22(left-1,gpio 5)", value: PPIN22} + - {label: "PPIN23(left-3,gpio 7)", value: PPIN23} + - {label: "PPIN25(right-2,gpio 38)", value: PPIN25} + - {label: "PPIN33(left-4,gpio 8)", value: PPIN33} + + - &baudselect + type: dropdown + help: 'Select the baud rate' + values: + - {label: unset,value:} + - 1200 + - 2400 + - 4800 + - 9600 + - 14400 + - 19200 + - 28800 + - 38400 + - 57600 + - 115200 + - 230400 + - 460800 - &serialRX <<: *gpioinput @@ -294,6 +366,33 @@ types: help: 'number of the GPIO pin for the transmit function' target: "define:#serial#TX" mandatory: true + - &serialEnablePin + <<: *gpiopin + key: ENA + label: "enable pin" + help: "GPIO pin for output enable" + target: "define:#serial#ENA" + mandatory: false + - &serialEnableLow + type: checkbox + key: ELOW + label: "enable low" + target: "define:#serial#ELO" + default: false + help: "set: low on enable pin for output, unset: high on enable pin for output" + values: + - key: true + value: 1 + - key: false + value: 0 + + - &serialFixedBaud + <<: *baudselect + key: fixedBaud + label: "fixed baud" + help: "you can set a fixed baud rate here, this disables changing the baud rate in the UI" + target: "define:#serial#BAUD" + - &serialValues - key: true children: @@ -310,6 +409,9 @@ types: children: - *serialRX - *serialTX + - *serialEnablePin + - *serialEnableLow + - *serialFixedBaud - key: bi value: 2 label: "BiDir" @@ -318,18 +420,25 @@ types: children: - *serialRX - *serialTX + - *serialFixedBaud - key: rx value: 3 label: "RX" description: "Input only" children: - *serialRX + - *serialEnablePin + - *serialEnableLow + - *serialFixedBaud - key: tx value: 1 label: "TX" description: "output only" children: - *serialTX + - *serialEnablePin + - *serialEnableLow + - *serialFixedBaud - &serial1 type: checkbox label: 'Serial 1' @@ -664,13 +773,18 @@ types: label: "Gps Base" url: "https://docs.m5stack.com/en/atom/atomicgps" resource: serial + - value: M5_GPSV2_KIT + description: "M5 Stack Gps Base v2.0" + label: "Gps Base" + url: "https://docs.m5stack.com/en/atom/Atomic_GPS_Base_v2.0" + resource: serial - value: M5_PROTO_HUB description: "M5 Stack HUB PROTO" url: "https://docs.m5stack.com/en/atom/atomhub" label: "Hub Proto" base: - gpioinputv: *protogpio - gpiopinv: *protogpio + gpioinputv: "#protogpio#" + gpiopinv: "#protogpio#" children: *m5protochildren - value: M5_PORTABC @@ -689,6 +803,13 @@ resources: config: children: + - type: string + label: 'Build Name' + key: buildname + target: "define:GWBUILD_NAME" + help: "Set a name to identify your build. Will also become the name for the generated files and the firmware type in the image. Max 31 characters." + max: 31 + allowed: "0-9A-Za-z_-" - type: select target: environment label: 'Board' @@ -697,6 +818,7 @@ config: gpiopinv: *gpiopinv gpioinputv: *gpioinputv grv: "" + protogpio: *protogpio values: - value: m5stack-atom-generic label: m5stack-atom @@ -711,6 +833,8 @@ config: description: "M5 Stack AtomS3 light" url: "http://docs.m5stack.com/en/core/AtomS3%20Lite" resource: *esp32default + base: + protogpio: *protogpios3 children: - *m5base - *m5groove @@ -725,7 +849,7 @@ config: - value: nodemcu-generic label: nodemcu - description: "Node mcu esp32" + description: "Node mcu esp32,4MB flash, no PSRAM" url: "https://docs.platformio.org/en/stable/boards/espressif32/nodemcu-32s.html" resource: *esp32default children: @@ -746,6 +870,38 @@ config: base: busname: "1" bus: "1" + - <<: *spisensors + base: + busname: "2" + bus: "2" + + - value: s3devkitm-generic + label: s3devkitm + description: "esp32 s3 generic, 8MB flash, no PSRAM " + url: "https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/hw-reference/esp32s3/user-guide-devkitm-1.html" + resource: *esp32default + base: + gpiopinv: *gpiopinvs3 + gpioinputv: *gpiopinvs3 + protogpio: *protogpios3 + children: + - *serial1 + - *serial2 + - *can + - *resetButton + - *led + - <<: *iicsensors + base: + busname: "1" + bus: "" + - <<: *iicsensors + base: + busname: "2" + bus: "2" + - <<: *spisensors + base: + busname: "1" + bus: "1" - <<: *spisensors base: busname: "2" diff --git a/webinstall/cibuild.js b/webinstall/cibuild.js index 690da1d..285bacc 100644 --- a/webinstall/cibuild.js +++ b/webinstall/cibuild.js @@ -167,8 +167,17 @@ class PipelineInfo{ updateStatus(); if (gitSha !== undefined) param.tag=gitSha; param.config=JSON.stringify(config); + let buildname=config['root:buildname'] + if (buildname){ + param.suffix="-"+buildname + } if (buildVersion !== undefined){ - param.suffix="-"+buildVersion; + if (param.suffix){ + param.suffix+="-"+buildVersion; + } + else{ + param.suffix="-"+buildVersion; + } } fetchJson(API,Object.assign({ api:'start'},param)) @@ -234,7 +243,11 @@ class PipelineInfo{ } const downloadConfig=()=>{ let name=configName; - if (isModified) name=name.replace(/[0-9]*$/,'')+formatDate(undefined,true); + const buildname=config["root:buildname"] + if (buildname && name != buildname){ + name+="-"+buildname+"-"; + } + name=name.replace(/[0-9]*$/,'')+formatDate(undefined,true); name+=".json"; fileDownload(JSON.stringify(config),name); } @@ -521,6 +534,38 @@ class PipelineInfo{ addDescription(config,inputFrame); initialConfig=expandedValues[0]; } + if (config.type === 'string'){ + let ip=addEl('input','t'+config.type,inputFrame); + addDescription(config,inputFrame); + const buildChild=(value)=>{ + if (value) { + if (config.max) { + if (value && value.length > config.max) { + value = value.substring(0, config.max); + } + } + if (config.allowed) { + let check = new RegExp("[^" + config.allowed + "]", "g"); + let nv = value.replace(check, ""); + if (nv != value) { + value = nv; + } + } + } + return Object.assign({},config,{key: value,value:value}); + } + initialConfig=buildChild(current); + ip.value=initialConfig.value||""; + ip.addEventListener('change',(ev)=>{ + let value=ev.target.value; + let cbv=buildChild(value); + if (cbv.value != value){ + ev.target.value=cbv.value; + } + callback(cbv,false); + + }); + } let childFrame=addEl('div','childFrame',frame); if (initialConfig !== undefined){ callback(initialConfig,true,childFrame); diff --git a/webinstall/config/m5stack-atom-gps_v2-canunit.json b/webinstall/config/m5stack-atom-gps_v2-canunit.json new file mode 100644 index 0000000..e7f13be --- /dev/null +++ b/webinstall/config/m5stack-atom-gps_v2-canunit.json @@ -0,0 +1 @@ +{"root:board":"m5stack-atom-generic","root:board:m5lightbase":"M5_GPSV2_KIT","root:board:m5groove":"CAN","root:board:m5groove:m5groovecan":"M5_CANUNIT"}