Skip to content

Latest commit

 

History

History
661 lines (430 loc) · 27.9 KB

File metadata and controls

661 lines (430 loc) · 27.9 KB

Build Guide for Keyball39

This guide provides detailed instructions for assembling the Keyball39.
※This guide uses photos of the white PCB version of Keyball39, but the same procedure applies to the black PCB version.
Sections that require special attention for black PCB sets are marked with ⚫️ at the beginning.

日本語版のKeyball39ビルドガイドはこちらです。

01

【Table of Contents】

Preparation

Implementation

Assembly

Finishing

1. Parts Check

Please check that all kit contents are included when your kit arrives.

1-1. Kit Contents

The standard set can accommodate one thumb trackball on either the left or right side.

Single-hand kits are also available for dual-ball specifications with trackballs on both sides, or for assembly without trackballs on either side.

If you purchased a single-hand set or dual-ball set, please check the included parts list in your kit for the contents.

⚠️ If ProMicro pin headers + pin sockets are included instead of 12P connectors, please use the build guide here.

Keyball39 Standard Kit Contents

Part Name Quantity Notes
Middle PCB (Left/Right) 1 set Main board
Top PCB Plate (Left/Right) 1 set For key switch mounting
Middle Acrylic Plate (Left/Right) 1 set For key switch mounting
Bottom Acrylic Plate (Left/Right) 1 set Bottom cover
ProMicro Protection Plate 2 pieces For board protection
Trackball Holding Case (Top/Bottom) 1 set For ball mounting
Φ2 Ceramic Ball 1 piece Spare
Trackball Reading Board 1 piece Sensor board
L-shaped Connector Pin (7-pin) 1 piece For sensor connection
Trackball Reading IC 1 piece PMW3360
Reading IC Lens 1 piece Optical lens
Flat Head Tapping Screw M1.7 2 pieces For trackball case mounting
Small Head Tapping Screw M1.7 2 pieces For trackball case assembly
TRRS Jack 2 pieces For left/right connection
Tactile Switch 2 pieces For reset
Straight Connector Pin (12-pin) 4 pieces For ProMicro connection
Diode (SMD type) 50+ pieces For key matrix error prevention
Kailh PCB Socket CherryMX compatible 42+ pieces For key switches
Kailh PCB Socket choc compatible 5 pieces Used when modifying thumb keys to low profile
OLED Module 2 pieces Display
4-pin Header 2 pieces For OLED connection
4-pin Socket 2 pieces For OLED connection
Spacer M2 7mm 13+ pieces Standard spacers
Spacer M2 9mm 4 pieces For height adjustment
Spacer M2 4mm 5 pieces Used for thumb low profile specification
Screw M2 3.5mm 34+ pieces For plate mounting
Cushion Rubber 4 pieces For bottom anti-slip

02

1-2. Parts You Need to Prepare Yourself Before Assembly

The following parts are not included in the kit and need to be purchased separately.

Part Name Quantity Notes
ProMicro 2 pieces You can choose inexpensive ones or USB Type-C compatible ones
CherryMX Compatible Key Switches 39 pieces 34 pieces if using thumb low profile specification
Low Profile Key Switches 5 pieces Only if using thumb low profile specification
34mm Diameter Trackball 1 piece Required when using trackball
TRS (3-pole) Cable 1 piece TRRS (4-pole) cable is also acceptable
Micro USB Cable 1 piece Compatible with the ProMicro you purchased

03

1-3. Parts and Options That Can Be Installed After Assembly

The following parts can be installed after assembly and can be customized according to your preferences.

Part Name Quantity Notes
Keycaps 39 pieces 1u 39 pieces
Low Profile Keycaps 5 pieces Only for thumb low profile specification - 1u 5 pieces
YS-SK6812MINI-E 46 pieces ※SK6812MINI cannot be used

04

2. Preparation

2-1. Required Tools

The following tools are required for assembling Keyball39. Please check that you have all of them.

