templates
/
KiBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated docs (KiCad version for *_replace preflights)

This commit is contained in:
Salvador E. Tropea 2022-03-13 15:58:06 -03:00
parent 342fb40c59
commit dd210162b7
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -129,6 +129,7 @@ This section is used to specify tasks that will be executed before generating an
- *regexp*: Alias for regex. - *regexp*: Alias for regex.
- `ignore_unconnected`: [boolean=false] Option for `run_drc`. Ignores the unconnected nets. Useful if you didn't finish the routing. - `ignore_unconnected`: [boolean=false] Option for `run_drc`. Ignores the unconnected nets. Useful if you didn't finish the routing.
- `pcb_replace`: [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date. - `pcb_replace`: [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date.
This is useful for KiCad 5, use `set_text_variables` when using KiCad 6.
This pre-flight modifies the PCB. Even when a back-up is done use it carefully. This pre-flight modifies the PCB. Even when a back-up is done use it carefully.
* Valid keys: * Valid keys:
- `date_command`: [string=''] Command to get the date to use in the PCB.\ - `date_command`: [string=''] Command to get the date to use in the PCB.\
@ -153,6 +154,7 @@ This section is used to specify tasks that will be executed before generating an
- `run_erc`: [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct. - `run_erc`: [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct.
The report file name is controlled by the global output pattern (%i=erc %x=txt). The report file name is controlled by the global output pattern (%i=erc %x=txt).
- `sch_replace`: [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date. - `sch_replace`: [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date.
This is useful for KiCad 5, use `set_text_variables` when using KiCad 6.
This pre-flight modifies the schematics. Even when a back-up is done use it carefully. This pre-flight modifies the schematics. Even when a back-up is done use it carefully.
* Valid keys: * Valid keys:
- `date_command`: [string=''] Command to get the date to use in the SCH.\ - `date_command`: [string=''] Command to get the date to use in the SCH.\

2
docs/samples/generic_plot.kibot.yaml
View File

@ -37,6 +37,7 @@ preflight:
# [boolean=false] Option for `run_drc`. Ignores the unconnected nets. Useful if you didn't finish the routing. # [boolean=false] Option for `run_drc`. Ignores the unconnected nets. Useful if you didn't finish the routing.
ignore_unconnected: false ignore_unconnected: false
# [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date. # [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date.
# This is useful for KiCad 5, use `set_text_variables` when using KiCad 6.
# This pre-flight modifies the PCB. Even when a back-up is done use it carefully. # This pre-flight modifies the PCB. Even when a back-up is done use it carefully.
pcb_replace: pcb_replace:
date_command: "git log -1 --format='%as' -- $KIBOT_PCB_NAME" date_command: "git log -1 --format='%as' -- $KIBOT_PCB_NAME"
@ -52,6 +53,7 @@ preflight:
# The report file name is controlled by the global output pattern (%i=erc %x=txt). # The report file name is controlled by the global output pattern (%i=erc %x=txt).
run_erc: true run_erc: true
# [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date. # [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date.
# This is useful for KiCad 5, use `set_text_variables` when using KiCad 6.
# This pre-flight modifies the schematics. Even when a back-up is done use it carefully. # This pre-flight modifies the schematics. Even when a back-up is done use it carefully.
sch_replace: sch_replace:
date_command: "git log -1 --format='%as' -- $KIBOT_SCH_NAME" date_command: "git log -1 --format='%as' -- $KIBOT_SCH_NAME"