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

[DOCs] Added warning about PcbDraw and complex PCBs 

- Also added credits for some 3D models we use

Related to #369
This commit is contained in:
Salvador E. Tropea 2023-01-16 17:25:19 -03:00
parent b8529e7b6f
commit 9ba56adf39
3 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -3422,7 +3422,11 @@ Notes:
* Type: `pcbdraw` * Type: `pcbdraw`
* Description: Exports the PCB as a 2D model (SVG, PNG or JPG). * Description: Exports the PCB as a 2D model (SVG, PNG or JPG).
Uses configurable colors. Uses configurable colors.
Can also render the components if the 2D models are available Can also render the components if the 2D models are available.
Note that this output is fast for simple PCBs, but becomes useless for huge ones.
You can easily create very complex PCBs using the `panelize` output.
In this case you can use other outputs, like `render_3d`, which are slow for small
PCBs but can handle big ones
* Valid keys: * Valid keys:
- **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output. - **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
- **`dir`**: [string='./'] Output directory for the generated files. - **`dir`**: [string='./'] Output directory for the generated files.
@ -5837,3 +5841,5 @@ This case is [discussed here](docs/1_SCH_2_part_PCBs)
- **PTV09A 3D Model**: Dmitry Levin ([GrabCad](https://grabcad.com/dmitry.levin-6)) - **PTV09A 3D Model**: Dmitry Levin ([GrabCad](https://grabcad.com/dmitry.levin-6))
- **PcbDraw PCB example**: [Arduino Learning Kit Starter](https://github.com/RoboticsBrno/ArduinoLearningKitStarter) - **PcbDraw PCB example**: [Arduino Learning Kit Starter](https://github.com/RoboticsBrno/ArduinoLearningKitStarter)
- **Battery charger example**: [RB0002-BatteryPack](https://cadlab.io/project/22740/master/files) - **Battery charger example**: [RB0002-BatteryPack](https://cadlab.io/project/22740/master/files)
- **IT-1187A 3D Model**: Anton Pavlov ([GrabCad](https://grabcad.com/anton.pavlov-2))
- **105017-0001 3D Model**: M.B.I. ([GrabCad](https://grabcad.com/m.b.i-1))

2
docs/README.in
View File

@ -2138,3 +2138,5 @@ This case is [discussed here](docs/1_SCH_2_part_PCBs)
- **PTV09A 3D Model**: Dmitry Levin ([GrabCad](https://grabcad.com/dmitry.levin-6)) - **PTV09A 3D Model**: Dmitry Levin ([GrabCad](https://grabcad.com/dmitry.levin-6))
- **PcbDraw PCB example**: [Arduino Learning Kit Starter](https://github.com/RoboticsBrno/ArduinoLearningKitStarter) - **PcbDraw PCB example**: [Arduino Learning Kit Starter](https://github.com/RoboticsBrno/ArduinoLearningKitStarter)
- **Battery charger example**: [RB0002-BatteryPack](https://cadlab.io/project/22740/master/files) - **Battery charger example**: [RB0002-BatteryPack](https://cadlab.io/project/22740/master/files)
- **IT-1187A 3D Model**: Anton Pavlov ([GrabCad](https://grabcad.com/anton.pavlov-2))
- **105017-0001 3D Model**: M.B.I. ([GrabCad](https://grabcad.com/m.b.i-1))

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

@ -2149,7 +2149,11 @@ outputs:
variant: '' variant: ''
# PcbDraw - Beautiful 2D PCB render: # PcbDraw - Beautiful 2D PCB render:
# Uses configurable colors. # Uses configurable colors.
# Can also render the components if the 2D models are available # Can also render the components if the 2D models are available.
# Note that this output is fast for simple PCBs, but becomes useless for huge ones.
# You can easily create very complex PCBs using the `panelize` output.
# In this case you can use other outputs, like `render_3d`, which are slow for small
# PCBs but can handle big ones
- name: 'pcbdraw_example' - name: 'pcbdraw_example'
comment: 'Exports the PCB as a 2D model (SVG, PNG or JPG).' comment: 'Exports the PCB as a 2D model (SVG, PNG or JPG).'
type: 'pcbdraw' type: 'pcbdraw'