@dheerajsom/pinhub 0.1.0

package/dist/boards/pico-shared.js

@@ -0,0 +1,108 @@
+/**
+ * Raspberry Pi Pico / Pico W 40-pin castellated DIP edge. Physical pins run
+ * 1–20 down the left side and 21–40 back up the right side (USB at the top),
+ * so row r pairs physical pin r with physical pin 41−r.
+ */
+function edge(physical, label, category, extra = {}) {
+    const left = physical <= 20;
+    return {
+        physical,
+        position: {
+            row: left ? physical : 41 - physical,
+            column: left ? 1 : 2,
+        },
+        label,
+        category,
+        ...extra,
+    };
+}
+const V33 = { voltage: "3.3 V" };
+export function picoEdgeHeader() {
+    return {
+        id: "dip-edge",
+        name: "40-pin castellated DIP edge",
+        description: "Viewed from above with the USB connector at the top; pin 1 is top-left, pin 40 top-right.",
+        layout: { rows: 20, columns: 2 },
+        pins: [
+            edge(1, "GP0", "communication", { gpio: "GP0", functions: ["UART0 TX"], ...V33 }),
+            edge(2, "GP1", "communication", { gpio: "GP1", functions: ["UART0 RX"], ...V33 }),
+            edge(3, "GND", "ground"),
+            edge(4, "GP2", "gpio", { gpio: "GP2", ...V33 }),
+            edge(5, "GP3", "gpio", { gpio: "GP3", ...V33 }),
+            edge(6, "GP4", "communication", { gpio: "GP4", functions: ["I2C0 SDA"], ...V33 }),
+            edge(7, "GP5", "communication", { gpio: "GP5", functions: ["I2C0 SCL"], ...V33 }),
+            edge(8, "GND", "ground"),
+            edge(9, "GP6", "gpio", { gpio: "GP6", ...V33 }),
+            edge(10, "GP7", "gpio", { gpio: "GP7", ...V33 }),
+            edge(11, "GP8", "communication", { gpio: "GP8", functions: ["SPI1 RX"], ...V33 }),
+            edge(12, "GP9", "communication", { gpio: "GP9", functions: ["SPI1 CSn"], ...V33 }),
+            edge(13, "GND", "ground"),
+            edge(14, "GP10", "communication", { gpio: "GP10", functions: ["SPI1 SCK"], ...V33 }),
+            edge(15, "GP11", "communication", { gpio: "GP11", functions: ["SPI1 TX"], ...V33 }),
+            edge(16, "GP12", "gpio", { gpio: "GP12", ...V33 }),
+            edge(17, "GP13", "gpio", { gpio: "GP13", ...V33 }),
+            edge(18, "GND", "ground"),
+            edge(19, "GP14", "gpio", { gpio: "GP14", ...V33 }),
+            edge(20, "GP15", "gpio", { gpio: "GP15", ...V33 }),
+            edge(21, "GP16", "communication", { gpio: "GP16", functions: ["SPI0 RX"], ...V33 }),
+            edge(22, "GP17", "communication", { gpio: "GP17", functions: ["SPI0 CSn"], ...V33 }),
+            edge(23, "GND", "ground"),
+            edge(24, "GP18", "communication", { gpio: "GP18", functions: ["SPI0 SCK"], ...V33 }),
+            edge(25, "GP19", "communication", { gpio: "GP19", functions: ["SPI0 TX"], ...V33 }),
+            edge(26, "GP20", "communication", { gpio: "GP20", functions: ["I2C0 SDA"], ...V33 }),
+            edge(27, "GP21", "communication", { gpio: "GP21", functions: ["I2C0 SCL"], ...V33 }),
+            edge(28, "GND", "ground"),
+            edge(29, "GP22", "gpio", { gpio: "GP22", ...V33 }),
+            edge(30, "RUN", "reserved", {
+                notes: ["Reset control: pull low to reset the board"],
+                ...V33,
+            }),
+            edge(31, "GP26", "analog", { gpio: "GP26", functions: ["ADC0"], ...V33 }),
+            edge(32, "GP27", "analog", { gpio: "GP27", functions: ["ADC1"], ...V33 }),
+            edge(33, "AGND", "ground", { notes: ["Analog ground reference"] }),
+            edge(34, "GP28", "analog", { gpio: "GP28", functions: ["ADC2"], ...V33 }),
+            edge(35, "ADC_VREF", "analog", {
+                notes: ["ADC reference voltage input/output"],
+                ...V33,
+            }),
+            edge(36, "3V3", "power", { voltage: "3.3 V", functions: ["3V3(OUT)"] }),
+            edge(37, "3V3_EN", "reserved", {
+                notes: ["Pull low to disable the onboard 3.3 V regulator"],
+            }),
+            edge(38, "GND", "ground"),
+            edge(39, "VSYS", "power", { voltage: "1.8–5.5 V", notes: ["Main system input voltage"] }),
+            edge(40, "VBUS", "power", { voltage: "5 V", notes: ["USB bus voltage"] }),
+        ],
+    };
+}
+export function picoDebugHeader(swdName) {
+    return {
+        id: "swd",
+        name: swdName,
+        layout: { rows: 3, columns: 1 },
+        pins: [
+            {
+                physical: 1,
+                position: { row: 1, column: 1 },
+                label: "SWCLK",
+                category: "communication",
+                functions: ["SWD clock"],
+                voltage: "3.3 V",
+            },
+            {
+                physical: 2,
+                position: { row: 2, column: 1 },
+                label: "GND",
+                category: "ground",
+            },
+            {
+                physical: 3,
+                position: { row: 3, column: 1 },
+                label: "SWDIO",
+                category: "communication",
+                functions: ["SWD data"],
+                voltage: "3.3 V",
+            },
+        ],
+    };
+}

