CommandCatcher.h

Go to the documentation of this file.

#include "Arduino.h"
#include <stdint.h>
#include <avr/pgmspace.h>
#ifndef CommandCatcher_h
#define CommandCatcher_h


class CommandListener {
public:
  virtual ~CommandListener() = default;
  
  virtual void notify(char* cmd, char* param);
};
 
 
class CommandCatcher {
public:
  
   typedef void (*CCListener)(char*, char*);

  CommandCatcher();

  void init(Stream& serial=Serial, uint8_t bufsize=16);
  
  void update(bool close=true);

  void addListener(CCListener myListener);

  void addListener(CommandListener* obj);

  void setTerminator(char term);

  void setSeparator(char sep);

  void close();

  bool ready();

  char* getCommand();

  char* getParameter();
 
  
private:
  Stream& ser = Serial;
  bool initialized = false;
 
  char*   buffer = NULL;
  uint8_t buflen = 0;
  uint8_t reclen = 0;
  uint8_t cmdlen = 0;
  bool    cmdrdy = false;
  bool    overrun = false;
  
  char  terminator = '\n';
  char  separator = ' ';
  
  class FListener : public CommandListener {
  public:
    FListener(void method(char*, char*)) : method(method) {}
 
    void notify(char* cmd, char* param) override {
      method(cmd, param);
    }
  private:
    void (*method)(char*, char*);
  };
  
  static const uint8_t    maxListeners = 4;
  CommandListener*        listeners[maxListeners];
  uint8_t                 numListeners = 0;
  
  // returns true if command is available
  bool updateBuffer();
  void notifyListeners();
};
 
// global command catcher object for convenience
extern CommandCatcher CCatcher;
 
// **********************
#endif