Tool Name Purpose
Soldering Iron (Temperature adjustable if implementing LEDs) Soldering work
Solder (Low melting point is effective if implementing LEDs) For connections
#0 + Precision Driver For screw tightening
Tweezers For handling parts
150 grit sandpaper For polishing when cutting plates

05

2-2. Firmware

To operate Keyball39, firmware needs to be written to the ProMicro you purchased.

Pre-built firmware can be easily written using REMAP, a web-based keyboard management software.

Writing is explained in detail in Chapter 3-7 for test firmware writing and Chapter 10 for production firmware writing.

3. Implementation

Now we begin soldering work.

The PCB is reversible, so first decide which side will be left/right hand.
When operating the trackball with your right thumb, the trackball will be attached to the area where the PCB is cut, as shown in the red circle in the photo below.

20

When operating the trackball with your left thumb, the layout is as shown in the photo below.

21

This build guide explains the specification with the trackball on the right hand.

⚡️ Warning: If you solder the wrong side, rework will be very difficult.
Please mark the front side with masking tape or similar as shown in the photo below to prevent mistakes.

22

⚫️ For black PCB sets, you can optionally fill the sides of the top PCB and middle PCB with a black marker for a cleaner finish.

138

3-1. Before Soldering

The soldering iron tip should be shaped like a bamboo spear tip, which makes it easier to place solder on flat surfaces and "scoop up" excess solder.

27

3-2. Installing Diodes

Now let's solder the diodes in order.
All diodes are soldered on the back side.

The diode silk marks are the marks shown by the arrows in the photo below, with a total of 45 pieces on both sides.

⚡️Warning: Diodes have polarity, so please install them in the correct orientation.
The orientation is where the straight line on the component matches the straight line at the tip of the arrow in the silk mark.
Please check the orientation carefully by looking at the photo below.
All diodes on the same board are arranged in the same orientation.
Please check that the orientation matches the surrounding diodes as you proceed with soldering.

25

The diode silk has black dots as shown in red in the photo below, so you can verify polarity after soldering the diodes.

26

Let's start soldering.
First, apply solder to one side of the diode pad.

28

Grab the diode with tweezers and fix it while melting the pre-applied solder.

30

Rotate the board 180 degrees and flow solder to the other leg of the diode.
Finally, touch both legs with the iron tip, and if the diode doesn't fall off, both legs are soldered.

Solder the other leg

Install a total of 45 diodes on both sides.

37

3-3. Soldering LEDs (Optional)

LEDs (YS-SK6812MINI-E) are optional.
A total of 46 pieces can be installed on both sides.
However, LEDs are very sensitive to heat, so please adjust the iron tip temperature to 220°C to 280°C.
Since the iron tip temperature is low, heat may not transfer to the pad, making it easy for solder to become "tempura" (poor connection).
The keyboard can be used without LEDs, and lighting all LEDs is quite difficult.
We recommend completing it without LEDs first. LEDs can be added later.

All LEDs are soldered on the back side.

Match the leg with the notch on the YS-SK6812MINI-E 4-pin with the marked pad and place the LED for soldering.

LEDs are mixed with upward and downward facing ones, but if you match the pin notch with the marking as shown in the photo below, the up/down orientation will automatically match.

Soldering all 4 pins at once can cause the component temperature to rise and damage it, so please solder 2 pins at a time with intervals.
For this reason, place about 10 LEDs at once, and move to the next LED soldering after applying solder once.
This prevents continuously heating one LED.

80

After soldering is complete, connect the USB cable and check the lighting.

LEDs are wired in series, so it's easy to identify the problematic area if only some light up.

For example, if LEDs up to number 12 light up but LEDs from number 13 onwards don't light up, there's likely a problem with the soldering of [LED number 12 or 13], so please redo the soldering of those LEDs.
If it still doesn't improve, LED failure is suspected, so please replace LED number 13.

Repeat the lighting check and soldering correction until all LEDs light up.

82

3-4. Soldering Key Sockets

Key sockets are soldered on the back side like diodes.
Set them to match the silk mark and shape for soldering.

⚡️Warning: If they protrude from the silk, the orientation is wrong.
Please check the correct orientation in the photo below.

