# sujaldev/bison architecture

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

- Interactive diagram: https://gitdiagram.com/sujaldev/bison
- Repository: https://github.com/sujaldev/bison

## Overview

##### Main System Components

a. Hardware/Physical Components (from CAD files)
- Mechanical assembly (test jig)
- Sensor mounting system
- Circuit housing

b. Firmware Component
- Embedded system running on microcontroller
- Sensor interfaces

c. Client Software
- Python-based interface

**[Physical Layer]**

- Mechanical Components
- Test Jig Assembly
- Load Cell
- Mounting System

- Electronic Components
- Circuit Board
- Sensors

**[Firmware Layer]**

- Microcontroller
- Sensor Data Processing
- Communication Interface

**[Software Layer]**

- Python Client
- Data Visualization/Analysis

##### Component Relationships

Use the following connection types:
- Double lines for mechanical connections

##### Additional Elements

- Sensor types and locations
- Communication protocols used
- Data processing pipeline
- Power distribution
- Mounting interface with bicycle

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef mechanical fill:#b3d9ff,stroke:#333
    classDef electronic fill:#90EE90,stroke:#333
    classDef firmware fill:#FFB366,stroke:#333
    classDef software fill:#DDA0DD,stroke:#333

    subgraph Physical
        subgraph Mechanical
            TestJig["Test Jig Assembly"]:::mechanical
            LoadCell["Load Cell"]:::mechanical
            CrankSystem["Crank System"]:::mechanical
            PedalSystem["Pedal System"]:::mechanical
            MountSystem["Mounting System"]:::mechanical
            BearingSystem["Bearing System"]:::mechanical
            
            TestJig --> LoadCell
            TestJig --> CrankSystem
            TestJig --> PedalSystem
            TestJig --> MountSystem
            TestJig --> BearingSystem
        end

        subgraph Electronics
            Circuit["Circuit Board"]:::electronic
            Sensors["Sensors"]:::electronic
            
            Circuit --- Sensors
        end

        Sensors -.-> LoadCell
    end

    subgraph Firmware
        Controller["Main Controller"]:::firmware
        Libraries["External Libraries"]:::firmware
        Headers["Header Files"]:::firmware
        
        Controller --> Libraries
        Controller --> Headers
    end

    subgraph Software
        PythonClient["Python Client"]:::software
        ClientDeps["Client Dependencies"]:::software
        
        PythonClient --> ClientDeps
    end

    %% Cross-layer connections
    Sensors ==> Controller
    Controller ==> PythonClient

    %% Click events for component mapping
    click TestJig "https://github.com/sujaldev/bison/blob/main/cad/test-jig/test-jig-assembly.f3z"
    click LoadCell "https://github.com/sujaldev/bison/blob/main/cad/test-jig/load-cell.f3d"
    click CrankSystem "https://github.com/sujaldev/bison/blob/main/cad/test-jig/crank-arm.f3d"
    click PedalSystem "https://github.com/sujaldev/bison/blob/main/cad/test-jig/pedal.f3d"
    click MountSystem "https://github.com/sujaldev/bison/blob/main/cad/test-jig/table-attachment.f3d"
    click BearingSystem "https://github.com/sujaldev/bison/blob/main/cad/test-jig/bearing.f3d"
    click Controller "https://github.com/sujaldev/bison/blob/main/firmware/src/main.cpp"
    click Libraries "https://github.com/sujaldev/bison/tree/main/firmware/lib/"
    click Headers "https://github.com/sujaldev/bison/tree/main/firmware/include/"
    click PythonClient "https://github.com/sujaldev/bison/blob/main/client/main.py"
    click ClientDeps "https://github.com/sujaldev/bison/blob/main/client/requirements.txt"

    %% Legend
    subgraph Legend
        L1[" "]:::mechanical
        L2[" "]:::electronic
        L3[" "]:::firmware
        L4[" "]:::software
        L1_text["Mechanical"]
        L2_text["Electronic"]
        L3_text["Firmware"]
        L4_text["Software"]
    end
```