package/dist/boards/raspberry-pi-5.d.ts

@@ -0,0 +1,2 @@
+import type { Board } from "../model.js";
+export declare const raspberryPi5: Board;

package/dist/boards/raspberry-pi-5.js

@@ -0,0 +1,108 @@
+/**
+ * 40-pin J8 header pin. Odd physical pins sit in column 1, even in column 2,
+ * one pin pair per row — matching the physical header viewed from above.
+ */
+function j8(physical, label, category, extra = {}) {
+    return {
+        physical,
+        position: { row: Math.ceil(physical / 2), column: physical % 2 === 1 ? 1 : 2 },
+        label,
+        category,
+        ...extra,
+    };
+}
+const V33 = { voltage: "3.3 V" };
+export const raspberryPi5 = {
+    id: "raspberry-pi-5",
+    name: "Raspberry Pi 5",
+    manufacturer: "Raspberry Pi",
+    aliases: ["rpi5", "pi5", "raspberry-pi-5", "rpi-5", "pi-5", "raspi5"],
+    description: "Current mainstream Raspberry Pi SBC with the standard 40-pin GPIO header (Broadcom BCM2712).",
+    revisionNote: "The J8 40-pin header layout shown here is shared by all modern 40-pin Raspberry Pi models.",
+    warnings: [
+        {
+            severity: "danger",
+            text: "GPIO uses 3.3 V logic. Do not apply 5 V to any GPIO pin.",
+        },
+        {
+            severity: "warning",
+            text: "Physical pins 27 and 28 (GPIO0/GPIO1, ID_SD/ID_SC) are reserved for the HAT ID EEPROM; avoid general-purpose use.",
+        },
+        {
+            severity: "info",
+            text: "Pin numbers are the physical J8 header numbers; GPIO numbers are BCM numbering.",
+        },
+    ],
+    sources: [
+        {
+            title: "Raspberry Pi GPIO documentation",
+            url: "https://www.raspberrypi.com/documentation/computers/raspberry-pi.html",
+            official: true,
+        },
+        {
+            title: "Raspberry Pi 5 product brief",
+            url: "https://datasheets.raspberrypi.com/rpi5/raspberry-pi-5-product-brief.pdf",
+            official: true,
+        },
+    ],
+    headers: [
+        {
+            id: "j8",
+            name: "40-pin GPIO header (J8)",
+            description: "Viewed from above with pin 1 at the top-left of the header.",
+            layout: { rows: 20, columns: 2 },
+            pins: [
+                j8(1, "3V3", "power", { voltage: "3.3 V" }),
+                j8(2, "5V", "power", { voltage: "5 V" }),
+                j8(3, "GPIO2", "communication", { gpio: "GPIO2", functions: ["SDA1"], ...V33 }),
+                j8(4, "5V", "power", { voltage: "5 V" }),
+                j8(5, "GPIO3", "communication", { gpio: "GPIO3", functions: ["SCL1"], ...V33 }),
+                j8(6, "GND", "ground"),
+                j8(7, "GPIO4", "gpio", { gpio: "GPIO4", functions: ["GPCLK0"], ...V33 }),
+                j8(8, "GPIO14", "communication", { gpio: "GPIO14", functions: ["TXD0"], ...V33 }),
+                j8(9, "GND", "ground"),
+                j8(10, "GPIO15", "communication", { gpio: "GPIO15", functions: ["RXD0"], ...V33 }),
+                j8(11, "GPIO17", "gpio", { gpio: "GPIO17", ...V33 }),
+                j8(12, "GPIO18", "gpio", { gpio: "GPIO18", functions: ["PWM0", "PCM_CLK"], ...V33 }),
+                j8(13, "GPIO27", "gpio", { gpio: "GPIO27", ...V33 }),
+                j8(14, "GND", "ground"),
+                j8(15, "GPIO22", "gpio", { gpio: "GPIO22", ...V33 }),
+                j8(16, "GPIO23", "gpio", { gpio: "GPIO23", ...V33 }),
+                j8(17, "3V3", "power", { voltage: "3.3 V" }),
+                j8(18, "GPIO24", "gpio", { gpio: "GPIO24", ...V33 }),
+                j8(19, "GPIO10", "communication", { gpio: "GPIO10", functions: ["SPI0 MOSI"], ...V33 }),
+                j8(20, "GND", "ground"),
+                j8(21, "GPIO9", "communication", { gpio: "GPIO9", functions: ["SPI0 MISO"], ...V33 }),
+                j8(22, "GPIO25", "gpio", { gpio: "GPIO25", ...V33 }),
+                j8(23, "GPIO11", "communication", { gpio: "GPIO11", functions: ["SPI0 SCLK"], ...V33 }),
+                j8(24, "GPIO8", "communication", { gpio: "GPIO8", functions: ["SPI0 CE0"], ...V33 }),
+                j8(25, "GND", "ground"),
+                j8(26, "GPIO7", "communication", { gpio: "GPIO7", functions: ["SPI0 CE1"], ...V33 }),
+                j8(27, "GPIO0", "reserved", {
+                    gpio: "GPIO0",
+                    functions: ["ID_SD"],
+                    ...V33,
+                    notes: ["Reserved for HAT ID EEPROM"],
+                }),
+                j8(28, "GPIO1", "reserved", {
+                    gpio: "GPIO1",
+                    functions: ["ID_SC"],
+                    ...V33,
+                    notes: ["Reserved for HAT ID EEPROM"],
+                }),
+                j8(29, "GPIO5", "gpio", { gpio: "GPIO5", ...V33 }),
+                j8(30, "GND", "ground"),
+                j8(31, "GPIO6", "gpio", { gpio: "GPIO6", ...V33 }),
+                j8(32, "GPIO12", "gpio", { gpio: "GPIO12", functions: ["PWM0"], ...V33 }),
+                j8(33, "GPIO13", "gpio", { gpio: "GPIO13", functions: ["PWM1"], ...V33 }),
+                j8(34, "GND", "ground"),
+                j8(35, "GPIO19", "gpio", { gpio: "GPIO19", functions: ["PCM_FS"], ...V33 }),
+                j8(36, "GPIO16", "gpio", { gpio: "GPIO16", ...V33 }),
+                j8(37, "GPIO26", "gpio", { gpio: "GPIO26", ...V33 }),
+                j8(38, "GPIO20", "gpio", { gpio: "GPIO20", functions: ["PCM_DIN"], ...V33 }),
+                j8(39, "GND", "ground"),
+                j8(40, "GPIO21", "gpio", { gpio: "GPIO21", functions: ["PCM_DOUT"], ...V33 }),
+            ],
+        },
+    ],
+};