85

If assembling thumb keys in low profile specification, solder low profile sockets to the thumb key locations (5 keys on both sides).
These low profile sockets also have orientation.

As shown in the photo below, place the terminal with the black resin part in an octagonal shape near the center of the switch.

85

For soldering, apply solder to one side of the socket pad as shown in the blue circle.

86

Fit the socket and press down with tweezers from above, then touch the iron tip with a little solder from the side of the terminal, and the solder will melt and the socket will sink.
Based on experience, this method is least likely to cause "tempura" (poor connection).

87

Rotate the board 180 degrees and solder the other terminal.

Solder a total of 39 pieces on both sides.
For thumb key PCB sockets, either CherryMX compatible sockets or low profile sockets alone are fine.
※Both are installed in the photo.

89

3-5. Soldering Jumpers

Jumpers need to be shorted to operate the OLED module.

⚡️Warning: Jumper soldering is done only on the back side.
There are "Back Side Only" markings, with [4 pieces each] on the left and right boards.
Warm the pad with the iron tip, then melt solder to create a bridge.

41

If you're not confident in soldering or not good at bridge work, try applying solder to the 8 pads first as shown in the photo below.

40b

Adding solder here should make bridging easier.

40b

If the solder freshness deteriorates (heated multiple times), surface tension decreases and bridging becomes difficult.
Scrape off the solder once and add solder or flux to try again.
When bridging is successful, it should look like the photo below. Bridge a total of 8 locations on both sides.

There are other jumpers, but these will be explained later, so please solder only 4 locations each on the left and right for now.

3-6. TRRS Socket, Tactile Switch, and 4-pin Socket

Solder the parts shown in the photo below.

⚡️Warning: This time all are installed only on the front side, so please be careful.

51

If you're worried about parts floating, fix them with masking tape or similar for soldering.

52

When all are installed, it should look like the photo below.

53

3-7. Soldering ProMicro

ProMicro is soldered using the connector pins shown in the photo below, which makes replacement easier when ProMicro fails.
Connector pins have installation direction, so please look at the photo carefully for the work.

⚠️ If ProMicro pin headers + pin sockets are included instead of 12P connectors, please use the build guide here.

60

First, insert the connector pin into the board [front side].

61

Insert the connector to match the square silk frame.
If the black silk frame is misaligned with the connector, the insertion hole is wrong.

61

Insert ProMicro into the inserted connector pin.
Solder only the ProMicro side in a state where it's firmly inserted to the end.
Soldering while inserted into the board prevents the connector pin from being installed at an angle.

⚡️Warning: If you solder the connector pin to the middle PCB side as well, replacement will be very difficult when ProMicro fails.

63

OLED can be installed on both left and right boards as standard.
Insert a 4-pin header into the 4-pin socket and place the OLED module. Then solder only one of the 4 pins.

While melting the solder of the single soldered pin, press the OLED module from above to prevent it from floating.
Also, adjusting it to be parallel with ProMicro will look better.

Once the position is determined, solder the remaining 3 pins.

70

3-8. ProMicro Programming and Operation Check

Let's write test firmware to ProMicro.
The test firmware has a keymap layout that's easy to verify operation, and LEDs light up in red→green→blue sequence, making it easy to find problematic areas.
If you're skipping LED soldering, etc., and don't need test firmware, you can write the official firmware from Chapter 10 here.

Keyball39 firmware is common regardless of which side the trackball is mounted on.
Please write (FLASH) the Keyball_test.hex registered in REMAP.
Clicking the FLASH button in the link above will display instructions for the writing method.
If the keyboard is not recognized even with the USB cable connected, try pressing the soldered RESET switch quickly twice.
※Be sure to write the same hex file to both left and right Pro Micros.

If you want to directly edit Keyball39 firmware and build it yourself, source files are available in this repository, so please download and use them.

After writing is complete, check that characters are input to a text editor by shorting the key switch pad with tweezers as shown in the photo below. The keyboard left and right may be reversed, but that's not a problem for now.
Please just check that some characters are input and ProMicro is working.
You don't need to test all keys yet, but checking operation early makes problem isolation easier.
※Firmware writing must be done for both left and right Pro Micros.

