GithubHelp home page GithubHelp logo

mahearn22 / puca Goto Github PK

View Code? Open in Web Editor NEW

This project forked from footfingers/puca

0.0 0.0 0.0 47.45 MB

Information related to the Púca macropad: Build Guide and Case/Plate files

Home Page: https://FFKeebs.com

License: MIT License

puca's Introduction

Púca Build Guide

Contents

  • Required Parts
  • Getting Started
  • OLED
  • ProMicro
  • Reset Switch
  • Testing before continuing
  • Diode
  • OLED
  • Hotswap Sockets

Availability:

Required Parts

Below are a list of all parts for building a Púca Pad. Optional items are listed separately.

Required

Name Quantity
PCB 1
Diodes 23
Hotswap Sockets 19-22
Reset Switch 1
Pro Micro / Elite-C 1
Rotary Encoder 1
Plate Botton 1
Plate Top 1
Acrylic Guard 1
M2 Standoffs 6
M2 Screws 12

Optional

Name Quantity
OLED Module 1
WS2812B LED's 8
Rubber Feet 4

A video guide can be found here:

Vial Firmware

Vial Firmware is available in the Firmware Folder. https://github.com/FootFingers/Puca/tree/main/Firmware

QMK is currently being merged and will be available in QMK Toolbox

Getting Started

Assuming you have all of the required parts listed above, you can start the process of building your Púca.

The PCB is not reversible. The correct layout can be seen below, but is essentially the side with the diodes and the Púca logo on the right.

Testing your Controller

Begin by plugging your ProMicro into your PC / laptop with an appropriate cable. If you haven't already, download the Púca firmware file. Then open QMK Toolbox, select the Púca Firmware file from the dropdown menu and short the reset and ground pads. This should auto-detect in QMK Toolbox, and allow you to click 'flash'. Some output will be displayed on screen, and you will be prompted once complete. Keep in mind that if using a promicro controller, the usb ports are fragile and too much force will break them.

OLED

If you intend on using the supplied OLED display with your Púca, then you will need to bridge four pads. The OLED will not work unless these pads are bridged. These pads are located under the pro-micro, so it is recommended to bridge these first. Apply solder to one side of the pad and then drag across to the other, the finished product should look as follows:

briged oled

Close-up example of briged pads from CRKBD:

Pro Micro / Elite-C / Bit-C

The microctroller also needs to be in the correct orientation, with the components facing down in the case of the supplied ProMicro or optional Elite-C/Bit-C.

We will begin by soldering the microcontroller. We perform this now to ensure that the PCB and controller are functioning correctly, which will also help narrow the cause of any issues that could potentially occur here: most commonly due to incorrect soldering.

First, we will solder the ProMicro in place. This can be made hotswap using either millmax sockets or a ProMicro hotswap socket kit and either pins or diode legs. For this guide, we will assume that you have the Púca base kit, and will use parts available from there. Place the pins into the PCB as seen below:

We will then solder these in place. It is recommended to use a small piece of masking tape to hold the pins in place during this process to ensure it is kept flat.

Next, place your pro-micro / elite-c face down. The orientation here is extremely important for two reasons; Firstly, this provides a lower profile which allow the OLED and acrylic guard to be placed closer to the PCB. Secondly, it just won't work due to the pad placement. Make sure the orientation is correct, with the components facing downward, and the back of the pro-micro PCB visible.

⚠️ WARNING
If using a Bit-C controller you will need to provide a small amount of space between the usb-c port and the board, please refer to the video linked above for steps on this.

It should look like the image below:

Then apply solder to each of the pins poking through the pro-micro. Ensure the solder provides a clean and solid connection, as seen below:

Desoldering a ProMicro is not an experience I would recommend.

solder meme

Reset Switch

Next, we will solder the reset switch in place so that we can flash firmware to the board. The orientation is not important here, as long as it is placed with the button to the top of the board and soldered from beneath. See image below:

Testing before continuing

It is highly recommend to stop at this point and test that everything is working correctly. Desoldering components is not as easy as installing them, and troubleshooting at this stage is far easier than if all components have been installed.

If the above steps complete without issue, then everything is working correctly so far. We will test each stage throughout the build process to identify issues as early as possible.

Diodes

Now we will start with the diodes. These will be on display on the right side of the PCB. The orientation here is important as a diode will only allow current to pass in one direction, placing it in the opposite direction will stop the current from passing from the switch to the ProMicro, and will result in the associated key not working. The PCB has a line on the north edge of the diode which represents the cathode end, this should match the line on the diode. The correct orientation can be seen below:

You can do these individually if you wish, or row-by-row. For the purpose of this guide they will be done row-by-row. Joiners from the original GB will also be supplied with a diode bender to optionally use.

Place the leg of the anode end of the diode into the PCB, and bend 90 degrees to it will sit centrally. An example of this can be seen below:

Now, take note of roughly how far it is before the next bend, remove the diode and bend by hand. Place back into the PCB, and if done correctly, should sit flush against the PCB. An optional step you can take is to tape the diodes into place so they do not move position. If doing this optional step make sure to use kapton tape as it has a much higher heat tolerance than traditional tape, and will not melt under normal conditions:

The diode legs on the back of the PCB can be bent to hold the diode in place, seen below:

