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

[Rotation Filter][DOCs] Documented how angles and offsets are interpreted

This commit is contained in:
Salvador E. Tropea 2023-11-17 08:10:55 -03:00
parent 556ea9fe8d
commit e49f6702ff
2 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/configuration/sup_filters.rst
View File

@ -129,6 +129,8 @@ Supported filters
Note that the computation for bottom rotations is wrong, forcing the user to uses arbitrary rotations. Note that the computation for bottom rotations is wrong, forcing the user to uses arbitrary rotations.
The correct computation is `(180 - component rot) + angle` but the plugin does `180 - (component rot + angle)`. The correct computation is `(180 - component rot) + angle` but the plugin does `180 - (component rot + angle)`.
This option forces the wrong computation for compatibility. This option forces the wrong computation for compatibility.
This option also controls the way offset signs are interpreted. When enabled the offsets matches this plugin,
when disabled matches the interpretation used by the matthewlai/JLCKicadTools plugin.
- ``comment`` :index:`: <pair: filter - rot_footprint; comment>` [string=''] A comment for documentation purposes. - ``comment`` :index:`: <pair: filter - rot_footprint; comment>` [string=''] A comment for documentation purposes.
- ``extend`` :index:`: <pair: filter - rot_footprint; extend>` [boolean=true] Extends the internal list of rotations with the one provided. - ``extend`` :index:`: <pair: filter - rot_footprint; extend>` [boolean=true] Extends the internal list of rotations with the one provided.
Otherwise just use the provided list. Otherwise just use the provided list.
@ -143,15 +145,17 @@ Supported filters
This concept is from the bennymeg/JLC-Plugin-for-KiCad tool. This concept is from the bennymeg/JLC-Plugin-for-KiCad tool.
- ``offsets`` :index:`: <pair: filter - rot_footprint; offsets>` [list(list(string))] A list of pairs regular expression/offset. - ``offsets`` :index:`: <pair: filter - rot_footprint; offsets>` [list(list(string))] A list of pairs regular expression/offset.
Components matching the regular expression will be moved the specified offset. Footprints matching the regular expression will be moved the specified offset.
The offset must be two numbers separated by a comma. The first is the X offset. The offset must be two numbers separated by a comma. The first is the X offset.
The signs matches the matthewlai/JLCKicadTools plugin specs.
- ``rot_fields`` :index:`: <pair: filter - rot_footprint; rot_fields>` [string|list(string)='JLCPCB Rotation Offset,JLCRotOffset'] List of fields that can contain a rotation offset. - ``rot_fields`` :index:`: <pair: filter - rot_footprint; rot_fields>` [string|list(string)='JLCPCB Rotation Offset,JLCRotOffset'] List of fields that can contain a rotation offset.
The optional fields can contain a counter-clockwise orientation offset in degrees. The optional fields can contain a counter-clockwise orientation offset in degrees.
This concept is from the bennymeg/JLC-Plugin-for-KiCad tool. This concept is from the bennymeg/JLC-Plugin-for-KiCad tool.
- ``rotations`` :index:`: <pair: filter - rot_footprint; rotations>` [list(list(string))] A list of pairs regular expression/rotation. - ``rotations`` :index:`: <pair: filter - rot_footprint; rotations>` [list(list(string))] A list of pairs regular expression/rotation.
Components matching the regular expression will be rotated the indicated angle. Footprints matching the regular expression will be rotated the indicated angle.
The angle matches the matthewlai/JLCKicadTools plugin specs.
- ``skip_bottom`` :index:`: <pair: filter - rot_footprint; skip_bottom>` [boolean=false] Do not rotate components on the bottom. - ``skip_bottom`` :index:`: <pair: filter - rot_footprint; skip_bottom>` [boolean=false] Do not rotate components on the bottom.
- ``skip_top`` :index:`: <pair: filter - rot_footprint; skip_top>` [boolean=false] Do not rotate components on the top. - ``skip_top`` :index:`: <pair: filter - rot_footprint; skip_top>` [boolean=false] Do not rotate components on the top.

14
kibot/fil_rot_footprint.py
View File

