rbxii3/firmware
1
0
Fork 0
mirror of https://github.com/meshtastic/firmware.git synced 2025-12-23 03:00:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

add more documentaiton

Browse Source
This commit is contained in:
Jm Casler
2023-07-26 16:48:04 -07:00
committed by Thomas Göttgens
parent 641d117106
commit e9cbe54eca
5 changed files with 93 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
src/memGet.cpp
View File

@@ -1,8 +1,21 @@
/**
* @file memGet.cpp
* @brief Implementation of MemGet class that provides functions to get memory information.
*
* This file contains the implementation of MemGet class that provides functions to get
* information about free heap, heap size, free psram and psram size. The functions are
* implemented for ESP32 and NRF52 architectures. If the platform does not have heap
* management function implemented, the functions return UINT32_MAX or 0.
*/
#include "memGet.h"
#include "configuration.h"
MemGet memGet;
/**
* Returns the amount of free heap memory in bytes.
* @return uint32_t The amount of free heap memory in bytes.
*/
uint32_t MemGet::getFreeHeap()
{
#ifdef ARCH_ESP32
@@ -15,6 +28,10 @@ uint32_t MemGet::getFreeHeap()
#endif
}
/**
* Returns the size of the heap memory in bytes.
* @return uint32_t The size of the heap memory in bytes.
*/
uint32_t MemGet::getHeapSize()
{
#ifdef ARCH_ESP32
@@ -27,6 +44,11 @@ uint32_t MemGet::getHeapSize()
#endif
}
/**
* Returns the amount of free psram memory in bytes.
*
* @return The amount of free psram memory in bytes.
*/
uint32_t MemGet::getFreePsram()
{
#ifdef ARCH_ESP32
@@ -36,6 +58,11 @@ uint32_t MemGet::getFreePsram()
#endif
}
/**
* @brief Returns the size of the PSRAM memory.
*
* @return uint32_t The size of the PSRAM memory.
*/
uint32_t MemGet::getPsramSize()
{
#ifdef ARCH_ESP32