<assembly.device />

assembly.device groups boards and mechanical parts into a complete device. Add model or modelUrl to render a model at the world origin.

import { assembly } from "@tscircuit/core"

export default () => (
  <assembly.device
    name="product"
    model="https://docs.tscircuit.com/models/assembly/housing.glb"
  >
    <board name="B1" width="40mm" height="30mm" />
  </assembly.device>
)

Property	Description
name	Optional device name.
purchaseUrls	Optional array of HTTP(S) purchase links for the device.
supplierPartNumbers	Optional supplier-to-SKU map for the device.
model	Modelprinter string or HTTP(S) model URL.
modelUrl	Imported CAD model URL. Use either model or modelUrl.
children	Boards, motors, subassemblies, and screens.

Bill of materials

A device contributes its own assembly BOM line when it has model, modelUrl, purchaseUrls or supplierPartNumbers. An explicitly empty purchaseUrls={[]} or supplierPartNumbers={{}} also opts it into a line. Each device line has quantity one.

Without a model or purchasing metadata, the device is transparent to the assembly BOM: its materials attach to the nearest material ancestor, or become root entries. This lets a device organize the design without adding an extra material to purchase. See the assembly BOM example for nesting, purchasing links and converter usage.

Modelprinter strings

Use a modelprinter string directly in model; no modelcdn URL is needed. This display is 16 × 10 mm with a 5 mm cable.

import { assembly } from "@tscircuit/core"

export default () => (
  <assembly.device
    name="display-demo"
    model="flexscreen_w16_h10_flex5_sitsflat"
  />
)

Assembly models add 3D geometry without creating PCB footprints or electrical connections. For imported models, see cadmodel for supported formats.

Use assembly.motor to add a motor and mount a controller to its backface, assembly.subassembly to group mechanical parts, or assembly.screen to attach a display to a connector. See Mounting 3D models for screws aligned with board holes.

Author staged exploded views with assembly.explosion.stage and assembly.explosion.move.