Code Monkey home page Code Monkey logo

keyboard-layouter's Introduction

Keyboard Layouter Plugin

MIT License

Keyboard Layouter is a plugin for KiCad(pcbnew). This plugin places switch footprints in the location specified by JSON of Keyboard Layout Editor.

I have confirmed that it works with pcbnew version (5.1.0)-1 release build on Windows.

demo

Install

Download keyboard_layouter.py and put it to the following directory:

  • Windows: %APPDATA%/Roaming/kicad/scripting/plugins
  • macOS: ~/Library/Application Support/kicad/scripting/plugins or ~/Library/Preferences/kicad/scripting/plugins
  • Linux: ~/.kicad/scripting/plugins or ~/.kicad_plugins

Usage

Preparation

Make keyboard layout at Keyboard Layout Editor. Top left legend should be the reference number of the switch footprint. And download JSON file.

keyboard-layout-editor

I have created keyboard-layouter-playground so that you can quickly try the Keyboard Layouter plugin. This repository has sample-json and sample netlist.

Execution

Open Pcbnew and choose "Tools" -> "External plugins" -> "Keyboard Layouter".

pcbnew

keyboard-layouter

Select your JSON file and push "Run" button.

Limitation

Supported switch footprints are Cherry MX in kicad-footprints/Button_Switch_Keyboard.pretty only. Therefore, the size of switch that can be used is limited to the following.

  • 1.00u (1 x 1)
  • 1.25u (1.25 x 1)
  • 1.50u (1.5 x 1)
  • 1.75u (1.75 x 1)
  • 2.00u (2 x 1, 1 x 2)
  • 2.25u (2.25 x 1)
  • 2.75u (2.75 x 1)
  • 6.25u (6.25 x 1)
  • ISO Enter

License

This software is released under the MIT License, see LICENSE.

keyboard-layouter's People

Contributors

yskoht avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.