component-code¶

Package name: jitx/parts/component-code

Summary¶

Data Types¶

LayerValue ¶

Constructors¶

Function	Description
LayerValue	Constructor for `defstruct LayerValue`

SupportRequireCode ¶

Constructors¶

Function	Description
SupportRequireCode	Constructor for `defstruct SupportRequireCode`

SymbolCode ¶

Constructors¶

Function	Description
SymbolCode	Constructor for `defstruct SymbolCode`

Functions¶

Function	Description
to-jitx

CopperCode ¶

Constructors¶

Function	Description
CopperCode	Constructor for `defstruct CopperCode`

Model3DCode ¶

Constructors¶

Function	Description
Model3DCode	Constructor for `defstruct Model3DCode`

Functions¶

Function	Description
Model3DCode

PourCode ¶

Constructors¶

Function	Description
PourCode	Constructor for `defstruct PourCode`

PCBLayerReference ¶

Constructors¶

Function	Description
PCBLayerReference	Constructor for `defstruct PCBLayerReference`

SymbolPinCode ¶

Constructors¶

Function	Description
SymbolPinCode	Constructor for `defstruct SymbolPinCode`

SupportOptionCode ¶

Constructors¶

Function	Description
SupportOptionCode	Constructor for `defstruct SupportOptionCode`

LandPatternCode ¶

Constructors¶

Function	Description
LandPatternCode	Constructor for `defstruct LandPatternCode`

Functions¶

Function	Description
LandPatternCode
to-jitx

PinByTypeCode ¶

PinByIndexCode ¶

Constructors¶

Function	Description
PinByIndexCode	Constructor for `defstruct PinByIndexCode`

PinPropertiesCode ¶

Constructors¶

Function	Description
PinPropertiesCode	Constructor for `defstruct PinPropertiesCode`

Functions¶

Function	Description
to-jitx

NoConnectCode ¶

Constructors¶

Function	Description
NoConnectCode	Constructor for `defstruct NoConnectCode`

LayerReference ¶

Constructors¶

Function	Description
LayerReference	Constructor for `defstruct LayerReference`

LandPatternPadCode ¶

Constructors¶

Function	Description
LandPatternPadCode	Constructor for `defstruct LandPatternPadCode`

Functions¶

Function	Description
LandPatternPadCode

PinByBundleCode ¶

Constructors¶

Function	Description
PinByBundleCode	Constructor for `defstruct PinByBundleCode`

ComponentPropertyCode ¶

Constructors¶

Function	Description
ComponentPropertyCode	Constructor for `defstruct ComponentPropertyCode`

Functions¶

Function	Description
to-jitx

PinByNameCode ¶

Constructors¶

Function	Description
PinByNameCode	Constructor for `defstruct PinByNameCode`

PinMappingCode ¶

Constructors¶

Function	Description
PinMappingCode	Constructor for `defstruct PinMappingCode`

PinByRequireCode ¶

Constructors¶

Function	Description
PinByRequireCode	Constructor for `defstruct PinByRequireCode`

SymbolDrawCode ¶

Constructors¶

Function	Description
SymbolDrawCode	Constructor for `defstruct SymbolDrawCode`

GeomCode ¶

ComponentCode ¶

Constructors¶

Function	Description
ComponentCode	Constructor for `defstruct ComponentCode`

Functions¶

Function	Description
ComponentCode

BundleCode ¶

Constructors¶

Function	Description
BundleCode	Constructor for `defstruct BundleCode`

PCBLayerValue ¶

Constructors¶

Function	Description
PCBLayerValue	Constructor for `defstruct PCBLayerValue`

PCBLayerCode ¶

Constructors¶

Function	Description
PCBLayerCode	Constructor for `defstruct PCBLayerCode`

PCBPadCode ¶

Constructors¶

Function	Description
PCBPadCode	Constructor for `defstruct PCBPadCode`

Functions¶

Function	Description
PCBPadCode
to-jitx

PinPropertyCode ¶

Constructors¶

Function	Description
PinPropertyCode	Constructor for `defstruct PinPropertyCode`

DimensionsCode ¶

Constructors¶

Function	Description
DimensionsCode	Constructor for `defstruct DimensionsCode`

Functions¶

Function	Description
DimensionsCode

ViaCode ¶

Constructors¶

Function	Description
ViaCode	Constructor for `defstruct ViaCode`

SupportCode ¶

Constructors¶

Function	Description
SupportCode	Constructor for `defstruct SupportCode`

Functions¶

Function	Description
SupportCode

PowerPinCode ¶

Constructors¶

Function	Description
PowerPinCode	Constructor for `defstruct PowerPinCode`

General Definitions¶

Function	Description
j-string-or-unknown

Definitions¶

LayerValue¶

public defstruct LayerValue :
    layer: String
    text: Text

layer: String
text: Text

Constructors¶

LayerValue¶

Constructor for defstruct LayerValue

public defn LayerValue (layer:String, text:Text)

SupportRequireCode¶

public defstruct SupportRequireCode :
    bundle-name: String

bundle-name: String

Constructors¶

SupportRequireCode¶

Constructor for defstruct SupportRequireCode

public defn SupportRequireCode (bundle-name:String)

SymbolCode¶

public defstruct SymbolCode :
    bank: Int
    draws: Tuple<SymbolDrawCode>
    layer-reference: LayerReference
    layer-value: LayerValue
    name: String
    pins: Tuple<SymbolPinCode>

bank: Int
draws: Tuple<SymbolDrawCode>
layer-reference: LayerReference
layer-value: LayerValue
name: String
pins: Tuple<SymbolPinCode>

Constructors¶

SymbolCode¶

Constructor for defstruct SymbolCode

public defn SymbolCode (name:String, bank:Int, pins:Tuple<SymbolPinCode>, layer-reference:LayerReference, layer-value:LayerValue, draws:Tuple<SymbolDrawCode>)

Functions¶

to-jitx¶

public defn to-jitx (s:SymbolCode) -> SchematicSymbol

Returns SchematicSymbol

CopperCode¶

public defstruct CopperCode <: GeomCode :
    layer: LayerIndex
    shape: Shape

layer: LayerIndex
shape: Shape

Constructors¶

CopperCode¶

Constructor for defstruct CopperCode

public defn CopperCode (layer:LayerIndex, shape:Shape)

Model3DCode¶

public defstruct Model3DCode :
    model3d: Model3D
    model3d-id: String

model3d: Model3D
model3d-id: String

Constructors¶

Model3DCode¶

Constructor for defstruct Model3DCode

public defn Model3DCode (model3d:Model3D, model3d-id:String)

Functions¶

Model3DCode¶

public defn Model3DCode (json:JObject) -> Model3DCode

Returns Model3DCode

PourCode¶

public defstruct PourCode <: GeomCode :
    isolate: Double
    layer: LayerIndex
    orphans: True|False
    rank: Int
    shape: Shape

isolate: Double
layer: LayerIndex
orphans: True|False
rank: Int
shape: Shape

Constructors¶

PourCode¶

Constructor for defstruct PourCode

public defn PourCode (layer:LayerIndex, shape:Shape, isolate:Double, rank:Int, orphans:True|False)

PCBLayerReference¶

public defstruct PCBLayerReference :
    layer-specifier: LayerSpecifier
    text: Text

layer-specifier: LayerSpecifier
text: Text

Constructors¶

PCBLayerReference¶

Constructor for defstruct PCBLayerReference

public defn PCBLayerReference (layer-specifier:LayerSpecifier, text:Text)

SymbolPinCode¶

public defstruct SymbolPinCode :
    direction: Dir
    length: Double
    name-size: Double|False
    number-size: Double|False
    pin: PinByTypeCode
    point: Point

direction: Dir
length: Double
name-size: Double|False
number-size: Double|False
pin: PinByTypeCode
point: Point

Constructors¶

SymbolPinCode¶

Constructor for defstruct SymbolPinCode

public defn SymbolPinCode (pin:PinByTypeCode, point:Point, direction:Dir, length:Double, number-size:Double|False, name-size:Double|False)

