# jnunez2001/rj-pisowifi architecture

> Architecture diagram of the GitHub repository jnunez2001/rj-pisowifi, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jnunez2001/rj-pisowifi
- Repository: https://github.com/jnunez2001/rj-pisowifi

## Overview

R&J PisoWifi provides coin-operated WiFi access and PC rental, in standalone or external-router mode. The WiFi flow runs from coin input or voucher through server-side credit/session handling, network access control, and timed expiry; administrators configure and monitor the service, while customers use the portal. A separate Windows client supports PC rental and talks to rental API endpoints. The graph also preserves the ESP32/ESP8266 firmware and router-driver capabilities. Some links are documented only at the API or product level; those are dashed where source-level wiring was not shown.

Main entry points: [`server/config/database.js`](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/config/database.js) (SQLite database), [`server/routes/coin.js`](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/routes/coin.js) (Coin endpoints), [`server/services/sessionService.js`](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/sessionService.js) (Session lifecycle), [`server/app.js`](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/app.js) (Express application)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_server["WiFi server"]
  node_db[("SQLite database<br/>[database.js]")]
  node_app["Express application<br/>[app.js]"]
  node_coin_route["Coin endpoints<br/>[coin.js]"]
  node_credit["Coin credit"]
  node_gpio["Coin-slot GPIO<br/>[coinslotGpio.js]"]
  node_session_route["Session endpoints<br/>[session.js]"]
  node_session["Session lifecycle<br/>[sessionService.js]"]
  node_timer["Session timer<br/>[timerService.js]"]
  node_network["Network dispatcher<br/>[networkService.js]"]
  node_drivers["Network drivers"]
  node_mikrotik["MikroTik control<br/>[mikrotikService.js]"]
  node_mikrotik_api["Router API client"]
  node_rental_api["Rental endpoints"]
end

subgraph group_access["Customer access"]
  node_portal["Customer portal<br/>[portal.js]"]
  node_vouchers["Voucher service<br/>[voucherService.js]"]
end

subgraph group_admin["Administration"]
  node_admin_routes["Admin API<br/>[admin.js]"]
  node_admin_ui["Admin panel"]
end

subgraph group_firmware["Coin hardware"]
  node_esp32["ESP32 firmware"]
  node_esp8266["ESP8266 firmware"]
end

subgraph group_pc["PC rental"]
  node_pc_client["Windows rental client<br/>[RentalApiClient.cs]"]
  node_pc_ui["Rental UI<br/>[Program.cs]"]
end

node_customer(("Customer"))
node_admin_actor(("Administrator"))

node_app -->|"initializes"| node_db
node_app -->|"mounts routes"| node_coin_route
node_app -->|"mounts routes"| node_session_route
node_app -->|"mounts routes"| node_portal
node_coin_route -->|"credits coins"| node_credit
node_coin_route -->|"uses GPIO"| node_gpio
node_coin_route -->|"reads and writes"| node_db
node_gpio -->|"credits coins"| node_credit
node_session_route -->|"manages sessions"| node_session
node_session_route -->|"reads and writes"| node_db
node_session -->|"reads and writes"| node_db
node_session -->|"generates vouchers"| node_vouchers
node_session -->|"controls access"| node_network
node_timer -->|"expires sessions"| node_session
node_timer -->|"shapes traffic"| node_network
node_network -->|"dispatches to"| node_drivers
node_drivers -.->|"selects backend"| node_mikrotik
node_mikrotik -->|"uses client"| node_mikrotik_api
node_portal -->|"reads data"| node_db
node_portal -->|"handles vouchers"| node_vouchers
node_admin_routes -->|"reads and writes"| node_db
node_admin_actor -.->|"uses"| node_admin_ui
node_admin_ui -.->|"calls API"| node_admin_routes
node_customer -.->|"opens portal"| node_portal
node_esp32 -.->|"reports coin input"| node_coin_route
node_esp8266 -.->|"reports coin input"| node_coin_route
node_pc_ui -->|"uses API client"| node_pc_client
node_pc_client -.->|"calls endpoints"| node_rental_api
node_rental_api -.->|"persists rental state"| node_db