package/dist/boards/raspberry-pi-pico-w.d.ts

@@ -0,0 +1,2 @@
+import type { Board } from "../model.js";
+export declare const raspberryPiPicoW: Board;

package/dist/boards/raspberry-pi-pico-w.js

@@ -0,0 +1,36 @@
+import { picoDebugHeader, picoEdgeHeader } from "./pico-shared.js";
+export const raspberryPiPicoW = {
+    id: "raspberry-pi-pico-w",
+    name: "Raspberry Pi Pico W",
+    manufacturer: "Raspberry Pi",
+    aliases: ["pico-w", "picow", "rpi-pico-w", "raspberry-pi-pico-w"],
+    description: "Wireless (Wi-Fi/Bluetooth) version of the Pico. Same 40-pin edge pinout as the Pico; the SWD debug pads move to the middle of the board.",
+    revisionNote: "Edge pinout matches the original Pico, but the onboard LED is driven by the wireless chip (WL_GPIO0), not RP2040 GPIO25.",
+    warnings: [
+        {
+            severity: "danger",
+            text: "GPIO uses 3.3 V logic and is not 5 V tolerant.",
+        },
+        {
+            severity: "warning",
+            text: "Some RP2040 GPIO are used internally for the wireless interface; the onboard LED is not on GPIO25 as on the original Pico.",
+        },
+        {
+            severity: "warning",
+            text: "ADC inputs (GP26–GP28) must stay within the ADC reference voltage range.",
+        },
+    ],
+    sources: [
+        {
+            title: "Raspberry Pi Pico W pinout PDF",
+            url: "https://pip-assets.raspberrypi.com/categories/686-raspberry-pi-pico-w/documents/RP-008315-DS-1-PicoW-A4-Pinout.pdf",
+            official: true,
+        },
+        {
+            title: "Raspberry Pi Pico documentation",
+            url: "https://www.raspberrypi.com/documentation/microcontrollers/raspberry-pi-pico.html",
+            official: true,
+        },
+    ],
+    headers: [picoEdgeHeader(), picoDebugHeader("SWD debug pads (mid-board)")],
+};

