From 7e2a635ae12d8b8ae2f4682075be4afcecd2a0d2 Mon Sep 17 00:00:00 2001 From: easyw Date: Sun, 23 Feb 2020 18:39:09 +0100 Subject: [PATCH] better ReadMe file --- FabricationPositions/fabrication_positions.py | 2 +- PcbToDxf/action_menu_pcb2dxf.py | 2 +- README.md | 63 ++++++------------- Snap2Grid/snap2grid.py | 4 +- 4 files changed, 24 insertions(+), 47 deletions(-) diff --git a/FabricationPositions/fabrication_positions.py b/FabricationPositions/fabrication_positions.py index cc901f4..98c1eb3 100644 --- a/FabricationPositions/fabrication_positions.py +++ b/FabricationPositions/fabrication_positions.py @@ -319,7 +319,7 @@ class generatePOS( pcbnew.ActionPlugin ): self.description should be a comprehensive description of the plugin """ - self.name = "Fabrication Position output \nversion "+___version___ + self.name = "Fabrication Footprint Position \nversion "+___version___ self.category = "Fabrication Output" self.description = "Generate POS output for SMD, THD, Virtual\nand Board Statistics" #self.SetIcon(PyEmbeddedImage(getPos_ico_b64_data).GetIcon()) diff --git a/PcbToDxf/action_menu_pcb2dxf.py b/PcbToDxf/action_menu_pcb2dxf.py index 84caf88..035b260 100644 --- a/PcbToDxf/action_menu_pcb2dxf.py +++ b/PcbToDxf/action_menu_pcb2dxf.py @@ -227,7 +227,7 @@ class pcb2dxf( pcbnew.ActionPlugin ): self.description should be a comprehensive description of the plugin """ - self.name = "export technical layers of pcb to DXF \nversion "+___version___ + self.name = "Export pcb technical layers to DXF \nversion "+___version___ self.category = "export PCB" self.description = "export technical layers of pcb to DXF (saved board)" self.show_toolbar_button = True diff --git a/README.md b/README.md index 0047321..0c1181b 100644 --- a/README.md +++ b/README.md @@ -5,41 +5,31 @@ Check your kicad_pcb for annular ring violations: PTH Plated Trough Hole, NPTH Non Plated Trough Hole Pads and Vias -- ### action_menu_pcb2dxf -A script to export technical layers of kicad PCB to DXF -DXF generated file has single line draw as it should be for mechanical interchange (this option is missing in pcbnew plot) - -- ### action_menu_move_to_layer -A script to Move Selected Drawing(s) to chosen new Layer (available only in GAL) +- ### Snap Selected Footprint(s) to Grid +Tool to move the selected footprint module(s) to the Grid. +The Modules can be easily aligned to GridOrigin or to Auxiliary Origin. -- ### action_positions -A script to Generate Position Files for SMD, THD, Virtual, ALL - +- ### Fabrication Footprint Position +Tool for the creation of the necessary files for the production of the printed circuit board. +Generate Position Files for SMD, THD, Virtual and ALL components, referred to Auxiliary Origin. + +- ### Move Selected Drawings to chosen Layer +Tool to Move Selected Drawing(s) to the chosen new Layer. + +- ### Export pcb technical layers to DXF +Tool to export technical layers of kicad PCB to DXF. +The DXF generated file has single line draw and different layers for each pcb technical layer. + --- -## action_menu_annular_check.py -A script to check for annular ring violations -for PTH, NPTH pads and vias - -requirements: KiCAD pcbnew > 4.0 built with KICAD_SCRIPTING_ACTION_MENU option activated -release "1.5.3" - -'action_menu_annular_check.py' checking PCB for Annular Ring in PTH, NPTH and Vias -(SMD, Connector and NPTH are skipped) -default Annular Ring >= 0.125 both for TH Pads and Vias -to change values modify: - - AR_SET = 0.150 #minimum annular accepted for pads - AR_SET_V = 0.150 #minimum annular accepted for vias - DRL_EXTRA = 0.100 #extra drill margin size for production +## Annular Ring Checker +Check your kicad_pcb for annular ring violations: +PTH Plated Trough Hole, NPTH Non Plated Trough Hole Pads and Vias Launch the Annular Check script in pcbnew from Tools menu: ![Annular Check](screenshots/annular-checker.gif) -### todo (annular_check) -- [ ] add colors to output list - --- -## action_menu_pcb2dxf +## Export pcb technical layers to DXF **kicadpcb2dxf** _dxf exporter for mechanical layers of a kicad_pcb board_ - "Dwgs", "Cmts", "Edge", "Eco1", "Eco2", "F.Fab", "B.Fab", "F.CrtYd", "B.CrtYd" @@ -61,13 +51,10 @@ done: - [x] added text support (mirror & alignement not supported) - [x] added multiline text - [x] add quote support - -### todo (kicadpcb2dxf) -- [ ] tbd --- -## action_menu_move_to_layer -A script to Move Selected Drawing(s) to chosen new Layer (available only in GAL) +## Move Selected Drawings to chosen Layer +Tool to Move Selected Drawing(s) to chosen new Layer requirements: KiCAD pcbnew > 4.0 built with KICAD_SCRIPTING_ACTION_MENU option activated release "1.1.0" @@ -82,13 +69,3 @@ release "1.1.0" Launch the 'Move Selected drawings to chosen Layer' script in pcbnew from Tools menu ![Move Selected drawings to chosen Layer](screenshots/move_to_layer.png) - -- ### action_positions -A script to Generate Position Files for SMD, THD, Virtual, ALL - -The script will generate Fabrication POS files for: - -- SMD -- THD -- VIRTUAL -- ALL diff --git a/Snap2Grid/snap2grid.py b/Snap2Grid/snap2grid.py index 2de96bd..9c68e7d 100644 --- a/Snap2Grid/snap2grid.py +++ b/Snap2Grid/snap2grid.py @@ -83,9 +83,9 @@ class snap_to_grid( pcbnew.ActionPlugin ): self.description should be a comprehensive description of the plugin """ - self.name = "Snap Selected Modules to Grid \nversion "+__version__ + self.name = "Snap Selected Footprint(s) to Grid \nversion "+__version__ self.category = "Modify PCB" - self.description = "Automaticaly Snap Selected Module(s) to Grid on an existing PCB" + self.description = "Automaticaly Snap Selected Footprint Module(s) to Grid on an existing PCB" #self.pcbnew_icon_support = hasattr(self, "show_toolbar_button") self.show_toolbar_button = True self.icon_file_name = os.path.join(os.path.dirname(__file__), './snap2grid.png')