click node_db "https://github.com/jnunez2001/rj-pisowifi/blob/main/server/config/database.js"
click node_app "https://github.com/jnunez2001/rj-pisowifi/blob/main/server/app.js"
click node_coin_route "https://github.com/jnunez2001/rj-pisowifi/blob/main/server/routes/coin.js"
click node_credit "https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/coinCreditService.js"
click node_gpio "https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/coinslotGpio.js"
click node_session_route "https://github.com/jnunez2001/rj-pisowifi/blob/main/server/routes/session.js"
click node_session "https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/sessionService.js"
click node_timer "https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/timerService.js"
click node_network "https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/networkService.js"
click node_drivers "https://github.com/jnunez2001/rj-pisowifi/tree/main/server/services/drivers"
click node_mikrotik "https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/mikrotikService.js"
click node_mikrotik_api "https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/mikrotikApiClient.js"
click node_portal "https://github.com/jnunez2001/rj-pisowifi/blob/main/server/routes/portal.js"
click node_vouchers "https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/voucherService.js"
click node_admin_routes "https://github.com/jnunez2001/rj-pisowifi/blob/main/server/routes/admin.js"
click node_admin_ui "https://github.com/jnunez2001/rj-pisowifi/tree/main/public/admin/js"
click node_esp32 "https://github.com/jnunez2001/rj-pisowifi/tree/main/esp32/firmware/rj_pisowifi"
click node_esp8266 "https://github.com/jnunez2001/rj-pisowifi/tree/main/esp8266/firmware/rj_pisowifi_esp8266"
click node_pc_client "https://github.com/jnunez2001/rj-pisowifi/blob/main/windows-rental-client/RentalApiClient.cs"
click node_pc_ui "https://github.com/jnunez2001/rj-pisowifi/blob/main/windows-rental-client/Program.cs"
click node_rental_api "https://github.com/jnunez2001/rj-pisowifi/tree/main/server/routes"

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_db,node_app,node_coin_route,node_credit,node_gpio,node_session_route,node_session,node_timer,node_network,node_drivers,node_mikrotik,node_mikrotik_api,node_rental_api toneBlue
class node_portal,node_vouchers toneAmber
class node_admin_routes,node_admin_ui toneMint
class node_esp32,node_esp8266 toneRose
class node_pc_client,node_pc_ui,node_customer,node_admin_actor toneIndigo
```

## Components

### WiFi server

- [SQLite database](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/config/database.js): `server/config/database.js`
- [Express application](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/app.js): `server/app.js`
- [Coin endpoints](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/routes/coin.js): `server/routes/coin.js`
- [Coin credit](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/coinCreditService.js): `server/services/coinCreditService.js`
- [Coin-slot GPIO](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/coinslotGpio.js): `server/services/coinslotGpio.js`
- [Session endpoints](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/routes/session.js): `server/routes/session.js`
- [Session lifecycle](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/sessionService.js): `server/services/sessionService.js`
- [Session timer](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/timerService.js): `server/services/timerService.js`
- [Network dispatcher](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/networkService.js): `server/services/networkService.js`
- [Network drivers](https://github.com/jnunez2001/rj-pisowifi/tree/main/server/services/drivers): `server/services/drivers`
- [MikroTik control](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/mikrotikService.js): `server/services/mikrotikService.js`
- [Router API client](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/mikrotikApiClient.js): `server/services/mikrotikApiClient.js`
- [Rental endpoints](https://github.com/jnunez2001/rj-pisowifi/tree/main/server/routes): `server/routes`

### Customer access

- [Customer portal](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/routes/portal.js): `server/routes/portal.js`
- [Voucher service](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/services/voucherService.js): `server/services/voucherService.js`

### Administration

- [Admin API](https://github.com/jnunez2001/rj-pisowifi/blob/main/server/routes/admin.js): `server/routes/admin.js`
- [Admin panel](https://github.com/jnunez2001/rj-pisowifi/tree/main/public/admin/js): `public/admin/js`

### Coin hardware

- [ESP32 firmware](https://github.com/jnunez2001/rj-pisowifi/tree/main/esp32/firmware/rj_pisowifi): `esp32/firmware/rj_pisowifi`
- [ESP8266 firmware](https://github.com/jnunez2001/rj-pisowifi/tree/main/esp8266/firmware/rj_pisowifi_esp8266): `esp8266/firmware/rj_pisowifi_esp8266`

### PC rental

- [Windows rental client](https://github.com/jnunez2001/rj-pisowifi/blob/main/windows-rental-client/RentalApiClient.cs): `windows-rental-client/RentalApiClient.cs`
- [Rental UI](https://github.com/jnunez2001/rj-pisowifi/blob/main/windows-rental-client/Program.cs): `windows-rental-client/Program.cs`

### Other components

- **Customer**
- **Administrator**

## Connections

- Express application → SQLite database: initializes (evidence: `server/app.js`)
- Express application → Coin endpoints: mounts routes (evidence: `server/app.js`)
- Express application → Session endpoints: mounts routes (evidence: `server/app.js`)
- Express application → Customer portal: mounts routes (evidence: `server/app.js`)
- Coin endpoints → Coin credit: credits coins (evidence: `server/routes/coin.js`)
- Coin endpoints → Coin-slot GPIO: uses GPIO (evidence: `server/routes/coin.js`)
- Coin endpoints → SQLite database: reads and writes (evidence: `server/routes/coin.js`)
- Coin-slot GPIO → Coin credit: credits coins (evidence: `server/services/coinslotGpio.js`)
- Session endpoints → Session lifecycle: manages sessions (evidence: `server/routes/session.js`)
- Session endpoints → SQLite database: reads and writes (evidence: `server/routes/session.js`)
- Session lifecycle → SQLite database: reads and writes (evidence: `server/services/sessionService.js`)
- Session lifecycle → Voucher service: generates vouchers (evidence: `server/services/sessionService.js`)
- Session lifecycle → Network dispatcher: controls access (evidence: `server/services/sessionService.js`)
- Session timer → Session lifecycle: expires sessions (evidence: `server/services/timerService.js`)
- Session timer → Network dispatcher: shapes traffic (evidence: `server/services/timerService.js`)
- Network dispatcher → Network drivers: dispatches to (evidence: `server/services/networkService.js`)
- Network drivers → MikroTik control: selects backend
- MikroTik control → Router API client: uses client (evidence: `server/services/mikrotikService.js`)
- Customer portal → SQLite database: reads data (evidence: `server/routes/portal.js`)
- Customer portal → Voucher service: handles vouchers (evidence: `server/routes/portal.js`)
- Admin API → SQLite database: reads and writes (evidence: `server/routes/admin.js`)
- Administrator → Admin panel: uses
- Admin panel → Admin API: calls API
- Customer → Customer portal: opens portal
- ESP32 firmware → Coin endpoints: reports coin input
- ESP8266 firmware → Coin endpoints: reports coin input
- Rental UI → Windows rental client: uses API client (evidence: `windows-rental-client/Program.cs`)
- Windows rental client → Rental endpoints: calls endpoints
- Rental endpoints → SQLite database: persists rental state (evidence: `server/routes/session.js`)
