Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Label 4 for rotated keys #10

Open
ludvigStrom opened this issue Oct 5, 2023 · 1 comment
Open

Label 4 for rotated keys #10

ludvigStrom opened this issue Oct 5, 2023 · 1 comment

Comments

@ludvigStrom
Copy link

I am currently using the kicad-kle-placer plugin for KiCad 7.0 and have encountered some difficulties and confusion regarding the use of “Label 4” for rotated keys, as mentioned in the documentation.

Issue Description:
I am working with a keyboard layout where all keys are rotated, and I understand that I need to use “Label 4” for these rotated keys. However, the term “Label 4” is not clearly defined or explained in the documentation, leading to confusion and challenges in using the plugin effectively.

Specific Points of Confusion:
Definition of “Label 4”: The term “Label 4” is not clear to me. I am unsure whether it refers to a specific field in the KiCad Symbol Fields table, a position in the KLE JSON output, or something else.
Location of “Label 4”: If “Label 4” refers to a position in the KLE JSON, could you please clarify which position or field this corresponds to? The JSON output has various fields and positions, and it’s not evident which one is “Label 4”.
Usage of “Label 4”: Could you provide detailed instructions or examples of how to use “Label 4” correctly for rotated keys? Step-by-step guidance would be greatly appreciated.

Steps Taken:
I have assigned legends to keys in KLE and exported the JSON output.
I have attempted to use the first legend (top-left) as the reference number for each key (e.g., '1' for SW1), but this approach does not seem to work.
I have reviewed the plugin’s Python script but did not find clarification on “Label 4”.
I have created a new field in KiCads "Symbol fields table" and added id 1 for SW1 etc.
I Have renamed that field to label4 instead of field 4

Request for Assistance:
Could you please provide clear definitions and explanations for “Label 4”?
Could you offer detailed instructions or examples on how to use “Label 4” for rotated keys?
If possible, consider updating the documentation to include this information for the benefit of all users.

@zykrah
Copy link
Owner

zykrah commented Oct 5, 2023

Hi there, the label numbers are as i describe here: https://github.com/zykrah/firmware-scripts. There is an example of where the number should go in the readme on this repo too, on the screenshots of the KLE rotated key examples.

However, i admit the wording is less clear. I'll update it soon. Thanks for the heads up

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants