Circuit JSON to Connectivity Map

This library provides utilities to generate connectivity maps from circuit JSON data. It's designed to work with the @tscircuit/soup library and offers functionality to find connected networks and create connectivity maps.

Installation

To install the library, use npm or bun:

npm add circuit-json-to-connectivity-map

Features

• Find connected networks from a list of connections
• Generate source port connectivity maps from circuit JSON data
• Generate full connectivity maps from circuit JSON data

Usage

Finding Connected Networks

import { findConnectedNetworks } from "circuit-json-to-connectivity-map"

const connections = [
  ["A", "B"],
  ["B", "C"],
  ["D", "E"],
]

const result = findConnectedNetworks(connections)
console.log(result)

// Output:
// {
//   connectivity_net0: ["A", "B", "C"],
//   connectivity_net3: ["D", "E"],
// }

Generating Source Port Connectivity Map

import { getSourcePortConnectivityMapFromCircuitJson } from "circuit-json-to-connectivity-map"
import type { AnyCircuitElement } from "circuit-json"

const circuitJson: AnyCircuitElement[] = [
  // Your circuit JSON data here
]

const connectivityMap = getSourcePortConnectivityMapFromCircuitJson(circuitJson)

// Check if two IDs are connected
console.log(connectivityMap.areIdsConnected("port1", "port2"))

// Get all IDs connected to a specific net
console.log(connectivityMap.getIdsConnectedToNet("net1"))

// Get the net connected to a specific ID
console.log(connectivityMap.getNetConnectedToId("port1"))

Generating Full Connectivity Map

import { getFullConnectivityMapFromCircuitJson } from "circuit-json-to-connectivity-map"
import type { AnyCircuitElement } from "circuit-json"

const circuitJson: AnyCircuitElement[] = [
  // Your circuit JSON data here
]

const fullConnectivityMap = getFullConnectivityMapFromCircuitJson(circuitJson)

// Check if two IDs are connected (including PCB elements)
console.log(fullConnectivityMap.areIdsConnected("smtpad1", "port1"))

// Get all IDs connected to a specific net
console.log(fullConnectivityMap.getIdsConnectedToNet("net1"))

// Get the net connected to a specific ID
console.log(fullConnectivityMap.getNetConnectedToId("pcb_port1"))

API Reference

findConnectedNetworks(connections: Array<string[]>): Record<string, string[]>

Finds connected networks from a list of connections.

getSourcePortConnectivityMapFromCircuitJson(circuitJson: AnyCircuitElement[]): ConnectivityMap

Generates a source port connectivity map from circuit JSON data.

getFullConnectivityMapFromCircuitJson(circuitJson: AnyCircuitElement[]): ConnectivityMap

Generates a full connectivity map from circuit JSON data, including PCB elements.

ConnectivityMap

A class representing the connectivity map with methods:

• areIdsConnected(id1: string, id2: string): boolean
• getIdsConnectedToNet(netId: string): string[]
• getNetConnectedToId(id: string): string | undefined

Development

This project uses Bun as its JavaScript runtime.

To start development:

1. Clone the repository
2. Run bun install to install dependencies
3. Make your changes
4. Run bun test to ensure all tests pass

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License