Build from parts

A description names one machine. Give a board with what goes on it, or a base (a whole device by its catalogue key) with what goes on that.

import { build } from "@johnmorrisdotca/hako-devices/build";

const machine = build({ board: "pi4", case: "armor", hat: "pitft-28" });
machine.report.stack; // { riser: 0, under: 16.8 }
machine.size; // the mesh's width, depth and height in millimetres
machine.glb().bytes; // a .glb
machine.svg("thin"); // the drawing
machine.metrics(); // its scale, for drawing it to scale
machine.printAreas(); // where `print` can go

build throws a FitError when a machine does not go together; its report says why. check answers the same question with no three.js, so a form can ask on every change:

import { check } from "@johnmorrisdotca/hako-devices";

const report = check({ board: "pi3b", hat: "poe-plus" });
report.ok; // false
report.issues[0].code; // "no-poe-pins"

A form that never shows an error

whatFits says what to offer and nearestWorking what to change, so a form never has to show a fault. Both are pure and need no three.js, and neither touches print, which stays at the person's own risk.

import { fillNeeded, nearestWorking, whatFits } from "@johnmorrisdotca/hako-devices";

// a needed choice with one answer is made for you: bare holes under a hat get their header, and a module with no hat gets the one hat that takes it
fillNeeded({ board: "pi-zero-2w", hat: "oled-bonnet" }).description; // { board: "pi-zero-2w", hat: "oled-bonnet", solderHeader: true }

// grey what cannot work, with its reason
whatFits({ board: "pi-zero-2w" }, "case").find((option) => option.id === "armor"); // { id: "armor", name: "...", fits: false, why: "... is cut for other sockets than those of ..." }

// or take anything, and change the rest: the second argument is the choice just made, which stays
const { description, changes } = nearestWorking({ board: "pi-zero-2w", case: "armor" }, "board");
description.case; // "unipi"
changes[0].message; // "the case is now Small domed case (UniPiCase Zero style)"

The nearest set changes as little as it can. Another case that fits is nearer than no case, because cases do one job; a hat, a module or a cooler each does its own job, so no hat is nearer than a different hat. A board moves last of all, when a part fits no other way. hat-overhangs stays a warning: a hat past a board's edge goes together, so it is a fact to say, not a fit to avoid. The demo's builder is both ways behind one switch.

The description

How parts attach

A hat over tall sockets rises by itself: check({ board: "pi4", hat: "pitft-28" }) gives a note that it sits 6.2 mm higher on a stacking header. Give riser yourself and a height that is too short is a warning that names the height needed.

The fit codes

Presets

PRESETS holds real machines to use or start from: a Pi 4 in a finned case with a 2.8-inch touch screen, a Pi 3 B with an OLED bonnet, a Pi Zero 2 W in a small domed case, and more.

import { PRESETS } from "@johnmorrisdotca/hako-devices";
import { build } from "@johnmorrisdotca/hako-devices/build";

const machines = PRESETS.map((preset) => build(preset.description));
machines.length; // 8

A part on its own

import { buildPart } from "@johnmorrisdotca/hako-devices/build";

buildPart("armor").svg("thick");
buildPart("pitft-28").glb();

The print option

Every device has areas where your words can go: machine.printAreas() lists them, the first being the main one. Nothing is painted unless you ask, and a shipped .glb has clear faces there, so nothing shows in any other viewer. What you print is at your own risk: do not print someone else's trademark.