# sency-ai/smkit-ui-android-demo architecture

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

- Interactive diagram: https://gitdiagram.com/sency-ai/smkit-ui-android-demo
- Repository: https://github.com/sency-ai/smkit-ui-android-demo

## Overview

##### Main Components

a) Client Application Layer:
- MainActivity (Entry point)
- MainViewModel (MVVM architecture component)
- XML Layouts (UI components)

b) SMKitUI SDK Integration Layer:
- Configuration Component
- Camera Integration
- Assessment Module
- Custom Workout Module

c) External Services:
- Sency Artifactory Repository
- Authentication Service (for UI Key validation)

- [User Interface Layer]
- ↓
- [Application Layer]
- ↓
- [SMKitUI SDK Layer]
- ↓
- [External Services Layer]

##### Component Relationships

a) User Interface Flow:
- MainActivity ←→ MainViewModel
- ↓
- SMKitUI Configuration
- ↓
- Camera Integration
- ↓
- Assessment/Custom Workout Features

b) Dependencies Flow:
- App Build System → Sency Artifactory
- SMKitUI Config → Authentication Service

##### Important Elements to Highlight

- Permission Requirements:
- Camera access
- Hardware features (camera, autofocus)
- Configuration Flow:
- UI Key validation
- Success/Failure callbacks
- SDK Version Constraints:
- Minimum SDK version 26
- Portrait orientation requirement

##### Technical Details

- SDK Version: 0.2.4
- Minimum Android SDK: 26
- Key Dependencies
- Required Permissions

##### Implementation Notes

Annotations for critical implementation points:
- Configuration must be called at app launch
- Portrait orientation requirement
- Camera permission handling
- Error handling pathways

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph UI
        MA[MainActivity]
        XML[XML Layouts]
        MVM[MainViewModel]
    end

    subgraph SDK
        Config[Configuration Component]
        Camera[Camera Integration]
        Assessment[Assessment Module]
        Workout[Custom Workout Module]
    end

    subgraph External
        Artifactory[Sency Artifactory]
        Auth[Authentication Service]
    end

    subgraph Requirements
        direction TB
        Permissions[Required Permissions]
        Hardware[Hardware Requirements]
        Version[Version Constraints]
    end

    %% Relationships
    MA --> MVM
    MA --> XML
    MA --> Config
    Config --> Camera
    Camera --> Assessment
    Camera --> Workout
    Config --> Auth
    MA --> Permissions

    %% Technical Requirements
    Version --> MA
    Hardware --> Camera
    
    classDef ui fill:#2196F3,stroke:#1565C0,color:white
    classDef sdk fill:#4CAF50,stroke:#388E3C,color:white
    classDef external fill:#9E9E9E,stroke:#616161,color:white
    classDef requirements fill:#FF9800,stroke:#F57C00,color:white

    class MA,MVM,XML ui
    class Config,Camera,Assessment,Workout sdk
    class Artifactory,Auth external
    class Permissions,Hardware,Version requirements

    %% Click Events
    click MA "https://github.com/sency-ai/smkit-ui-android-demo/blob/main/app/src/main/java/com/example/smkituidemoapp/MainActivity.kt"
    click MVM "https://github.com/sency-ai/smkit-ui-android-demo/blob/main/app/src/main/java/com/example/smkituidemoapp/viewModels/MainViewModel.kt"
    click XML "https://github.com/sency-ai/smkit-ui-android-demo/blob/main/app/src/main/res/layout/main_activity.xml"
    click Assessment "https://github.com/sency-ai/smkit-ui-android-demo/blob/main/Assessment.md"
    click Workout "https://github.com/sency-ai/smkit-ui-android-demo/blob/main/CustomWorkout.md"
    click Permissions "https://github.com/sency-ai/smkit-ui-android-demo/blob/main/app/src/main/AndroidManifest.xml"
    click Version "https://github.com/sency-ai/smkit-ui-android-demo/blob/main/gradle/libs.versions.toml"

    %% Legend
    subgraph Legend
        direction TB
        L1[UI Components]:::ui
        L2[SDK Components]:::sdk
        L3[External Services]:::external
        L4[Requirements]:::requirements
    end
```
