thooge
/
esp32-nmea2000-obp60
mirror of https://github.com/thooge/esp32-nmea2000-obp60.git
1
0
Fork 0
Code Releases Activity

#19: add help tab, allow to set the help URL with the HELP_URL capability

This commit is contained in:
andreas 2022-03-02 11:23:31 +01:00
parent 785ece971e
commit a288959009
5 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
lib/api/GwApi.h
View File

@ -129,4 +129,7 @@ class GwApi{
#ifndef DECLARE_CAPABILITY #ifndef DECLARE_CAPABILITY
#define DECLARE_CAPABILITY(name,value) #define DECLARE_CAPABILITY(name,value)
#endif #endif
#ifndef DECLARE_STRING_CAPABILITY
#define DECLARE_STRING_CAPABILITY(name,value)
#endif
#endif #endif

2
lib/exampletask/GwExampleTask.h
View File

@ -46,4 +46,6 @@ DECLARE_CAPABILITY(testboard2,true);
//hide some config value //hide some config value
//just set HIDE + the name of the config item to true //just set HIDE + the name of the config item to true
DECLARE_CAPABILITY(HIDEminXdrInterval,true); DECLARE_CAPABILITY(HIDEminXdrInterval,true);
DECLARE_STRING_CAPABILITY(HELP_URL,"https://www.wellenvogel.de");
#endif #endif

1
lib/usercode/GwUserCode.cpp
View File

@ -42,6 +42,7 @@ class GwUserCapability{
#define DECLARE_USERTASK_PARAM(task,...) GwUserTaskDef __##task##__(task,#task,__VA_ARGS__); #define DECLARE_USERTASK_PARAM(task,...) GwUserTaskDef __##task##__(task,#task,__VA_ARGS__);
#define DECLARE_INITFUNCTION(task) GwInitTask __Init##task##__(task,#task); #define DECLARE_INITFUNCTION(task) GwInitTask __Init##task##__(task,#task);
#define DECLARE_CAPABILITY(name,value) GwUserCapability __CAP##name##__(#name,#value); #define DECLARE_CAPABILITY(name,value) GwUserCapability __CAP##name##__(#name,#value);
#define DECLARE_STRING_CAPABILITY(name,value) GwUserCapability __CAP##name##__(#name,value);
#include "GwApi.h" #include "GwApi.h"
#include "GwUserTasks.h" #include "GwUserTasks.h"
class TaskApi : public GwApi class TaskApi : public GwApi

1
web/index.html
View File

@ -21,6 +21,7 @@
<div class="tab" data-page="xdrPage">XDR</div> <div class="tab" data-page="xdrPage">XDR</div>
<div class="tab" data-page="dashboardPage">Data</div> <div class="tab" data-page="dashboardPage">Data</div>
<div class="tab" data-page="updatePage">Update</div> <div class="tab" data-page="updatePage">Update</div>
<div class="tab" data-url="https://github.com/wellenvogel/esp32-nmea2000" data-window="help" id="helpButton">Help</div>
</div> </div>
<div id="statusPage" class="tabPage"> <div id="statusPage" class="tabPage">
<div id="statusPageContent"> <div id="statusPageContent">

10
web/index.js
View File

@ -1073,6 +1073,10 @@ function createConfigDefinitions(parent, capabilities, defs,includeXdr) {
function loadConfigDefinitions() { function loadConfigDefinitions() {
getJson("api/capabilities") getJson("api/capabilities")
.then(function (capabilities) { .then(function (capabilities) {
if (capabilities.HELP_URL){
let el=document.getElementById('helpButton');
if (el) el.setAttribute('data-url',capabilities.HELP_URL);
}
getJson("config.json") getJson("config.json")
.then(function (defs) { .then(function (defs) {
getJson("xdrconfig.json") getJson("xdrconfig.json")
@ -1191,7 +1195,11 @@ function converterInfo() {
} }
function handleTab(el) { function handleTab(el) {
let activeName = el.getAttribute('data-page'); let activeName = el.getAttribute('data-page');
if (!activeName) return; if (!activeName) {
let extUrl= el.getAttribute('data-url');
if (! extUrl) return;
window.open(extUrl,el.getAttribute('data-window')||'_');
}
let activeTab = document.getElementById(activeName); let activeTab = document.getElementById(activeName);
if (!activeTab) return; if (!activeTab) return;
let all = document.querySelectorAll('.tabPage'); let all = document.querySelectorAll('.tabPage');