From 02f8bc5ca5130155058dbbb8e7462d8cd1b525bd Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Fri, 22 Mar 2024 08:33:00 -0300 Subject: [PATCH] [DOCs][Added] A note about using bom instead of position See #593 --- docs/samples/generic_plot.kibot.yaml | 1 + docs/source/configuration/outputs/position.rst | 3 ++- kibot/out_position.py | 3 ++- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index bb6e5b014..13dfcbe01 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -2887,6 +2887,7 @@ outputs: variant: '' # Pick & place: # This output is what you get from the 'File/Fabrication output/Footprint position (.pos) file' menu in pcbnew. + # Note that if you need a more customized output you can use the *bom* output, which can include positions. - name: 'position_example' comment: 'Generates the file with position information for the PCB components, used by the pick and place machine.' type: 'position' diff --git a/docs/source/configuration/outputs/position.rst b/docs/source/configuration/outputs/position.rst index 7c41a97d4..9bfcbf2f2 100644 --- a/docs/source/configuration/outputs/position.rst +++ b/docs/source/configuration/outputs/position.rst @@ -7,7 +7,8 @@ Pick & place ~~~~~~~~~~~~ Generates the file with position information for the PCB components, used by the pick and place machine. -This output is what you get from the 'File/Fabrication output/Footprint position (.pos) file' menu in pcbnew. +This output is what you get from the 'File/Fabrication output/Footprint position (.pos) file' menu in pcbnew. |br| +Note that if you need a more customized output you can use the *bom* output, which can include positions. |br| Type: ``position`` diff --git a/kibot/out_position.py b/kibot/out_position.py index 0d0263e1e..faf929545 100644 --- a/kibot/out_position.py +++ b/kibot/out_position.py @@ -351,7 +351,8 @@ def run(self, fname): class Position(BaseOutput): # noqa: F821 """ Pick & place Generates the file with position information for the PCB components, used by the pick and place machine. - This output is what you get from the 'File/Fabrication output/Footprint position (.pos) file' menu in pcbnew. """ + This output is what you get from the 'File/Fabrication output/Footprint position (.pos) file' menu in pcbnew. + Note that if you need a more customized output you can use the *bom* output, which can include positions. """ def __init__(self): super().__init__() with document: