# fboegard/m5_nightscoutmon architecture

> Architecture diagram of the GitHub repository fboegard/m5_nightscoutmon, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/fboegard/m5_nightscoutmon
- Repository: https://github.com/fboegard/m5_nightscoutmon

## Overview

##### Project type and purpose
- This is an embedded IoT full-stack application running on an M5Stack (ESP32) device.
- Purpose: periodically fetch blood-glucose (“BG”) data from a Nightscout server over Wi-Fi, display it (and optional sensor readings) on a small LCD, log errors, sound alarms, provide a simple web-based config interface, and read configuration/images from an SD card.

##### File structure
- Top-level firmware sources:
- M5_NightscoutMon.ino (main Arduino sketch)
- DHT12.cpp/.h, SHT3X.cpp/.h (environment sensors)
- IniFile.cpp/.h (INI parser)
- M5NSconfig.cpp/.h, M5NSWebConfig.cpp/.h (configuration & embedded web server)
- externs.h (global declarations)
- iot_iconset_16x16.c (graphics)
- Free_Fonts.h (fonts)
- PlatformIO folder: preconfigured VSCode/Platform.IO project
- Binaries folder: compiled .bin artifacts
- SD folder: default M5NS.INI example
- images folder: JPEG boot screens

##### README for additional insights
- Architecture is monolithic firmware on ESP32 but logically split into:
- Initialization: mount SD, parse M5NS.INI (nightscout URL, Wi-Fi SSIDs, thresholds, pages)
- Networking: connect to one of up to 9 Wi-Fi SSIDs → HTTP GET Nightscout JSON via ArduinoJson
- UI: update three display pages + optional error/log page
- Sensors: read DHT12 or SHT3X if present for temperature/humidity
- Alarm & input handling: buttons for brightness, page sweep, snooze/sleep
- Web server: optional lightweight HTTP server for remote config

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "M5Stack Device"
        style M5Stack Device fill:#eef,stroke:#333,stroke-width:2px
        EventLoop["Main Firmware & Event Loop\n(M5_NightscoutMon.ino)"]:::logic
        ConfigLoader["Config Loader\n(IniFile.cpp/.h)"]:::logic
        click ConfigLoader "https://github.com/fboegard/m5_nightscoutmon/blob/master/IniFile.cpp"
        click ConfigLoader "https://github.com/fboegard/m5_nightscoutmon/blob/master/IniFile.h"
        LocalConfig["Local Config Manager\n(M5NSconfig.cpp/.h)"]:::logic
        click LocalConfig "https://github.com/fboegard/m5_nightscoutmon/blob/master/M5NSconfig.cpp"
        click LocalConfig "https://github.com/fboegard/m5_nightscoutmon/blob/master/M5NSconfig.h"
        WebServer["Embedded Web Server\n(M5NSWebConfig.cpp/.h)"]:::io
        click WebServer "https://github.com/fboegard/m5_nightscoutmon/blob/master/M5NSWebConfig.cpp"
        click WebServer "https://github.com/fboegard/m5_nightscoutmon/blob/master/M5NSWebConfig.h"
        NetworkMgr["Network Manager\n(HTTP & JSON)"]:::io
        SensorDHT12["DHT12 Driver"]:::io
        click SensorDHT12 "https://github.com/fboegard/m5_nightscoutmon/blob/master/DHT12.cpp"
        click SensorDHT12 "https://github.com/fboegard/m5_nightscoutmon/blob/master/DHT12.h"
        SensorSHT3X["SHT3X Driver"]:::io
        click SensorSHT3X "https://github.com/fboegard/m5_nightscoutmon/blob/master/SHT3X.cpp"
        click SensorSHT3X "https://github.com/fboegard/m5_nightscoutmon/blob/master/SHT3X.h"
        UIIcon["Icon Set\n(iot_iconset_16x16.c)"]:::logic
        click UIIcon "https://github.com/fboegard/m5_nightscoutmon/blob/master/iot_iconset_16x16.c"
        UIFont["Fonts\n(Free_Fonts.h)"]:::logic
        click UIFont "https://github.com/fboegard/m5_nightscoutmon/blob/master/Free_Fonts.h"
        AlarmMgr["Alarm & Sound Manager"]:::logic
        ErrorLog["Error Logger"]:::io
        Externs["Globals & Externals\n(externs.h)"]:::logic
        click Externs "https://github.com/fboegard/m5_nightscoutmon/blob/master/externs.h"
    end

    SDCard["microSD Card\n(SD/M5NS.INI)"]:::io
    click SDCard "https://github.com/fboegard/m5_nightscoutmon/blob/master/SD/M5NS.INI"
    Binaries["Compiled Binaries"]:::io
    click Binaries "https://github.com/fboegard/m5_nightscoutmon/tree/master/Binaries/"
    PlatformIO["PlatformIO Project"]:::io
    click PlatformIO "https://github.com/fboegard/m5_nightscoutmon/blob/master/PlatformIO/M5_NightscoutMon_PlatformIO.zip"
    Images["Boot & Splash Images"]:::io
    click Images "https://github.com/fboegard/m5_nightscoutmon/tree/master/images/"

    Nightscout["Nightscout REST API"]:::ext
    Users["LAN Clients"]:::ext

    subgraph "Optional Sensors"
        style OptionalSensors stroke-dasharray: 5 5
        DHT["DHT12 Sensor"]:::io
        SHT["SHT3X Sensor"]:::io
    end

    SDCard -->|"read INI"| ConfigLoader
    ConfigLoader -->|inject config| LocalConfig
    ConfigLoader -->|inject config| NetworkMgr
    ConfigLoader -->|inject config| AlarmMgr
    EventLoop -->|loop| NetworkMgr
    EventLoop -->|loop| SensorDHT12
    EventLoop -->|loop| SensorSHT3X
    NetworkMgr -->|HTTP GET/JSON| Nightscout
    Nightscout -->|JSON response| NetworkMgr
    NetworkMgr -->|parsed data| UIIcon
    NetworkMgr -->|parsed data| UIFont
    SensorDHT12 -->|sensor data| UIIcon
    SensorSHT3X -->|sensor data| UIIcon
    UIIcon -->|draw| UIFont
    UIFont -->|render| EventLoop
    EventLoop -->|button events| AlarmMgr
    AlarmMgr -->|sound| EventLoop
    EventLoop -->|serve| WebServer
    WebServer -->|HTTP| Users
    WebServer -->|mDNS| Users
    EventLoop -->|log errors| ErrorLog
    ErrorLog -->|write| SDCard

    classDef io fill:#bbdefb,stroke:#1e88e5,stroke-width:1px
    classDef logic fill:#c8e6c9,stroke:#2e7d32,stroke-width:1px
    classDef ext fill:#ffe0b2,stroke:#ef6c00,stroke-width:1px
```