75

4. Assembling the Trackball Reading Board

Prepare the board shown in the photo below (hereinafter, ball board) and optical sensor.

※For quality confirmation of sensors and boards, pre-soldered ball boards may arrive.
In that case, skip this step and proceed to L-shaped connector soldering in Chapter 4-2.

90

4-1. Soldering the Sensor

The sensor IC is inserted from the back side where no components are mounted on the ball board.

⚡️Warning: If the sensor polarity is wrong, repair will be very difficult!
Please carefully confirm that it's inserted in the correct orientation and from the correct direction before soldering!
Match the notch indicating pin 1 of the IC with the [1pin] silk on the board.

91

The IC looks like this from the back.
Solder all pins from the front side where SMD components are mounted (the side without the Keyball logo).

92

Use tweezers to peel off the protective seals [2 pieces].

93

Attach the sensor lens to the side where the protective seals were peeled off.
The lens has direction, and if the direction is wrong, the two thin pins of the lens may break, so please check the direction carefully.
There's a protrusion like the arrow in the photo below at the front of the lens, and this should be on the top side when mounting.

95

If the lens and IC directions match, the two pins of the lens should insert into the IC without force. Please insert slowly.

94

4-2. Soldering the L-shaped Connector

Next, install the L-shaped connector pin on the front side of the board where the trackball will be mounted.
The L-shaped connector also has direction. Insert the side where the pins are not U-shaped into the middle board for soldering.

96

Apply masking tape or similar to prevent parts from floating and solder from the back side.

97

Next, solder the 4 jumpers for optical sensor signal lines.

⚡️Warning: There are jumpers near the soldered connector, so apply solder to only the back side and short them as shown in the photo below.

97

5. Soldering the Left-Right Detection Jumper on the Left Side

⚡️Warning: The standard Keyball39 firmware has a function to automatically detect the left/right of the keyboard.
For detection, solder a jumper at one location only on the left side board.

When looking at the left side board from the back, there's a LEFT silk as shown in the red circle in the photo below.
Please solder the jumper next to this to short it.

140

If mounting the trackball on the left side, the position is slightly different, and the LEFT jumper will be at the position shown in the photo below.

⚡️Warning: Be sure to jumper only the left side board.

141

The soldering work is now complete.

As a side note, before turning off the soldering iron, apply plenty of solder to the tip. When you use it next time, if you remove this solder, you can resume work with a shiny tip!

100

6. Cutting the Top Plate (Optional)

Keyball39 requires cutting the perforated thumb key section of the top plate for assembly.
Use a cutter to make cuts in the perforated sections on both front and back sides, then fold and separate.

101

Polish the cut surface with about 150 grit sandpaper.

102

7. Assembly

7-1. Installing the Protection Plate

Install the ProMicro protection plate on the middle board. First, screw the 9mm spacer.

110

Screw the acrylic protection plate to the spacer.

The protection plate shape is common for both trackball and non-trackball sides. There's no front/back.

111

7-2. Assembling the Top Plate

Screw the 7mm spacer to the back side of the top plate.

If assembling thumb keys in low profile specification, attach 4mm spacers to the thumb key top plate.

112

Insert key switches into the four corners of the top plate and the thumb plate.

This improves the positioning accuracy between plates.

113

Match the screw holes of the top plate and middle acrylic plate, and stack the plates.

114

Next, also match the screw holes of the soldered middle board, and stack while confirming that the key switch terminals fit firmly into the key sockets.

114

7-3. Assembling the Bottom Plate

※Previously there were donut-shaped acrylic spacers, but they were discontinued because the effect couldn't be obtained due to variations in acrylic thickness.
If acrylic spacers are included in your kit, please discard them.

Peel off the protective sheet of the acrylic bottom plate, place it on the back of the main body, and screw it.
Next, attach cushion rubber to the four corners of the keyboard back.

8. Installing the Trackball

