easyeda - Download and Convert EasyEDA Footprints

Convert EasyEDA JSON PCB footprints into Circuit JSON or tscircuit components.

npm install -g easyeda

Library Usage

Converting to Circuit JSON

import { convertEasyEdaJsonToCircuitJson } from "easyeda"

// Convert to tscircuit soup
const soupJson = convertEasyEdaJsonToCircuitJson(rawEasyJson)

Converting to TypeScript React Component

import { convertRawEasyEdaToTs } from "easyeda"

// Convert to TypeScript React component
const tsxComponent = await convertRawEasyEdaToTs(rawEasyJson)

Full Example: Fetching and Converting to TSX

import { fetchEasyEDAComponent, convertRawEasyEdaToTs } from "easyeda"

async function convertPartNumberToTsx(partNumber: string) {
  const rawEasyJson = await fetchEasyEDAComponent(partNumber)
  const tsxComponent = await convertRawEasyEdaToTs(rawEasyJson)
  return tsxComponent
}

// Usage
const ne555TsxComponent = await convertPartNumberToTsx("C46749")
console.log(ne555TsxComponent)

Fetching EasyEDA Component Data

import { fetchEasyEDAComponent } from "easyeda"

// Get raw EasyEDA JSON for a component
const rawEasyJson = await fetchEasyEDAComponent("C46749")

CLI

Install the CLI with npm install -g easyeda, you can then call the cli with either easyeda or easyeda-converter.

# Convert a schematic and footprint for JLCPCB part number C46749 (NE555) to tscircuit component
easyeda convert -i C46749 -o C46749.tsx
easyeda convert -i C46749 -t tsx

# Convert a footprint and schematic for JLCPCB part number C46749 (NE555) to tscircuit soup JSON
# More info: https://docs.tscircuit.com/api-reference/advanced/soup
easyeda convert -i C46749 -o C46749.soup.json

# Convert a footprint for JLCPCB part number C46749 (NE555) to KiCad footprint
easyeda convert -i C46749 -o C46749.kicad_mod

# Download the C46749 footprint and schematic and convert to readable JSON
easyeda convert -i C46749 -o C46749.bettereasy.json

# Can also convert from files!
easyeda convert -i ./C46749.raweasy.json -o C46749.soup.json

# Get exactly what is returned from the JLC API
# The footprint, schematic and some other data is encoded in strings, you
# probably want to convert to *.bettereasy.json
easyeda download -i C46749 -o C46749.raweasy.json

File Formats

| Format | Description | | ------------------- | ------------------------------------------------------------------------------------------- | | *.raweasy.json | The raw JSON from the EasyEDA API | | *.bettereasy.json | The raw JSON from the EasyEDA API, but with the footprint and schematic data decoded | | *.circuit.json | The tscircuit's easy-to-use JSON format (docs) | | *.kicad_mod | A KiCad footprint file | | *.tsx | A TypeScript React component file |

Advanced Usage

Customizing Conversion Options

When converting EasyEDA JSON to tscircuit soup, you can pass additional options:

import { convertEasyEdaJsonToCircuitJson } from "easyeda"

const soupJson = convertEasyEdaJsonToCircuitJson(rawEasyJson, {
  useModelCdn: true, // Use CDN for 3D models
  shouldRecenter: false, // Don't recenter the component
})

Supplying Datasheet Pin Attributes

Callers can provide a pinAttributes map using the @tscircuit/props schema. The converter matches rows to physical footprint pad identifiers: both "1" and "pin1" are accepted, as are "A1" and "pinA1" for BGA pads. A pin-prefixed row takes precedence when both forms specify the same attribute. Signal aliases are used only when no physical row is supplied, and conflicting alias rows are ignored.

import { convertEasyEdaJsonToCircuitJson, convertRawEasyEdaToTs } from "easyeda"

const pinAttributes = {
  "1": { requiresPower: true, requiresVoltage: "2.8V" },
  "2": { requiresGround: true },
  "3": {}, // Explicitly undocumented electrical role
}

const circuitJson = convertEasyEdaJsonToCircuitJson(betterEasy, { pinAttributes })
const tsx = await convertRawEasyEdaToTs({ rawEasy, pinAttributes })

Attributes are written onto Circuit JSON source_port records and included in the generated TSX. Supplied rows replace TSX label inference for that pin, including an explicit empty row. Other pins retain the existing inference. The browser exports convertRawEasyToTsx and convertBetterEasyToTsx accept the same option. Fetching and validating datasheet metadata remains the caller's responsibility; these options do not make a datasheet API request.

Working with Generated TypeScript Components

The generated TypeScript React components can be imported and used in your tscircuit projects:

import { NE555 } from "./NE555"

const MyCircuit = () => {
  return (
    <circuit>
      <NE555 name="U1" />
      {/* Other components */}
    </circuit>
  )
}

These components include proper typing for props and integrate seamlessly with the tscircuit ecosystem.

Development

Adding a test for a new part

Just run the following command. Use git status to see the files it introduces.

bun run add-test-for-part C46749

You can then run the test with bun test path/to/file.test.ts until you can successfully get the part working!