package/dist/boards/raspberry-pi-pico.d.ts

@@ -0,0 +1,2 @@
+import type { Board } from "../model.js";
+export declare const raspberryPiPico: Board;

package/dist/boards/raspberry-pi-pico.js

@@ -0,0 +1,36 @@
+import { picoDebugHeader, picoEdgeHeader } from "./pico-shared.js";
+export const raspberryPiPico = {
+    id: "raspberry-pi-pico",
+    name: "Raspberry Pi Pico",
+    manufacturer: "Raspberry Pi",
+    aliases: ["pico", "rpi-pico", "raspberry-pi-pico", "rp2040-pico"],
+    description: "RP2040 microcontroller board with a 40-pin castellated DIP edge, three ADC inputs, and an SWD debug header.",
+    revisionNote: "Pin map matches the official Pico R3 pinout. The Pico W shares this edge pinout but differs internally (see `ph pico-w`).",
+    warnings: [
+        {
+            severity: "danger",
+            text: "GPIO uses 3.3 V logic and is not 5 V tolerant.",
+        },
+        {
+            severity: "warning",
+            text: "ADC inputs (GP26–GP28) must stay within the ADC reference voltage range.",
+        },
+        {
+            severity: "info",
+            text: "RP2040 GPIO23–GPIO25 are used internally (SMPS control, VBUS sense, onboard LED) and are not on the edge header.",
+        },
+    ],
+    sources: [
+        {
+            title: "Raspberry Pi Pico pinout PDF",
+            url: "https://pip-assets.raspberrypi.com/categories/610-raspberry-pi-pico/documents/RP-008309-DS-1-Pico-R3-A4-Pinout.pdf",
+            official: true,
+        },
+        {
+            title: "Raspberry Pi Pico documentation",
+            url: "https://www.raspberrypi.com/documentation/microcontrollers/raspberry-pi-pico.html",
+            official: true,
+        },
+    ],
+    headers: [picoEdgeHeader(), picoDebugHeader("SWD debug header (board end)")],
+};

