ir

Documentation

Index

• Constants
• type DesignIR
  • func MergeProjectIR(bom *DesignIR, netlist *DesignIR, projectPath string, now time.Time) *DesignIR
• type IRMetadata
• type Net
• type Part
• type PinRef

Constants

const SchemaVersion = "0"

Types

type DesignIR

type DesignIR struct {
	Version       string     `json:"version"`
	Source        string     `json:"source"`
	Parts         []Part     `json:"parts"`
	Metadata      IRMetadata `json:"metadata"`
	ParseErrors   []string   `json:"-"`
	ParseWarnings []string   `json:"-"`
	Nets          []Net      `json:"nets,omitempty"`
}

DesignIR is a stable internal representation of an imported hardware design.

func MergeProjectIR

func MergeProjectIR(bom *DesignIR, netlist *DesignIR, projectPath string, now time.Time) *DesignIR

MergeProjectIR combines BOM and netlist imports into a single project-level DesignIR.

type IRMetadata

type IRMetadata struct {
	InputFile string `json:"input_file"`
	ParsedAt  string `json:"parsed_at"`
	Delimiter string `json:"-"`
}

IRMetadata captures deterministic metadata about the imported source.

type Net

type Net struct {
	Name string   `json:"name"`
	Pins []PinRef `json:"pins"`
}

type Part

type Part struct {
	Ref          string            `json:"ref"`
	Value        string            `json:"value"`
	Footprint    string            `json:"footprint"`
	MPN          string            `json:"mpn,omitempty"`
	Manufacturer string            `json:"manufacturer,omitempty"`
	Fields       map[string]string `json:"fields,omitempty"`
}

Part is an input-agnostic component entry.

type PinRef

type PinRef struct {
	Ref string `json:"ref"`
	Pin string `json:"pin"`
}