Debug.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * Debug.h
 *
 ****/

#pragma once

#include "HardwareSerial.h"
#include "Clock.h"
#include "WString.h"
#include "Services/CommandProcessing/CommandProcessingIncludes.h"

typedef Delegate<void(char dbgChar)> DebugPrintCharDelegate; 

typedef struct {
    DebugPrintCharDelegate debugDelegate = nullptr; 
    Stream* debugStream = nullptr;                  
} DebugOuputOptions;

typedef enum {
    eDBGnoPrefix = 0, 
    eDBGusePrefix = 1 
} eDBGPrefix;

class DebugClass : public Print
{
public:
    DebugClass();

    void initCommand();

    void start();

    void stop();

    bool status()
    {
        return started;
    }

    void setDebug(DebugPrintCharDelegate reqDelegate);

    void setDebug(Stream& reqStream);

    /* implementation of write for Print Class */
    size_t write(uint8_t) override;

private:
    bool started = false;
    bool useDebugPrefix = true;
    bool newDebugLine = true;
    DebugOuputOptions debugOut;
    void printPrefix();
    void processDebugCommands(String commandLine, CommandOutput* commandOutput);
};

extern DebugClass Debug;