lvppUtils.h

Go to the documentation of this file.

// Copyright 2023 Robert M. Wolff (bob dot wolff 68 at gmail dot com)
//
// Redistribution and use in source and binary forms, with or without modification, 
// are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this 
// list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, 
// this list of conditions and the following disclaimer in the documentation and/or 
// other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors 
// may be used to endorse or promote products derived from this software without 
// specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
#pragma once
 
#ifdef ESP_PLATFORM
#include "Arduino.h"
#endif
 
#include <vector>
#include <string>
#include <sstream>
#include <iomanip>
 
constexpr uint16_t MAX_SAMPLENAME = 32;
 
typedef struct espRec {
    uint32_t heapFree;
    uint32_t heapSize;
    uint32_t heapLargestBlock;
    uint32_t heapLowWaterMark;
    char sampleName[MAX_SAMPLENAME+1];
} espRec_t;
 
class espSystats {
public:
    espSystats();
    void takeSample(const char* sampName);      // Records current stats.
    void takeSampleAndPrintResults(const char* sampName);
    std::string takeSampleAndGetResults(const char* sampName);
    void printStaticStats();
    std::string getStaticStats();
    void printFullReport();
    std::string getFullReport();
protected:
    void recordSample(const char* sampName); 
    uint32_t cpuFreqMHz;            
    uint32_t sketchFreeSpace;       
    uint32_t sketchSize;            
    std::vector<espRec_t> samples;  
};
 
extern espSystats ESPSystats;