package/dist/catalog.d.ts

@@ -0,0 +1,22 @@
+import type { Board } from "./model.js";
+import { boards } from "./boards/index.js";
+/**
+ * Normalizes a user query or alias: case-insensitive, and spaces, underscores
+ * and repeated hyphens all collapse to single hyphens, so "Raspberry Pi 5",
+ * "raspberry_pi_5" and "raspberry-pi-5" are equivalent.
+ */
+export declare function normalizeQuery(query: string): string;
+export declare function resolveBoard(query: string): Board | undefined;
+export type Suggestion = {
+    board: Board;
+    /** The closest matching alias — what the user probably meant to type. */
+    alias: string;
+    distance: number;
+};
+/**
+ * Ranks boards by edit distance between the query and their closest alias.
+ * Prefix matches count as very close so "rasp" still suggests the Pis.
+ */
+export declare function suggestBoards(query: string, max?: number): Suggestion[];
+export declare function searchBoards(query: string): Board[];
+export { boards };

package/dist/catalog.js

@@ -0,0 +1,74 @@
+import { boards } from "./boards/index.js";
+/**
+ * Normalizes a user query or alias: case-insensitive, and spaces, underscores
+ * and repeated hyphens all collapse to single hyphens, so "Raspberry Pi 5",
+ * "raspberry_pi_5" and "raspberry-pi-5" are equivalent.
+ */
+export function normalizeQuery(query) {
+    return query
+        .toLowerCase()
+        .replace(/[\s_]+/g, "-")
+        .replace(/-+/g, "-")
+        .replace(/^-|-$/g, "");
+}
+function candidateNames(board) {
+    return [board.id, normalizeQuery(board.name), ...board.aliases.map(normalizeQuery)];
+}
+export function resolveBoard(query) {
+    const q = normalizeQuery(query);
+    if (!q)
+        return undefined;
+    return boards.find((board) => candidateNames(board).includes(q));
+}
+function levenshtein(a, b) {
+    const prev = new Array(b.length + 1);
+    for (let j = 0; j <= b.length; j++)
+        prev[j] = j;
+    for (let i = 1; i <= a.length; i++) {
+        let diagonal = prev[0];
+        prev[0] = i;
+        for (let j = 1; j <= b.length; j++) {
+            const insertOrDelete = Math.min(prev[j], prev[j - 1]) + 1;
+            const substitute = diagonal + (a[i - 1] === b[j - 1] ? 0 : 1);
+            diagonal = prev[j];
+            prev[j] = Math.min(insertOrDelete, substitute);
+        }
+    }
+    return prev[b.length];
+}
+/**
+ * Ranks boards by edit distance between the query and their closest alias.
+ * Prefix matches count as very close so "rasp" still suggests the Pis.
+ */
+export function suggestBoards(query, max = 3) {
+    const q = normalizeQuery(query);
+    if (!q)
+        return [];
+    const scored = boards.map((board) => {
+        let best = { board, alias: board.id, distance: Number.POSITIVE_INFINITY };
+        for (const name of candidateNames(board)) {
+            const distance = name.startsWith(q) ? 1 : levenshtein(q, name);
+            if (distance < best.distance)
+                best = { board, alias: name, distance };
+        }
+        return best;
+    });
+    const threshold = Math.max(2, Math.floor(q.length / 2));
+    return scored
+        .filter((s) => s.distance <= threshold)
+        .sort((a, b) => a.distance - b.distance)
+        .slice(0, max);
+}
+export function searchBoards(query) {
+    const q = normalizeQuery(query);
+    if (!q)
+        return [];
+    return boards.filter((board) => [
+        board.id,
+        normalizeQuery(board.name),
+        normalizeQuery(board.manufacturer),
+        normalizeQuery(board.description ?? ""),
+        ...board.aliases.map(normalizeQuery),
+    ].some((text) => text.includes(q)));
+}
+export { boards };

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+import { runCli } from "./run.js";
+const result = await runCli(process.argv.slice(2));
+if (result.stdout)
+    process.stdout.write(result.stdout);
+if (result.stderr)
+    process.stderr.write(result.stderr);
+process.exitCode = result.code;

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export type { Board, Header, Pin, PinCategory, Source, Warning, WarningSeverity, } from "./model.js";
+export { boards, normalizeQuery, resolveBoard, searchBoards, suggestBoards } from "./catalog.js";
+export { renderBoard, type RenderOptions } from "./render/board.js";
+export { asciiChars, unicodeChars, type CharSet } from "./render/chars.js";
+export { makeChalk } from "./render/theme.js";
+export { runCli, type RunOptions, type RunResult } from "./run.js";
+export { VERSION } from "./version.js";

