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

Updated the docs and example

This commit is contained in:
Salvador E. Tropea 2021-11-19 10:58:28 -03:00
parent 67427d9eff
commit 98bb4b0cfb
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -1413,6 +1413,8 @@ Next time you need this list just use an alias, like this:
- `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted. - `dnf_filter`: [string|list(string)=''] Name of the filter to mark components as not fitted.
A short-cut to use for simple cases where a variant is an overkill. A short-cut to use for simple cases where a variant is an overkill.
- `download`: [boolean=true] Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD. - `download`: [boolean=true] Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD.
- `height`: [number=720] Image height (aprox.).
- `id_add`: [string=''] Text to add to the %i expansion content. To differentiate variations of this output.
- `kicad_3d_url`: [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models. - `kicad_3d_url`: [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models.
- `move_x`: [number=0] Steps to move in the X axis, positive is to the right. - `move_x`: [number=0] Steps to move in the X axis, positive is to the right.
Just like pressing the right arrow in the 3D viewer. Just like pressing the right arrow in the 3D viewer.
@ -1421,6 +1423,7 @@ Next time you need this list just use an alias, like this:
- `no_smd`: [boolean=false] Used to exclude 3D models for surface mount components. - `no_smd`: [boolean=false] Used to exclude 3D models for surface mount components.
- `no_tht`: [boolean=false] Used to exclude 3D models for through hole components. - `no_tht`: [boolean=false] Used to exclude 3D models for through hole components.
- `no_virtual`: [boolean=false] Used to exclude 3D models for components with 'virtual' attribute. - `no_virtual`: [boolean=false] Used to exclude 3D models for components with 'virtual' attribute.
- `orthographic`: [boolean=false] Enable the orthographic projection mode (top view looks flat).
- `output`: [string='%f-%i%v.%x'] Name for the generated image file (%i='3D_$VIEW' %x='png'). Affected by global options. - `output`: [string='%f-%i%v.%x'] Name for the generated image file (%i='3D_$VIEW' %x='png'). Affected by global options.
- `ray_tracing`: [boolean=false] Enable the ray tracing. Much better result, but slow, and you'll need to adjust `wait_rt`. - `ray_tracing`: [boolean=false] Enable the ray tracing. Much better result, but slow, and you'll need to adjust `wait_rt`.
- `silk`: [string='#E5E5E5'] Color for the silk screen. - `silk`: [string='#E5E5E5'] Color for the silk screen.
@ -1430,6 +1433,7 @@ Next time you need this list just use an alias, like this:
- `view`: [string='top'] [top,bottom,front,rear,right,left,z,Z,y,Y,x,X] Point of view. - `view`: [string='top'] [top,bottom,front,rear,right,left,z,Z,y,Y,x,X] Point of view.
- `wait_ray_tracing`: [number=5] How many seconds we must wait before capturing the ray tracing render. - `wait_ray_tracing`: [number=5] How many seconds we must wait before capturing the ray tracing render.
Lamentably KiCad can save an unfinished image. Enlarge it if your image looks partially rendered. Lamentably KiCad can save an unfinished image. Enlarge it if your image looks partially rendered.
- `width`: [number=1280] Image width (aprox.).
- `zoom`: [number=0] Zoom steps. Use positive to enlarge, get closer, and negative to reduce. - `zoom`: [number=0] Zoom steps. Use positive to enlarge, get closer, and negative to reduce.
Same result as using the mouse wheel in the 3D viewer. Same result as using the mouse wheel in the 3D viewer.

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

@ -1040,6 +1040,10 @@ outputs:
dnf_filter: '' dnf_filter: ''
# [boolean=true] Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD # [boolean=true] Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD
download: true download: true
# [number=720] Image height (aprox.)
height: 720
# [string=''] Text to add to the %i expansion content. To differentiate variations of this output
id_add: ''
# [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models # [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models
kicad_3d_url: 'https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/' kicad_3d_url: 'https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'
# [number=0] Steps to move in the X axis, positive is to the right. # [number=0] Steps to move in the X axis, positive is to the right.
@ -1054,6 +1058,8 @@ outputs:
no_tht: false no_tht: false
# [boolean=false] Used to exclude 3D models for components with 'virtual' attribute # [boolean=false] Used to exclude 3D models for components with 'virtual' attribute
no_virtual: false no_virtual: false
# [boolean=false] Enable the orthographic projection mode (top view looks flat)
orthographic: false
# [string='%f-%i%v.%x'] Name for the generated image file (%i='3D_$VIEW' %x='png'). Affected by global options # [string='%f-%i%v.%x'] Name for the generated image file (%i='3D_$VIEW' %x='png'). Affected by global options
output: '%f-%i%v.%x' output: '%f-%i%v.%x'
# [boolean=false] Enable the ray tracing. Much better result, but slow, and you'll need to adjust `wait_rt` # [boolean=false] Enable the ray tracing. Much better result, but slow, and you'll need to adjust `wait_rt`
@ -1071,6 +1077,8 @@ outputs:
# [number=5] How many seconds we must wait before capturing the ray tracing render. # [number=5] How many seconds we must wait before capturing the ray tracing render.
# Lamentably KiCad can save an unfinished image. Enlarge it if your image looks partially rendered # Lamentably KiCad can save an unfinished image. Enlarge it if your image looks partially rendered
wait_ray_tracing: 5 wait_ray_tracing: 5
# [number=1280] Image width (aprox.)
width: 1280
# [number=0] Zoom steps. Use positive to enlarge, get closer, and negative to reduce. # [number=0] Zoom steps. Use positive to enlarge, get closer, and negative to reduce.
# Same result as using the mouse wheel in the 3D viewer # Same result as using the mouse wheel in the 3D viewer
zoom: 0 zoom: 0