Ok, so let me clarify. I know what REF** does. I know what ${REFERENCE} does but what is the difference? is ${REFERENCE} something left over from older versions? I see it gets generated when you create a new footprint. If it still needs to be there how do I recreate it if I delete it?
Thanks,
Andrew
You are contradicting yourself here. If you know what they are, you should also know the difference. If you don’t know the difference, then you’ve made some false assumption. I could make guesses what your false assumption is, but I’m not in the mood for that. It’s also you who wants help, so I ask you to give a short description of what the meaning is of each of those two strings.
Well, the REF** field is used on the silk layer, and the ${REFERENCE} is used on the fab layer (fab layer is handy for more assembly info than can be gleaned from a silk drawing, but is not always needed):
I like to add extra info to fab, and since the fab reference is in the kicad ${} variable format, I concatenate another field (pulled from my database) to add a little extra bit of useful assy info to fab layer drawings: ${REFERENCE}${FabExtRef}.
Here the silk has the simple R71 ref, and on fab layer the extended ref field adds the 3-digit code(s) that are printed on an 0603 resistor:
Why REF** on silk and ${REFERENCE} on fab? I have no idea but – perhaps someone knows the history.
Thank You Sir! That’s exactly what I wanted to know.
Andrew
Paul,
Clearly you need to add more fiber to your diet. Nothing you have said is helpful, just insulting.
It’s quite amazing, actually. without me having to give a short description or any other thing, Teletypeguy was able to give me a helpful answer without having to flex his “mood.”
As I said, a little fiber should help. If it doesn’t, try pulling that stick out… if you’re not careful, you could lose an eye.
I have no 
either but surely this is where the two are not equivalent. The documentation says that REF** is the initial value of the RefDes field, and I see it on things that I don’t annotate, like logos, while other symbols get set to R21, C42, and so forth. If ${REFERENCE} were put in this field wouldn’t that result in infinite regress?
It’s more about there only being one reference field in the footprint, and any other text that’s meant to display a reference needing a special pointer (I’m not sure if it’s a good word to describe it).
Here are properties windows for both the REF** and ${REFERENCE} fields:
REF** is historical.
Each footprint must have one primary reference designator. It’s the Reference field of the footprint, and by convention it has text REF** by default. When you create a new footprint it will be in the silkscreen layer and can’t be deleted (deleting it is impossible, even pressing Del only sets it invisible), but you can set it invisible or change its layer. According to the KiCad Library Conventions for the official footprints it should be in the Silk.F layer.
You can of course add several reference designator texts. The KLC says there should be one copy of the reference designator in the Fab layer. In older versions of KiCad this was achieved with text “%R”. But later, for version 6.0, the idea of more generic text variables was added. Symbol fields can be used in the footprints. It didn’t make much sense to stick with the old style %R (or the corresponding %V for the Value). It was changed to ${REFERENCE}.
Actually it looks like REF** is just an arbitrary string which could be anything. You can’t do anything special with it. You can’t use it as a variable. It’s just a placeholder for actual reference designator and shows with one glance that this footprint doesn’t have a reference designator yet. What is important is the field. The Reference field is the link between the symbol and the footprint: it’s updated when you update the PCB from the schematic, or vice versa: the symbol reference is updated according to this field if you update the schematic from the PCB. You can change the text of the field to anything and it still works, or set it invisible, but you can’t delete the field or change the field’s name.
Unless someone finds a case where REF** actually does anything special, I would say that it’s just a string. Only ${REFERENCE} has a special meaning: it carries the reference designator text. It automatically follows the content of the Reference field.
We must understand the difference between conventions or defaults on one hand and how KiCad works on the other. The Reference field, which is always there and can’t be deleted, is how KiCad works. The text REF** there is only a convention and the default text, but otherwise it doesn’t have any special meaning and as far as I can see is not relied on anywhere in KiCad.
The variable name REFERENCE is part of how KiCad works, but its existence in the footprint F.Fab layer text item in the official footprints or in newly created footprints is only a convention and it is added by default. These non-mandatory text items and/or property fields can be deleted and added at will.
So, I bet you didn’t know what REF** and ${REFERENCE} and those fields actually do, but I’m not sure if others understood this, either.
No, because the Reference field is special. When the text replacement variables were developed (by Jeff) I pondered on this and justified why the reference designators (I thought about the schematic, but it goes for the PCB, too) shouldn’t do text substitution at all. KiCad uses references in certain ways and it would be far too brittle to allow for the user “creative” ways to use that field.
You can test this by replacing a Reference field text in a PCB with ${REFERENCE}. It is seen there verbatim. The fab layer copy also reads ${REFERENCE}, verbatim, but not because that fab layer field says ${REFERENCE} verbatim. Actually that ${REFERENCE} is substituted with the reference designator, which now happens to be ${REFERENCE}, verbatim.
Further reading for KiCad history enthusiasts (about text replacement variables in general, about replacement in the Reference field and about the old %R): New string replacement options for kicad assets.
I have no proof for this, but I think that the primary reference designator text is in the Silk layer only because that’s the most natural place for the refdes if there’s only one. As I said, the Reference property field is mandatory, and properties are embodied as text items which must have a layer. Silk is the default layer for the Reference in KiCad, but can be changed. Notice that the secondary reference in the Fab layer is just a normal text item, not a property field. It’s totally optional but by default is added to the Fab layer because that layer in KiCad contains other similar information about the footprints/components.
Anyone who creates their own libraries can change the layer of the primary reference text and can leave out the secondary, or put it in a different layer. Even the REF** text can be changed to something else in the library, it’s just the default text when the footprint is put to the PCB without a link to the schematic.
eelik ate all my fibers.
This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.
