# madhavraj2004/ipollusense_nit architecture

> Architecture diagram of the GitHub repository madhavraj2004/ipollusense_nit, 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/madhavraj2004/ipollusense_nit
- Repository: https://github.com/madhavraj2004/ipollusense_nit

## Overview

##### Project Type and Purpose
- This is a single-module Android mobile app (“app/”) built with Java (and a bit of C++ via `a.cpp`), following MVVM principles.
- It connects to physical devices over Bluetooth, displays data in the UI via Fragments/Activities, and integrates with Firebase for cloud messaging and services (per `google-services.json`).

##### File Structure
Top-level:
– `app/`: Android module
– `build.gradle`, `gradle/`: Build scripts and wrapper
In `app/`:
– `src/main/java/com/example/ipollusen/`:
- Activities (e.g., `LoginActivity`, `MainActivity`, `SplashActivity`)
- Fragments (e.g., `RoomsFragment`, `MapsFragment`, `RecommendationFragment`)
- ViewModels (e.g., `RoomDetailsViewModel`, `AssistantViewModel`)
- Services (e.g., `BluetoothService`, `MyFirebaseMessagingService`)
- Data models/adapters (e.g., `ApplianceModel`, `RoomModel`, `ApplianceJsonAdapter`)
– `src/main/res/`: layouts, drawables, navigation graph (`mobile_navigation.xml`), values, menus
– `libs/serviceLibrary-release.aar`: packaged helper library (likely for device/service communication)
– `a.cpp`: native code (NDK) used by the app—possibly sensor data processing

##### README for Insights
- Confirms it is an Android Studio project using Gradle, with Firebase integration.

a. Main Components
1. UI Layer
– Activities & Fragments
– Navigation Component
2. Presentation Layer
– ViewModels (MVVM)
– LiveData / Observers
3. Data & Domain Layer
– Data models & JSON adapters
– Local/native code (`a.cpp`)
– `serviceLibrary.aar`
4. Services & Business Logic
– BluetoothService (scans/connects to IoT sensors)
– MyFirebaseMessagingService (push notifications)
5. External Systems
– Bluetooth Devices (sensors)
– Firebase (Cloud Messaging, Analytics, possibly Realtime Database)
– Google Maps API (in `MapsFragment`)

b. Relationships & Interactions
– UI → ViewModel: user events and data binding
– ViewModel → Service/Library: invokes BluetoothService or native code via JNI
– BluetoothService ↔ Physical Sensors (BLE)
– ViewModel → FirebaseMessagingService: registers for/handles push notifications
– Data flow: Sensor data → BluetoothService → ViewModel → UI
– Push flow: Firebase → MyFirebaseMessagingService → ViewModel → NotificationFragment/UI

c. Architectural Patterns
– MVVM: clear separation of UI (Activities/Fragments) and business logic (ViewModels)
– Android Navigation Component for in-app routing
– JNI bridge for C++ sensor processing (`a.cpp`)
– External AAR (`serviceLibrary`) encapsulates device-specific logic

