diff --git a/docs/keyboards/ergonaut-one/build-guide.md b/docs/keyboards/ergonaut-one/build-guide.md index 6e64b06..a9ec00d 100644 --- a/docs/keyboards/ergonaut-one/build-guide.md +++ b/docs/keyboards/ergonaut-one/build-guide.md @@ -11,25 +11,40 @@ title: Build Guide | ----------------------------------- | | ![](/img/one_build_guide/pcb/0.jpg) | -You can assemble PCB in two different configurations - either with Xiao on "top", or on the "bottom". Pick a configuration based on the variant of the case you would want to use. - ### Case compatibility -| Xiao position | Modern Case | Classic Case | -| ------------- | ----------- | ------------ | -| Bottom | ✅ | ❌ | -| Top | ❌ | ✅ | +You can assemble PCB in two different configurations - either with Xiao on "top", or on the "bottom". +Pick a configuration based on the variant of the case you would want to use. + +:::note + +All the images in this guide are using the configuration with the Xiao on the "bottom". + +::: + +| Case | Xiao position | +| ------- | ------------- | +| Modern | Bottom | +| Classic | Top | ### Soldering #### Xiao -Before soldering the Xiao, please, apply a **small** amount of solder on the battery pins on the bottom of Xiao. If you applied too much - you can collect the solder to the iron tip with some flux. Xiao shouldn't be skewed on the board! +Before soldering the Xiao, please, apply a **small** amount of solder on the battery pins on the bottom of Xiao. +If you applied too much - you can collect the solder to the iron tip with some flux. + +:::tip + +The Xiao should sit flush on the PCB without being skewed or angled! If it's not +laying flat on the PCB, there is too much solder on the pins. + +::: ![](/img/one_build_guide/pcb/bat_pins.jpg) 1. Position Xiao in its designated place -2. Start by soldering two opposite pins +2. Start by soldering two opposite pins to keep it in place 3. Solder the rest of the pins 4. Flip the board 5. Put some flux in the holes (marked by the red circle in the photo), and fill them with solder (you might want to heat those pins a little longer than usual) @@ -41,21 +56,39 @@ Before soldering the Xiao, please, apply a **small** amount of solder on the bat #### Diodes -If you are building a "Bottom Xiao" configuration, diodes should be on the **SAME** side as Xiao. -If you are building a "Top Xiao" configuration, diodes should be on the **OPPOSITE** side from Xiao. +"Bottom Xiao" configuration: diodes should be on the **SAME** side as Xiao. +"Top Xiao" configuration: diodes should be on the **OPPOSITE** side from Xiao. -Please take note that diodes have polarity. +Please take note that diodes have polarity that are shown on the PCB and on the +diodes with a line. ![](/img/one_build_guide/pcb/diode.png) +![](/img/one_build_guide/pcb/diode_2.jpg) + +1. Add a small amount of solder to one pad +2. Place the diode on the pads with tweezers, making sure they are in the + correct orientation +3. Melt the solder already on the pad and ensure the diode aligned properly +4. Solder the other pad + | Left | Right | | ------------------------------------- | ------------------------------------- | | ![](/img/one_build_guide/pcb/3_l.jpg) | ![](/img/one_build_guide/pcb/3_r.jpg) | #### Hotswap Sockets -If you are building a "Bottom Xiao" configuration, sockets should be on the **SAME** side as Xiao. -If you are building a "Top Xiao" configuration, sockets should be on the **OPPOSITE** side from Xiao. +"Bottom Xiao" configuration: sockets should be on the **SAME** side as Xiao. +"Top Xiao" configuration: sockets should be on the **OPPOSITE** side from Xiao. + +The orientation of the sockets does **not** matter. + +1. Insert the sockets into the PCB +2. Solder one pin of each socket to keep them in place, ensuring the socket is + flat against the PCB +3. Check if the sockets are flat, if there are any that are not, reheat the + solder and adjust the socket +4. Solder the other side of the sockets | Left | Right | | ------------------------------------- | ------------------------------------- | @@ -65,11 +98,16 @@ If you are building a "Top Xiao" configuration, sockets should be on the **OPPOS Power switches are always on the opposite side of Xiao. +1. Add a small amount of solder to one pad +2. Place the switch on the pad with the mounting pins in the holes +3. Melt the solder already on the pad and ensure the switch is aligned properly +4. Solder the other pads + ![](/img/one_build_guide/pcb/5.jpg) -#### Test your soldering +#### Test for shorts -If you have a multimeter, test for shorts: +If you have a multimeter, test for shorts before connecting the battery. 1. Between "-" and "+"; 2. Between GND and 5V on the Xiao; @@ -77,19 +115,60 @@ If you have a multimeter, test for shorts: ![](/img/one_build_guide/pcb/pins.jpg) -Then connect the battery, turn on the power switch and verify the voltage between GND and 3V3 is 3.3 volts. -If the voltage is not there, you probably need to re-solder the underside pads. +#### JST Connector (Optional) -If you do not have a multimeter, just proceed with the instructions. +The JST connector is optional and is used to connect the battery to the PCB. +If your battery doesn't have a JST connector or if you prefer to do so, you can +solder the battery wires directly to the PCB in the next step. + +JST connector should be on the same side as the battery. + +1. Apply solder to the larger solder pad closest to the Xiao as it is the most + difficult to solder with the connector in place +2. Align the JST connector on the pad, making sure the small leads on the + connector are aligned with the pad labeled "+" and "-" +3. Heat the solder pad with the previously applied solder and push the connector + down onto the pad, ensuring it is flush with the PCB and the leads are aligned +4. Solder the other pads #### Batteries -You can choose any side for battery wires soldering, but I suggest using the same side as Xiao. +If you are added a JST connector and have a compatible battery, you just connect +the battery and move on to the next step. + +:::warning + +Please take note of battery polarity. Positive wire (red) should go to "+", +negative wire (black) to "-". + +::: + +You can choose any side for battery wires soldering, but using the same side as +the Xiao is suggested. + +Even though the battery is protected, it's recommended to solder on 1 wire at a +time to prevent two loose exposed wires from touching and causing a short. -Please take note of battery polarity. Positive wire (red) should go to "+", negative wire (black) to "-". +1. Strip the end of the ONE battery wire. The amount of bare wire should be + enough to pass through the hole with a little extra to fold over. +2. Pass the wire through the hole in the PCB such that the wire comes from the + side opposite of the other connection, parallel to both solder pads (refer to + the image) +3. Fold the wire on the backside such that it folds away from the other + connection +4. Solder the wire to the through hole pad +5. Trim the excess wire on the backside +6. Repeat for the other wire ![](/img/one_build_guide/pcb/6.jpg) +#### Test the battery connection + +If you do not have a multimeter, skip this step. + +Turn on the power switch and verify the voltage between GND and 3V3 is 3.3 volts. +If the voltage is not there, you probably need to re-solder the underside pads. + ### Clean up Clean your PCB from flux residues. IPA (isopropyl alcohol) with Q-tips should do the trick. @@ -144,7 +223,11 @@ Flip the keyboard again, and insert the bottom part of the case. Now the tricky part - you should place hex nuts in the hex slots on the bottom side of the case, and insert screws from the top side of the case. -**Note: please do not overtighten the screws!** +:::warning + +Please do not overtighten the screws! You can easily damage the case. + +::: | Top | Bottom | | ------------------------------------ | ------------------------------------ | diff --git a/docs/keyboards/ergonaut-one/build-preparations.md b/docs/keyboards/ergonaut-one/build-preparations.md index 45b68fe..b9d953b 100644 --- a/docs/keyboards/ergonaut-one/build-preparations.md +++ b/docs/keyboards/ergonaut-one/build-preparations.md @@ -60,10 +60,13 @@ You can choose to use one of three provided variants of the case: You'd probably need: -* FDM 3D Printer or a friend with a printer; +* FDM 3D Printer, a friend with a printer, or an online 3D printing service; * **[ONLY FOR CLASSIC CASE]** Scalpel or some other cutting tool to remove included supports; * **[OPTIONAL]** Deburring tool. +[JLCPCB](https://jlcpcb.com/) and [PCBWay](https://www.pcbway.com/) also provide 3D printing services, +so you can order your case along with PCBs if you do not have access to a 3D printer. + #### BOM You'd need some additional hardware to assemble your case: @@ -72,7 +75,7 @@ You'd need some additional hardware to assemble your case: | ----------------------------- | --- | ---------------------------------------------------------------------------------------- | | M2 8mm Flat Countersunk Screw | 8 | [Aliexpress](https://aliexpress.com/item/32975242274.html?sku_id=66696774380) | | M2 Hex Nut | 8 | [Aliexpress](https://aliexpress.com/item/1005003994209489.html?sku_id=12000027676602569) | -| Silicone Feet Pads 8mmx2.5mm | 8 | [Aliexpress](https://aliexpress.com/item/32750517847.html) | +| Silicone Feet Pads 8mmx2.5mm | 8 | [Aliexpress](https://aliexpress.com/item/3256802433818462.html) | #### Printing @@ -92,6 +95,21 @@ Choose your desired case variant (Classic or Modern) and print four parts: * Left Bottom; * Right Bottom (model should be mirrored by X axis in slicer). +If you are using a online 3D printing service, you can easily mirror the STL +with [this online tool](https://stl-mirror.beekeeb.com/). This will give you +3 options to mirror the STL file, choose the one that mirrors the model by the +X axis which is labeled "yz". + +:::note + +You may receive a message from online services that require confirmation to +continue with the print due to the thin walls increasing the risk of potential +damage or issues in the printing process. +In the case of printing PA12 Nylon MJF from JLCPCB, the case was printed without +any issues but your mileage may vary. + +::: + ### 3D Printed Modern Case | Front | Back | @@ -108,12 +126,20 @@ Choose your desired case variant (Classic or Modern) and print four parts: | -------------------------------------------------------- | ------------------------------------------------------- | | ![3D Printed Classic Case Front](/img/one_classic_1.jpg) | ![3D Printed Classic Case Back](/img/one_classic_2.jpg) | -**Note: this model contains included bed adhesion-improving supports, which should be removed after print.** +:::note + +This model contains included bed adhesion-improving supports, which should be removed after print. + +::: | Bottom part placement | Top part placement | | -------------------------------------------------------------- | -------------------------------------------------------------- | | ![3D Printed Classic Case Bot](/img/one_classic_bot_print.jpg) | ![3D Printed Classic Case Top](/img/one_classic_top_print.jpg) | -**Note: After the print don't forget to remove included supports from the top parts. The image below for a reference:** +:::note + +After the print don't forget to remove included supports from the top parts. The image below for a reference: + +::: ![3D Printed Classic Case Supports](/img/one_classic_top_supports.jpg) diff --git a/static/img/one_build_guide/pcb/diode_2.jpg b/static/img/one_build_guide/pcb/diode_2.jpg new file mode 100644 index 0000000..bcf5dca Binary files /dev/null and b/static/img/one_build_guide/pcb/diode_2.jpg differ