SupportOptionCode¶

public defstruct SupportOptionCode :
    pin-mappings: Tuple<PinMappingCode>
    requires: Tuple<SupportRequireCode>

pin-mappings: Tuple<PinMappingCode>
requires: Tuple<SupportRequireCode>

Constructors¶

SupportOptionCode¶

Constructor for defstruct SupportOptionCode

public defn SupportOptionCode (requires:Tuple<SupportRequireCode>, pin-mappings:Tuple<PinMappingCode>)

LandPatternCode¶

public defstruct LandPatternCode :
    geometries: Tuple<GeomCode>
    layers: Tuple<PCBLayerCode>
    model3ds: Tuple<Model3DCode>
    name: String
    pads: Tuple<LandPatternPadCode>
    pcb-layer-reference: PCBLayerReference
    pcb-layer-value: PCBLayerValue

geometries: Tuple<GeomCode>
layers: Tuple<PCBLayerCode>
model3ds: Tuple<Model3DCode>
name: String
pads: Tuple<LandPatternPadCode>
pcb-layer-reference: PCBLayerReference
pcb-layer-value: PCBLayerValue

Constructors¶

LandPatternCode¶

Constructor for defstruct LandPatternCode

public defn LandPatternCode (name:String, pads:Tuple<LandPatternPadCode>, pcb-layer-reference:PCBLayerReference, pcb-layer-value:PCBLayerValue, layers:Tuple<PCBLayerCode>, geometries:Tuple<GeomCode>, model3ds:Tuple<Model3DCode>)

Functions¶

LandPatternCode¶

public defn LandPatternCode (json:JObject) -> LandPatternCode

Returns LandPatternCode

to-jitx¶

public defn to-jitx (lp:LandPatternCode, jitx-pads-by-pcb-pad-name:HashTable<String, Pad>) -> LandPattern

Returns LandPattern

PinByTypeCode¶

public deftype PinByTypeCode

PinByIndexCode¶

public defstruct PinByIndexCode <: PinByTypeCode :
    index: Int
    name: String

index: Int
name: String

Constructors¶

PinByIndexCode¶

Constructor for defstruct PinByIndexCode

public defn PinByIndexCode (name:String, index:Int)

PinPropertiesCode¶

public defstruct PinPropertiesCode :
    no-connects: Tuple<NoConnectCode>
    pins: Tuple<PinPropertyCode>
    power-pins: Tuple<PowerPinCode>

no-connects: Tuple<NoConnectCode>
pins: Tuple<PinPropertyCode>
power-pins: Tuple<PowerPinCode>

Constructors¶

PinPropertiesCode¶

Constructor for defstruct PinPropertiesCode

public defn PinPropertiesCode (pins:Tuple<PinPropertyCode>, power-pins:Tuple<PowerPinCode>, no-connects:Tuple<NoConnectCode>)

Functions¶

to-jitx¶

public defn to-jitx (pin-props:PinPropertiesCode)

NoConnectCode¶

public defstruct NoConnectCode :
    pin: PinByTypeCode

pin: PinByTypeCode

Constructors¶

NoConnectCode¶

Constructor for defstruct NoConnectCode

public defn NoConnectCode (pin:PinByTypeCode)

LayerReference¶

public defstruct LayerReference :
    layer: String
    text: Text

layer: String
text: Text

Constructors¶

LayerReference¶

Constructor for defstruct LayerReference

public defn LayerReference (layer:String, text:Text)

LandPatternPadCode¶

public defstruct LandPatternPadCode :
    pcb-pad-name: String
    pin: PinByTypeCode
    pose: Pose
    side: Side

pcb-pad-name: String
pin: PinByTypeCode
pose: Pose
side: Side

Constructors¶

LandPatternPadCode¶

Constructor for defstruct LandPatternPadCode

public defn LandPatternPadCode (pin:PinByTypeCode, pcb-pad-name:String, pose:Pose, side:Side)

Functions¶

LandPatternPadCode¶