d. Key Technologies & Frameworks
– Android SDK (Activities, Fragments, Services)
– Android Jetpack: ViewModel, LiveData, Navigation
– Firebase Cloud Messaging
– Bluetooth LE APIs
– Google Maps Android API
– Gradle build system
– Native code via NDK (C++)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    subgraph "UI Layer"
        direction TB
        LoginActivity["LoginActivity"]:::ui
        MainActivity["MainActivity"]:::ui
        RoomsFragment["RoomsFragment"]:::ui
        MapsFragment["MapsFragment"]:::ui
        NavigationGraph["Navigation Graph"]:::ui
    end

    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        RoomDetailsViewModel["RoomDetailsViewModel"]:::presentation
        AssistantViewModel["AssistantViewModel"]:::presentation
    end

    %% Data & Domain Layer
    subgraph "Data & Domain Layer"
        direction TB
        ApplianceModel["ApplianceModel"]:::data
        RoomModel["RoomModel"]:::data
        JSONAdapter["ApplianceJsonAdapter"]:::data
        NativeCPP["a.cpp"]:::data
        AARLibrary["serviceLibrary-release.aar"]:::data
    end

    %% Services & Business Logic
    subgraph "Services & Business Logic"
        direction TB
        BluetoothService["BluetoothService"]:::service
        FCMService["MyFirebaseMessagingService"]:::service
    end

    %% External Systems
    subgraph "External Systems"
        direction TB
        BLEDevices["Bluetooth Devices"]:::external
        Firebase["Firebase"]:::external
        MapsAPI["Google Maps API"]:::external
    end

    %% Data Flows
    LoginActivity -->|"user events & data binding"| RoomDetailsViewModel
    MainActivity -->|"navigation events"| NavigationGraph
    NavigationGraph -->|"routes to Fragments"| RoomsFragment
    NavigationGraph -->|"routes to Fragments"| MapsFragment

    RoomsFragment -->|"observes LiveData"| RoomDetailsViewModel
    MapsFragment -->|"observes LiveData"| AssistantViewModel

    RoomDetailsViewModel -->|"requests data"| BluetoothService
    AssistantViewModel -->|"register for push"| FCMService

    BluetoothService -->|"BLE scan/connect"| BLEDevices
    FCMService -.->|"push notification"| Firebase

    BluetoothService -->|"sensor data"| RoomDetailsViewModel
    Firebase -->|"push event"| FCMService
    FCMService -->|"notifies"| AssistantViewModel

    RoomDetailsViewModel -->|"provides data"| RoomsFragment
    AssistantViewModel -->|"provides data"| MapsFragment

    %% Domain interactions
    RoomDetailsViewModel -->|"parses JSON"| JSONAdapter
    JSONAdapter -->|"maps to"| ApplianceModel
    JSONAdapter -->|"maps to"| RoomModel

    BluetoothService -->|"native processing via JNI"| NativeCPP
    BluetoothService -->|"uses library logic"| AARLibrary

    MapsFragment -->|"displays map"| MapsAPI

    %% Click Events
    click LoginActivity "https://github.com/madhavraj2004/ipollusense_nit/blob/main/app/src/main/java/com/example/ipollusen/LoginActivity.java"
    click MainActivity "https://github.com/madhavraj2004/ipollusense_nit/blob/main/app/src/main/java/com/example/ipollusen/MainActivity.java"
    click RoomsFragment "https://github.com/madhavraj2004/ipollusense_nit/blob/main/app/src/main/java/com/example/ipollusen/RoomsFragment.java"
    click MapsFragment "https://github.com/madhavraj2004/ipollusense_nit/blob/main/app/src/main/java/com/example/ipollusen/MapsFragment.java"
    click NavigationGraph "https://github.com/madhavraj2004/ipollusense_nit/blob/main/app/src/main/res/navigation/mobile_navigation.xml"
    click RoomDetailsViewModel "https://github.com/madhavraj2004/ipollusense_nit/blob/main/app/src/main/java/com/example/ipollusen/RoomDetailsViewModel.java"
    click AssistantViewModel "https://github.com/madhavraj2004/ipollusense_nit/blob/main/app/src/main/java/com/example/ipollusen/ui/assistant/AssistantViewModel.java"
    click ApplianceModel "https://github.com/madhavraj2004/ipollusense_nit/blob/main/app/src/main/java/com/example/ipollusen/ApplianceModel.java"
    click a.cpp "https://github.com/madhavraj2004/ipollusense_nit/blob/main/app/a.cpp"
    click AARLibrary "https://github.com/madhavraj2004/ipollusense_nit/blob/main/app/libs/serviceLibrary-release.aar"
    click BluetoothService "https://github.com/madhavraj2004/ipollusense_nit/blob/main/app/src/main/java/com/example/ipollusen/BluetoothService.java"
    click FCMService "https://github.com/madhavraj2004/ipollusense_nit/blob/main/app/src/main/java/com/example/ipollusen/MyFirebaseMessagingService.java"

    %% Styles
    classDef ui fill:#cdeeff,stroke:#0066cc,stroke-width:1px
    classDef presentation fill:#d4edda,stroke:#28a745,stroke-width:1px
    classDef data fill:#ffe5b4,stroke:#ff8c00,stroke-width:1px
    classDef service fill:#ffd1dc,stroke:#ff1493,stroke-width:1px
    classDef external fill:#e0e0e0,stroke:#606060,stroke-width:1px
```
