ESPNode
base_generic.h
Go to the documentation of this file.
1 #ifndef _BASE_GENERIC_H_
2 #define _BASE_GENERIC_H_
3 #include <Arduino.h>
12 class Base_Generic {
13 public:
18  Base_Generic(void);
19 
26  void begin(const char* _html_place, const char* _label);
27 
35  void begin(const char* _html_place, const char* _label, const char* _mqtt_name);
36 
45  void begin(const char* _html_place, const char* _label, const char* _mqtt_name, const char* _keyword);
46 
52  void loop(time_t now);
53 
61  bool set(const String& _keyword, const String& _value);
62 
68  bool keyword_match(const String& _keyword);
69 
77  void html_update();
78 
85  void html_init();
86 
87  //----------------Variablen---------------
88 
92  String keyword;
93 
97  String html_place;
98 
102  String label;
103 
108  bool is_state = false;
109 
113  String state;
114 
115  // HTML Support
116 
120  bool html_has_info = false;
121 
128  String html_info;
129 
135  String html_json;
136 
141  bool html_json_filled = false;
142 
143  // MQTT Support
144 
148  bool mqtt_has_info = false;
149 
153  String mqtt_info;
154 
159  bool mqtt_stat_changed = false;
160 
164  bool mqtt_has_stat = false;
165 
172  String mqtt_stat;
173 
177  String mqtt_name;
178 
179 };
180 
181 #endif
Ein generisches Objekt für einen Sensor/Actor. Achtung: Nicht zum Einbau bestimmt,...
Definition: base_generic.h:12
String mqtt_name
Die Bezeichnung für den ersten Wert.
Definition: base_generic.h:177
bool set(const String &_keyword, const String &_value)
Der Komandointerpreter. Hier als leere Funktion implementiert, kann im abgeleiteten Objekt gefüllt we...
Definition: base_generic.cpp:33
String state
Der aktuelle State des Nodes wird hier abgelegt (nur wenn dieses Modul den State setzt)
Definition: base_generic.h:113
bool mqtt_stat_changed
Schalter ob "obj_mqtt_state" verändert worden ist und neu (=true) übertragen werden soll....
Definition: base_generic.h:159
bool is_state
Ein Schalter der angibt ob der Nodestatus aus diesem Modul genommen wird. Macht nur Sinn bei einem Sc...
Definition: base_generic.h:108
String html_info
Systeminformationen zum Sensor für die Webseite als json abgespeichert. Dieser String muss durch das ...
Definition: base_generic.h:128
String label
Eine Beschriftung für die Webseite. Wird sie gesetzt, wird sie auch als Schlüsselwort genutzt.
Definition: base_generic.h:102
bool mqtt_has_stat
In der abgeleiteten Klasse wird hier auf "true" gesetzt wenn dieses Modul Statusdaten bereitstellt.
Definition: base_generic.h:164
void loop(time_t now)
Eine Funktion die im Hauptprogramm im loop regelmäßig aufgerufen wird. Hier als leere Funktion implem...
Definition: base_generic.cpp:30
bool html_json_filled
Schalter: Wird wahr wenn html_json gefüllt ist. Die Rücksetzung des Schalters erfolgt durch das Haupt...
Definition: base_generic.h:141
void html_init()
Initialisierung einer Webseite Wenn sich ein Browser verbindet und die Webseite des Nodes aufruft,...
Definition: base_generic.cpp:50
String mqtt_info
Sollte es in diesem Modul telemetrieähnliche Daten geben, werden diese hier als Teil-JSON eingetragen...
Definition: base_generic.h:153
String mqtt_stat
Der MQTT Status Dieser String muss durch das abgeleitete Objekt gefüllt werden. Dabei gilt für jeden ...
Definition: base_generic.h:172
String html_place
Der Einbauort für diesen Sensor/Actor, dient auch als Schlüsselwort wenn die Änderung durch die Webse...
Definition: base_generic.h:97
String keyword
Das gespeicherte Schlüsselword für diesen Sensor/Actor.
Definition: base_generic.h:92
bool html_has_info
In der abgeleiteten Klasse wird hier auf "true" gesetzt wenn dieses Modul Daten für die Seite "System...
Definition: base_generic.h:120
Base_Generic(void)
Der Initiator. Hier werden alle Variablen auf ihre Anfangswerte gesetzt.
Definition: base_generic.cpp:4
void begin(const char *_html_place, const char *_label)
Legt die Startkonfiguration des Sensors fest. Die übergebenen Variabelen werden in die entsprechenden...
Definition: base_generic.cpp:9
bool keyword_match(const String &_keyword)
Prüft ob das übergebene keyword dem hinterlegten keyword entspricht.
Definition: base_generic.cpp:37
void html_update()
Sendet ein Zustandsupdate an den Webbrowser. Sendet alle benötigten Daten um eine Zustandsänderung au...
Definition: base_generic.cpp:45
bool mqtt_has_info
In der abgeleiteten Klasse wird hier auf "true" gesetzt wenn dieses Modul Telemetriedaten bereitstell...
Definition: base_generic.h:148
String html_json
Informationen zum Sensor für die Webseite als json abgespeichert; Dieser String muss durch das abgele...
Definition: base_generic.h:135
time_t now
Eine Variable für Zeitinformationen.
Definition: main.h:115