OOKwiz
on/off-keying for ESP32 and a variety of supported radio modules
Classes | Macros
Settings.h File Reference
#include <map>
#include <Arduino.h>
#include "serial_output.h"
#include "config.h"

Go to the source code of this file.

Classes

class  Settings
 

Macros

#define SETTING(name)   Settings::get(#name, name);
 
#define SETTING_WITH_DEFAULT(name, default)   if (!Settings::get(#name, name)) name = default;
 
#define SETTING_OR_ERROR(name)
 
#define MANDATORY(name)
 

Macro Definition Documentation

◆ SETTING

#define SETTING (   name)    Settings::get(#name, name);

Definition at line 10 of file Settings.h.

◆ SETTING_WITH_DEFAULT

#define SETTING_WITH_DEFAULT (   name,
  default 
)    if (!Settings::get(#name, name)) name = default;

Definition at line 14 of file Settings.h.

◆ SETTING_OR_ERROR

#define SETTING_OR_ERROR (   name)
Value:
if (!Settings::get(#name, name)) {\
ERROR("Mandatory setting '%s' missing.\n", #name);\
return false;\
}
static bool get(const String &name, String &value)
Get a value from memory as String.
Definition: Settings.cpp:211

Definition at line 21 of file Settings.h.

◆ MANDATORY

#define MANDATORY (   name)
Value:
if (!Settings::isSet(#name)) {\
ERROR("Mandatory setting '%s' missing.\n", #name);\
return false;\
}
static bool isSet(const String &name)
Find out if a key with given name exists in memory.
Definition: Settings.cpp:180

Definition at line 26 of file Settings.h.