package/dist/index.js

@@ -0,0 +1,6 @@
+export { boards, normalizeQuery, resolveBoard, searchBoards, suggestBoards } from "./catalog.js";
+export { renderBoard } from "./render/board.js";
+export { asciiChars, unicodeChars } from "./render/chars.js";
+export { makeChalk } from "./render/theme.js";
+export { runCli } from "./run.js";
+export { VERSION } from "./version.js";

package/dist/model.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Typed hardware data model shared by all renderers. Designed so the data can
+ * eventually be shared with the PinHub Next.js site — no renderer concerns
+ * belong in here.
+ */
+export type PinCategory = "power" | "ground" | "gpio" | "analog" | "digital" | "communication" | "reserved" | "nc";
+export type WarningSeverity = "danger" | "warning" | "info";
+export type Warning = {
+    severity: WarningSeverity;
+    text: string;
+};
+export type Source = {
+    title: string;
+    url: string;
+    official: boolean;
+};
+export type Pin = {
+    /** Physical pin number as printed or conventionally counted on the board. */
+    physical: number;
+    /** Grid position within the header (1-based). */
+    position: {
+        row: number;
+        column: number;
+    };
+    label: string;
+    gpio?: string;
+    functions?: string[];
+    category: PinCategory;
+    voltage?: string;
+    notes?: string[];
+};
+export type Header = {
+    id: string;
+    name: string;
+    description?: string;
+    layout: {
+        rows: number;
+        columns: number;
+    };
+    pins: Pin[];
+};
+export type Board = {
+    id: string;
+    name: string;
+    manufacturer: string;
+    aliases: string[];
+    description?: string;
+    revisionNote?: string;
+    warnings: Warning[];
+    sources: Source[];
+    headers: Header[];
+};

package/dist/model.js

@@ -0,0 +1,6 @@
+/**
+ * Typed hardware data model shared by all renderers. Designed so the data can
+ * eventually be shared with the PinHub Next.js site — no renderer concerns
+ * belong in here.
+ */
+export {};

package/dist/render/board.d.ts

@@ -0,0 +1,12 @@
+import type { ChalkInstance } from "chalk";
+import type { Board } from "../model.js";
+import type { CharSet } from "./chars.js";
+export type RenderOptions = {
+    chalk: ChalkInstance;
+    chars: CharSet;
+    width: number;
+    compact: boolean;
+};
+export declare function wrapText(text: string, width: number, indent: string): string[];
+export declare function renderWarnings(board: Board, opts: RenderOptions): string[];
+export declare function renderBoard(board: Board, opts: RenderOptions): string;