[DOCs] Updated with the new populate output
This commit is contained in:
Salvador E. Tropea
parent
ddd0018f43
commit
b0a395e68a
|
|
@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
|
||||
## [1.4.1] - Unreleased
|
||||
### Added
|
||||
- New output:
|
||||
- `populate` to create step-by-step assembly instructions
|
||||
- Diff:
|
||||
- Option to compare only the first schematic page. (See #319)
|
||||
- PcbDraw:
|
||||
|
|
|
|||
50
README.md
50
README.md
|
|
@ -155,6 +155,9 @@ Notes:
|
|||
[**KiCad PCB/SCH Diff**](https://github.com/INTI-CMNB/KiDiff) v2.4.3 [](https://github.com/INTI-CMNB/KiDiff) 
|
||||
- Mandatory for `diff`
|
||||
|
||||
[**mistune**](https://pypi.org/project/mistune/) [](https://pypi.org/project/mistune/) [](https://packages.debian.org/bullseye/python3-mistune)
|
||||
- Mandatory for `populate`
|
||||
|
||||
[**QRCodeGen**](https://pypi.org/project/QRCodeGen/) [](https://pypi.org/project/QRCodeGen/) [](https://pypi.org/project/QRCodeGen/) [](https://packages.debian.org/bullseye/python3-qrcodegen) 
|
||||
- Mandatory for `qr_lib`
|
||||
|
||||
|
|
@ -2861,6 +2864,48 @@ Notes:
|
|||
Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
|
||||
- `run_by_default`: [boolean=true] When enabled this output will be created when no specific outputs are requested.
|
||||
|
||||
* Populate - Assembly instructions builder
|
||||
* Type: `populate`
|
||||
* Description: Creates a markdown and/or HTML file explaining how to assembly a PCB.
|
||||
Each step shows the already soldered components and the ones to add highlighted.
|
||||
This is equivalent to the PcbDraw's Populate command, but integrated to KiBot.
|
||||
For more information about the input markdown file please consult the PcbDraw project
|
||||
* Valid keys:
|
||||
- **`comment`**: [string=''] A comment for documentation purposes.
|
||||
- **`dir`**: [string='./'] Output directory for the generated files.
|
||||
If it starts with `+` the rest is concatenated to the default dir.
|
||||
- **`name`**: [string=''] Used to identify this particular output definition.
|
||||
- **`options`**: [dict] Options for the `populate` output.
|
||||
* Valid keys:
|
||||
- **`format`**: [string='html'] [html,md] Format for the generated output.
|
||||
- **`input`**: [string=''] Name of the input file describing the assembly. Must be a markdown file.
|
||||
Note that the YAML section of the file will be skipped, all the needed information
|
||||
comes from this output and the `renderer` output.
|
||||
- **`renderer`**: [string=''] Name of the output used to render the PCB steps.
|
||||
Currently this must be a `pcbdraw` output.
|
||||
- `dnf_filter`: [string|list(string)='_none'] Name of the filter to mark components as not fitted.
|
||||
A short-cut to use for simple cases where a variant is an overkill.
|
||||
- `imgname`: [string='img/populating_%d.%x'] Pattern used for the image names. The `%d` is replaced by the image number.
|
||||
The `%x` is replaced by the extension. Note that the format is selected by the
|
||||
`renderer`.
|
||||
- `initial_components`: [string|list(string)=''] List of components soldered before the first step.
|
||||
- `pre_transform`: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
|
||||
A short-cut to use for simple cases where a variant is an overkill.
|
||||
- `template`: [string] The name of the handlebars template used for the HTML output.
|
||||
The extension must be `.handlebars`, it will be added when missing.
|
||||
The `simple.handlebars` template is a built-in template.
|
||||
- `variant`: [string=''] Board variant to apply.
|
||||
- `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.
|
||||
- `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`: [string=''] Copy the `options` section from the indicated output.
|
||||
- `output_id`: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
|
||||
- `priority`: [number=50] [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`: [boolean=true] When enabled this output will be created when no specific outputs are requested.
|
||||
|
||||
* Pick & place
|
||||
* Type: `position`
|
||||
* Description: Generates the file with position information for the PCB components, used by the pick and place machine.
|
||||
|
|
@ -4430,7 +4475,7 @@ relative paths. So you can move the new PCB file to any place, as long as the `3
|
|||
- **Original KiCad Automation Scripts**: Scott Bezek, Productize SPRL
|
||||
- **KiBoM**: Oliver Henry Walters (@SchrodingersGat)
|
||||
- **Interactive HTML BoM**: @qu1ck
|
||||
- **PcbDraw**: Jan Mrázek (@yaqwsx)
|
||||
- **PcbDraw/Populate**: Jan Mrázek (@yaqwsx)
|
||||
- **KiCost**: Dave Vandenbout (@devbisme) and Hildo Guillardi Júnior (@hildogjr)
|
||||
- **KiCAD to Boardview exporter**: @whitequark
|
||||
- **S-expression parser**: Takafumi Arakaki
|
||||
|
|
@ -4438,6 +4483,9 @@ relative paths. So you can move the new PCB file to any place, as long as the `3
|
|||
- **Board2Pdf**: Albin Dennevi
|
||||
- **PyPDF2**: Mathieu Fenniak
|
||||
- **svgutils**: Bartosz Telenczuk (@btel)
|
||||
- **svgpathtools**: Andy A. Port
|
||||
- **pybars**: Will Bond and Mjumbe Wawatu Ukweli (Canonical Ltd.)
|
||||
- **pymeta**: Allen Short and Waldemar Kornewald
|
||||
- **Contributors**:
|
||||
- **Error filters ideas**: Leandro Heck (@leoheck)
|
||||
- **GitHub Actions Integration/SVG output**: @nerdyscout
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ Package: kibot
|
|||
Architecture: all
|
||||
Multi-Arch: foreign
|
||||
Depends: ${misc:Depends}, ${python3:Depends}, python3-yaml, kicad (>= 5.1.6), python3-wxgtk4.0
|
||||
Recommends: kibom.inti-cmnb (>= 1.8.0), kicost (>= 1.1.8), interactivehtmlbom.inti-cmnb (>= 2.4.1), imagemagick, librsvg2-bin, python3-xlsxwriter, rar, ghostscript, python3-lxml
|
||||
Recommends: kibom.inti-cmnb (>= 1.8.0), kicost (>= 1.1.8), interactivehtmlbom.inti-cmnb (>= 2.4.1), imagemagick, librsvg2-bin, python3-xlsxwriter, rar, ghostscript, python3-lxml, python3-mistune
|
||||
Suggests: pandoc, texlive-latex-base, texlive-latex-recommended, git, poppler-utils, kidiff, python3-numpy
|
||||
Description: KiCad Bot
|
||||
KiBot is a program which helps you to automate the generation of KiCad
|
||||
|
|
|
|||
|
|
@ -1888,7 +1888,7 @@ relative paths. So you can move the new PCB file to any place, as long as the `3
|
|||
- **Original KiCad Automation Scripts**: Scott Bezek, Productize SPRL
|
||||
- **KiBoM**: Oliver Henry Walters (@SchrodingersGat)
|
||||
- **Interactive HTML BoM**: @qu1ck
|
||||
- **PcbDraw**: Jan Mrázek (@yaqwsx)
|
||||
- **PcbDraw/Populate**: Jan Mrázek (@yaqwsx)
|
||||
- **KiCost**: Dave Vandenbout (@devbisme) and Hildo Guillardi Júnior (@hildogjr)
|
||||
- **KiCAD to Boardview exporter**: @whitequark
|
||||
- **S-expression parser**: Takafumi Arakaki
|
||||
|
|
@ -1896,6 +1896,9 @@ relative paths. So you can move the new PCB file to any place, as long as the `3
|
|||
- **Board2Pdf**: Albin Dennevi
|
||||
- **PyPDF2**: Mathieu Fenniak
|
||||
- **svgutils**: Bartosz Telenczuk (@btel)
|
||||
- **svgpathtools**: Andy A. Port
|
||||
- **pybars**: Will Bond and Mjumbe Wawatu Ukweli (Canonical Ltd.)
|
||||
- **pymeta**: Allen Short and Waldemar Kornewald
|
||||
- **Contributors**:
|
||||
- **Error filters ideas**: Leandro Heck (@leoheck)
|
||||
- **GitHub Actions Integration/SVG output**: @nerdyscout
|
||||
|
|
|
|||
|
|
@ -1630,6 +1630,42 @@ outputs:
|
|||
source: '*.pdf'
|
||||
# [boolean=false] Use the `pdfunite` tool instead of PyPDF2 Python module
|
||||
use_external_command: false
|
||||
# Populate - Assembly instructions builder:
|
||||
# Each step shows the already soldered components and the ones to add highlighted.
|
||||
# This is equivalent to the PcbDraw's Populate command, but integrated to KiBot.
|
||||
# For more information about the input markdown file please consult the PcbDraw project
|
||||
- name: 'populate_example'
|
||||
comment: 'Creates a markdown and/or HTML file explaining how to assembly a PCB.'
|
||||
type: 'populate'
|
||||
dir: 'Example/populate_dir'
|
||||
options:
|
||||
# [string|list(string)='_none'] Name of the filter to mark components as not fitted.
|
||||
# A short-cut to use for simple cases where a variant is an overkill
|
||||
dnf_filter: '_none'
|
||||
# [string='html'] [html,md] Format for the generated output
|
||||
format: 'html'
|
||||
# [string='img/populating_%d.%x'] Pattern used for the image names. The `%d` is replaced by the image number.
|
||||
# The `%x` is replaced by the extension. Note that the format is selected by the
|
||||
# `renderer`
|
||||
imgname: 'img/populating_%d.%x'
|
||||
# [string|list(string)=''] List of components soldered before the first step
|
||||
initial_components: ''
|
||||
# [string=''] Name of the input file describing the assembly. Must be a markdown file.
|
||||
# Note that the YAML section of the file will be skipped, all the needed information
|
||||
# comes from this output and the `renderer` output
|
||||
input: ''
|
||||
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
|
||||
# A short-cut to use for simple cases where a variant is an overkill
|
||||
pre_transform: '_none'
|
||||
# [string=''] Name of the output used to render the PCB steps.
|
||||
# Currently this must be a `pcbdraw` output
|
||||
renderer: ''
|
||||
# [string] The name of the handlebars template used for the HTML output.
|
||||
# The extension must be `.handlebars`, it will be added when missing.
|
||||
# The `simple.handlebars` template is a built-in template
|
||||
template: 'simple'
|
||||
# [string=''] Board variant to apply
|
||||
variant: ''
|
||||
# Pick & place:
|
||||
# This output is what you get from the 'File/Fabrication output/Footprint position (.pos) file' menu in pcbnew.
|
||||
- name: 'position_example'
|
||||
|
|
|
|||
|
|
@ -855,6 +855,40 @@ deps = '{\
|
|||
"url": null,\
|
||||
"url_down": null\
|
||||
},\
|
||||
"mistune": {\
|
||||
"arch": "python-mistune",\
|
||||
"command": "mistune",\
|
||||
"comments": [],\
|
||||
"deb_package": "python3-mistune",\
|
||||
"downloader": null,\
|
||||
"downloader_str": null,\
|
||||
"extra_arch": null,\
|
||||
"extra_deb": null,\
|
||||
"help_option": "--version",\
|
||||
"importance": 10000,\
|
||||
"in_debian": true,\
|
||||
"is_kicad_plugin": false,\
|
||||
"is_python": true,\
|
||||
"module_name": "mistune",\
|
||||
"name": "mistune",\
|
||||
"no_cmd_line_version": false,\
|
||||
"no_cmd_line_version_old": false,\
|
||||
"output": "populate",\
|
||||
"plugin_dirs": null,\
|
||||
"pypi_name": "mistune",\
|
||||
"roles": [\
|
||||
{\
|
||||
"desc": null,\
|
||||
"mandatory": true,\
|
||||
"max_version": null,\
|
||||
"output": "populate",\
|
||||
"version": null\
|
||||
}\
|
||||
],\
|
||||
"tests": [],\
|
||||
"url": null,\
|
||||
"url_down": null\
|
||||
},\
|
||||
"numpy": {\
|
||||
"arch": "python-numpy",\
|
||||
"command": "numpy",\
|
||||
|
|
|
|||
Loading…
Reference in New Issue