public defn LandPatternPadCode (json:JObject) -> LandPatternPadCode

Returns LandPatternPadCode

PinByBundleCode¶

public defstruct PinByBundleCode <: PinByTypeCode :
    bundle-name: String
    pin-name: String

bundle-name: String
pin-name: String

Constructors¶

PinByBundleCode¶

Constructor for defstruct PinByBundleCode

public defn PinByBundleCode (bundle-name:String, pin-name:String)

ComponentPropertyCode¶

public defstruct ComponentPropertyCode :
    name: Symbol
    value: JITXValue|None

name: Symbol
value: JITXValue|None

Constructors¶

ComponentPropertyCode¶

Constructor for defstruct ComponentPropertyCode

public defn ComponentPropertyCode (name:Symbol, value:JITXValue|None)

Functions¶

to-jitx¶

public defn to-jitx (prop:ComponentPropertyCode)

PinByNameCode¶

public defstruct PinByNameCode <: PinByTypeCode :
    pin-name: String

pin-name: String

Constructors¶

PinByNameCode¶

Constructor for defstruct PinByNameCode

public defn PinByNameCode (pin-name:String)

PinMappingCode¶

public defstruct PinMappingCode :
    key: PinByTypeCode
    value: PinByTypeCode

key: PinByTypeCode
value: PinByTypeCode

Constructors¶

PinMappingCode¶

Constructor for defstruct PinMappingCode

public defn PinMappingCode (key:PinByTypeCode, value:PinByTypeCode)

PinByRequireCode¶

public defstruct PinByRequireCode <: PinByTypeCode :
    bundle-name: String

bundle-name: String

Constructors¶

PinByRequireCode¶

Constructor for defstruct PinByRequireCode

public defn PinByRequireCode (bundle-name:String)

SymbolDrawCode¶

public defstruct SymbolDrawCode :
    name: String
    shape: Shape

name: String
shape: Shape

Constructors¶

SymbolDrawCode¶

Constructor for defstruct SymbolDrawCode

public defn SymbolDrawCode (name:String, shape:Shape)

GeomCode¶

public deftype GeomCode <: Comparable

ComponentCode¶

public defstruct ComponentCode :
    bundles: Tuple<BundleCode>
    datasheet: String
    description: String
    emodel: EModel|False
    landpattern: LandPatternCode|False
    manufacturer: String
    metadata: Tuple<MetadataCode>
    mpn: String
    name: String
    pcb-pads: Tuple<PCBPadCode>
    pin-properties: False|PinPropertiesCode
    properties: Tuple<ComponentPropertyCode>
    reference_prefix: String
    supports: Tuple<SupportCode>
    symbols: Tuple<SymbolCode>

bundles: Tuple<BundleCode>
datasheet: String
description: String
emodel: EModel|False
landpattern: LandPatternCode|False
manufacturer: String
metadata: Tuple<MetadataCode>
mpn: String
name: String
pcb-pads: Tuple<PCBPadCode>
pin-properties: False|PinPropertiesCode
properties: Tuple<ComponentPropertyCode>
reference_prefix: String
supports: Tuple<SupportCode>
symbols: Tuple<SymbolCode>

Constructors¶

ComponentCode¶

Constructor for defstruct ComponentCode

public defn ComponentCode (name:String, description:String, manufacturer:String, mpn:String, datasheet:String, reference_prefix:String, emodel:EModel|False, pin-properties:False|PinPropertiesCode, pcb-pads:Tuple<PCBPadCode>, landpattern:LandPatternCode|False, symbols:Tuple<SymbolCode>, metadata:Tuple<MetadataCode>, properties:Tuple<ComponentPropertyCode>, bundles:Tuple<BundleCode>, supports:Tuple<SupportCode>)

Functions¶

ComponentCode¶

public defn ComponentCode (json:JObject) -> ComponentCode

Returns ComponentCode

BundleCode¶

public defstruct BundleCode :
    name: String

name: String

Constructors¶

BundleCode¶

Constructor for defstruct BundleCode

public defn BundleCode (name:String)

