Skip to content

Commit

Permalink
add splinktegrated
Browse files Browse the repository at this point in the history
  • Loading branch information
bstiq committed Jan 3, 2024
1 parent 9546701 commit b3c2f93
Show file tree
Hide file tree
Showing 30 changed files with 252 additions and 0 deletions.
212 changes: 212 additions & 0 deletions _includes/splinktegrated_preparation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,212 @@
# Table of contents

1. TOC
{:toc}

# Introduction

In this section we will prepare the Splinktegrated. The Splinktegrated is an open-source board based on the RP2040 controller, which acts as the "brains" of your keyboard.

{: .tip }
In your kit, you might get either a Splinky with shield PCB, or a Splinktegrated. If you have a Splinky, refer to the Splinky guide.

**Please read all the instructions first, and then follow them carefully using the pictures.**

{: .warning }
> Do not install the audio jack and reset button yet.
>
> You will need to prepare one **"Right"** shield PCB, and one **"Left"** - use the legends on the PCB.
>
> We will start with preparing the headers, then the left side, and after that do the right side.
# Headers
## Headers - Required parts

![](../assets/pics/guides/splinktegrated/1.jpg)

**For the following step, please prepare:**
- 12-pin header (x2)

Using pliers, cut the headers into pieces of **4 pins**:
![](../assets/pics/guides/splinktegrated/2.jpg)

You only need 4 pieces, you can set the other ones aside.

# Left side
## Left side - Required parts

![](../assets/pics/guides/splinktegrated/4.jpg)

**For the following step, please prepare:**

- 4-pin header (x2)
- Splinktegrated main board
- Splinktegrated daughter board

{: .warning }
In the next section, we will prepare the first Splinktegrated by installing the daughterboard onto the motherboard. **It is very important to install it on the correct side**, otherwise it will not work. Make sure to look at the pictures carefully! 

Check warning on line 47 in _includes/splinktegrated_preparation.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (daughterboard)

## Left side - Installing the daughterboard

Check warning on line 49 in _includes/splinktegrated_preparation.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (daughterboard)

- Install the headers onto the motherboard
- Install the daughterboard on top

Check warning on line 52 in _includes/splinktegrated_preparation.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (daughterboard)
- **Double check against the picture that it is on the correct side**
- Use normally-closed pliers to hold it

![](../assets/pics/guides/splinktegrated/6.jpg)

- **At all times, make sure the daughterboard is pressed against the motherboard**

Check warning on line 58 in _includes/splinktegrated_preparation.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (daughterboard)
- There should be no gap between the daughterboard, the header pins, and the motherboard

Check warning on line 59 in _includes/splinktegrated_preparation.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (daughterboard)

![](../assets/pics/guides/splinktegrated/7.jpg)

- Inspect the front of the assembly: 
- Make sure that the headers are flush with the motherboard and daugtherboard

Check warning on line 64 in _includes/splinktegrated_preparation.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (daugtherboard)
- Solder the top headers, then the bottom headers
- Finally, cut the headers to make them flush using pliers

![](../assets/pics/guides/splinktegrated/9.jpg)

## Left side - Reset button

{: .warning }
The reset button needs to be installed on a specific side. Read the instructions and inspect the pictures carefully first, then proceed with the soldering.

![](../assets/pics/guides/splinktegrated/12.jpg)

**For the following step, please prepare:**

- Splinktegrated assembly (left)
- Reset button

![](../assets/pics/guides/splinktegrated/14.jpg)

- Flip the assembly
- Solder the reset button
- Use the same technique as the diodes (pre-tin one pad) 

## Left side - Jumper


{: .warning }
The jumper needs to be installed on a specific side. Read the instructions and inspect the pictures carefully first, then proceed with the soldering.

Use the picture to identify the jumper.

![](../assets/pics/guides/splinktegrated/16.jpg)

Solder the jumper, so that the 2 pads are bridged together.

![](../assets/pics/guides/splinktegrated/17.jpg)

## Left side - Audio jack

{: .warning }
In this step, we will solder the audio jack. At this point, we will only solder one pad (the 5V). This is so that later we can adjust its exact position once it's inserted into the 3d case. The audio jack needs to be installed on a specific side. Read the instructions and inspect the pictures carefully first, then proceed with the soldering.

![](../assets/pics/guides/splinktegrated/20.jpg)

**For the following step, please prepare:**

- Splinktegrated assembly (left)
- Audio jack


![](../assets/pics/guides/splinktegrated/21.jpg)

- Install the audio jack
- **Solder only the bottom left pin . We will align the audio jack in the case and solder the other pins later**


# Right side
## Right side - Required parts

![](../assets/pics/guides/splinktegrated/3.jpg)

**For the following step, please prepare:**

