# usenocturne/nocturne-image architecture

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

- Interactive diagram: https://gitdiagram.com/usenocturne/nocturne-image
- Repository: https://github.com/usenocturne/nocturne-image

## Overview

##### Main Components

a. Hardware Layer:
- Spotify Car Thing Device
- Raspberry Pi (Host Device)
- USB Connections

b. System Layer:
- Debian 12 Base System
- System Services (/files/data/lib/systemd/system/)
- Configuration Files (/files/data/etc/)

c. Application Layer:
- Chromium Browser Service
- VNC Service
- USB Gadget Service
- Brightness Control System
- Nocturne Web Application

**┌─────────────────────────────────────────────┐**
- Hardware Layer                 │
- ┘
- ↕
**┌─────────────────────────────────────────────┐**
- System Layer                   │
- ┘
- ↕
**┌─────────────────────────────────────────────┐**
- Application Layer                │
- ┘

##### Component Relationships

- Data flow (→): Between components that exchange information
- Dependencies (⇢): Between services that rely on each other
- USB connections (⇌): Between hardware components

##### Specific Implementation Details

a. Boot Process:
- System initialization
- Service startup sequence
- Configuration

b. Service Integration:
- Chromium service for web interface
- VNC service for remote access
- Brightness control system
- USB gadget configuration

c. Configuration Management:
- System configuration files
- Chromium policies
- Settings

##### Additional Elements

Annotations for:
- Setup requirements
- Network connectivity options (desk vs. car setup)
- Spotify integration points
- System requirements

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Hardware
        CT[Car Thing Device]:::hardware
        RPI[Raspberry Pi Host]:::hardware
        USB[USB Connections]:::hardware
        CT --- USB
        USB --- RPI
    end

    subgraph System
        DEB[Debian 12 Base]:::system
        SYSD[System Services]:::system
        CONF[Configuration Files]:::system
        
        DEB --> SYSD
        DEB --> CONF
        
        click SYSD "https://github.com/usenocturne/nocturne-image/tree/main//files/data/lib/systemd/system/"
        click CONF "https://github.com/usenocturne/nocturne-image/tree/main//files/data/etc/"
    end

    subgraph Applications
        CHRM[Chromium Browser]:::app
        VNC[VNC Service]:::app
        USBG[USB Gadget Service]:::app
        BRT[Brightness Control]:::app
        WEB[Nocturne Web App]:::app
        
        CHRM --> WEB
        
        click CHRM "https://github.com/usenocturne/nocturne-image/blob/main//files/data/lib/systemd/system/chromium.service"
        click VNC "https://github.com/usenocturne/nocturne-image/blob/main//files/data/lib/systemd/system/vnc.service"
        click USBG "https://github.com/usenocturne/nocturne-image/blob/main//files/data/lib/systemd/system/usbgadget.service"
        click BRT "https://github.com/usenocturne/nocturne-image/blob/main//files/data/lib/systemd/system/brightness-control.service"
    end

    subgraph Configuration
        CHRC[Chromium Config]:::config
        VNCC[VNC Config]:::config
        USBC[USB Gadget Config]:::config
        BRTC[Brightness Settings]:::config
        DISP[Display Config]:::config
        
        click CHRC "https://github.com/usenocturne/nocturne-image/blob/main//files/data/etc/chromium/policies/managed/managed_policies.json"
        click VNCC "https://github.com/usenocturne/nocturne-image/tree/main//files/data/scripts/vnc_passwd"
        click USBC "https://github.com/usenocturne/nocturne-image/tree/main//files/system_a/etc/init.d/S49usbgadget"
        click BRTC "https://github.com/usenocturne/nocturne-image/blob/main//files/data/scripts/brightness_settings.py"
        click DISP "https://github.com/usenocturne/nocturne-image/blob/main//files/data/etc/X11/xorg.conf"
    end

    subgraph Scripts
        CHRMS[Chromium Scripts]:::script
        VNCS[VNC Scripts]:::script
        USBS[USB Scripts]:::script
        BRTS[Brightness Scripts]:::script
        DISPS[Display Scripts]:::script
        
        click CHRMS "https://github.com/usenocturne/nocturne-image/blob/main//files/data/scripts/start_chromium.sh"
        click VNCS "https://github.com/usenocturne/nocturne-image/blob/main//files/data/scripts/setup_vnc.sh"
        click USBS "https://github.com/usenocturne/nocturne-image/blob/main//files/data/scripts/setup_usbgadget.sh"
        click BRTS "https://github.com/usenocturne/nocturne-image/blob/main//files/data/scripts/brightness-control.py"
        click DISPS "https://github.com/usenocturne/nocturne-image/blob/main//files/data/scripts/setup_display.sh"
    end

    %% Relationships
    Hardware --> System
    System --> Applications
    Applications --> Configuration
    Configuration --> Scripts

    %% Styles
    classDef hardware fill:#E0E0E0,stroke:#333,stroke-width:2px
    classDef system fill:#B3E0FF,stroke:#333,stroke-width:2px
    classDef app fill:#FFB366,stroke:#333,stroke-width:2px
    classDef config fill:#90EE90,stroke:#333,stroke-width:2px
    classDef script fill:#FFE5B4,stroke:#333,stroke-width:2px

    %% Legend
    subgraph Legend
        L1[Hardware Component]:::hardware
        L2[System Component]:::system
        L3[Application Component]:::app
        L4[Configuration Component]:::config
        L5[Script Component]:::script
    end
```
