# boostedspaceprogram/satmonitor architecture

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

- Interactive diagram: https://gitdiagram.com/boostedspaceprogram/satmonitor
- Repository: https://github.com/boostedspaceprogram/satmonitor

## Overview

##### Project Type and Purpose
- This is a full-stack desktop application built in Python that focuses on satellite monitoring. Its purpose is to gather and display real-time satellite data through a Multiple Document Interface (MDI) application.
- The README specifies real-time satellite tracking, telemetry visualization, and potential 3D modeling, making the application both data-intensive and interactive.

##### Major Components to be Represented
a. Application Entry Point:
- main.py – the starting point of the application.
b. Core Functionalities (Business/Logic Layer):
- src/Functions – Contains modules for essential functions such as:
- Globe.py (likely related to satellite orbit visualizations)
- Livestream.py (handling live video or data feeds)
- Requests.py (managing API/data requests)
- ScreenReziser.py (probably adapting UI components to different screen resolutions)
- Settings.py (configuration management)
- UserNotificationProvider.py (hooking notifications to user-initiated events)
c. User Interface (Presentation Layer):
- src/GUI – Houses all the GUI components:
- MainWindow.py, Console.py, MDI.py (support for multiple documents/windows)
- Widgets – Custom GUI widgets like About.py and Livestream.py.
- StatusBar.py for real-time feedback.
d. Notifications System:
- src/Notifications – Contains a set of providers (Discord, Ntfy, Telegram, and Windows notification providers). This clearly delineates an external communication layer which informs users about important events or updates.
e. Build and Deployment:
- Sat-Monitor.spec and SatMonitor-build.iss along with the .github/workflows folder (which contains CI build scripts for Windows and Linux) indicate that an integrated build/deployment pipeline is in place.
f. Configuration and Dependencies:
- files like requirements.txt and settings.json should be acknowledged as the backbone for dependency and runtime configuration management.

##### Relationships and Interactions
- The entry point (main.py) loads the configuration, sets up the UI, and calls the business logic from the Functions module.
- UI modules (“GUI”) call business functions from the Functions layer to fetch real-time satellite data.
- The Functions layer, in turn, might trigger notification providers (from the Notifications module) based on data changes or incoming alerts.
- Build/deployment pipelines relate to the entire system by packaging the application (indicating a CI/CD integration).
- That the UI layer (MDI, Ribbon, Widgets) and the logic components (Functions and Notifications) are loosely coupled, following best practices like separation of concerns.

