Package Use

Now that we’ve created a package, we need to know how to use it.

Self-documenting

A benefit of TypeScript is that you can write a lot of documentation in the code itself. You’ll notice the JSDoc comments in the package code. This will result in VSCode hints and tips as you write the code, explaining parameters and providing examples.

Copying files

Refer to the structure section for the file structure of a package, particularly the postinstall.js file. KiCAD expects symbols and footprints to be in the ./build directory, but we haven’t actually npm installed the package, so those files will need to be manually copied there.

import

The tooling gave us the import statement for the package.

import { typecad_package } from "./typecad_package";

new

Now create a new instance of the package.

import { Schematic } from '@typecad/typecad';
import { typecad_package } from "./typecad_package";
import * as _0805 from '@typecad/passives/0805'

let typecad = new Schematic('typecad_docs');
let u1 = new typecad_package({ schematic: typecad });                           // schematic is required
let u1 = new typecad_package({ schematic: typecad, reference: 'U1' });          // specify the reference designator
let u1 = new typecad_package({ schematic: typecad, passives: _0805 });          // change passives to 0805
let u1 = new typecad_package({ schematic: typecad, pcb: pcb });                 // include PCB

Connections

After creating the instance, you’ll probably want to connect the package’s components to something. You can access the pins of any component in the package.

u1.U1.GND // the ground pin of the ATtiny3227
u1.U1.VCC // the power pin of the ATtiny3227

add

After the package has been imported and a new instance created, configuration is done, and connections made, you add it to the schematic.

import { Schematic } from '@typecad/typecad';
import { typecad_package } from "./typecad_package";
let typecad = new Schematic('typecad_docs');

let u1 = new typecad_package({ schematic: typecad });

u1.add();
The package's components will be added to the schematic.

place

If the package includes a layout, you can use it like this:

import { PCB, Schematic } from '@typecad/typecad';
import { typecad_package } from "./typecad_package";
let typecad = new Schematic('typecad_docs');
let pcb = new PCB('typecad_docs');

let u1 = new typecad_package({ schematic: typecad });

u1.add();
u1.place();

Do Not Populate

If a package includes a component you don’t want included in the netlist or layout:

let u1 = new typecad_package({ schematic: typecad });
u1.U1.dnp = true;