PCBLayerValue¶

public defstruct PCBLayerValue :
    layer-specifier: LayerSpecifier
    text: Text

layer-specifier: LayerSpecifier
text: Text

Constructors¶

PCBLayerValue¶

Constructor for defstruct PCBLayerValue

public defn PCBLayerValue (layer-specifier:LayerSpecifier, text:Text)

PCBLayerCode¶

public defstruct PCBLayerCode :
    layer: LayerSpecifier
    shape: Shape

layer: LayerSpecifier
shape: Shape

Constructors¶

PCBLayerCode¶

Constructor for defstruct PCBLayerCode

public defn PCBLayerCode (layer:LayerSpecifier, shape:Shape)

PCBPadCode¶

public defstruct PCBPadCode :
    layers: Tuple<PCBLayerCode>
    name: String
    shape: Shape
    type: PadType

layers: Tuple<PCBLayerCode>
name: String
shape: Shape
type: PadType

Constructors¶

PCBPadCode¶

Constructor for defstruct PCBPadCode

public defn PCBPadCode (name:String, type:PadType, shape:Shape, layers:Tuple<PCBLayerCode>)

Functions¶

PCBPadCode¶

public defn PCBPadCode (json:JObject) -> PCBPadCode

Returns PCBPadCode

to-jitx¶

public defn to-jitx (p:PCBPadCode) -> Pad

Returns Pad

PinPropertyCode¶

public defstruct PinPropertyCode :
    bank: Int|False
    direction: Dir
    electrical-type: String
    pads: Tuple<PinByTypeCode>
    pin: PinByTypeCode

bank: Int|False
direction: Dir
electrical-type: String
pads: Tuple<PinByTypeCode>
pin: PinByTypeCode

Constructors¶

PinPropertyCode¶

Constructor for defstruct PinPropertyCode

public defn PinPropertyCode (pin:PinByTypeCode, pads:Tuple<PinByTypeCode>, direction:Dir, electrical-type:String, bank:Int|False)

DimensionsCode¶

public defstruct DimensionsCode :
    x: Double
    y: Double
    z: Double|UNKNOWN

x: Double
y: Double
z: Double|UNKNOWN

Constructors¶

DimensionsCode¶

Constructor for defstruct DimensionsCode

public defn DimensionsCode (x:Double, y:Double, z:Double|UNKNOWN)

Functions¶

DimensionsCode¶

public defn DimensionsCode (json:JObject) -> DimensionsCode

Returns DimensionsCode

ViaCode¶

public defstruct ViaCode <: GeomCode :
    center-point: Point
    end: LayerIndex
    hole-radius: Double
    radius: Double
    start: LayerIndex
    type: ViaType

center-point: Point
end: LayerIndex
hole-radius: Double
radius: Double
start: LayerIndex
type: ViaType

Constructors¶

ViaCode¶

Constructor for defstruct ViaCode

public defn ViaCode (type:ViaType, start:LayerIndex, end:LayerIndex, center-point:Point, radius:Double, hole-radius:Double)

SupportCode¶

public defstruct SupportCode :
    bundle-name: String
    options: Tuple<SupportOptionCode>

bundle-name: String
options: Tuple<SupportOptionCode>

Constructors¶

SupportCode¶

Constructor for defstruct SupportCode

public defn SupportCode (bundle-name:String, options:Tuple<SupportOptionCode>)

Functions¶

SupportCode¶

public defn SupportCode (json:JObject) -> SupportCode

Returns SupportCode

PowerPinCode¶

public defstruct PowerPinCode :
    max-voltage: Double
    min-voltage: Double
    pin: PinByTypeCode

max-voltage: Double
min-voltage: Double
pin: PinByTypeCode

Constructors¶

PowerPinCode¶

Constructor for defstruct PowerPinCode

public defn PowerPinCode (pin:PinByTypeCode, min-voltage:Double, max-voltage:Double)

General Definitions¶

j-string-or-unknown¶

public defn j-string-or-unknown (json:JSON) -> String|UNKNOWN

Returns String|UNKNOWN