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

allow to hide config values by calling setValue

This commit is contained in:
andreas 2023-10-27 21:32:16 +02:00
parent 95d9025f8e
commit 51065acc8d
3 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
lib/config/GWConfig.cpp
View File

@ -120,11 +120,12 @@ int GwConfigHandler::getInt(const String name,int defaultv) const{
void GwConfigHandler::stopChanges(){
allowChanges=false;
}
bool GwConfigHandler::setValue(String name,String value){
bool GwConfigHandler::setValue(String name,String value, bool hide){
if (! allowChanges) return false;
GwConfigInterface *i=getConfigItem(name,false);
if (!i) return false;
i->value=value;
i->type=hide?GwConfigInterface::HIDDEN:GwConfigInterface::READONLY;
return true;
}

2
lib/config/GWConfig.h
View File

@ -36,7 +36,7 @@ class GwConfigHandler: public GwConfigDefinitions{
* will become a noop after stopChanges has been called
* !use with care! no checks of the value
*/
bool setValue(String name, String value);
bool setValue(String name, String value, bool hide=false);
static void toHex(unsigned long v,char *buffer,size_t bsize);
unsigned long getSaltBase(){return saltBase;}
~GwConfigHandler();

19
lib/exampletask/GwExampleTask.cpp
View File

@ -39,8 +39,15 @@ void exampleInit(GwApi *api){
api->addCapability("testboard", "true");
api->addCapability("testboard2", "true");
// hide some config value
// just set HIDE + the name of the config item to true
api->addCapability("HIDEminXdrInterval", "true");
// and force it's default value
auto current=api->getConfig()->getConfigItem(GwConfigDefinitions::minXdrInterval,false);
String defaultXdrInt="50";
if (current){
defaultXdrInt=current->getDefault();
}
//with the true parameter this config value will be hidden
//if you would like the user to be able to see this item, omit the "false", the config value will be read only
api->getConfig()->setValue(GwConfigDefinitions::minXdrInterval,defaultXdrInt,true);
// example for a user defined help url that will be shown when clicking the help button
api->addCapability("HELP_URL", "https://www.wellenvogel.de");
@ -51,14 +58,6 @@ void exampleInit(GwApi *api){
if (!api->taskInterfaces()->claim<ExampleNotWorkingIf>(taskName)){
api->getLogger()->logDebug(GwLog::ERROR,"unable to claim ExampleNotWorkingIf");
}
//this example is a more or less useless example how you could set some
//config value to a fixed value
//you can only set config values within the init function
//you could also compute this value from some own configuration
//for this example it would make a lot of sense to declare a capability
//to hide this config item from the UI - see header file
api->getConfig()->setValue(api->getConfig()->minXdrInterval,"50");
//check if we should simulate some voltage measurements
//add an XDR mapping in this case
String voltageTransducer=api->getConfig()->getString(GwConfigDefinitions::exTransducer);