jitx¶
Package name: jitx
Summary¶
Data Types¶
JITXDef¶
Stackup¶
LandPattern¶
Constructors¶
Function | Description |
---|---|
LandPattern | Constructor for defstruct LandPattern |
DifferentialRoutingStructure¶
Constructors¶
Function | Description |
---|---|
DifferentialRoutingStructure | Constructor for defstruct DifferentialRoutingStructure |
ViewMode¶
SinglePin¶
BackdrillSet¶
Backdrills with associated sides
Functions¶
Function | Description |
---|---|
backdrill-sides | Get all defined backdrills in the set |
Backdrill (+ 7) | Combine top and/or bottom backdrills |
StackupLayer¶
Constructors¶
Function | Description |
---|---|
StackupLayer | Constructor for defstruct StackupLayer |
InstanceType¶
BOMColumn¶
JITXObjectProperty¶
Constructors¶
Function | Description |
---|---|
JITXObjectProperty | Constructor for defstruct JITXObjectProperty |
MaterialType¶
Both¶
A supplement to the Side enum representing both sides of the board.
JITXObject¶
Multis¶
Function | Description |
---|---|
local | |
unsafe-hash |
Instantiable¶
Constructors¶
Function | Description |
---|---|
Instantiable | Constructor for defstruct Instantiable |
Bundle¶
ViaStructure¶
Constructors¶
Function | Description |
---|---|
ViaStructure | Constructor for defstruct ViaStructure |
SchematicSymbol¶
Constructors¶
Function | Description |
---|---|
SchematicSymbol | Constructor for defstruct SchematicSymbol |
BOMViewMode¶
Backdrill¶
Generic drill info that could be used for either a top or bottom backdrill
Instance¶
PortArray¶
BOMField¶
Model3D¶
TopologyName¶
Constructors¶
Function | Description |
---|---|
TopologyName | Constructor for defstruct TopologyName |
SymbolPin¶
ImportCadResult¶
ImportResult¶
Constructors¶
Function | Description |
---|---|
ImportResult | Constructor for defstruct ImportResult |
Board¶
Material¶
SchematicTemplate¶
Constructors¶
Function | Description |
---|---|
SchematicTemplate | Constructor for defstruct SchematicTemplate |
ViaType¶
Functions¶
Function | Description |
---|---|
esir-via-type |
IpcInfo¶
BOMMetricType¶
PadType¶
LandPatternPad¶
Constructors¶
Function | Description |
---|---|
LandPatternPad | Constructor for defstruct LandPatternPad |
ClearanceType¶
PackagePose¶
Constructors¶
Function | Description |
---|---|
PackagePose | Constructor for defstruct PackagePose |
InstantiableArray¶
Constructors¶
Function | Description |
---|---|
InstantiableArray | Constructor for defstruct InstantiableArray |
Rules¶
ConnectedItems¶
Constructors¶
Function | Description |
---|---|
ConnectedItems | Constructor for defstruct ConnectedItems |
ComponentBoardStatus¶
TransmissionType¶
RuleClearance¶
Constructors¶
Function | Description |
---|---|
RuleClearance | Constructor for defstruct RuleClearance |
Vec3D¶
ViaDrillType¶
Self¶
CadSoftware¶
RoutingStructure¶
Constructors¶
Function | Description |
---|---|
RoutingStructure | Constructor for defstruct RoutingStructure |
Via¶
BOMMetric¶
RoutingRules¶
Constructors¶
Function | Description |
---|---|
RoutingRules | Constructor for defstruct RoutingRules |
Pad¶
ComponentBOMStatus¶
Pin¶
PortType¶
NetClass¶
InstantiableType¶
Net¶
TraceType¶
General Definitions¶
Function | Description |
---|---|
symmetric-about-x (+ 1) | |
symmetric-about-y (+ 1) | |
vector (+ 1) | |
mirror-x-loc | |
mirror-y-loc | |
via-type-name | |
deprecate-syntax (+ 1) |
Variable | Description |
---|---|
Both | The one value of this type. |
self |
Definitions¶
JITXDef¶
public deftype JITXDef <: Hashable & Equalable
Stackup¶
public defstruct Stackup <: JITXDef :
LandPattern¶
public defstruct LandPattern <: JITXDef :
DifferentialRoutingStructure¶
public defstruct DifferentialRoutingStructure <: JITXDef :
Constructors¶
DifferentialRoutingStructure¶
Constructor for defstruct DifferentialRoutingStructure
public defn DifferentialRoutingStructure (id:DefID)
ViewMode¶
public defenum ViewMode <: Equalable & Hashable
-
UpdateView
-
NewView
SinglePin¶
public defstruct SinglePin <: PortType :
BackdrillSet¶
Backdrills with associated sides
public deftype BackdrillSet
-
top?:
- the backdrill starting on top side of board (if any) -
bottom?:
- the backdrill starting on bottom side of board (if any)
This is canonical form used by via API
Multis¶
empty?¶
public defmulti empty? (bd:BackdrillSet) -> True|False
- Returns
True|False
top?¶
public defmulti top? (bd:BackdrillSet) -> Backdrill|False
- Returns
Backdrill|False
bottom?¶
public defmulti bottom? (bd:BackdrillSet) -> Backdrill|False
- Returns
Backdrill|False
Functions¶
backdrill-sides¶
Get all defined backdrills in the set
public defn backdrill-sides (bds:BackdrillSet) -> Tuple<KeyValue<Side, Backdrill>>
- Returns
Tuple<KeyValue<Side, Backdrill>>
Backdrill¶
Combine top and/or bottom backdrills
public defn Backdrill ( -- top:Backdrill|False = ?, bottom:Backdrill|False = ?) -> BackdrillSet
- Returns
BackdrillSet
Backdrill¶
Combine top and bottom backdrills sets
public defn Backdrill ( -- top:BackdrillSet, bottom:BackdrillSet) -> BackdrillSet
- Returns
BackdrillSet
It is an error if top argument has a bottom side defined or vice versa
Backdrill¶
Create a single sided backdrill from a generic backdrill
public defn Backdrill ( -- side:Side, drill:Backdrill) -> BackdrillSet
- Returns
BackdrillSet
Backdrill¶
Make a single sided backdrill
public defn Backdrill ( -- side:Side, diameter:Double, startpad-diameter:Double, solder-mask-opening:Double, copper-clearance:Double) -> BackdrillSet
- Returns
BackdrillSet
Backdrill¶
Combine a sequence of sides and backdrills
public defn Backdrill (sides:Seqable<KeyValue<Side, Backdrill|False>>) -> BackdrillSet
- Returns
BackdrillSet
It is an error if different values for the same side are given e.g Backdrill([Top => small-drill, Bottom => big-drill])
Backdrill¶
Unions two backdrill sets.
public defn Backdrill (bds0:BackdrillSet, bds1:BackdrillSet) -> BackdrillSet
- Returns
BackdrillSet
e.g Backdrill(top-drill, bottom-drill)
Will raise an error if different backdrills for the same side are found
Backdrill¶
Overload for creating a backdrill for one side from a KeyValue
public defn Backdrill (side-and-bd:KeyValue<Side, Backdrill>) -> BackdrillSet
- Returns
BackdrillSet
e.g Backdrill(Bottom => some-backdrill)
Backdrill¶
Overload for creating a backdrill for a two sides from KeyValues
public defn Backdrill (side-and-bd0:KeyValue<Side, Backdrill>, side-and-bd1:KeyValue<Side, Backdrill>) -> BackdrillSet
- Returns
BackdrillSet
e.g Backdrill(Top => small-drill, Bottom => big-drill)
StackupLayer¶
public defstruct StackupLayer <: JITXObject :
Constructors¶
StackupLayer¶
Constructor for defstruct StackupLayer
public defn StackupLayer (local:LocalID)
InstanceType¶
public defenum InstanceType <: Equalable & Hashable
-
SingleComponent
-
SingleModule
-
InstanceArray
BOMColumn¶
public defstruct BOMColumn :
field: BOMField
name: String
width: Double
-
field: BOMField
-
name: String
-
width: Double
Constructors¶
BOMColumn¶
Constructor for defstruct BOMColumn
public defn BOMColumn (field:BOMField, name:String, width:Double)
JITXObjectProperty¶
public defstruct JITXObjectProperty :
object: JITXObject
property-name: Symbol
value: ?
-
object: JITXObject
-
property-name: Symbol
-
value: ?
Constructors¶
JITXObjectProperty¶
Constructor for defstruct JITXObjectProperty
public defn JITXObjectProperty (object:JITXObject, property-name:Symbol, value:?)
MaterialType¶
public defenum MaterialType <: Equalable & Hashable
-
Conductor
-
Dielectric
Both¶
A supplement to the Side enum representing both sides of the board.
public deftype Both
Functions¶
to-tented¶
public defn to-tented (v:Side|Both|True|False) -> Side|True|False
- Returns
Side|True|False
JITXObject¶
public deftype JITXObject <: Equalable
Multis¶
local¶
public defmulti local (obj:JITXObject) -> LocalID
- Returns
LocalID
unsafe-hash¶
public defmulti unsafe-hash (obj:JITXObject) -> Int
- Returns
Int
Functions¶
local-kv-to-pins¶
public defn local-kv-to-pins (obj:KeyValue<LocalID, LocalID>) -> KeyValue<JITXObject, JITXObject>
- Returns
KeyValue<JITXObject, JITXObject>
local-kv?¶
public defn local-kv? (obj:KeyValue<JITXObject, JITXObject>|JITXObject|False) -> KeyValue<LocalID, LocalID>|LocalID|False
- Returns
KeyValue<LocalID, LocalID>|LocalID|False
kv?-local¶
public defn kv?-local (obj:KeyValue<JITXObject, JITXObject>|JITXObject) -> KeyValue<LocalID, LocalID>|LocalID
- Returns
KeyValue<LocalID, LocalID>|LocalID
local?¶
public defn local? (obj:JITXObject|False) -> LocalID|False
- Returns
LocalID|False
local-kv¶
public defn local-kv (obj:KeyValue<JITXObject, JITXObject>) -> KeyValue<LocalID, LocalID>
- Returns
KeyValue<LocalID, LocalID>
Instantiable¶
public defstruct Instantiable <: JITXDef & InstantiableType :
Constructors¶
Instantiable¶
Constructor for defstruct Instantiable
public defn Instantiable (id:DefID)
Bundle¶
public defstruct Bundle <: JITXDef & PortType :
ViaStructure¶
public defstruct ViaStructure <: JITXObject :
Constructors¶
ViaStructure¶
Constructor for defstruct ViaStructure
public defn ViaStructure (local:LocalID)
SchematicSymbol¶
public defstruct SchematicSymbol <: JITXDef :
Constructors¶
SchematicSymbol¶
Constructor for defstruct SchematicSymbol
public defn SchematicSymbol (id:DefID)
BOMViewMode¶
public defenum BOMViewMode <: Equalable & Hashable
-
BOM-STD
-
BOM-DIFF
-
BOM-LAST
Backdrill¶
Generic drill info that could be used for either a top or bottom backdrill
public defstruct Backdrill <: Hashable & Equalable :
copper-clearance: Double
diameter: Double
solder-mask-opening: Double
startpad-diameter: Double
-
copper-clearance: Double
-
diameter: Double
-
solder-mask-opening: Double
-
startpad-diameter: Double
-
diameter:
- drill diameter, mm -
startpad-diameter:
- starting pad diameter, mm -
solder-mask-opening:
- Soldermask Opening diameter, mm -
copper-clearance:
- Copper Clearance Diameter, mm
Constructors¶
Backdrill¶
Constructor for defstruct Backdrill
public defn Backdrill (diameter:Double, startpad-diameter:Double, solder-mask-opening:Double, copper-clearance:Double)
Backdrill¶
Constructor for defstruct Backdrill
public defn Backdrill ( -- diameter:Double, startpad-diameter:Double, solder-mask-opening:Double, copper-clearance:Double)
Multis¶
top?¶
public defmulti top? (bd:BackdrillSet) -> Backdrill|False
- Returns
Backdrill|False
bottom?¶
public defmulti bottom? (bd:BackdrillSet) -> Backdrill|False
- Returns
Backdrill|False
Functions¶
Backdrill¶
Combine top and/or bottom backdrills
public defn Backdrill ( -- top:Backdrill|False = ?, bottom:Backdrill|False = ?) -> BackdrillSet
- Returns
BackdrillSet
Backdrill¶
Combine top and bottom backdrills sets
public defn Backdrill ( -- top:BackdrillSet, bottom:BackdrillSet) -> BackdrillSet
- Returns
BackdrillSet
It is an error if top argument has a bottom side defined or vice versa
Backdrill¶
Create a single sided backdrill from a generic backdrill
public defn Backdrill ( -- side:Side, drill:Backdrill) -> BackdrillSet
- Returns
BackdrillSet
Backdrill¶
Make a single sided backdrill
public defn Backdrill ( -- side:Side, diameter:Double, startpad-diameter:Double, solder-mask-opening:Double, copper-clearance:Double) -> BackdrillSet
- Returns
BackdrillSet
Backdrill¶
Combine a sequence of sides and backdrills
public defn Backdrill (sides:Seqable<KeyValue<Side, Backdrill|False>>) -> BackdrillSet
- Returns
BackdrillSet
It is an error if different values for the same side are given e.g Backdrill([Top => small-drill, Bottom => big-drill])
Backdrill¶
Unions two backdrill sets.
public defn Backdrill (bds0:BackdrillSet, bds1:BackdrillSet) -> BackdrillSet
- Returns
BackdrillSet
e.g Backdrill(top-drill, bottom-drill)
Will raise an error if different backdrills for the same side are found
Backdrill¶
Overload for creating a backdrill for one side from a KeyValue
public defn Backdrill (side-and-bd:KeyValue<Side, Backdrill>) -> BackdrillSet
- Returns
BackdrillSet
e.g Backdrill(Bottom => some-backdrill)
Backdrill¶
Overload for creating a backdrill for a two sides from KeyValues
public defn Backdrill (side-and-bd0:KeyValue<Side, Backdrill>, side-and-bd1:KeyValue<Side, Backdrill>) -> BackdrillSet
- Returns
BackdrillSet
e.g Backdrill(Top => small-drill, Bottom => big-drill)
Instance¶
public defstruct Instance <: JITXObject :
PortArray¶
public defstruct PortArray <: PortType :
base: PortType
elements: Tuple<Int>
-
base: PortType
-
elements: Tuple<Int>
Constructors¶
PortArray¶
Constructor for defstruct PortArray
public defn PortArray (type:PortType, elements:Tuple<Int|Range>)
BOMField¶
public defenum BOMField <: Equalable & Hashable
-
BOMFieldStatus
-
BOMFieldDescription
-
BOMFieldInsts
-
BOMFieldDatasheet
-
BOMFieldManufacturer
-
BOMFieldMPN
-
BOMFieldVendor
-
BOMFieldSKU
-
BOMFieldQuantity
-
BOMFieldPrice
-
BOMFieldSubtotal
-
BOMFieldPreferred
Model3D¶
public defstruct Model3D <: Hashable & Equalable :
filename: String
position: Vec3D
properties: Tuple<KeyValue<String, String>>
rotation: Vec3D
scale: Vec3D
-
filename: String
-
position: Vec3D
-
properties: Tuple<KeyValue<String, String>>
-
rotation: Vec3D
-
scale: Vec3D
Constructors¶
Model3D¶
Constructor for defstruct Model3D
public defn Model3D (filename:String, position:Vec3D, scale:Vec3D, rotation:Vec3D, properties:Tuple<KeyValue<String, String>> = ?)
TopologyName¶
public defstruct TopologyName <: JITXObject :
Constructors¶
TopologyName¶
Constructor for defstruct TopologyName
public defn TopologyName (local:LocalID)
SymbolPin¶
public defstruct SymbolPin <: JITXObject :
ImportCadResult¶
public deftype ImportCadResult
ImportResult¶
public defstruct ImportResult <: ImportCadResult :
directory: String
directory: String
Constructors¶
ImportResult¶
Constructor for defstruct ImportResult
public defn ImportResult (directory:String)
Board¶
public defstruct Board <: JITXDef :
Material¶
public defstruct Material <: JITXDef :
SchematicTemplate¶
public defstruct SchematicTemplate <: JITXDef :
Constructors¶
SchematicTemplate¶
Constructor for defstruct SchematicTemplate
public defn SchematicTemplate (id:DefID)
ViaType¶
public defenum ViaType <: Equalable & Hashable
-
THVia
-
MicroVia
-
BlindVia
Functions¶
esir-via-type¶
public defn esir-via-type (via-type-name:String) -> ViaType
- Returns
ViaType
IpcInfo¶
public defstruct IpcInfo :
name: String
name: String
BOMMetricType¶
public defenum BOMMetricType <: Equalable & Hashable
-
BOMMetricLineItems
-
BOMMetricComponentCount
-
BOMMetricTotalCost
PadType¶
public defenum PadType <: Equalable & Hashable
-
SMD
-
TH
LandPatternPad¶
public defstruct LandPatternPad <: JITXObject :
Constructors¶
LandPatternPad¶
Constructor for defstruct LandPatternPad
public defn LandPatternPad (local:LocalID)
ClearanceType¶
public defenum ClearanceType <: Equalable & Hashable
-
MinCopperWidth
-
MinCopperCopperSpace
-
MinCopperHoleSpace
-
MinCopperEdgeSpace
-
MinAnnularRing
-
MinDrillDiameter
-
MinSilkscreenWidth
-
MinPitchLeaded
-
MinPitchBGA
-
MaxBoardWidth
-
MaxBoardHeight
-
SolderMaskRegistration
-
MinSilkscreenTextHeight
-
MinSilkSolderMaskSpace
-
MinThPadExpandOuter
-
MinSolderMaskOpening
-
MinSolderMaskBridge
-
MinHoleToHole
-
MinPthPinSolderClearance
PackagePose¶
public defstruct PackagePose :
anchor: Instance|False
inst: Instance
pose: Pose|False
side: Side
-
anchor: Instance|False
-
inst: Instance
-
pose: Pose|False
-
side: Side
Constructors¶
PackagePose¶
Constructor for defstruct PackagePose
public defn PackagePose (inst:Instance, pose:Pose|False, side:Side, anchor:Instance|False)
InstantiableArray¶
public defstruct InstantiableArray <: InstantiableType :
base: InstantiableType
length: Int
-
base: InstantiableType
-
length: Int
Constructors¶
InstantiableArray¶
Constructor for defstruct InstantiableArray
public defn InstantiableArray (base:InstantiableType, length:Int)
Rules¶
public defstruct Rules <: JITXDef :
ConnectedItems¶
public defstruct ConnectedItems :
abstract-pins: Tuple<Pin>
component-pins: Tuple<Pin>
module-pins: Tuple<Pin>
nets: Tuple<Net>
-
abstract-pins: Tuple<Pin>
-
component-pins: Tuple<Pin>
-
module-pins: Tuple<Pin>
-
nets: Tuple<Net>
Constructors¶
ConnectedItems¶
Constructor for defstruct ConnectedItems
public defn ConnectedItems (nets:Tuple<Net>, module-pins:Tuple<Pin>, component-pins:Tuple<Pin>, abstract-pins:Tuple<Pin>)
ComponentBoardStatus¶
public defenum ComponentBoardStatus <: Equalable & Hashable
-
OnBoard
-
NotOnBoard
-
InBoardVariant
TransmissionType¶
public defenum TransmissionType <: Equalable & Hashable
-
StriplineTransmission
-
DifferentialMicroStripTransmission
RuleClearance¶
public defstruct RuleClearance <: PropertyValue :
type: ClearanceType
value: Double
-
type: ClearanceType
-
value: Double
Constructors¶
RuleClearance¶
Constructor for defstruct RuleClearance
public defn RuleClearance (type:ClearanceType, value:Double)
Vec3D¶
public defstruct Vec3D <: Hashable & Equalable :
x: Double
y: Double
z: Double
-
x: Double
-
y: Double
-
z: Double
Constructors¶
Vec3D¶
Constructor for defstruct Vec3D
public defn Vec3D (x:Double, y:Double, z:Double)
ViaDrillType¶
public defenum ViaDrillType <: Equalable & Hashable
-
MechanicalDrill
-
LaserDrill
Self¶
public defstruct Self <: JITXObject :
CadSoftware¶
public defenum CadSoftware <: Equalable & Hashable
-
Kicad
-
KicadV5
-
KicadV6
-
Altium
-
AltiumJSON
RoutingStructure¶
public defstruct RoutingStructure <: JITXDef :
Constructors¶
RoutingStructure¶
Constructor for defstruct RoutingStructure
public defn RoutingStructure (id:DefID)
Via¶
public defstruct Via <: JITXDef :
BOMMetric¶
public defstruct BOMMetric :
metric: BOMMetricType
name: String
value: Maybe<Int|Double|String>
-
metric: BOMMetricType
-
name: String
-
value: Maybe<Int|Double|String>
Constructors¶
BOMMetric¶
Constructor for defstruct BOMMetric
public defn BOMMetric (metric:BOMMetricType, name:String, value:Maybe<Int|Double|String> = ?)
RoutingRules¶
public defstruct RoutingRules <: JITXObject :
Constructors¶
RoutingRules¶
Constructor for defstruct RoutingRules
public defn RoutingRules (local:LocalID)
Pad¶
public defstruct Pad <: JITXDef :
ComponentBOMStatus¶
public defenum ComponentBOMStatus <: Equalable & Hashable
-
InBOM
-
NotInBOM
-
MarkedDNP
-
InBOMVariant
Pin¶
public defstruct Pin <: JITXObject :
PortType¶
public deftype PortType <: Hashable & Equalable
Functions¶
get¶
public defn get (c:PortType, elems:Tuple<Int|Range>) -> PortType
- Returns
PortType
get¶
public defn get (c:PortType, elems:Range) -> PortType
- Returns
PortType
get¶
public defn get (c:PortType, length:Int) -> PortType
- Returns
PortType
NetClass¶
public defstruct NetClass <: Equalable & Hashable :
min-space: False|Double
min-trace: False|Double
min-via-diameter: False|Double
min-via-drill: False|Double
name: Symbol
-
min-space: False|Double
-
min-trace: False|Double
-
min-via-diameter: False|Double
-
min-via-drill: False|Double
-
name: Symbol
Constructors¶
NetClass¶
Constructor for defstruct NetClass
public defn NetClass (name:Symbol, min-space:False|Double, min-trace:False|Double, min-via-diameter:False|Double, min-via-drill:False|Double)
Functions¶
NetClass¶
public defn NetClass (name:Symbol, specs:Collection<KeyValue<Symbol, Double>>) -> NetClass
- Returns
NetClass
InstantiableType¶
public deftype InstantiableType <: Equalable
Functions¶
get¶
public defn get (c:InstantiableType, len:Int) -> InstantiableType
- Returns
InstantiableType
Net¶
public defstruct Net <: JITXObject :
TraceType¶
public defenum TraceType <: Equalable & Hashable & PropertyValue
-
SingleEndedTrace
-
DifferentialTrace
General Definitions¶
symmetric-about-x¶
public defn symmetric-about-x<?T> (axis:Double, ss:Seqable<Shape&?T>)
symmetric-about-x¶
public defn symmetric-about-x<?T> (ss:Seqable<Shape&?T>)
symmetric-about-y¶
public defn symmetric-about-y<?T> (axis:Double, ss:Seqable<Shape&?T>)
symmetric-about-y¶
public defn symmetric-about-y<?T> (ss:Seqable<Shape&?T>)
vector¶
public defn vector (dir:Dir, len:Double)
vector¶
public defn vector (dir:Dir)
mirror-x-loc¶
public defn mirror-x-loc (axis-x:Double)
mirror-y-loc¶
public defn mirror-y-loc (axis-y:Double)
via-type-name¶
public defn via-type-name (start:LayerIndex, end:LayerIndex, hole-radius:Double, num-copper-layers:Int) -> String
- Returns
String
deprecate-syntax¶
public defn deprecate-syntax (info:FileInfo|False, keyword:String, new-keyword:String, context:String, v)
deprecate-syntax¶
public defn deprecate-syntax (info:FileInfo|False, keyword:String, context:String, v)
Both¶
The one value of this type.
public val Both
self¶
public val self
Related Packages¶
Forwards packages: jitx/anchor, jitx/schematic-table, jitx/toleranced, jitx/ref, jitx/grid-locs, jitx/layer-specs, jitx/interval, jitx/stateful, jitx/emodel-types, jitx/pose, jitx/transform, jitx/signal-models, jitx/percentage, jitx/shapes