@ -123,11 +123,13 @@ class Rot_Footprint(BaseFilter): # noqa: F821
the adjust so you get `(180 - component rot + angle)`. This is used by JLCPCB """ the adjust so you get `(180 - component rot + angle)`. This is used by JLCPCB """
self.rotations = Optionable self.rotations = Optionable
""" [list(list(string))] A list of pairs regular expression/rotation. """ [list(list(string))] A list of pairs regular expression/rotation.
Components matching the regular expression will be rotated the indicated angle """ Footprints matching the regular expression will be rotated the indicated angle.
The angle matches the matthewlai/JLCKicadTools plugin specs """
self.offsets = Optionable self.offsets = Optionable
""" [list(list(string))] A list of pairs regular expression/offset. """ [list(list(string))] A list of pairs regular expression/offset.
Components matching the regular expression will be moved the specified offset. Footprints matching the regular expression will be moved the specified offset.
The offset must be two numbers separated by a comma. The first is the X offset """ The offset must be two numbers separated by a comma. The first is the X offset.
The signs matches the matthewlai/JLCKicadTools plugin specs """
self.skip_bottom = False self.skip_bottom = False
""" Do not rotate components on the bottom """ """ Do not rotate components on the bottom """
self.skip_top = False self.skip_top = False
@ -144,7 +146,9 @@ class Rot_Footprint(BaseFilter): # noqa: F821
""" Implements the `rot_fields` and `offset_fields` in the same way that the bennymeg/JLC-Plugin-for-KiCad tool. """ Implements the `rot_fields` and `offset_fields` in the same way that the bennymeg/JLC-Plugin-for-KiCad tool.
Note that the computation for bottom rotations is wrong, forcing the user to uses arbitrary rotations. Note that the computation for bottom rotations is wrong, forcing the user to uses arbitrary rotations.
The correct computation is `(180 - component rot) + angle` but the plugin does `180 - (component rot + angle)`. The correct computation is `(180 - component rot) + angle` but the plugin does `180 - (component rot + angle)`.
This option forces the wrong computation for compatibility """ This option forces the wrong computation for compatibility.
This option also controls the way offset signs are interpreted. When enabled the offsets matches this plugin,
when disabled matches the interpretation used by the matthewlai/JLCKicadTools plugin """
def config(self, parent): def config(self, parent):
super().config(parent) super().config(parent)
@ -244,6 +248,7 @@ class Rot_Footprint(BaseFilter): # noqa: F821
rcos = cos(rotation) rcos = cos(rotation)
comp.pos_offset_x = pos_offset_x * rcos - pos_offset_y * rsin comp.pos_offset_x = pos_offset_x * rcos - pos_offset_y * rsin
comp.pos_offset_y = pos_offset_x * rsin + pos_offset_y * rcos comp.pos_offset_y = pos_offset_x * rsin + pos_offset_y * rcos
# The signs here matches matthewlai/JLCKicadTools offsets because the database comes from this plugin
comp.pos_offset_x = -GS.from_mm(comp.pos_offset_x) comp.pos_offset_x = -GS.from_mm(comp.pos_offset_x)
comp.pos_offset_y = GS.from_mm(comp.pos_offset_y) comp.pos_offset_y = GS.from_mm(comp.pos_offset_y)
# logger.error(f"{comp.ref} Ang: {angle} DB offset: {pos_offset_x},{pos_offset_y} " # logger.error(f"{comp.ref} Ang: {angle} DB offset: {pos_offset_x},{pos_offset_y} "
@ -260,6 +265,7 @@ class Rot_Footprint(BaseFilter): # noqa: F821
logger.warning(f'{W_BADOFFSET}Wrong offset `{value}` in {f} field of {comp.ref}') logger.warning(f'{W_BADOFFSET}Wrong offset `{value}` in {f} field of {comp.ref}')
return False return False
if self.bennymeg_mode: if self.bennymeg_mode:
# Signs here matches bennymeg/JLC-Plugin-for-KiCad because the fields usage comes from it
pos_offset_x = -pos_offset_x pos_offset_x = -pos_offset_x
pos_offset_y = -pos_offset_y pos_offset_y = -pos_offset_y
self.apply_offset_value(comp, comp.offset_footprint_rot, pos_offset_x, pos_offset_y) self.apply_offset_value(comp, comp.offset_footprint_rot, pos_offset_x, pos_offset_y)