sys.h File Reference

Header file for system utilities in Rishka applications. More...

#include <librishka/types.h>

Go to the source code of this file.

Classes
class	Sys
	Class for handling system utilities in Rishka applications. More...

Enumerations
enum	sysinfon_t {   SYSINFO_CHIPCORES , SYSINFO_CHIP_REV , SYSINFO_CPU_FREQ , SYSINFO_CYCLE_COUNT ,   SYSINFO_EFUSE_MAC , SYSINFO_FLASH_MODE , SYSINFO_FLASH_SPEED , SYSINFO_FREE_HEAP ,   SYSINFO_FREE_PSRAM , SYSINFO_HEAP_SIZE , SYSINFO_MAX_ALLOC_HEAP , SYSINFO_MIN_FREE_HEAP ,   SYSINFO_MIN_FREE_PSRAM , SYSINFO_PSRAM_SIZE , SYSINFO_TEMP_VAL , SYSINFO_CARD_TYPE ,   SYSINFO_CARD_SIZE , SYSINFO_NUM_SECTORS , SYSINFO_SECTOR_SIZE , SYSINFO_TOTAL_STORAGE ,   SYSINFO_USED_STORAGE }
	Enumeration for system information numeric keys. More...
enum	sysinfos_t { SYSINFO_CHIPMODEL , SYSINFO_SDK_VERSION , SYSINFO_SKETCH_MD5 }
	Enumeration for system information string keys. More...
enum	sdcard_t {   SD_CARD_NONE , SD_CARD_MMC , SD_CARD_SD , SD_CARD_SDHC ,   SD_CARD_UNKNOWN }
	Enumeration for SD card types. More...

Detailed Description

Header file for system utilities in Rishka applications.

Author

Nathanne Isip

This header file defines the Sys class, which provides functionalities for accessing system information and executing system commands on ESP32-WROVER microcontrollers.

Enumeration Type Documentation

sdcard_t

enum sdcard_t

Enumeration for SD card types.

The sdcard_t enumeration defines the types of SD cards supported.

Enumerator
SD_CARD_NONE	No SD card
SD_CARD_MMC	MMC SD card
SD_CARD_SD	Standard SD card
SD_CARD_SDHC	SDHC SD card
SD_CARD_UNKNOWN	Unknown SD card type

sysinfon_t

enum sysinfon_t

Enumeration for system information numeric keys.

The sysinfon_t enumeration defines numeric keys used to retrieve various system information such as chip cores, CPU frequency, memory usage, etc.

Enumerator
SYSINFO_CHIPCORES	Number of CPU cores
SYSINFO_CHIP_REV	Chip revision
SYSINFO_CPU_FREQ	CPU frequency in Hz
SYSINFO_CYCLE_COUNT	CPU cycle count
SYSINFO_EFUSE_MAC	EFUSE MAC address
SYSINFO_FLASH_MODE	Flash mode
SYSINFO_FLASH_SPEED	Flash speed
SYSINFO_FREE_HEAP	Free heap memory
SYSINFO_FREE_PSRAM	Free PSRAM memory
SYSINFO_HEAP_SIZE	Total heap size
SYSINFO_MAX_ALLOC_HEAP	Maximum allocatable heap
SYSINFO_MIN_FREE_HEAP	Minimum free heap
SYSINFO_MIN_FREE_PSRAM	Minimum free PSRAM
SYSINFO_PSRAM_SIZE	Total PSRAM size
SYSINFO_TEMP_VAL	Chip temperature
SYSINFO_CARD_TYPE	SD card type
SYSINFO_CARD_SIZE	SD card size
SYSINFO_NUM_SECTORS	Number of SD card sectors
SYSINFO_SECTOR_SIZE	SD card sector size
SYSINFO_TOTAL_STORAGE	Total storage capacity
SYSINFO_USED_STORAGE	Used storage capacity

sysinfos_t

enum sysinfos_t

Enumeration for system information string keys.

The sysinfos_t enumeration defines string keys used to retrieve various system information such as chip model, SDK version, etc.

Enumerator
SYSINFO_CHIPMODEL	Chip model
SYSINFO_SDK_VERSION	SDK version
SYSINFO_SKETCH_MD5	Sketch MD5 hash