# bitmavrick/lumolight architecture

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

- Interactive diagram: https://gitdiagram.com/bitmavrick/lumolight
- Repository: https://github.com/bitmavrick/lumolight

## Overview

##### Main Components
- Application Entry: Represent the Android Application class (LumolightApp.kt) which initializes the app.
- Activities & UI Layer: Show the main activities such as MainActivity.kt and FlashTileActivity.kt. Also include the various UI screens grouped under packages like:
- Home Screen (HomeScreen.kt and its associated view model and components)
- Settings (SettingScreen.kt, SettingViewModel.kt, etc.)
- Flash/Screen Flash functionalities (FlashScreen.kt, QuickFlashScreen.kt, ScreenFlash.kt, etc.)
- UI Tabs: Different tabs for flashlight, quick action, and screen flash (each with their own view model and UI state files under ui/tab).
- Data Layer: Include the data access component (UserPreferencesRepository.kt) for handling preferences and any state persistence.
- Services: Include LumolightTileService.kt, which provides tile support for quick access to the front flash.
- System & Services: The system package (System.kt) indicates interaction with lower-level system functionalities like triggering the flash hardware.

##### Interactions and Relationships
- Service Interaction: Illustrate how the LumolightTileService connects to system services to provide tile functionality, enabling quick access without launching full application screens.
- System Access: Connect the System component to both the front flash (screen brightness adjustments) and back flash (torch toggling) functionalities, showing interaction with Android hardware APIs.

##### Architectural Patterns and Design Principles
- MVVM Pattern: Emphasize that the app uses ViewModels (e.g., CoreViewModel, HomeViewModel, etc.) to manage UI state and business logic.
- Modular UI Components: Different screen components (home, settings, SOS, flash-related screens) are clearly separated, making the architecture scalable.
- DI for Loose Coupling: The presence of an AppModule for dependency injection suggests a focus on modularity and ease of testing.
- Use of Android Resource System: The multiple res directories (values, themes, drawables) indicate use of Android’s resource management for dynamic theming and localization.

##### Relevant Technologies and Frameworks
- Android (Kotlin-based) as the development platform.
- Gradle for build configuration, with Kotlin DSL build files (build.gradle.kts).
- Material You design primitives impacting the UI design components.
- Android’s architectural components (ViewModel, LiveData, etc.), even if not explicitly mentioned, are implied by the project structure.
- Dependency Injection (possibly Dagger/Hilt or a similar framework, as suggested by the di package).