- 4-pin header (x2)
- Splinktegrated main board
- Splinktegrated daughter board

{: .warning }
In the next section, we will prepare the first Splinktegrated by installing the daughterboard onto the motherboard. **It is very important to install it on the correct side**, otherwise it will not work. Make sure to look at the pictures carefully! 

## Right side - Installing the daughterboard

- Install the headers onto the motherboard
- Install the daughterboard on top
- **Double check against the picture that it is on the correct side**
- Use normally-closed pliers to hold it

![](../assets/pics/guides/splinktegrated/5.jpg)

- **At all times, make sure the daughterboard is pressed against the motherboard**
- There should be no gap between the daughterboard, the header pins, and the motherboard

![](../assets/pics/guides/splinktegrated/8.jpg)

- Inspect the front of the assembly: 
- Make sure that the headers are flush with the motherboard and daugtherboard

Check warning on line 150 in _includes/splinktegrated_preparation.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (daugtherboard)
- Solder the top headers, then the bottom headers
- Finally, cut the headers to make them flush using pliers

![](../assets/pics/guides/splinktegrated/10.jpg)

## Right side - Reset button

{: .warning }
The reset button needs to be installed on a specific side. Read the instructions and inspect the pictures carefully first, then proceed with the soldering.

![](../assets/pics/guides/splinktegrated/11.jpg)

**For the following step, please prepare:**

- Splinktegrated assembly (right)
- Reset button

![](../assets/pics/guides/splinktegrated/13.jpg)

- Flip the assembly
- Solder the reset button
- Use the same technique as the diodes (pre-tin one pad) 

## Right side - Jumper


{: .warning }
The jumper needs to be installed on a specific side. Read the instructions and inspect the pictures carefully first, then proceed with the soldering.

Use the picture to identify the jumper.

![](../assets/pics/guides/splinktegrated/15.jpg)

Solder the jumper, so that the 2 pads are bridged together.

![](../assets/pics/guides/splinktegrated/18.jpg)

## Right side - Audio jack

{: .warning }
In this step, we will solder the audio jack. At this point, we will only solder one pad (the 5V). This is so that later we can adjust its exact position once it's inserted into the 3d case. The audio jack needs to be installed on a specific side. Read the instructions and inspect the pictures carefully first, then proceed with the soldering.

![](../assets/pics/guides/splinktegrated/19.jpg)

**For the following step, please prepare:**

- Splinktegrated assembly (right)
- Audio jack


![](../assets/pics/guides/splinktegrated/22.jpg)

- Install the audio jack
- **Solder only the bottom left pin . We will align the audio jack in the case and solder the other pins later**

# Checkup

You now have 2 Splinktegrated assemblies. Make sure they match with the pictures below. **Pay close attention to the audio jack, reset button, and jumper**.

![](../assets/pics/guides/splinktegrated/23.jpg)

![](../assets/pics/guides/splinktegrated/24.jpg)
4 changes: 4 additions & 0 deletions _includes/splinky_preparation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ We will install it onto a **shield PCB** (also called **MCU holder**), as well a
{: .tip }
In your kit, you might get either an Elite-C, or a Splinky/RP2040-compatible board. Newer kits ship with the Splinky, but if you have an old kit you might have an Elite-C. The installation instructions are the same for both of them, just look carefully at the pictures.


{: .tip }
In your kit, you might get either a Splinky with shield PCB, or a Splinktegrated. If you have a Splinktegrated, refer to the Splinktegrated guide.

**Please read all the instructions first, and then follow them carefully using the pictures.**

{: .warning }
Expand Down
Binary file added assets/pics/guides/splinktegrated/1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/10.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/11.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/12.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/13.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/14.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/15.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/16.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/17.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/18.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/19.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/20.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/21.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/22.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/23.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/24.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/4.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/5.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/6.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/7.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/8.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/pics/guides/splinktegrated/9.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions bg_charybdis/08splinktegrated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: default
title: Preparing the Splinktegrated
nav_order: 8
parent: Build guide - Charybdis
---


{% include splinktegrated_preparation.md %}
9 changes: 9 additions & 0 deletions bg_cnano/08splinktegrated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: default
title: Preparing the Splinktegrated
nav_order: 8
parent: Build guide - Charybdis
---


{% include splinktegrated_preparation.md %}
9 changes: 9 additions & 0 deletions bg_scylla/08splinktegrated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: default
title: Preparing the Splinktegrated
nav_order: 8
parent: Build guide - Charybdis
---


{% include splinktegrated_preparation.md %}
9 changes: 9 additions & 0 deletions bg_skeletyl/08splinktegrated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: default
title: Preparing the Splinktegrated
nav_order: 8
parent: Build guide - Charybdis
---


{% include splinktegrated_preparation.md %}

0 comments on commit b3c2f93

Please sign in to comment.