Skip to content

typecad/typecad

Repository files navigation

typeCAD logo

KiCAD + TypeScript + npm = typeCAD

typeCAD is a way to programmatically create hardware designs.

It's done with TypeScript and all the goodness of the npm/Node.js ecosystem.

  • millions of packages that you can use
  • create portable/importable/shareable packages
  • semantic version control

The schematic portion of hardware can be done with just a few simple TypeScript classes. Rather than clicking and dragging, a line of code creates a component, and another line connects it. Sections of code can be turned into reusable modules and those modules can be turned into npm packages.

Code can be version controlled, status tracked, git push/pull/PR/issues can be used, and all the typical tools for software design can be used for hardware design now

Example

This typeCAD code...

import { Schematic, Component } from '@typecad/typecad'
import { Resistor, LED } from './modules/passives/0805'

let typecad = new Schematic('typecad');
let bt1 = new Component('Device:Battery_Cell', 'BT1', '2450', 'Battery:BatteryHolder_Keystone_3008_1x2450');
let r1 = new Resistor({ value: "1 kOhm"});
let d1 = new LED();

typecad.net('vcc', bt1.pin(1), r1.pin(1));
typecad.net('r-led', r1.pin(2), d1.pin(2));
typecad.net('gnd', d1.pin(1));

typecad.create(r1, led, bt1);
typecad.netlist();

...is the same as this schematic.

simple led circuit

The difference is that code can be copied, turned into reusable packages, version controlled, and used within the npm/Node.js system.

Get started

Read through the documentation for a full walkthrough:

npx @typecad/create-typecad

Support

buymeacoffee-green-badge

About

🤖programmatically 💥create 🛰️hardware

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published