Skip to content

Latest commit

 

History

History

sugarglider

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

Sugar Glider Build Guide

Colstag + Touchpad + Thumb Clusters + OLED + Knobs

It can do almost anything you can think of between touchpad and steno.

Finished Build

Table of Contents

These tools and components are required to complete the project and are not included in the kit. The linked names of the components will generally link to a place where you can buy them.

These tools are not necessary to complete the build, but might make the process a little easier for you or help you correct mistakes if you make them.

  • Through-Hole leg bender forming tool
  • Solder Sucker
  • Solder Wick
  • Switch Puller

Note: You might have extras of some components. This is normal and is to account for small mistakes.

The Big Stuff

  • PCB

PCB

  • Bottom

Bottom

  • Plates

Plates

Components

  • BlackPill

BlackPill

  • Diodes (60)

Diodes (60)

  • 10KOhm Resistor

10KOhm Resistor

  • 220 Ohm Resistor

220 Ohm Resistor

  • LEDs

LEDs

  • OLED

OLED

  • GPIO Expander and IC Socket

GPIO Expander and IC Socket

  • Acrylic Mounting Rings

Acrylic Mounting Rings

  • Nugget and Touchpad pack

Nugget and Touchpad pack

  • Encoders

Encoders

  • Knob

Knob

  • Buttons

Buttons

Assembly Hardware

  • 12x M2 12mm standoffs

M2 12mm standoffs

  • 4x M2 3mm male female standoffs

M2 3mm male female standoffs

  • 4x M2 6mm screws

M2 6mm screws

  • 20x M2 4mm screws

M2 4mm screws

  • 8x Rubber bumpons (feet)

Rubber bumpons

Firmware is on our firmware repo, available here: https://github.com/MechWild/mw_firmware/releases

All BlackPills that we sell are tested and preflashed with a modified version of either the BBS firmware or OBE firmware. This is just so that you can plug it in and test to make sure it is connected to your computer correctly and then flash it before building the rest of the board. By default, the blue light on the front of the black pill will be connected to the Num Lock status indicator for your computer. Plug in the black pill, and toggle Num Lock with another keyboard to see if the light responds accordingly. All BlackPills that we sell are tested and preflashed with a modified version of either the BBS firmware or OBE firmware. This is just so that you can plug it in and test to make sure it is connected to your computer correctly and then flash it before building the rest of the board. By default, the blue light on the front of the black pill will be connected to the Num Lock status indicator for your computer. Plug in the black pill, and toggle Num Lock with another keyboard to see if the light responds accordingly.

Next, we will try and put it into bootloader mode. To do this, hold the button labeled “Boot0” on the top of the Blackpill, and while you are still holding that button, tap and release the “NRST” button. Then after a second or two, release the “Boot0” button. If nothing happens in QMK toolbox or if it still is responding when you push the Num Lock, then you should try again, because it didn’t go into bootloader mode.

Now we will try and flash the Blackpill using QMK toolbox (or your tool of choice.) Grab the appropriate firmware from the link at the beginning of this step, download it, select it in QMK Toolbox, put the BlackPill in bootloader mode then click flash.

Step 1: OLED Headers

For the first step, you are going to solder the OLED headers to the top of the PCB (the top of the PCB does not have an outline around where the BlackPill sits.) We are doing this because it makes it easier to attach the OLED later on once the other parts are in place.

An easy but time consuming step. The direction of each diode matters and the black line on the diode should match up with the black line (or white line on black PCBs) on the silkscreen on the PCB. Make sure each diode is on the bottom of the PCB.

Step 2: Diodes

Solder them in place, clip the excess legs with your flush cutters, then flip it back to the front of the board and admire your handiwork.

Put the buttons in the place marked for them on the top of the PCB. Flip the board, and solder them into place. The legs of the buttons go out the left and right side, so make sure they are oriented to go in that way.

Step 3: Buttons

You will have 3 220 Ohm resistors in your kit. They are marked with RED-RED-BLACK-BLACK-BROWN as the band colors. The direction they face doesn't matter and they go in positions R1, R2, R3 on the bottom of the PCB.

Step 4: LED Resistors

The LEDs that the resistors are for go on top of the PCB and NORMALLY would align the flat edge of the LED with the silkscreen, however, the footprint for the LEDs was flipped for the initial production run and the LEDs need to go backwards from how they normally should be. That means you will have the flat edge of the LED facing away from the flat edge on the silkscreen. The direction for this step matters very much.

