# jonakeys/hubrpi architecture

> Architecture diagram of the GitHub repository jonakeys/hubrpi, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jonakeys/hubrpi
- Repository: https://github.com/jonakeys/hubrpi

## Overview

##### Main Components

a. Frontend Layer:
- wxPython GUI Framework
- Main Application Window (hubrpi.py)
- Tab-based Interface Modules (all files in modules/ directory)

b. External Services:
- OpenWeather API Integration
- CalDAV Calendar Service
- Bitcoin Price Service (implied from screenshots)

c. Data Storage:
- Local CSV/TXT Files (in data/ directory)
- Fortune Cookie Database
- Energy Usage Data

d. Media Components:
- Music Streaming Scripts
- Graphics Resources

**[User Interface Layer]**
**┌─────────────────────────────────────────┐**
- GUI Components (wxPython)               │
- ┌─────────┐ ┌─────────┐ ┌─────────┐    │
- Weather  │ │Calendar │ │Energy   │    │
- Tab      │ │Tab      │ │Tab      │    │
- ┘ └─────────┘ └─────────┘    │
- ┘
- ↑               ↑
**[Application Logic Layer]**
**┌─────────────────────────────────────────┐**
- Module Controllers                      │
- ┌─────────┐ ┌─────────┐ ┌─────────┐    │
- Weather  │ │Calendar │ │Energy   │    │
- Module   │ │Module   │ │Module   │    │
- ┘ └─────────┘ └─────────┘    │
- ┘
- ↑               ↑
**[Data & Services Layer]**
**┌─────────────────────────────────────────┐**
- ┌─────────┐ ┌─────────┐ ┌─────────┐    │
- OpenWeath│ │CalDAV   │ │Local    │    │
- API      │ │Service  │ │Storage  │    │
- ┘ └─────────┘ └─────────┘    │
- ┘

##### Important Elements to Highlight

a. Module Integration:
- How each tab module (m_tab*.py) connects to the main application
- Data flow between modules and services

b. External Dependencies:
- OpenWeather API connection
- CalDAV calendar integration
- Music streaming services

c. File System Integration:
- Data file access (CSV, TXT)
- Graphics resources
- Music script execution

##### Notes for Implementation
- Keep the main application flow clear and centered
- Related modules visually
- Use consistent symbols for similar components
- Version information for major dependencies
- Notes about hardware requirements

This design should provide a clear understanding of how the application works on a Raspberry Pi with a touchscreen interface while maintaining the detail necessary for development and maintenance.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph UI["User Interface Layer"]
        direction TB
        GUI[GUI Framework wxPython]
        WeatherTab["Weather Tab"]
        CalendarTab["Calendar Tab"]
        EnergyTab["Energy Tab"]
        BitcoinTab["Bitcoin Tab"]
        FortuneTab["Fortune Tab"]
        MusicTab["Music Tab"]
        ToolsTab["Tools Tab"]
    end

    subgraph AL["Application Logic Layer"]
        direction TB
        MainApp["Main Application Controller"]
        WeatherMod["Weather Module"]
        CalendarMod["Calendar Module"]
        EnergyMod["Energy Module"]
        BitcoinMod["Bitcoin Module"]
        FortuneMod["Fortune Module"]
        MusicMod["Music Module"]
        ToolsMod["Tools Module"]
        UtilTools["Utility Tools"]
    end

    subgraph DS["Data & Services Layer"]
        direction TB
        OpenWeather["OpenWeather API"]
        CalDAV["CalDAV Service"]
        LocalStorage["Local Storage"]
        subgraph DataFiles["Data Files"]
            EnergyData["Energy Data CSV"]
            FortuneDB["Fortune Database"]
            EnergyStats["Energy Statistics"]
        end
        subgraph Media["Media Resources"]
            WeatherIcons["Weather Icons"]
            MusicRes["Music Resources"]
            MusicScripts["Music Scripts"]
        end
    end

    %% UI to Logic Connections
    GUI --> MainApp
    WeatherTab --> WeatherMod
    CalendarTab --> CalendarMod
    EnergyTab --> EnergyMod
    BitcoinTab --> BitcoinMod
    FortuneTab --> FortuneMod
    MusicTab --> MusicMod
    ToolsTab --> ToolsMod

    %% Logic to Data Connections
    WeatherMod --> OpenWeather
    CalendarMod --> CalDAV
    EnergyMod --> EnergyData
    FortuneMod --> FortuneDB
    MusicMod --> MusicScripts
    WeatherMod --> WeatherIcons
    MusicMod --> MusicRes
    EnergyMod --> EnergyStats
    
    %% Component Mappings
    click MainApp "https://github.com/jonakeys/hubrpi/blob/main/hubrpi.py"
    click WeatherMod "https://github.com/jonakeys/hubrpi/blob/main/modules/m_tabWeer.py"
    click CalendarMod "https://github.com/jonakeys/hubrpi/blob/main/modules/m_tabAgenda.py"
    click EnergyMod "https://github.com/jonakeys/hubrpi/blob/main/modules/m_tabEnergie.py"
    click BitcoinMod "https://github.com/jonakeys/hubrpi/blob/main/modules/m_tabBitcoin.py"
    click FortuneMod "https://github.com/jonakeys/hubrpi/blob/main/modules/m_tabFortune.py"
    click MusicMod "https://github.com/jonakeys/hubrpi/blob/main/modules/m_tabMuziek.py"
    click UtilTools "https://github.com/jonakeys/hubrpi/blob/main/modules/m_tools.py"
    click WeatherIcons "https://github.com/jonakeys/hubrpi/tree/main/graphics/VClouds_weather_icons"
    click EnergyData "https://github.com/jonakeys/hubrpi/blob/main/data/energie_hubrpi.csv"
    click FortuneDB "https://github.com/jonakeys/hubrpi/blob/main/data/fortune.u8"
    click MusicScripts "https://github.com/jonakeys/hubrpi/tree/main/muziek"
    click MusicRes "https://github.com/jonakeys/hubrpi/tree/main/graphics"
    click EnergyStats "https://github.com/jonakeys/hubrpi/blob/main/data/energieverbruik_2022.txt"
    click ToolsMod "https://github.com/jonakeys/hubrpi/blob/main/modules/m_tabTools.py"

    %% Styling
    classDef ui fill:#a8d1f0
    classDef logic fill:#90EE90
    classDef data fill:#FFE4B5
    classDef media fill:#DDA0DD
    
    class GUI,WeatherTab,CalendarTab,EnergyTab,BitcoinTab,FortuneTab,MusicTab,ToolsTab ui
    class MainApp,WeatherMod,CalendarMod,EnergyMod,BitcoinMod,FortuneMod,MusicMod,ToolsMod,UtilTools logic
    class OpenWeather,CalDAV,LocalStorage,DataFiles,EnergyData,FortuneDB,EnergyStats data
    class Media,WeatherIcons,MusicRes,MusicScripts media
```
