Rail
Title: Rail
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: A power supply rail with its decoupling requirements
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + id | No | string | No | - | Internal identifier for this rail, referenced by pin rail fields (e.g. vplus, vdd_core) |
| + net | No | string | No | - | Net name in the schematic (e.g. VCC_3V3, GND) |
| - type | No | enum (of string) | No | - | power: externally supplied rail. internal_node: generated internally (e.g. LDO output). |
| - input_filter | No | array | No | - | Ordered list of passive components forming the filter network between the source supply and this rail net. Use 'from' on the first series element to name the source net; the rail net itself is the output node. Shunt elements use 'to: GND'. Example: +3V3 → 33Ω (from: VREG_VIN) → VREG_AVDD → 4.7µF (to: GND). |
| - bulk_decoupling | No | array | No | - | Large bulk decoupling capacitors placed near the component |
| - remark | No | string | No | - | Free-form note about this rail (e.g. must be sequenced before DVDD, shared with another supply) |
1. Property id
| Type | string |
| Required | Yes |
Description: Internal identifier for this rail, referenced by pin rail fields (e.g. vplus, vdd_core)
2. Property net
| Type | string |
| Required | Yes |
Description: Net name in the schematic (e.g. VCC_3V3, GND)
3. Property type
| Type | enum (of string) |
| Required | No |
Description: power: externally supplied rail. internal_node: generated internally (e.g. LDO output).
Must be one of: * "power" * "internal_node"
4. Property input_filter
| Type | array |
| Required | No |
Description: Ordered list of passive components forming the filter network between the source supply and this rail net. Use 'from' on the first series element to name the source net; the rail net itself is the output node. Shunt elements use 'to: GND'. Example: +3V3 → 33Ω (from: VREG_VIN) → VREG_AVDD → 4.7µF (to: GND).
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| Passive Component | A passive component used in decoupling, filtering, or required external circuits |
4.1. Passive Component
Title: Passive Component
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Defined in | passive_component.schema.json |
Description: A passive component used in decoupling, filtering, or required external circuits
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + type | No | enum (of string) | No | - | Component type |
| - required | No | boolean | No | - | True if this component is mandatory for correct operation. False or absent means the component is optional (e.g. a debug button, an optional filter). |
| - resistance | No | object | No | In measured_value.schema.json | Measured Value |
| - capacitance | No | object | No | Same as resistance | Measured Value |
| - inductance | No | object | No | Same as resistance | Measured Value |
| - impedance_at_100mhz | No | object | No | Same as resistance | Measured Value |
| - voltage_rating | No | object | No | Same as resistance | Measured Value |
| - current_rating | No | object | No | Same as resistance | Measured Value |
| - esr | No | object | No | Same as resistance | Measured Value |
| - frequency | No | object | No | Same as resistance | Measured Value |
| - frequency_tolerance | No | object | No | Same as resistance | Measured Value |
| - load_capacitance | No | object | No | Same as resistance | Measured Value |
| - series_r | No | object | No | Same as resistance | Measured Value |
| - xin_cap | No | object | No | Same as resistance | Measured Value |
| - xout_cap | No | object | No | Same as resistance | Measured Value |
| - dielectric | No | array of string | No | - | Acceptable capacitor dielectrics in order of preference (e.g. [X5R, X7R]) |
| - recommended_mpn | No | string | No | - | Specific manufacturer part number recommended by the IC datasheet or design guide. Deviating requires re-validation. |
| - package | No | string | No | - | Recommended component package / footprint (e.g. '0402', '0806') |
| - condition | No | string | No | - | Design condition under which this component or value applies (e.g. 'IOVDD=3.3V'). If the condition is not met the component must be re-evaluated. |
| - placement | No | enum (of string) | No | - | Required placement proximity relative to the associated pin or component |
| - orientation | No | string | No | - | Required mounting orientation for orientation-sensitive components (e.g. shielded inductors whose magnetic field direction affects adjacent components). Presence of this field implies the component must not be rotated arbitrarily. Value should describe the correct placement direction (e.g. 'winding-start towards output capacitor'). |
| - quantity | No | enum (of string) | No | - | How many instances of this component are needed |
| - scope | No | enum (of string) | No | - | component: one per IC instance. bus: shared across all devices on the bus. |
| - from | No | string | No | - | Source net or pin name this component connects from (net name in rail input_filter context; pin name in required_external context) |
| - to | No | string | No | - | Destination net or pin name this component connects to |
| - remark | No | string | No | - | Free-form note about why this component is needed or how to select it |
4.1.1. Property type
| Type | enum (of string) |
| Required | Yes |
Description: Component type
Must be one of: * "capacitor" * "resistor" * "ferrite_bead" * "inductor" * "crystal" * "diode" * "switch"
4.1.2. Property required
| Type | boolean |
| Required | No |
Description: True if this component is mandatory for correct operation. False or absent means the component is optional (e.g. a debug button, an optional filter).
4.1.3. Property resistance
Title: Measured Value
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | measured_value.schema.json |
Description: Resistance value (for resistors and pull-ups)
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + value | No | number | No | - | Numeric quantity |
| + unit | No | string | No | - | Unit of measurement. Must be an SI unit or SI-derived unit, optionally with an SI prefix (e.g. V, mV, A, mA, Ω, kΩ, F, nF, µF, H, nH, Hz, kHz, MHz, W, mW, °C, m, mm). Dimensionless ratios such as ppm and % are also accepted. |
4.1.3.1. Property value
| Type | number |
| Required | Yes |
Description: Numeric quantity
4.1.3.2. Property unit
| Type | string |
| Required | Yes |
Description: Unit of measurement. Must be an SI unit or SI-derived unit, optionally with an SI prefix (e.g. V, mV, A, mA, Ω, kΩ, F, nF, µF, H, nH, Hz, kHz, MHz, W, mW, °C, m, mm). Dimensionless ratios such as ppm and % are also accepted.
4.1.4. Property capacitance
Title: Measured Value
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | resistance |
Description: Capacitance value (for capacitors)
4.1.5. Property inductance
Title: Measured Value
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | resistance |
Description: Inductance value (for inductors)
4.1.6. Property impedance_at_100mhz
Title: Measured Value
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | resistance |
Description: Impedance at 100 MHz (for ferrite beads)
4.1.7. Property voltage_rating
Title: Measured Value
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | resistance |
Description: Maximum rated voltage
4.1.8. Property current_rating
Title: Measured Value
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | resistance |
Description: Maximum rated continuous current
4.1.9. Property esr
Title: Measured Value
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | resistance |
Description: Equivalent series resistance (max, for capacitors and crystals)
4.1.10. Property frequency
Title: Measured Value
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | resistance |
Description: Nominal oscillation frequency (for crystals)
4.1.11. Property frequency_tolerance
Title: Measured Value
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | resistance |
Description: Frequency tolerance (for crystals, unit: ppm)
4.1.12. Property load_capacitance
Title: Measured Value
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | resistance |
Description: Specified load capacitance (for crystals, unit: pF)
4.1.13. Property series_r
Title: Measured Value
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | resistance |
Description: Series resistor (Rs) in the oscillator drive path (for crystals only). Rs is placed in series between the MCU oscillator output (XOUT) and the crystal, limiting drive current. The crystal's XOUT-side pin is placed on an intermediate net; Rs bridges that net back to the XOUT pin net.
4.1.14. Property xin_cap
Title: Measured Value
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | resistance |
Description: Load capacitor on the crystal XIN side, placed between the crystal's sense-side terminal (same net as the MCU XIN pin) and GND.
4.1.15. Property xout_cap
Title: Measured Value
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | resistance |
Description: Load capacitor on the crystal XOUT side, placed between the crystal's drive-side terminal and GND. Used together with series_r when the XOUT cap must sit on the crystal side of Rs (not on the MCU XOUT pin directly).
4.1.16. Property dielectric
| Type | array of string |
| Required | No |
Description: Acceptable capacitor dielectrics in order of preference (e.g. [X5R, X7R])
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| dielectric items | - |
4.1.16.1. dielectric items
| Type | string |
| Required | No |
4.1.17. Property recommended_mpn
| Type | string |
| Required | No |
Description: Specific manufacturer part number recommended by the IC datasheet or design guide. Deviating requires re-validation.
4.1.18. Property package
| Type | string |
| Required | No |
Description: Recommended component package / footprint (e.g. '0402', '0806')
4.1.19. Property condition
| Type | string |
| Required | No |
Description: Design condition under which this component or value applies (e.g. 'IOVDD=3.3V'). If the condition is not met the component must be re-evaluated.
4.1.20. Property placement
| Type | enum (of string) |
| Required | No |
Description: Required placement proximity relative to the associated pin or component
Must be one of: * "close" * "nearby" * "per_pin" * "per_component"
4.1.21. Property orientation
| Type | string |
| Required | No |
Description: Required mounting orientation for orientation-sensitive components (e.g. shielded inductors whose magnetic field direction affects adjacent components). Presence of this field implies the component must not be rotated arbitrarily. Value should describe the correct placement direction (e.g. 'winding-start towards output capacitor').
4.1.22. Property quantity
| Type | enum (of string) |
| Required | No |
Description: How many instances of this component are needed
Must be one of: * "1" * "per_pin" * "per_component"
4.1.23. Property scope
| Type | enum (of string) |
| Required | No |
Description: component: one per IC instance. bus: shared across all devices on the bus.
Must be one of: * "component" * "bus"
4.1.24. Property from
| Type | string |
| Required | No |
Description: Source net or pin name this component connects from (net name in rail input_filter context; pin name in required_external context)
4.1.25. Property to
| Type | string |
| Required | No |
Description: Destination net or pin name this component connects to
4.1.26. Property remark
| Type | string |
| Required | No |
Description: Free-form note about why this component is needed or how to select it
5. Property bulk_decoupling
| Type | array |
| Required | No |
Description: Large bulk decoupling capacitors placed near the component
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| Passive Component | A passive component used in decoupling, filtering, or required external circuits |
5.1. Passive Component
Title: Passive Component
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Same definition as | Passive Component |
Description: A passive component used in decoupling, filtering, or required external circuits
6. Property remark
| Type | string |
| Required | No |
Description: Free-form note about this rail (e.g. must be sequenced before DVDD, shared with another supply)
Generated using json-schema-for-humans on 2026-03-30 at 10:42:34 +0000