ref-label

The ref-label statement is a tool for creating the reference designator Text shape from outside a component's land pattern.

This is a tool primarily used by the importer that allows the JITX runtime to place components and their reference designators accurately on the board.

This statement is only valid in the pcb-module context.

Signature


ref-label(<INST>) = <Text>
  • &lt;INST> - A ref to an instance of a component in the current pcb-module context.
  • &lt;Text> - A Text shape instance that describes the features of the reference designator for this component instance.
    • The Text object will define the location, pose, size, and font for the reference designator.
    • The string value of this Text object must be the literal string >REF - otherwise an exception is thrown.

Usage

As mentioned above, this statement is primarily a tool for the importer. A typical example will look like: 


pcb-module top-level:
  ...

  ref-label(self.MCU.osc) = Text(">REF", 1.0, C, loc(18.380, 5.080, 90.000), "", TrueTypeFont, false, false)

In this example the component instance is a public component instance osc of a sub-module named MCU. Notice the use >REF as the text literal string. This is a template value for the reference designator and will be replaced by the JITX runtime when the design compiles.

The C argument in this context is the Anchor parameter. The anchor indicates the origin of the text object. In this case C indicates "Center."