# koggertech/koggerapp architecture

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

- Interactive diagram: https://gitdiagram.com/koggertech/koggerapp
- Repository: https://github.com/koggertech/koggerapp

## Overview

##### Project Type and Purpose
- Full-featured, cross-platform C++/Qt QML client application (Windows, Linux, Android)

##### Top-Level Architectural Layers
- Platform Abstraction Layer
– Qt Kits (Windows/Linux via GCC/MinGW; Android via NDK/Clang)
– Android JNI bridge & Java wrappers (platform/android/src/android.*)
- Device & Link Layer
– Serial drivers (platform/android/libs/d2xx.jar; src/device/dev_driver.cpp)
– USB/UDP link manager (src/link/link_manager.cpp)
- Core Processing Layer
– Data protocols & converters (src/proto_binnary.cpp, src/converter_xtf.h)
– DSP & calibration (src/black_stripes_processor.cpp, src/id_binnary.cpp)
– Flasher & bootloader (src/flasher.cpp)
– Bottom-track & surface calc (scene3d/processors/surface_processor.cpp)
– Side-scan mosaic (src/stream_list.*, src/plot2D_*.cpp)
- & Tile Engine
– Tile providers, downloaders, DB (src/tile_engine/*.cpp)
– Globe map QML integration
- Visualization & Controllers
– 2D plotting (src/plot2D.cpp, src/waterfall.cpp)
– 3D scene engine (src/scene3d/core, domain, renderer)
– QML controllers (src/scene3d/controllers/*.cpp)
- UI Layer
– QML components (qml/*.qml, KoggerCommon, main.qml)
– Context properties & signals/slots binding to C++ backend
- Resource & Localization Layer
– Translations (translations/*.qm, .ts)
- Deployment & Build Scripts
– Linux & Windows deploy (scripts/*.sh, .bat)
– .pro project (KoggerApp.pro), CMakeLists for Android serial port

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Platform Abstraction Layer"
        AndroidJNI["Android JNI Module"]:::platform
        QtAndroidSerial["QtAndroid SerialPort Bridge"]:::platform
        BuildAndroid["Android Build Scripts & Manifests"]:::platform
    end

    subgraph "Device & Link Layer"
        SerialDriver["Serial Driver Wrappers"]:::device
        DevDriver["Device Driver"]:::device
        DeviceManager["Device Manager"]:::device
        UDPManager["USB/UDP Link Manager"]:::device
    end

    subgraph "Core Processing Layer"
        ProtoBinary["Protocol Parser (proto_binnary.cpp)"]:::core
        ConverterXTF["Converter XTF (converter_xtf.h)"]:::core
        BlackStripes["DSP & Calibration (black_stripes_processor.cpp)"]:::core
        IDBinary["DSP & Calibration (id_binnary.cpp)"]:::core
        Flasher["Flasher & Bootloader"]:::core
        SurfaceCalc["Bottom-Track & Surface Processor"]:::core
        StreamList["Stream List Handler"]:::core
        Echogram["Plot2D Echogram"]:::core
    end

    subgraph "Map & Tile Engine"
        TileDB["Tile DB"]:::map
        TileManager["Tile Manager"]:::map
        TileDownloader["Tile Downloader"]:::map
        TileGoogle["Google Tile Provider"]:::map
    end

    subgraph "Visualization & Controllers"
        Plot2DE["2D Plotting Engine"]:::vis
        Waterfall["Waterfall Engine"]:::vis
        Scene3DCore["3D Scene Core & Renderer"]:::vis
        DomainModels["3D Domain Models"]:::vis
        S3Control["Scene3D Controller"]:::vis
        MapControl["Map View Controller"]:::vis
    end

    subgraph "UI Layer"
        QMLMain["QML Frontend"]:::ui
        Plot2DQML["Plot2D QML"]:::ui
        KButton["KoggerCommon KButton"]:::ui
        Qmldir["KoggerCommon qmldir"]:::ui
    end

    subgraph "Resource & Localization Layer"
        Icons["Qt Icons Resource"]:::res
        ShadersRes["Shaders Resource"]:::res
        BaseVSH["Vertex Shader (base.vsh)"]:::res
        MosaicFSH["Fragment Shader (mosaic.fsh)"]:::res
        TranslationEN["Translation EN"]:::res
    end

    subgraph "Deployment & Build Scripts"
        ProjFile["KoggerApp.pro & CMakeLists"]:::deploy
        LinuxScript["linux_deploy_release.sh"]:::deploy
        WinScript["win_deploy_release.bat"]:::deploy
    end

    subgraph "Third-Party Dependencies"
        FreeType["FreeType Library"]:::third
    end

    %% Relationships
    AndroidJNI -->|wraps| SerialDriver
    QtAndroidSerial -->|wraps| SerialDriver
    BuildAndroid -->|configures| AndroidJNI

    SerialDriver -->|"raw sonar data"| ProtoBinary
    UDPManager -->|"raw sonar data"| ProtoBinary
    DevDriver -->|manages| SerialDriver
    DeviceManager -->|controls| SerialDriver

    ProtoBinary -->|"parsed data"| ConverterXTF
    ConverterXTF --> BlackStripes
    ConverterXTF --> IDBinary
    BlackStripes --> SurfaceCalc
    IDBinary --> SurfaceCalc
    SurfaceCalc --> Scene3DCore
    StreamList --> Echogram
    Echogram --> Plot2DE
    Plot2DE --> Waterfall

    Plot2DE --> S3Control
    Waterfall --> S3Control
    Scene3DCore --> S3Control
    Scene3DCore --> MapControl
    TileDownloader --> TileDB
    TileGoogle --> TileDownloader
    TileDB --> MapControl

    QMLMain <--> S3Control
    QMLMain <--> MapControl
    QMLMain --> Plot2DQML
    Plot2DQML --> Plot2DE
    KButton --> QMLMain
    Qmldir --> QMLMain

    Icons --> QMLMain
    ShadersRes --> Scene3DCore
    BaseVSH --> Scene3DCore
    MosaicFSH --> Plot2DE
    TranslationEN --> QMLMain

    ProjFile --> AndroidJNI
    ProjFile --> ProtoBinary
    ProjFile --> QMLMain
    LinuxScript --> ProjFile
    WinScript --> ProjFile

    FreeType --> Scene3DCore
    FreeType --> Plot2DE

    %% Click Events
    click AndroidJNI "https://github.com/koggertech/koggerapp/blob/master/platform/android/src/android.cpp"
    click QtAndroidSerial "https://github.com/koggertech/koggerapp/blob/master/platform/android/src/qtandroidserialport/src/qserialport_android.cpp"
    click BuildAndroid "https://github.com/koggertech/koggerapp/blob/master/platform/android/AndroidManifest.xml"
    click SerialDriver "https://github.com/koggertech/koggerapp/blob/master/platform/android/libs/d2xx.jar"
    click DevDriver "https://github.com/koggertech/koggerapp/blob/master/src/device/dev_driver.cpp"
    click DeviceManager "https://github.com/koggertech/koggerapp/blob/master/src/device/device_manager.cpp"
    click UDPManager "https://github.com/koggertech/koggerapp/blob/master/src/link/link_manager.cpp"
    click ProtoBinary "https://github.com/koggertech/koggerapp/blob/master/src/proto_binnary.cpp"
    click ConverterXTF "https://github.com/koggertech/koggerapp/blob/master/src/converter_xtf.h"
    click BlackStripes "https://github.com/koggertech/koggerapp/blob/master/src/black_stripes_processor.cpp"
    click IDBinary "https://github.com/koggertech/koggerapp/blob/master/src/id_binnary.cpp"
    click Flasher "https://github.com/koggertech/koggerapp/blob/master/src/flasher.cpp"
    click SurfaceCalc "https://github.com/koggertech/koggerapp/blob/master/src/scene3d/processors/surface_processor.cpp"
    click StreamList "https://github.com/koggertech/koggerapp/blob/master/src/stream_list.cpp"
    click Echogram "https://github.com/koggertech/koggerapp/blob/master/src/plot2D_echogram.cpp"
    click Plot2DE "https://github.com/koggertech/koggerapp/blob/master/src/plot2D.cpp"
    click Waterfall "https://github.com/koggertech/koggerapp/blob/master/src/waterfall.cpp"
    click Scene3DCore "https://github.com/koggertech/koggerapp/blob/master/src/scene3d/scene3d_renderer.cpp"
    click DomainModels "https://github.com/koggertech/koggerapp/blob/master/src/scene3d/domain/surface.cpp"
    click S3Control "https://github.com/koggertech/koggerapp/blob/master/src/scene3d/controllers/scene3d_control_menu_controller.cpp"
    click MapControl "https://github.com/koggertech/koggerapp/blob/master/src/scene3d/controllers/map_view_control_menu_controller.cpp"
    click QMLMain "https://github.com/koggertech/koggerapp/blob/master/qml/main.qml"
    click Plot2DQML "https://github.com/koggertech/koggerapp/blob/master/qml/Plot2D.qml"
    click KButton "https://github.com/koggertech/koggerapp/blob/master/qml/KoggerCommon/KButton.qml"
    click Qmldir "https://github.com/koggertech/koggerapp/tree/master/qml/KoggerCommon/qmldir"
    click Icons "https://github.com/koggertech/koggerapp/blob/master/resources/icons.qrc"
    click ShadersRes "https://github.com/koggertech/koggerapp/blob/master/resources/shaders.qrc"
    click BaseVSH "https://github.com/koggertech/koggerapp/blob/master/shaders/base.vsh"
    click MosaicFSH "https://github.com/koggertech/koggerapp/blob/master/shaders/mosaic.fsh"
    click TranslationEN "https://github.com/koggertech/koggerapp/blob/master/translations/translation_en.ts"
    click ProjFile "https://github.com/koggertech/koggerapp/blob/master/KoggerApp.pro"
    click LinuxScript "https://github.com/koggertech/koggerapp/blob/master/scripts/linux_deploy_release.sh"
    click WinScript "https://github.com/koggertech/koggerapp/blob/master/scripts/win_deploy_release.bat"
    click FreeType "https://github.com/koggertech/koggerapp/tree/master/third_party/freetype/include/freetype"

    %% Styles
    classDef platform fill:#AED6F1,stroke:#2980B9
    classDef device fill:#D6EAF8,stroke:#1F618D
    classDef core fill:#ABEBC6,stroke:#27AE60
    classDef map fill:#A3E4D7,stroke:#117A65
    classDef vis fill:#F9E79F,stroke:#B7950B
    classDef ui fill:#FADBD8,stroke:#C0392B
    classDef res fill:#D2B4DE,stroke:#7D3C98
    classDef deploy fill:#D5DBDB,stroke:#566573
    classDef third fill:#F5CBA7,stroke:#A04000
```