Repeat this process for each of the 23 required diodes, ensuring that there is a strong connection and the orientation is correct. Use a pair of flush cutters afterwards to trim the excess diode legs. The finished diodes should look as follows:

If you plan on using the OLED display skip ahead to the section: OLED (Optional). If not, we will test the diodes now.

Carefully plug the ProMicro in and either open Vial or your key tester of choice. Vial will be used for remapping the keys with a GUI later on. Using a pair of tweezers, touch each of the pads on the bottom of the PCB. This will simulate a key press, and if the diode's have been soldered correctly should register on screen for you. If a key does not register here follow the steps in the Troubleshooting section at the end.

OLED (Optional)

This is an optional item, however if you are intending on using the OLED it can be attached now. Place the OLED into position over the ProMicro and solder the four legs into position. If your diode has legs presoldered be aware that this will block your ProMicro, so will need to be removed if you plan on changing the controller. Optionally you can use diode legs instead of the supplied legs which can be bent out of the way in case the ProMicro needs to be changed in future.

We will then test to make sure the OLED is working correctly. Simply plug the Púca in and the OLED should automatically power on, displaying the Púca ghost and layer information. If you did not test the diodes in the previous step, then we will do this now.

Carefully plug the ProMicro in and either open Vial or your key tester of choice. Vial will be used for remapping the keys with a GUI later on. Using a pair of tweezers, touch each of the pads on the bottom of the PCB. This will simulate a key press, and if the diode's have been soldered correctly should register on screen for you. If a key does not register here follow the steps in the Troubleshooting section at the end.

Hotswap Sockets

Púca uses kailh sockets to provide the hotswap feature, and are required for this build. These are to be soldered to the bottom of the PCB, the opposite side of where the ProMicro and diodes are currently sitting. To solder the sockets in place first put a small amount of solder on one of the pads as seen in the example below:

The purpose of this is that we will reflow this connection to hold the socket in place. Next, place the hot-swap socket into the PCB and make sure it is firmly pressed against the PCB, it is important to make sure these are as flat as possible so the switch pins can fit in correctly. Next, reheat the solder that was placed on the pad whilst pressing the hotswap socket against the board with tweezers (this can also be done by hand, but be very careful not to burn yourself). This will cause the solder to flow again, and create a connection with the socket.

Whilst completing this step keep in mind the layout that you wish to achieve and solder sockets appropriately. Add a small amount of more solder onto the other end of the socket pressing against the pad to ensure a proper connection. Repeat this step for the other side so that both ends of the socket now have proper connections, example of how this should look below:

Underglow LED's (Optional)

This is an optional step and is only required if you wish to have underglow lighting on your Púca. To do this, simply solder the eight SMD LED's into their pads, taking note of the orientation of the LED. One of the corners of the LED has a triangle / is tabbed, and should be in the opposite corner to where you see the number one, see image below:

SMD LED Orientation

Again, note the orientation and see that the tabbed corner opposite to the number one. All eight of the LED's are linked in sequence, so if one of them is soldered incorrectly, everything after will also fail to work.

Solder one corner of the pad and place the LED into position, again making sure to use the correct orientation. Reflow the solder while lightly pressing the LED with a pair of tweezers so that it sits flush with the PCB. Continue to solder the other three pins to the pad.

Rotary Encoder

Place the rotary encoder into place. It will only fit in one orientation: the side with two pins facing to the north, and the side with three pins facing to the south. Proceed t osolder these pins and the two clips on either side. See image below:

Finishing up

All that is left is to assemble your newly completed kit. If you intend to use a layout that requires stabilizers, now is the time to screw them in. Next, First put a switch into the north side of the top plate, and another along the south edge. This will then be pushed into the PCB, and will provde support while the rest of your switches are pushed into place. Continue to populate all the slots required for your layout, making sure to check that the switch pins are straight before pushing them in to the PCB.

⚠️ WARNING
When putting switches into the PCB make sure to apply pressure to the kailh socket from the back of the PCB as well. Failure to apply pressure here can cause the force of pushing a switch into the socket to tear the socket and pad off the pcb.

Once the switches are in place now is the time to add the screws and standoffs. First, screw in the two standoffs on the right edge of the PCB, these will be used for supporting the acrlic guard. Next, screw in the four remaining standoffs into the top plate, and then orient the bottom plate so the screw holes line up, before screwing in the base plate.

If you haven't already done so, now is the time to attach the knob to the encoder. Then continue on and peel off the protective layer of acrylic from the guard and screw into place also. Finish up the build with the included rubber bumpons in each of the four corners of your base plate to keep your Puca still and secure on your desk.

Have Fun!

Troubleshooting

Key presses not registering

This can be down to a number of common causes.

  1. Diode is in the wrong orientation
  2. ProMicro does not have a strong soldered connection to the PCB
  3. Switch legs are not sitting in the hotswap socket correctly
  4. Diode is not soldered correctly

Underglow Not Working

The underglow LEDs are chained together, which means that if an LED in the chain is not correctly soldered, LEDs later in the chain also will not function. If you have any LEDs coming in, look through to make sure they each have a strong connection, if you have no LEDs turning on at all, it may be related to the first LED in the chain, located directly underneath the controller.

Check each of the above to troubleshoot and identify the issue.

puca's People

Contributors

footfingers 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.