70 lines
4.7 KiB
ReStructuredText
70 lines
4.7 KiB
ReStructuredText
.. Automatically generated by KiBot, please don't edit this file
|
|
|
|
.. index::
|
|
pair: QR_Lib; qr_lib
|
|
|
|
QR_Lib
|
|
~~~~~~
|
|
|
|
Generates a QR code symbol and footprint.
|
|
This output creates a library containing a symbol and footprint for a QR code. |br|
|
|
To refresh the generated symbols and footprints use the `update_qr` preflight. |br|
|
|
The workflow is as follows:
|
|
|
|
- Create the symbol and footprints using this output.
|
|
- Use them in your schematic and PCB.
|
|
- To keep them updated add the `update_qr` preflight
|
|
|
|
Type: ``qr_lib``
|
|
|
|
|
|
Parameters:
|
|
|
|
- **comment** :index:`: <pair: output - qr_lib; comment>` [string=''] A comment for documentation purposes. It helps to identify the output.
|
|
- **dir** :index:`: <pair: output - qr_lib; dir>` [string='./'] Output directory for the generated files.
|
|
If it starts with `+` the rest is concatenated to the default dir.
|
|
- **name** :index:`: <pair: output - qr_lib; name>` [string=''] Used to identify this particular output definition.
|
|
Avoid using `_` as first character. These names are reserved for KiBot.
|
|
- **options** :index:`: <pair: output - qr_lib; options>` [dict] Options for the `boardview` output.
|
|
|
|
- Valid keys:
|
|
|
|
- **lib** :index:`: <pair: output - qr_lib - options; lib>` [string='QR'] Short name for the library.
|
|
- **output** :index:`: <pair: output - qr_lib - options; output>` [string='%f-%i%I%v.%x'] Filename/dirname for the output library (%i=qr, %x=lib/kicad_sym/pretty).
|
|
You must use %x in the name to get a symbols lib and a footprints lib. Affected by global options.
|
|
- **qrs** :index:`: <pair: output - qr_lib - options; qrs>` [list(dict)] QR codes to include in the library.
|
|
|
|
- Valid keys:
|
|
|
|
- **layer** :index:`: <pair: output - qr_lib - options - qrs; layer>` [string='silk'] [silk,copper] Layer for the footprint.
|
|
- **name** :index:`: <pair: output - qr_lib - options - qrs; name>` [string='QR'] Name for the symbol/footprint.
|
|
- **size_pcb** :index:`: <pair: output - qr_lib - options - qrs; size_pcb>` [number=15] Size of the QR footprint.
|
|
- **size_sch** :index:`: <pair: output - qr_lib - options - qrs; size_sch>` [number=15] Size of the QR symbol.
|
|
- **text** :index:`: <pair: output - qr_lib - options - qrs; text>` [string='%p %r'] Text to encode as QR.
|
|
- ``correction_level`` :index:`: <pair: output - qr_lib - options - qrs; correction_level>` [string='low'] [low,medium,quartile,high] Error correction level.
|
|
- ``pcb_negative`` :index:`: <pair: output - qr_lib - options - qrs; pcb_negative>` [boolean=false] Generate a negative image for the PCB.
|
|
- ``size_units`` :index:`: <pair: output - qr_lib - options - qrs; size_units>` [string='millimeters'] [millimeters,inches] Units used for the size.
|
|
|
|
- ``reference`` :index:`: <pair: output - qr_lib - options; reference>` [string='QR'] The reference prefix.
|
|
- ``use_sch_dir`` :index:`: <pair: output - qr_lib - options; use_sch_dir>` [boolean=true] Generate the libs relative to the schematic/PCB dir.
|
|
|
|
- **type** :index:`: <pair: output - qr_lib; type>` [string=''] Type of output.
|
|
- ``category`` :index:`: <pair: output - qr_lib; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
|
|
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
|
|
The categories are currently used for `navigate_results`.
|
|
|
|
- ``disable_run_by_default`` :index:`: <pair: output - qr_lib; disable_run_by_default>` [string|boolean] Use it to disable the `run_by_default` status of other output.
|
|
Useful when this output extends another and you don't want to generate the original.
|
|
Use the boolean true value to disable the output you are extending.
|
|
- ``extends`` :index:`: <pair: output - qr_lib; extends>` [string=''] Copy the `options` section from the indicated output.
|
|
Used to inherit options from another output of the same type.
|
|
- ``groups`` :index:`: <pair: output - qr_lib; groups>` [string|list(string)=''] One or more groups to add this output. In order to catch typos
|
|
we recommend to add outputs only to existing groups. You can create an empty group if
|
|
needed.
|
|
|
|
- ``output_id`` :index:`: <pair: output - qr_lib; output_id>` [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
|
|
- ``priority`` :index:`: <pair: output - qr_lib; priority>` [number=90] [0,100] Priority for this output. High priority outputs are created first.
|
|
Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
|
|
- ``run_by_default`` :index:`: <pair: output - qr_lib; run_by_default>` [boolean=true] When enabled this output will be created when no specific outputs are requested.
|
|
|