# intel/acat architecture

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

## Overview

##### Project type and purpose
- ACAT is a modular, desktop assistive‐communication toolkit written in C#/.NET 4.8.1.
- It provides text entry via a variety of input devices (actuators), word/sentence prediction, speech synthesis, on‐screen panels, and application‐specific adapters (agents).

##### File structure
- Top‐level **Applications/** directory holds several EXEs:
- ACATTalk (main UI for speech/typing)
- ACATConfig (configuration UI)
- ACATWatch (monitoring UI)
- ConvAssistTerminate, installers, etc.
- **Libraries/ACATCore/** contains the core runtime:
- Event bus, ActuatorManagement, PanelManagement, AgentManagement, CommandManagement, WordPredictorManagement, TTSManagement, PreferencesManagement, Audit, Animation, Theme, Widget management, utilities.
- **Libraries/ACATExtension/** holds default implementations and extension‐point support.
- **Extensions/** contains plugin DLLs grouped by extension point:
- Actuators (BCI, Camera, Sample)
- AppAgents (application‐specific adapters)
- UI Panels & UserControls
- WordPredictors (ConvAssist, etc.)
- SpellCheckers, TTSEngines
- **ACATResources/** and **Assets/** store XML configs, localization, themes, media assets.
- **3rdParty/** and **Extensions/.../External/** deliver binaries for Accord.NET, ZedGraph, BrainFlow, OpenCV helpers.
- Setup scripts and installer definitions under **Setup/**.

##### README for insights
- Confirms it’s a plugin-based, configurable platform originally built for Professor Hawking.
- Emphasizes extensibility: new interfaces, sensors, language predictors, etc.

a. Main components
- Applications (EXEs): ACATTalk, ACATConfig, ACATWatch
- Core Runtime (ACATCore DLLs)
- Plugin Loader (ExtensionInvoker)
- Extensions/Plugins: Actuators, AppAgents, UI, WordPredictors, TTSEngines, SpellCheckers
- Resources & Configuration: XML panels, themes, user settings, SQLite/JSON word predictor DB
- External Services/Binaries: third-party ML libs, executables for camera gesture
- OS Interfaces: NamedPipes, COM interop (SAPI), USB/serial, Win32 hooks
b. Relationships & data flow
1. User interacts with hardware (keyboard, BCI headset, camera).
2. Input routed to Actuator plugin → raises Actuator events.
3. Core Runtime enqueues events → CommandManager & Interpreter
4. PanelManagement displays scanning panels & widgets → user selection events
5. Interpreter/CommandManager issues actions (e.g., “type letter”, “invoke word predictor”).
6. WordPredictor plugin receives requests (via NamedPipe), queries local DB/ML model, returns predictions.
7. TTS plugin (SAPI or HTTP client) synthesizes text → audio output.
8. Actuator plugin simulates keyboard input or performs other output actions.
9. AppAgents monitor external applications to adapt panels (context awareness).
10. Audit & Logging record user actions, system events.
11. Preferences subsystem loads/saves user settings.
c. Architectural patterns & principles
- Plugin-based architecture: core + extension points (Dependency Inversion, IoC).
- Event-driven pipeline (publish/subscribe of Actuator events → command execution).
- Separation of concerns: UI panels vs. core logic vs. hardware interop.
- Use of external processes/binaries for compute-intensive tasks (camera gesture).
- Modular layering: Applications → Core → Extensions → 3rd-party/native.
d. Key technologies
- C#/.NET Framework 4.8.1, Visual Studio solution (.sln)
- XML for panel definitions, localization RESX
- NamedPipes for inter‐process plugin comms
- SQLite/JSON for word predictor DB
- COM interop for SAPI TTS, Win32 hooks
- Third-party ML libs (Accord.NET), graphing (ZedGraph), BrainFlow, OpenCV executables
- NSIS/Inno scripts + Python for installer

##### Essential points
- Fully capture the **layering**:
1. Applications (ACATTalk, ACATConfig)
2. Core Runtime (ACATCore libraries)
3. Plugin loader & Extension points
4. Extensions (Actuators, UI, Agents, Predictors, TTS, SpellCheckers)
5. External dependencies & OS interfaces
- **configuration sources** (XML, RESX, DB files) feeding into Core/Plugins

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Applications"
        ACATTalk["ACATTalk"] 
        ACATConfig["ACATConfig"] 
        ACATWatch["ACATWatch"]
    end
    class ACATTalk,ACATConfig,ACATWatch apps

    subgraph "Core Runtime"
        ActuatorMgr["ActuatorManager"]
        PanelMgr["PanelManager"]
        CmdMgr["CommandManager"]
        Interpreter["Interpreter"]
        PrefsMgr["PreferencesManager"]
        ExtensionInvoker["ExtensionInvoker"]
    end
    class ActuatorMgr,PanelMgr,CmdMgr,Interpreter,PrefsMgr,ExtensionInvoker core

    subgraph "Plugins"
        subgraph "Actuator Plugins"
            DefaultAct["Default Actuators"]
            BCIAct["BCI Actuators"]
        end
        subgraph "UI Panels"
            DefaultUI["Default UI Panels"]
            BCIUI["BCI UI Scanners"]
        end
        subgraph "AppAgents"
            DefaultAgents["Default AppAgents"]
            BCIAgents["BCI Control Agents"]
        end
        subgraph "WordPredictors"
            ConvAssist["ConvAssist Predictor"]
        end
        subgraph "TTSEngines"
            SAPIEngine["SAPI TTS Engine"]
            TTSClient["HTTP TTS Client"]
        end
        subgraph "SpellCheckers"
            SpellCheck["SpellChecker"]
        end
    end
    class DefaultAct,BCIAct,DefaultUI,BCIUI,DefaultAgents,BCIAgents,ConvAssist,SAPIEngine,TTSClient,SpellCheck plugins

    subgraph "External & Config"
        Hardware["Hardware Input (Keyboard/BCI/Camera)"]
        NamedPipes["NamedPipes IPC"]
        COMSAPI["COM Interop (SAPI)"]
        SQLiteDB["SQLite/JSON DB"]
        XMLConfigs["Panel XML configs"]
        RESX["Localization RESX"]
        Themes["Theme XML"]
        ThirdParty["3rdParty Libraries"]
        CameraExt["Camera Actuator Externals"]
        SetupFiles["Setup & Installer Scripts"]
    end
    class Hardware,NamedPipes,COMSAPI,SQLiteDB,XMLConfigs,RESX,Themes,ThirdParty,CameraExt,SetupFiles external

    Hardware -->|input| DefaultAct
    Hardware -->|input| BCIAct
    DefaultAct -->|events| ActuatorMgr
    BCIAct -->|events| ActuatorMgr
    ActuatorMgr --> PanelMgr
    PanelMgr -->|renders panels| DefaultUI
    PanelMgr -->|renders scanners| BCIUI
    PanelMgr --> XMLConfigs
    PanelMgr --> Themes
    CmdMgr -->|executes commands| ActuatorMgr
    Interpreter --> CmdMgr
    ActuatorMgr --> Interpreter
    ExtensionInvoker --> DefaultAct
    ExtensionInvoker --> BCIAct
    ExtensionInvoker --> DefaultUI
    ExtensionInvoker --> BCIUI
    ExtensionInvoker --> DefaultAgents
    ExtensionInvoker --> BCIAgents
    ExtensionInvoker --> ConvAssist
    ExtensionInvoker --> SAPIEngine
    ExtensionInvoker --> TTSClient
    ExtensionInvoker --> SpellCheck
    ActuatorMgr --> NamedPipes
    CmdMgr --> NamedPipes
    NamedPipes --> ConvAssist
    ConvAssist --> SQLiteDB
    SAPIEngine --> COMSAPI
    TTSClient --> COMSAPI
    PrefsMgr --> RESX
    PrefsMgr --> Themes
    SetupFiles --> ACATTalk
    SetupFiles --> ACATConfig
    SetupFiles --> ACATWatch

    click ACATTalk "https://github.com/intel/acat/tree/master/src/Applications/ACATTalk"
    click ACATConfig "https://github.com/intel/acat/tree/master/src/Applications/ACATConfig"
    click ACATWatch "https://github.com/intel/acat/tree/master/src/Applications/ACATWatch"
    click ExtensionInvoker "https://github.com/intel/acat/blob/master/src/Libraries/ACATCore/Extensions/ExtensionInvoker.cs"
    click DefaultAct "https://github.com/intel/acat/tree/master/src/Extensions/Default/Actuators"
    click BCIAct "https://github.com/intel/acat/tree/master/src/Extensions/BCI/Actuators"
    click DefaultUI "https://github.com/intel/acat/tree/master/src/Extensions/Default/UI"
    click BCIUI "https://github.com/intel/acat/tree/master/src/Extensions/BCI/UI"
    click DefaultAgents "https://github.com/intel/acat/tree/master/src/Extensions/Default/AppAgents"
    click BCIAgents "https://github.com/intel/acat/tree/master/src/Extensions/BCI/Common/BCIControl"
    click ConvAssist "https://github.com/intel/acat/tree/master/src/Extensions/Default/WordPredictors/ConvAssist"
    click SAPIEngine "https://github.com/intel/acat/tree/master/src/Extensions/Default/TTSEngines/SAPIEngine"
    click TTSClient "https://github.com/intel/acat/tree/master/src/Extensions/Default/TTSEngines/TTSClient"
    click SpellCheck "https://github.com/intel/acat/tree/master/src/Extensions/Default/SpellCheckers/SpellCheck"
    click XMLConfigs "https://github.com/intel/acat/blob/master/src/ACATResources/en/*.xml"
    click RESX "https://github.com/intel/acat/blob/master/src/ACATResources/*.resx"
    click Themes "https://github.com/intel/acat/blob/master/src/Assets/Themes/Default/Theme.xml"
    click ThirdParty "https://github.com/intel/acat/tree/master/src/3rdParty"
    click CameraExt "https://github.com/intel/acat/tree/master/src/Extensions/Default/Actuators/CameraActuator/External"
    click SetupFiles "https://github.com/intel/acat/tree/master/src/Setup"

    classDef core fill:#e0f7fa,stroke:#006064,color:#000;
    classDef plugins fill:#e8f5e9,stroke:#2e7d32,color:#000;
    classDef apps fill:#fff9c4,stroke:#f9a825,color:#000;
    classDef external fill:#ffe0b2,stroke:#ef6c00,color:#000;
```
