# sensie-app/flutter-sensie-plugin architecture

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

- Interactive diagram: https://gitdiagram.com/sensie-app/flutter-sensie-plugin
- Repository: https://github.com/sensie-app/flutter-sensie-plugin

## Overview

##### Project Type and Purpose
- This is a Flutter plugin (“plugin_sensie”) that provides a Dart API for integrating the proprietary Sensie motion-capture SDK into Flutter apps. It exposes high-level classes (SensieEngine, CalibrationSession, etc.) to Flutter via the standard Flutter plugin mechanism (platform channels).

##### File-Structure Analysis
- Top-level:
- lib/         – Dart public API, method-channel wiring, platform interface
- android/     – Android plugin implementation in Java + bundled AAR
- ios/         – iOS plugin implementation in Swift + embedded SensieFramework
- example/     – Sample Flutter app showing plugin usage on both Android & iOS
- test/        – Dart unit tests
- pubspec.yaml – plugin metadata and dependencies
- Patterns:
- “plugin_sensie/lib” hosts the Flutter-side API and delegates calls via MethodChannel
- “android/src” provides PluginSensiePlugin.java that registers MethodChannel handlers and calls into SensieLibrary.aar
- “ios/Classes” and Wrapper.swift forward calls into the embedded SensieFramework.framework
- example/ demonstrates a typical full-stack: Flutter UI → plugin → native SDK → sensor hardware

##### Key Architectural Insights from README
- SensieEngine.init, connect(), startCalibration(), captureSensie(), etc., are asynchronous Dart methods
- Under the hood these call through MethodChannel to native code
- Native code calls into vendor SDK libraries (AAR on Android, framework on iOS) which talk to sensors/bluetooth

a. Main Components
1. Flutter Application (example/) – UI, business logic
2. Dart API Layer (lib/) – SensieEngine, CalibrationSession classes
3. MethodChannel (Dart ↔ native bridge)
4. Android Plugin Module
- Java PluginSensiePlugin
- SensieLibrary.aar (compiled SDK)
5. iOS Plugin Module
- Swift PluginSensiePlugin
- SensieFramework.framework (compiled SDK)
6. Device Sensors / Bluetooth (external hardware)
b. Relationships and Interactions
- Flutter UI invokes methods on SensieEngine (Dart API)
- Dart API marshals arguments over MethodChannel
- Platform plugin receives channel calls, translates into vendor SDK calls
- Vendor SDK communicates with device sensors via Bluetooth
- Native plugin returns sensor data/results back up the channel
- Dart layer dispatches callbacks to application
c. Architectural Patterns
- Plugin Pattern: platform interface + method channels
- Asynchronous API: futures and callbacks in Dart
- Separation of concerns: UI vs. plugin vs. native SDK
d. Relevant Technologies
- Flutter & Dart
- MethodChannel (flutter/services)
- Android: Java, AAR package, Gradle
- iOS: Swift, CocoaPods, .framework
- Bluetooth / sensor APIs inside vendor SDK

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Flutter Layer"
        direction TB
        ExampleApp["Flutter App (example/)"]:::dart
        subgraph "Dart API Layer"
            direction TB
            SensieEngine["SensieEngine"]:::dart
            CalibrationSession["CalibrationSession"]:::dart
            SensiePublic["sensie.dart"]:::dart
            Types["types.dart"]:::dart
            PlatformInterface["plugin_sensie_platform_interface.dart"]:::dart
            MethodChannel["plugin_sensie_method_channel.dart"]:::channel
        end
    end

    subgraph "Native Plugins"
        direction TB
        subgraph "Android Plugin"
            direction TB
            JavaPlugin["PluginSensiePlugin.java"]:::android
            AAR["SensieLibrary.aar"]:::ext
            Gradle["build.gradle"]:::android
        end
        subgraph "iOS Plugin"
            direction TB
            SwiftPlugin["PluginSensiePlugin.swift"]:::ios
            Wrapper["Wrapper.swift"]:::ios
            Framework["SensieFramework.framework"]:::ext
            Podspec["plugin_sensie.podspec"]:::ios
        end
    end

    Hardware["Device Sensors / Bluetooth"]:::ext

    ExampleApp -->|"uses"| SensieEngine
    SensieEngine -->|"init,connect, startCalibration, captureSensie, setAgreement"| MethodChannel
    CalibrationSession -->|"session methods"| MethodChannel

    MethodChannel -->|"invokeMethod"| JavaPlugin
    MethodChannel -->|"invokeMethod"| SwiftPlugin

    JavaPlugin -->|"calls SDK"| AAR
    SwiftPlugin -->|"calls SDK"| Framework

    AAR -->|"Bluetooth comm"| Hardware
    Framework -->|"Bluetooth comm"| Hardware

    Hardware -->|"sensor data"| JavaPlugin
    Hardware -->|"sensor data"| SwiftPlugin

    JavaPlugin -->|"result"| MethodChannel
    SwiftPlugin -->|"result"| MethodChannel

    MethodChannel -->|"callback"| SensieEngine
    MethodChannel -->|"callback"| CalibrationSession

    classDef dart fill:#D0E8FF,stroke:#0080FF,color:#000
    classDef channel fill:#E0FFE0,stroke:#00CC00,color:#000
    classDef android fill:#FFE0B2,stroke:#FF8000,color:#000
    classDef ios fill:#E1B2FF,stroke:#8000FF,color:#000
    classDef ext fill:#F0F0F0,stroke:#666666,color:#000

    click ExampleApp "https://github.com/sensie-app/flutter-sensie-plugin/tree/main/plugin_sensie/example/"
    click SensieEngine "https://github.com/sensie-app/flutter-sensie-plugin/blob/main/plugin_sensie/lib/sensie_engine.dart"
    click CalibrationSession "https://github.com/sensie-app/flutter-sensie-plugin/blob/main/plugin_sensie/lib/calibration_session.dart"
    click SensiePublic "https://github.com/sensie-app/flutter-sensie-plugin/blob/main/plugin_sensie/lib/sensie.dart"
    click Types "https://github.com/sensie-app/flutter-sensie-plugin/blob/main/plugin_sensie/lib/types.dart"
    click PlatformInterface "https://github.com/sensie-app/flutter-sensie-plugin/blob/main/plugin_sensie/lib/plugin_sensie_platform_interface.dart"
    click MethodChannel "https://github.com/sensie-app/flutter-sensie-plugin/blob/main/plugin_sensie/lib/plugin_sensie_method_channel.dart"
    click JavaPlugin "https://github.com/sensie-app/flutter-sensie-plugin/blob/main/plugin_sensie/android/src/main/java/com/sensie/plugin_sensie/PluginSensiePlugin.java"
    click AAR "https://github.com/sensie-app/flutter-sensie-plugin/blob/main/plugin_sensie/android/libs/SensieLibrary.aar"
    click Gradle "https://github.com/sensie-app/flutter-sensie-plugin/blob/main/plugin_sensie/android/build.gradle"
    click SwiftPlugin "https://github.com/sensie-app/flutter-sensie-plugin/blob/main/plugin_sensie/ios/Classes/PluginSensiePlugin.swift"
    click Wrapper "https://github.com/sensie-app/flutter-sensie-plugin/blob/main/plugin_sensie/ios/Wrapper.swift"
    click Framework "https://github.com/sensie-app/flutter-sensie-plugin/blob/main/plugin_sensie/ios/SensieFramework.framework"
    click Podspec "https://github.com/sensie-app/flutter-sensie-plugin/blob/main/plugin_sensie/ios/plugin_sensie.podspec"
```