##### Key Architectural Patterns and Technologies
- Layered Architecture: Clearly separate presentation (GUI) from business logic (Functions) and external integrations (Notifications and build scripts).
- Modular Design: By separating responsibilities into directories (Functions, GUI, Notifications), the design supports extensibility.
- Build Automation: Incorporate CI/CD processes as shown by the GitHub workflows.
- Although not explicitly mentioned, consider marking the inherent Model-View-Controller (MVC) or similar patterns in the GUI structure since the GUI components manage both display (View) and, through event-handlers, control logic.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Application Entry"
        entry["Main Entry (main.py)"]:::entry
    end

    subgraph "Business Logic (Functions)"
        globe["Globe Module"]:::logic
        livestreamFunc["Livestream Module"]:::logic
        requests["Requests Module"]:::logic
        screenReziser["ScreenReziser Module"]:::logic
        settingsFunc["Settings Module"]:::logic
        userNotif["User Notification Provider"]:::logic
    end

    subgraph "User Interface (GUI)"
        mainWindow["Main Window"]:::ui
        console["Console"]:::ui
        mdi["MDI"]:::ui
        subgraph "Ribbon Components"
            icons["Icons"]:::ui
            ribbonBtn["Ribbon Button"]:::ui
            ribbonPane["Ribbon Pane"]:::ui
            ribbonTab["Ribbon Tab"]:::ui
            ribbonTextbox["Ribbon Textbox"]:::ui
            ribbonWidget["Ribbon Widget"]:::ui
            styleSheets["Style Sheets"]:::ui
        end
        subgraph "Custom Widgets"
            aboutWidget["About Widget"]:::ui
            livestreamWidget["Livestream Widget"]:::ui
        end
        statusBar["Status Bar"]:::ui
    end

    subgraph "Notification Providers"
        discord["Discord Provider"]:::notif
        ntfy["Ntfy Provider"]:::notif
        telegram["Telegram Provider"]:::notif
        windowsNotif["Windows Provider"]:::notif
    end

    subgraph "Build and Deployment"
        spec["PyInstaller Spec"]:::build
        innosetup["Inno Setup Build Script"]:::build
        workflows["CI/CD Workflows"]:::build
    end

    subgraph "Configuration and Dependencies"
        requirements["Python Dependencies"]:::config
        runtimeConfig["Runtime Configuration"]:::config
    end

    %% Relationships
    entry -->|"initiates"| mainWindow
    entry -->|"initiates"| globe
    entry -->|"loads config"| requirements
    entry -->|"loads config"| runtimeConfig

    mainWindow -->|"requests data"| globe
    mainWindow -->|"requests data"| livestreamFunc
    console -->|"requests data"| requests
    mdi -->|"requests data"| screenReziser

    globe -->|"triggers"| discord
    livestreamFunc -->|"triggers"| telegram
    requests -->|"triggers"| ntfy
    settingsFunc -->|"triggers"| windowsNotif
    userNotif -->|"manages"| discord

    %% Build and Deployment links (representing integration of build system)
    spec --- innosetup
    workflows --- spec

    %% Connections from Business Logic to UI updates and Notifications
    globe --- mainWindow
    livestreamFunc --- livestreamWidget
    requests --- console
    userNotif --- statusBar

    %% Classes for styling
    classDef entry fill:#FFCCCB,stroke:#B22222,stroke-width:2px;
    classDef logic fill:#ADD8E6,stroke:#00008B,stroke-width:2px;
    classDef ui fill:#90EE90,stroke:#006400,stroke-width:2px;
    classDef notif fill:#FFD700,stroke:#DAA520,stroke-width:2px;
    classDef build fill:#E0FFFF,stroke:#008B8B,stroke-width:2px;
    classDef config fill:#FFFACD,stroke:#BDB76B,stroke-width:2px;

    %% Click Events
    click entry "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/main.py"
    click globe "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/Functions/Globe.py"
    click livestreamFunc "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/Functions/Livestream.py"
    click requests "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/Functions/Requests.py"
    click screenReziser "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/Functions/ScreenReziser.py"
    click settingsFunc "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/Functions/Settings.py"
    click userNotif "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/Functions/UserNotificationProvider.py"
    click mainWindow "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/GUI/MainWindow.py"
    click console "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/GUI/Console.py"
    click mdi "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/GUI/MDI.py"
    click icons "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/GUI/Ribbon/Icons.py"
    click ribbonBtn "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/GUI/Ribbon/RibbonButton.py"
    click ribbonPane "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/GUI/Ribbon/RibbonPane.py"
    click ribbonTab "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/GUI/Ribbon/RibbonTab.py"
    click ribbonTextbox "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/GUI/Ribbon/RibbonTextbox.py"
    click ribbonWidget "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/GUI/Ribbon/RibbonWidget.py"
    click styleSheets "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/GUI/Ribbon/StyleSheets.py"
    click aboutWidget "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/GUI/Widgets/About.py"
    click livestreamWidget "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/GUI/Widgets/Livestream.py"
    click statusBar "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/GUI/StatusBar.py"
    click discord "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/Notifications/DiscordNotificationProvider.py"
    click ntfy "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/Notifications/NtfyNotificationProvider.py"
    click telegram "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/Notifications/TelegramNotificationProvider.py"
    click windowsNotif "https://github.com/boostedspaceprogram/satmonitor/blob/main/src/Notifications/WindowsNotificationProvider.py"
    click spec "https://github.com/boostedspaceprogram/satmonitor/blob/main/Sat-Monitor.spec"
    click innosetup "https://github.com/boostedspaceprogram/satmonitor/blob/main/SatMonitor-build.iss"
    click workflows "https://github.com/boostedspaceprogram/satmonitor/blob/main/.github/workflows/compile-and-compress-linux.yml"
    click requirements "https://github.com/boostedspaceprogram/satmonitor/blob/main/requirements.txt"
    click runtimeConfig "https://github.com/boostedspaceprogram/satmonitor/blob/main/settings.json"
```