8-1. Inserting the Ball Reading Board

Insert the assembled trackball reading board into the 7-pin connector.
It's shown at an angle for clarity, but insert the board vertically.

120

The ball board is now standing vertically.

121

8-2. Assembling the Trackball Case

The trackball case has 3 ceramic balls pre-fixed.
If ceramic balls happen to fall off, please fix the spare ceramic ball with appropriate bond.
Please keep the spare ceramic ball for future use in case you lose the ball.

Shake the case to check that the ceramic balls don't fall off.

122

The two pins on the case top can be inserted into the hole in the case bottom.
Apply force slowly from top and bottom to combine. (It doesn't need to fit perfectly as it will stick together with the subsequent screw tightening.)

123

Attach M1.7 tapping screws.
The kit includes small head screws and flat head screws, but use the small head screws.

124

From the back of the case, screw these 2 locations.

⚡️Warning: Be careful not to overtighten.

125

8-3. Installing the Trackball Case

Install the completed case to the main body.
The ball board goes into the sensor storage area on the back of the case.
While making sure the ball board shown by the arrow is around the center of the case, slowly fit it from above.
If there's resistance, don't force it in, but pull it out once and try inserting again.

It should go all the way in without much force.

126

When checking from the back of the main body, there may be a gap as shown by the arrow between the main board and ball board.

128

In that case, gently push from the front of the case (in the direction of the finger mark).
Applying too much force may damage the L-shaped connector, so push gently.
When the gap disappears as shown in the photo below, the screw holes in the blue circle should match.

129

Tighten the flat head screws 2 pieces of M1.7 torx screws included in the kit from the back of the main body.
At this time, hold the ball holding case with your finger to prevent it from rotating while tightening the screws.

130

9. Final Assembly

Almost complete! Insert your preferred key switches and keycaps.

Finally, push the 34mm trackball into the case to complete!
Thank you for your hard work.

132

Keyball39 completed

10. Writing the Official Firmware

Now let's write the official firmware to ProMicro as the final step.

Keyball39 is compatible with ReMAP, so firmware writing and keymap changes are possible without installing special software. For instructions on using Remap, please refer to the article by Salicylic Acid's Self-Key Onsen Guide for detailed information.

To use ReMAP, open the REMAP catalog Keyball39 firmware page and FLASH (write) the Keyball39_via firmware.

As written in Chapter 3-7, clicking the FLASH button will display instructions for the writing method. If the keyboard is not recognized even with the USB cable connected, try pressing the soldered RESET switch quickly twice.

⚡️Warning: Be sure to write the same hex file to both left and right Pro Micros.

If you want to build firmware yourself
The latest Keyball39 firmware is published in the Github repository.
Copy this keyball folder to your QMK_Firmware/keyboards and freely edit keymaps etc. to make.

11. How to Use Keyball♪

  • The trackball changes to up/down/left/right scroll while switched to layer 3.

  • ReMAP allows easy keymap checking, changing, and writing.

  • USB cable can be inserted into either left or right side.
    However, keymaps are written to the ProMicro on the side where the USB cable is inserted, so please review the keymap when switching for the first time.

  • Specially prepared keycodes for the Keyball series are arranged in layer 3.
    They can be used to change the trackball to scroll, or change cursor speed and scroll speed.
    For details, please refer to the Keycode List.

⚡️Warning: Disconnecting the TRS cable while Keyball is connected to PC (powered on) can cause malfunction.
When disconnecting/connecting the TRS cable, always disconnect the USB cable first.

This concludes the Keyball39 build guide.
For questions or issues about Keyball39, please post to the Github repository, Yowkees/keyball Discussions.
We will respond as quickly as possible.

―Acknowledgments―
Thanks to the tremendous cooperation of KoRoN@Kaoriya, the Keyball39 firmware has significantly improved trackball operation smoothness, and the substantial memory reduction allows enjoyment of many LED actions. With such wonderful firmware created quickly, we were able to start selling Keyball39 very smoothly. I would like to express my deep gratitude here. Thank you very much.  @Yowkees