Go to the source code of this file.
|
| | _HKI ("<table>\n" " <tr>\n" " <th>Markup</th>\n" " <th></th>\n" " <th>Result</th>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>^{superscript}</samp></td>\n" " <td></td>\n" " <td> <br><samp><sup>superscript</sup> </samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>Driver Board^{Rev A}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Driver Board<sup>Rev A</sup></samp></td>\n" " </tr>\n" " <tr>\n" " <td><br></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>_{subscript}</samp></td>\n" " <td></td>\n" " <td> <br><samp><sub>subscript</sub> </samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>D_{0} - D_{15}</samp></td>\n" " <td></td>\n" " <td> <br><samp>D<sub>0</sub> - D<sub>15</sub></samp></td>\n" " </tr>\n" " <tr>\n" " <td></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>~{overbar}</samp><br> <br><samp>~{CLK}</samp></td>\n" " <td></td>\n" " <td> <samp><u> </u></samp><br> <samp>overbar</samp><br> <samp><u> </u></samp><br> <samp>CLK</samp></td>\n" " </tr>\n" " <tr>\n" " <td></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${variable}</samp></td>\n" " <td></td>\n" " <td> <br><samp><i>variable_value</i></samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${PROJECTNAME}</samp></td>\n" " <td></td>\n" " <td> <br><samp>MyBoard</samp></td>\n" " </tr>\n" " <tr>\n" " <td><br></td>\n" " </tr>\n" " <tr>\n" " <th>PCB Variables</th>\n" " <th></th>\n" " <th></th>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${FILENAME}</samp></td>\n" " <td></td>\n" " <td> <br><samp>board.kicad_pcb</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${FILEPATH}</samp></td>\n" " <td></td>\n" " <td> <br><samp>/path/to/board.kicad_pcb</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${LAYER}</samp> (in text/tables)</td>\n" " <td></td>\n" " <td> <br><samp>F.Cu, B.Cu, F.SilkS...</samp></td>\n" " </tr>\n" " <tr>\n" " <td><br></td>\n" " </tr>\n" " <tr>\n" " <th>Footprint Cross-References</th>\n" " <th></th>\n" " <th></th>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${refdes:field}</samp></td>\n" " <td></td>\n" " <td> <br><samp><i>field_value</i> of footprint <i>refdes</i></samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${U1:REFERENCE}</samp></td>\n" " <td></td>\n" " <td> <br><samp>U1</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${U1:VALUE}</samp></td>\n" " <td></td>\n" " <td> <br><samp>STM32F407VGT6</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${U1:FOOTPRINT_LIBRARY}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Package_QFP</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${U1:FOOTPRINT_NAME}</samp></td>\n" " <td></td>\n" " <td> <br><samp>LQFP-100_14x14mm_P0.5mm</samp></td>\n" " </tr>\n" " <tr>\n" " <td><br></td>\n" " </tr>\n" " <tr>\n" " <th>Pad/Pin Functions</th>\n" " <th></th>\n" " <th></th>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${refdes:NET_NAME(pad)}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Net name connected to pad</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${U1:NET_NAME(5)}</samp></td>\n" " <td></td>\n" " <td> <br><samp>VCC</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${refdes:SHORT_NET_NAME(pad)}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Short net name or NC</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${J1:SHORT_NET_NAME(3)}</samp></td>\n" " <td></td>\n" " <td> <br><samp>GND</samp> or <samp>NC</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${refdes:NET_CLASS(pad)}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Net class for pad</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${J1:NET_CLASS(1)}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Power</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${refdes:PIN_NAME(pad)}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Pin function/name</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${U1:PIN_NAME(5)}</samp></td>\n" " <td></td>\n" " <td> <br><samp>USART1_TX</samp></td>\n" " </tr>\n" " <tr>\n" " <td><br></td>\n" " </tr>\n" " <tr>\n" " <th>Table Variables</th>\n" " <th></th>\n" " <th></th>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${ROW}</samp> (in tables)</td>\n" " <td></td>\n" " <td> <br><samp>1, 2, 3...</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${COL}</samp> (in tables)</td>\n" " <td></td>\n" " <td> <br><samp>1, 2, 3...</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${ADDR}</samp> (in tables)</td>\n" " <td></td>\n" " <td> <br><samp>A1, B2, C3...</samp></td>\n" " </tr>\n" " <tr>\n" " <td><br></td>\n" " </tr>\n" " <tr>\n" " <th>Math Expressions</th>\n" " <th></th>\n" " <th></th>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>@{expression}</samp></td>\n" " <td></td>\n" " <td> <br><samp><i>evaluated_result</i></samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>@{2 + 3}</samp></td>\n" " <td></td>\n" " <td> <br><samp>5</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>@{${ROW} - 1}</samp></td>\n" " <td></td>\n" " <td> <br><samp>3</samp> (when ROW=4)</td>\n" " </tr>\n" " <tr>\n" " <td><br></td>\n" " </tr>\n" " <tr>\n" " <th>String Comparison & Conditional Text</th>\n" " <th></th>\n" " <th></th>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>@{\"text\" == \"text\"}</samp></td>\n" " <td></td>\n" " <td> <br><samp>1</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>@{\"text\" != \"other\"}</samp></td>\n" " <td></td>\n" " <td> <br><samp>1</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>@{if(condition, true_val, false_val)}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Conditional text display</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>@{if(\"${LAYER}\" == \"F.Cu\", \"TOP\", \"BOTTOM\")}</samp></td>\n" " <td></td>\n" " <td> <br><samp>TOP</samp> (on front layer) or <samp>BOTTOM</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>@{if(${ROW} > 5, \"High\", \"Low\")}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Numeric comparisons work too</samp></td>\n" " </tr>\n" " <tr>\n" " <td><br></td>\n" " </tr>\n" " <tr>\n" " <th>Escape Sequences</th>\n" " <th></th>\n" " <th></th>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>\\${LITERAL}</samp></td>\n" " <td></td>\n" " <td> <br><samp>${LITERAL}</samp> (not expanded)</td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>Price: \\$25.00</samp></td>\n" " <td></td>\n" " <td> <br><samp>Price: $25.00</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>\\@{x+y}</samp></td>\n" " <td></td>\n" " <td> <br><samp>@{x+y}</samp> (not evaluated)</td>\n" " </tr>\n" " <tr>\n" " <td><br></td>\n" " </tr>\n" " <tr>\n" " <th>Nested Variables</th>\n" " <th></th>\n" " <th></th>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${U1:NET_NAME(@{${ROW}-2})}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Dynamic net lookup in tables</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${U${ROW}:VALUE}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Dynamic footprint reference</samp></td>\n" " </tr>\n" " <tr>\n" " <td><br></td>\n" " </tr>\n" "</table>\n" "<p></p>\n" "<p></p>\n" "<i>Note that markup has precedence over variable expansion.</i>\n" "<p></p>\n" "<p><b>Footprint Cross-References:</b> Reference fields and pads on other footprints using <samp>${refdes:field}</samp> or <samp>${refdes:function(pad)}</samp> syntax.</p>\n" "<p><b>Nested Variables:</b> Variables can contain other variables. Inner variables are expanded first. Maximum nesting depth: 10 levels.</p>\n" "<p><b>Error Messages:</b></p>\n" "<ul>\n" "<li><samp><UNRESOLVED: token></samp> - Variable or function cannot be resolved</li>\n" "<li><samp><Unknown reference: U1></samp> - Footprint not found</li>\n" "</ul>\n" "\n" "") |
| |
◆ _HKI()
| _HKI |
( |
"<table>\n" " <tr>\n" " <th>Markup</th>\n" " <th></th>\n" " <th>Result</th>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>^{superscript}</samp></td>\n" " <td></td>\n" " <td> <br><samp><sup>superscript</sup> </samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>Driver Board^{Rev A}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Driver Board<sup>Rev A</sup></samp></td>\n" " </tr>\n" " <tr>\n" " <td><br></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>_{subscript}</samp></td>\n" " <td></td>\n" " <td> <br><samp><sub>subscript</sub> </samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>D_{0} - D_{15}</samp></td>\n" " <td></td>\n" " <td> <br><samp>D<sub>0</sub> - D<sub>15</sub></samp></td>\n" " </tr>\n" " <tr>\n" " <td></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>~{overbar}</samp><br> <br><samp>~{CLK}</samp></td>\n" " <td></td>\n" " <td> <samp><u> </u></samp><br> <samp>overbar</samp><br> <samp><u> </u></samp><br> <samp>CLK</samp></td>\n" " </tr>\n" " <tr>\n" " <td></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${variable}</samp></td>\n" " <td></td>\n" " <td> <br><samp><i>variable_value</i></samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${PROJECTNAME}</samp></td>\n" " <td></td>\n" " <td> <br><samp>MyBoard</samp></td>\n" " </tr>\n" " <tr>\n" " <td><br></td>\n" " </tr>\n" " <tr>\n" " <th>PCB Variables</th>\n" " <th></th>\n" " <th></th>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${FILENAME}</samp></td>\n" " <td></td>\n" " <td> <br><samp>board.kicad_pcb</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${FILEPATH}</samp></td>\n" " <td></td>\n" " <td> <br><samp>/path/to/board.kicad_pcb</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${LAYER}</samp> (in text/tables)</td>\n" " <td></td>\n" " <td> <br><samp>F. | Cu, |
|
|
B. | Cu, |
|
|
F.SilkS...</samp ></td >\n" "</tr >\n" "< tr >\n" "< td >< br ></td >\n" "</tr >\n" "< tr >\n" "< th >Footprint Cross-References</th >\n" "< th ></th >\n" "< th ></th >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${refdes:field}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >< i >field_value</i > of footprint< i >refdes</i ></samp ></td >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${U1:REFERENCE}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >U1</samp ></td >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${U1:VALUE}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >STM32F407VGT6</samp ></td >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${U1:FOOTPRINT_LIBRARY}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >Package_QFP</samp ></td >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${U1:FOOTPRINT_NAME}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >LQFP-100_14x14mm_P0.5mm</samp ></td >\n" "</tr >\n" "< tr >\n" "< td >< br ></td >\n" "</tr >\n" "< tr >\n" "< th >Pad/Pin Functions</th >\n" "< th ></th >\n" "< th ></th >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${refdes:NET_NAME(pad)}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >Net name connected to pad</samp ></td >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${U1:NET_NAME(5)}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >VCC</samp ></td >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${refdes:SHORT_NET_NAME(pad)}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >Short net name or NC</samp ></td >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${J1:SHORT_NET_NAME(3)}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >GND</samp > or< samp >NC</samp ></td >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${refdes:NET_CLASS(pad)}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >Net class for pad</samp ></td >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${J1:NET_CLASS(1)}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >Power</samp ></td >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${refdes:PIN_NAME(pad)}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >Pin function/name</samp ></td >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${U1:PIN_NAME(5)}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >USART1_TX</samp ></td >\n" "</tr >\n" "< tr >\n" "< td >< br ></td >\n" "</tr >\n" "< tr >\n" "< th >Table Variables</th >\n" "< th ></th >\n" "< th ></th >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${ROW}</samp >(in tables)</td >\n" "< td ></td >\n" "< td > < br >< samp > | 1, |
|
|
2 | , |
|
|
3...</samp ></td >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${COL}</samp >(in tables)</td >\n" "< td ></td >\n" "< td > < br >< samp > | 1, |
|
|
2 | , |
|
|
3...</samp ></td >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >${ADDR}</samp >(in tables)</td >\n" "< td ></td >\n" "< td > < br >< samp > | A1, |
|
|
B2 | , |
|
|
C3...</samp ></td >\n" "</tr >\n" "< tr >\n" "< td >< br ></td >\n" "</tr >\n" "< tr >\n" "< th >Math Expressions</th >\n" "< th ></th >\n" "< th ></th >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >@{expression}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >< i >evaluated_result</i ></samp ></td >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >@{2+3}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >5</samp ></td >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >@{${ROW} - 1}</samp ></td >\n" "< td ></td >\n" "< td > < br >< samp >3</samp >(when ROW=4)</td >\n" "</tr >\n" "< tr >\n" "< td >< br ></td >\n" "</tr >\n" "< tr >\n" "< th >String Comparison &Conditional Text</th >\n" "< th ></th >\n" "< th ></th >\n" "</tr >\n" "< tr >\n" "< td > < br >< samp >@{\"text\" == \"text\"}</samp></td>\n" " <td></td>\n" " <td> <br><samp>1</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>@{\"text\" != \"other\"}</samp></td>\n" " <td></td>\n" " <td> <br><samp>1</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>@{if(condition, true_val, false_val)}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Conditional text display</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>@{if(\"${LAYER}\" == \"F.Cu\", \"TOP\", \"BOTTOM\")}</samp></td>\n" " <td></td>\n" " <td> <br><samp>TOP</samp> (on front layer) or <samp>BOTTOM</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>@{if(${ROW} > 5, \"High\", \"Low\")}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Numeric comparisons work too</samp></td>\n" " </tr>\n" " <tr>\n" " <td><br></td>\n" " </tr>\n" " <tr>\n" " <th>Escape Sequences</th>\n" " <th></th>\n" " <th></th>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>\\${LITERAL}</samp></td>\n" " <td></td>\n" " <td> <br><samp>${LITERAL}</samp> (not expanded)</td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>Price: \\$25.00</samp></td>\n" " <td></td>\n" " <td> <br><samp>Price: $25.00</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>\\@{x+y}</samp></td>\n" " <td></td>\n" " <td> <br><samp>@{x+y}</samp> (not evaluated)</td>\n" " </tr>\n" " <tr>\n" " <td><br></td>\n" " </tr>\n" " <tr>\n" " <th>Nested Variables</th>\n" " <th></th>\n" " <th></th>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${U1:NET_NAME(@{${ROW}-2})}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Dynamic net lookup in tables</samp></td>\n" " </tr>\n" " <tr>\n" " <td> <br><samp>${U${ROW}:VALUE}</samp></td>\n" " <td></td>\n" " <td> <br><samp>Dynamic footprint reference</samp></td>\n" " </tr>\n" " <tr>\n" " <td><br></td>\n" " </tr>\n" "</table>\n" "<p></p>\n" "<p></p>\n" "<i>Note that markup has precedence over variable expansion.</i>\n" "<p></p>\n" "<p><b>Footprint Cross-References:</b> Reference fields and pads on other footprints using <samp>${refdes:field}</samp> or <samp>${refdes:function(pad)}</samp> syntax.</p>\n" "<p><b>Nested Variables:</b> Variables can contain other variables. Inner variables are expanded first. Maximum nesting depth: 10 levels.</p>\n" "<p><b>Error Messages:</b></p>\n" "<ul>\n" "<li><samp><UNRESOLVED: token></samp> - Variable or function cannot be resolved</li>\n" "<li><samp><Unknown reference: U1></samp> - Footprint not found</li>\n" "</ul>\n" "\n" "" | ) |
1.13.2