Benutzung


Installation der Library

  • Library herunterladen
  • Installationsanleitung auf Arduino.cc in Deutsch folgen
  • Alternativ: Installationsanleitung auf Arduino.cc in Englisch(etwas umfangreicher) folgen
  • Arduino IDE neu starten
  • Mitgeliefertes microBox Beispiel laden

Shell Kommandos

cat parameter
Der Befehl cat gibt einen Parameter aus.
Beispiel:
    cat /dev/hostname
cd directory
Der Befehl cd wechselt das aktuelle Verzeichnis.
Beispiel:
    cd /dev
echo value > parameter
Der Befehl echo schreibt Werte in Parameter.
Beispiel:
    echo 45.78 > /dev/temp_setpoint
loadpar
Der Befehl loadpar liest zuvor ins EEProm geschriebene Parameterwerte.
ll
Der Befehl ll listet den Inhalt des aktuellen Verzeichnisses in detaillierter Form.
ls
Der Befehl ls listet den Inhalt des aktuellen Verzeichnisses.
savepar
Der Befehl savepar schreibt die Werte aller Parameter ins EEProm.
watch command
Der Befehl watch zeigt zyklisch im 1 sec. Takt die Ausgabe eines Kommandos an.
Beispiel:
    watch cat temperature_act
watchcsv command
Der Befehl watchcsv zeigt zyklisch im 1 sec. Takt die Ausgabe eines Kommandos an und trennt die Ausgaben mit Semikolon.
Beispiel:
    watchcsv cat temperature_act

Library-Funktionen (API)


microBox/microBoxEsp Klasse

Eine Instanz der microBox Klasse steht nach dem Includieren von microbox.h in den Arduino Sketch unter dem Namen microbox zur Verfügung.

void microBox::begin(PARAM_ENTRY *pParams, const char* hostName, bool localEcho=true, char *histBuf=NULL, int historySize=0)
Die Methode begin initialisiert die microBox Library.
Parameter:
  • pParams Zeiger auf Array mit Parametern
  • hostName Name des Hosts zur Anzeige im Command prompt
  • localEcho Echo der eingeben Zeichen
  • histBuf Zeiger auf Puffer für Kommando Historie
  • historySize Länge des Puffers für Kommando Historie
struct PARAM_ENTRY
  • paramName Name des Parameters
  • pParam Zeiger auf den Parameter
  • parType Typ und Zugriffrechte des Parameters: PARTYPE_INT, PARTYPE_DOUBLE oder PARTYPE_STRING sowie PARTYPE_RW oder PARTYPE_RO
  • len Länge des Parameters in Byte (nur für Strings)
  • setFunc Callback wird nach dem Setzen des Parameters aufgerufen
  • getFunc Callback wird vor dem Lesen des Parameters aufgerufen
  • id ID wird den Callbacks übergeben
void microBoxEsp::begin(PARAM_ENTRY *pParams, const char *hostName, const char *loginPassword, char *histBuf = NULL, int historySize=0, HardwareSerial *serial=&Serial)
Die Methode begin initialisiert die microBoxEsp Library mit esp8266 Unterstützung.
Parameter:
  • pParams Zeiger auf Array mit Parametern
  • hostName Name des Hosts zur Anzeige im Kommando prompt
  • loginPassword Password für Login
  • histBuf Zeiger auf Puffer für Kommando Historie
  • historySize Länge des Puffers für Kommando Historie
  • serial Zur verwendende serielle Schnitstelle
void cmdParser()
Die Methode cmdParser muss zyklisch aufgerufen werden, um die microBox Funktionalität zu bekommen.
bool AddCommand(const char *cmdName, void (*cmdFunc)(char **param, uint8_t parCnt))
Die Methode AddCommand fügt microBox ein Benutzer Kommando hinzu.
Parameter:
  • cmdName Name des neuen Kommandos
  • cmdFunc Zeiger auf die Funktion des neuen Kommandos

Esp8266 Klasse

Eine Instanz der Esp8266 Klasse steht nach dem Inkludieren von microbox.h in den Arduino Sketch unter dem Namen esp8266 zur Verfügung.

void ConfigSettings(bool apMode, char *ssid, char *key)
Die Methode ConfigSettings konfiguriert die WLan-Verbindung des esp8266 Moduls. Diese Methode muss nur einmal aufgerufen werden. Das Modul merkt sich auch nach dem Ausschalten die Konfiguration.
Parameter:
  • apMode Modul in AccessPoint Modus oder Station Modus versetzen
  • ssid SSID für AccessPoint
  • key WPA-Key
void print(const __FlashStringHelper *buffer)
Die Methode print sendet einen String aus dem Flash über das esp8266 Modul.
Parameter:
  • buffer Zeiger auf String im Flash
void print(const char *buffer)
Die Methode print sendet einen String über das esp8266 Modul.
Parameter:
  • buffer Zeiger auf String
void print(int val)
Die Methode print sendet einen Integer-wert als String über das esp8266 Modul.
Parameter:
  • val Int der als String gesendet wird
void print(double val, int digits)
Die Methode print sendet einen Double-wert als String über das esp8266 Modul.
Parameter:
  • val Double der als String gesendet wird
  • digits Anzahl Nachkommastellen
void println(const __FlashStringHelper *buffer)
Die Methode println sendet einen String aus dem Flash über das esp8266 Modul mit anschließendem CRLF.
Parameter:
  • buffer Zeiger auf String im Flash
void println(const char *buffer)
Die Methode println sendet einen String über das esp8266 Modul mit anschließendem CRLF.
Parameter:
  • buffer Zeiger auf String
void println()
Die Methode println sendet CRLF über das esp8266 Modul.
void write(const uint8_t *buffer, size_t size)
Die Methode write sendet einen Puffer über das esp8266 Modul.
Parameter:
  • buffer Puffer
  • size Länge des Puffers