##### Specific Elements
- Clear labels: Name each component (Application, Activities, ViewModels, Data Repository, DI Module, Services, System Interface, Resource Manager).
- Notes on integration: Optionally annotate areas where dynamic theming is managed or where hardware features (flashlight) are accessed.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Android Application"
        AL["LumolightApp (Application Entry)"]:::ui
    end

    subgraph "UI Layer"
        MA["MainActivity"]:::ui
        FT["FlashTileActivity"]:::ui

        subgraph "Screens"
            HS["Home Screen & MVVM"]:::ui
            SS["Settings Screen & MVVM"]:::ui
            FS["Flash Screen"]:::ui
        end

        subgraph "UI Tabs"
            FL["Flashlight Tab"]:::ui
            QA["Quick Action Tab"]:::ui
            SF["Screen Flash Tab"]:::ui
        end
    end

    subgraph "Business & Dependency"
        DI["AppModule (DI)"]:::di
    end

    subgraph "Data Layer"
        DP["UserPreferencesRepository"]:::data
    end

    subgraph "Services & System"
        TS["LumolightTileService"]:::services
        SYS["System Interface"]:::system
    end

    subgraph "Resources & Configs"
        RC["Resources & Configs"]:::resources
    end

    %% Application launches
    AL -->|"launches"| MA
    AL -->|"launches"| FT

    %% Dependency Injection
    DI -->|"injects"| HS
    DI -->|"injects"| SS
    DI -->|"injects"| FS
    DI -->|"injects"| FL
    DI -->|"injects"| QA
    DI -->|"injects"| SF
    DI -->|"injects"| TS

    %% Activity to Screens & Tabs interactions
    MA -->|"displays"| HS
    MA -->|"navigates"| SS
    MA -->|"controls"| FS
    MA -->|"accesses"| FL
    MA -->|"accesses"| QA
    MA -->|"accesses"| SF

    FT -->|"triggers"| TS

    %% Screens and Tabs update Data Layer
    HS -->|"updates"| DP
    SS -->|"updates"| DP
    FL -->|"updates"| DP
    QA -->|"updates"| DP
    SF -->|"updates"| DP

    %% Service and Activity interact with System Interface
    TS -->|"calls"| SYS
    MA -->|"controls"| SYS

    %% Resources influence UI via theming/dynamic aspects
    RC -->|"themes"| MA
    RC -->|"themes"| HS
    RC -->|"themes"| SS
    RC -->|"themes"| FS
    RC -->|"themes"| FL
    RC -->|"themes"| QA
    RC -->|"themes"| SF

    %% Click Events
    click AL "https://github.com/bitmavrick/lumolight/blob/main/app/src/main/java/com/bitmavrick/lumolight/LumolightApp.kt"
    click MA "https://github.com/bitmavrick/lumolight/blob/main/app/src/main/java/com/bitmavrick/lumolight/activity/MainActivity.kt"
    click FT "https://github.com/bitmavrick/lumolight/blob/main/app/src/main/java/com/bitmavrick/lumolight/activity/FlashTileActivity.kt"
    click HS "https://github.com/bitmavrick/lumolight/tree/main/app/src/main/java/com/bitmavrick/lumolight/ui/screen/home"
    click SS "https://github.com/bitmavrick/lumolight/tree/main/app/src/main/java/com/bitmavrick/lumolight/ui/screen/setting"
    click FS "https://github.com/bitmavrick/lumolight/tree/main/app/src/main/java/com/bitmavrick/lumolight/ui/screen/screenFlash"
    click FL "https://github.com/bitmavrick/lumolight/tree/main/app/src/main/java/com/bitmavrick/lumolight/ui/tab/flashlight"
    click QA "https://github.com/bitmavrick/lumolight/tree/main/app/src/main/java/com/bitmavrick/lumolight/ui/tab/quickAction"
    click SF "https://github.com/bitmavrick/lumolight/tree/main/app/src/main/java/com/bitmavrick/lumolight/ui/tab/screenFlash"
    click DP "https://github.com/bitmavrick/lumolight/blob/main/app/src/main/java/com/bitmavrick/lumolight/data/UserPreferencesRepository.kt"
    click DI "https://github.com/bitmavrick/lumolight/blob/main/app/src/main/java/com/bitmavrick/lumolight/di/AppModule.kt"
    click TS "https://github.com/bitmavrick/lumolight/blob/main/app/src/main/java/com/bitmavrick/lumolight/service/LumolightTileService.kt"
    click SYS "https://github.com/bitmavrick/lumolight/blob/main/app/src/main/java/com/bitmavrick/lumolight/system/System.kt"
    click RC "https://github.com/bitmavrick/lumolight/tree/main/app/src/main/res"

    %% Styles
    classDef ui fill:#B3E5FC,stroke:#0277BD,stroke-width:2px;
    classDef di fill:#FFECB3,stroke:#FF9800,stroke-width:2px;
    classDef data fill:#F8BBD0,stroke:#C2185B,stroke-width:2px;
    classDef system fill:#CFD8DC,stroke:#607D8B,stroke-width:2px;
    classDef services fill:#E1BEE7,stroke:#8E24AA,stroke-width:2px;
    classDef resources fill:#C8E6C9,stroke:#388E3C,stroke-width:2px;
```