Step 5: Status LEDs

Basically the same deal as the LED resistors, but these are a different value (10KOhm) so are marked with BROWN-BLACK-BLACK-RED-BROWN colored bands. The direction of these doesn't matter. I like putting these on the top of the board but they could go on the bottom if you wanted. These should be placed in positions R4 and R5.

Step 6: GPIO Expander Resistors

Simple step. Direction matters. There is a little notch on one of the short ends of the socket's edge. That should face upwards. The socket goes on the top of the PCB next to the resistors from the previous step.

Step 7: GPIO Expander IC Socket

Now we put the BlackPill on the board. It goes on the bottom of the PCB and has the components face outwards (down) so that you can still push the buttons on it after it is soldered in place. USB port goes upwards, so it can be accessed.

Step 8: BlackPill

Now we put the OLED on those pins we soldered in the first step. No matter which style of OLED you have (narrow or wide one)it will face upwards towards the top edge of the board from the pins.

Step 9: OLED

The Nugget and touchpad mounting ring will come attached to each other with break away tabs. You will need to break away the excess parts of the mounting ring and clean it up a little so it looks good for you (and lets the touchpad fit in the middle.)

Check out the red circled bits below for what need to be cleaned up.

Step 10: Prep the Nugget

We do the switches now because the Nugget sits below one of the switches, so they need to be soldered on before we continue. This is also an easy time to do the encoders you are interested in using, but you will have an easier time if you solder the switches on before the encoders because of how tall the encoders are.

NOTE: IF YOU ARE USING THE HALF PLATES, THE SWITCHES WILL NEED TO BE INSERTED THROUGH THE PLATE BEFORE BEING SOLDERED.

I will not be soldering switches in this guide, but please make sure to do this in order.

Please make sure to test before this step, because fixing things is WAY easier before it is fully assembled.

Nugget goes under one of the switches at the bottom of the board, on the bottom of the PCB. It needs to be aligned so the 1 and 7 pin labels on the Nugget match the 1 and 7 pin labels on the PCB silkscreen. You will ONLY be soldering the two rows of 6 pins on the left and right sides and not the row of 4 or 5 that are on top or bottom of the Nugget.

Step 12: Solder the Nugget

There are two positions for the touchpad to be mounted. I will be using the top position for this guide. The short 3mm standoffs will go on the top of the board with female side facing upwards, and will be secured in place by a 10mm standoff screwed on the the male portion on the bottom of the PCB. There are 4 3mm standoff spots for each position that form a square shape.

Step 13: Mounting the TouchPad

Then you should be able to place the acrylic on the standoffs like so:

Step 13: Mounting the TouchPad

The touchpad itself fits snugly inside the white ring that was around the Nugget from step 10. There is a small tab inside the ring that goes in to a small slot in the lip of the touchpad. Align then as such and then place it on top of the acrylic mounting ring with the tab position on the left side as you look at it:

Step 13: Mounting the TouchPad

Sandwich the mounting ring by placing the other acrylic ring on top of it and then screwing it into place with the 6mm screws.

Step 13: Mounting the TouchPad

Now we need to connect the Nugget to the touchpad. This is easier once it is all mounted, which is why we are tackling it now. The grey lip on the ribbon connector on the Nugget itself will flip up a little. Slide one end of the ribbon cable (silver contacts facing down) into the connector and make sure it is aligned as straight-on with the connector as you can. Seat it properly, then close the connector tab. Then you will bring the cable up to the hole in the PCB that allows access to the ribbon cable mount on the touchpad itself. The contacts on the ribbon cable here will face to the right. Get a good grip and insert it in the mount as straight on as you can.

Step 14: Ribbon Cable

The GPIO expander need to be inserted into the socket you soldered in step 7. The notch on the expander aligns with the notch on the top of the socket. The pins will be a little too wide for the socket, so you will need to bend them in slightly (do it gently.)

Make sure it is fully seated in the socket and that the pins arent bent up and that they are fully inserted in the socket. Should look like this from the top.

Step 15: GPIO Expander

Now you will go ahead and put the rest of the long standoffs in the following positions on the bottom of the board. Once that is done, you can put the screws in through the bottom plate to secure it to the standoffs and complete the case. Make sure to use your bumpon feet to prevent screws from potentially scratching your desktop and also to keep it from sliding around. There are 8 bumpons included in the kit and I recommend they go in the positions shown below:

Step 16: Case Assembly Hardware