Classes

Schematic

The main class that represents the entire circuit.

import { Schematic } from '@typecad/typecad';
let typecad = new Schematic('typecad_concepts');
The only option is the name. The name determines the name of the resulting KiCAD files.

Component

The Component class represents individual parts like resistors, capacitors, ICs, etc. You add a Component to your Schematic.

import { Component } from '@typecad/typecad';

let R1 = new Component({ value: '1kohm' });
Options for the `Component` class are:
  • reference — reference designator
  • value — value of component
  • footprint — footprint
  • prefix — prefix for reference designator
  • datasheet — link to component datasheet
  • description — description of component
  • voltage — voltage rating of component
  • wattage — wattage rating of component
  • mpn — Manufacturer Part Number
  • dnp — true if component is Do Not Populate, false to place component
  • simulation — an object with simulation data { include: true, model: 'ngspice-model' }

Syntax

typeCAD makes use of the above syntax style for many of its classes, ie. passing an object of optional properties. Optional in terms of TypeScript code, if a particular property isn’t passed and typeCAD requires it, it will throw an error during build.

PCB

Creates a KiCAD .kicad_pcb PCB file. Components can be added to the PCB, placed and oriented with code.

import { PCB } from '@typecad/typecad';

let pcb = new PCB('typecad');
The only option is the name. The name determines the name of the resulting KiCAD .kicad_pcb file.

Power

Represents a power source like a battery or voltage regulator.

import { Power } from '@typecad/typecad';

let coin_cell = new Power({ power: holder.pin(1), gnd: holder.pin(2), voltage: 3.7 });
Options are:
  • power — pin on a component that supplies power
  • gnd — pin on a component that supplies ground
  • voltage — voltage of power source

Warning

Power represents a physical component that supplies power, that’s why it takes Pin objects as a parameter. This is often a battery holder or voltage regulator. It is not the equivalent of a VCC symbol or GND symbol in a schematic.




Passives