# bosakaczka/cyberpunk-terrarium architecture

> Architecture diagram of the GitHub repository bosakaczka/cyberpunk-terrarium, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bosakaczka/cyberpunk-terrarium
- Repository: https://github.com/bosakaczka/cyberpunk-terrarium

## Overview

Cyberpunk Terrarium is an ESP32-C3 terrarium display and lighting installation. On power-up, its firmware presents a boot intro, then scrolls randomly selected messages while animating the OLED and lighting effects; it also takes periodic GXHT30 readings and shows them between messages. The README documents these capabilities and identifies a single firmware sketch, but no source excerpts were provided, so internal call structure cannot be verified. The graph therefore shows documented responsibilities and hardware interactions without implying calls between firmware routines.

Main entry points: [`cyberpunk_terrarium/cyberpunk_terrarium.ino`](https://github.com/bosakaczka/cyberpunk-terrarium/blob/main/cyberpunk_terrarium/cyberpunk_terrarium.ino) (Terrarium firmware)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_firmware["Firmware"]
  node_sketch["Terrarium firmware"]
  node_boot["Boot intro"]
  node_messages["Message display"]
  node_glitches["Glitch effects"]
  node_sensor_logic["Sensor readings"]
  node_fluoro_logic["Fluorescent effect"]
  node_extra_led_logic["Extra LED effects"]
end

subgraph group_hardware["Terrarium hardware"]
  node_oled["SSD1306 OLED"]
  node_gxht30["GXHT30 sensor"]
  node_white_leds["White LEDs"]
  node_blue_leds["Blue LEDs"]
  node_red_led["Red beacon"]
end

node_power(("Power-on"))

node_power -->|"starts"| node_sketch
node_sketch -->|"shows intro"| node_boot
node_sketch -->|"scrolls messages"| node_messages
node_sketch -->|"animates"| node_glitches
node_sketch -->|"schedules readings"| node_sensor_logic
node_sketch -->|"updates effect"| node_fluoro_logic
node_sketch -->|"updates effects"| node_extra_led_logic
node_messages -->|"renders on"| node_oled
node_glitches -->|"alters display"| node_oled
node_sensor_logic -->|"measures"| node_gxht30
node_fluoro_logic -->|"drives"| node_white_leds
node_extra_led_logic -->|"flickers"| node_blue_leds
node_extra_led_logic -->|"flashes"| node_red_led

click node_sketch "https://github.com/bosakaczka/cyberpunk-terrarium/blob/main/cyberpunk_terrarium/cyberpunk_terrarium.ino"
click node_boot "https://github.com/bosakaczka/cyberpunk-terrarium/blob/main/cyberpunk_terrarium/cyberpunk_terrarium.ino"
click node_messages "https://github.com/bosakaczka/cyberpunk-terrarium/blob/main/cyberpunk_terrarium/cyberpunk_terrarium.ino"
click node_glitches "https://github.com/bosakaczka/cyberpunk-terrarium/blob/main/cyberpunk_terrarium/cyberpunk_terrarium.ino"
click node_sensor_logic "https://github.com/bosakaczka/cyberpunk-terrarium/blob/main/cyberpunk_terrarium/cyberpunk_terrarium.ino"
click node_fluoro_logic "https://github.com/bosakaczka/cyberpunk-terrarium/blob/main/cyberpunk_terrarium/cyberpunk_terrarium.ino"
click node_extra_led_logic "https://github.com/bosakaczka/cyberpunk-terrarium/blob/main/cyberpunk_terrarium/cyberpunk_terrarium.ino"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_sketch,node_boot,node_messages,node_glitches,node_sensor_logic,node_fluoro_logic,node_extra_led_logic toneBlue
class node_oled,node_gxht30,node_white_leds,node_blue_leds,node_red_led toneAmber
class node_power toneIndigo
```

## Components

### Firmware

- [Terrarium firmware](https://github.com/bosakaczka/cyberpunk-terrarium/blob/main/cyberpunk_terrarium/cyberpunk_terrarium.ino): `cyberpunk_terrarium/cyberpunk_terrarium.ino`
- [Boot intro](https://github.com/bosakaczka/cyberpunk-terrarium/blob/main/cyberpunk_terrarium/cyberpunk_terrarium.ino): `cyberpunk_terrarium/cyberpunk_terrarium.ino`
- [Message display](https://github.com/bosakaczka/cyberpunk-terrarium/blob/main/cyberpunk_terrarium/cyberpunk_terrarium.ino): `cyberpunk_terrarium/cyberpunk_terrarium.ino`
- [Glitch effects](https://github.com/bosakaczka/cyberpunk-terrarium/blob/main/cyberpunk_terrarium/cyberpunk_terrarium.ino): `cyberpunk_terrarium/cyberpunk_terrarium.ino`
- [Sensor readings](https://github.com/bosakaczka/cyberpunk-terrarium/blob/main/cyberpunk_terrarium/cyberpunk_terrarium.ino): `cyberpunk_terrarium/cyberpunk_terrarium.ino`
- [Fluorescent effect](https://github.com/bosakaczka/cyberpunk-terrarium/blob/main/cyberpunk_terrarium/cyberpunk_terrarium.ino): `cyberpunk_terrarium/cyberpunk_terrarium.ino`
- [Extra LED effects](https://github.com/bosakaczka/cyberpunk-terrarium/blob/main/cyberpunk_terrarium/cyberpunk_terrarium.ino): `cyberpunk_terrarium/cyberpunk_terrarium.ino`

### Terrarium hardware

- **SSD1306 OLED**
- **GXHT30 sensor**
- **White LEDs**
- **Blue LEDs**
- **Red beacon**

### Other components

- **Power-on**

## Connections

- Power-on → Terrarium firmware: starts (evidence: `README.md`)
- Terrarium firmware → Boot intro: shows intro (evidence: `README.md`)
- Terrarium firmware → Message display: scrolls messages (evidence: `README.md`)
- Terrarium firmware → Glitch effects: animates (evidence: `README.md`)
- Terrarium firmware → Sensor readings: schedules readings (evidence: `README.md`)
- Terrarium firmware → Fluorescent effect: updates effect (evidence: `README.md`)
- Terrarium firmware → Extra LED effects: updates effects (evidence: `README.md`)
- Message display → SSD1306 OLED: renders on (evidence: `README.md`)
- Glitch effects → SSD1306 OLED: alters display (evidence: `README.md`)
- Sensor readings → GXHT30 sensor: measures (evidence: `README.md`)
- Fluorescent effect → White LEDs: drives (evidence: `README.md`)
- Extra LED effects → Blue LEDs: flickers (evidence: `README.md`)
- Extra LED effects → Red beacon: flashes (evidence: `README.md`)
