funkey/FunKey-Project.github.io
1
0
Fork 0
mirror of https://github.com/FunKey-Project/FunKey-Project.github.io.git synced 2026-03-19 18:32:51 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

add boot rom description

Browse Source 
Signed-off-by: Michel-FK <michel.stempin@funkey-project.com>
This commit is contained in:
Michel-FK
2021-02-18 23:55:30 +01:00
parent c98feaf815
commit 20c14a519d
11 changed files with 635 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
docs/user_manual/tutorials/hardware/change_buttons.md
View File

@@ -1,8 +1,14 @@
You FunKey S is delivered with 4 extra sets of buttons (red, blue, yellow and green) so that you can customize them at will. It only requires a standard **Phillips
screwdriver (PH0)**, **tweezers** and a **knife or scissors** for cutting up the plastic holding the new buttons together.
You FunKey S is delivered with 4 extra sets of buttons (red, blue,
yellow and green) so that you can customize them at will. It only
requires a standard **Phillips screwdriver (PH0)**, **tweezers** and a
**knife or scissors** for cutting up the plastic holding the new
buttons together.
!!! note
Be careful when opening up the console. FunKey Project is not responsible for any damage done to your console when changing the buttons.
Be careful when opening up the console. FunKey Project is not
responsible for any damage done to your console when changing the
buttons.
### **STEP 1 - Removing the screws** {.step-title}
@@ -14,16 +20,18 @@ Using a standard **Phillips PH0 screwdriver**, remove the 2 screws on
the back of your FunKey S.
!!! warning
Be careful to use the correct screwdriver head size and type to
prevent damaging the screws (do not use JIS screwdrivers).
FunKey Project is not responsible for replacing damaged screws.
Be careful to use the correct screwdriver head size and type to
prevent damaging the screws (do not use JIS screwdrivers). FunKey
Project is not responsible for replacing damaged screws.
### **STEP 2 - Opening up the console** {.step-title}
![Pull up hinge first](/assets/images/disassembly/IMG_8848.jpg){.step-thumb}
![Console opened](/assets/images/disassembly/IMG_8989.jpg){.step-thumb}
Carefully remove the plastic back of the console by pulling up the hinge side first
Carefully remove the plastic back of the console by pulling up the
hinge side first
### **STEP 3 - Removing the keychain lanyard** {.step-title}
@@ -31,9 +39,11 @@ Carefully remove the plastic back of the console by pulling up the hinge side fi
![Console opened](/assets/images/disassembly/IMG_8993.jpg){.step-thumb}
![Pull up the plastic buttons](/assets/images/disassembly/IMG_8896.jpg){.step-thumb}
Carefully remove the keychain lanyard and its axis by pulling gently (it may fall off when opening).
Carefully remove the keychain lanyard and its axis by pulling gently
(it may fall off when opening).
!!! warning
The axis is a small part, be careful not to loose it.
### **STEP 4 - Removing the LR buttons** {.step-title}
@@ -42,9 +52,11 @@ Carefully remove the keychain lanyard and its axis by pulling gently (it may fal
![Pull up the plastic buttons](/assets/images/disassembly/IMG_8844.jpg){.step-thumb}
![Pull up the plastic buttons](/assets/images/disassembly/IMG_8900.jpg){.step-thumb}
Carefully remove the L/R plastic buttons by gently pulling them out of their axis
Carefully remove the L/R plastic buttons by gently pulling them out of
their axis
!!! warning
Be careful not to damage the L/R switches on the circuit board!
### **STEP 5 - Unplugging the battery** {.step-title}
@@ -54,12 +66,20 @@ Carefully remove the L/R plastic buttons by gently pulling them out of their axi
![Get the battery out of the way](/assets/images/disassembly/IMG_8986_arrow.jpg){.step-thumb}
!!! note
This step is not required for changing the buttons, but we still advise it. You can however jump to the next step and not unplug the battery.
Lift the battery and pull gently by the top of the circuit board to unplug the battery. The battery may be stuck to the processor with double-sided adhesive, it's perfectly normal if you have to lift with a bit of force to unstick it.
This step is not required for changing the buttons, but we still
advise it. You can however jump to the next step and not unplug
the battery.
Lift the battery and pull gently by the top of the circuit board to
unplug the battery. The battery may be stuck to the processor with
double-sided adhesive, it's perfectly normal if you have to lift with
a bit of force to unstick it.
!!! warning
Be sure to pull on the connector and **NOT the wires** when removing the battery. It is recommended to use tweezers.
Be sure to pull on the connector and **NOT the wires** when
removing the battery. It is recommended to use tweezers.
### **STEP 6 - Unplugging the screen** {.step-title}
@@ -68,8 +88,11 @@ Lift the battery and pull gently by the top of the circuit board to unplug the b
![Unplug screen](/assets/images/disassembly/IMG_8938.jpg){.step-thumb}
Now that you have access to the circuit board, you can unplug the screen.
!!! warning
This connector is fragile, unplug it vertically without force. It is recommended to use tweezers.
This connector is fragile, unplug it vertically without force. It
is recommended to use tweezers.
### **STEP 7 - Removing the circuit board** {.step-title}
@@ -77,14 +100,16 @@ Now that you have access to the circuit board, you can unplug the screen.
![Pull PCB by its micro-USB port](/assets/images/disassembly/IMG_8943.jpg){.step-thumb}
![Pull PCB by its micro-USB port](/assets/images/disassembly/IMG_8902.jpg){.step-thumb}
By grabbing it **by the hinge side**, gently pull up the circuit board from the plastic casing.
By grabbing it **by the hinge side**, gently pull up the circuit board
from the plastic casing.
### **STEP 8 - Removing the buttons you wish to change** {.step-title}
![Remove buttons](/assets/images/disassembly/IMG_8934.jpg){.step-thumb}
![Remove buttons](/assets/images/disassembly/IMG_8905.jpg){.step-thumb}
Remove the buttons from their socket. It is recommended to use tweezers.
Remove the buttons from their socket. It is recommended to use
tweezers.
### **STEP 9 - Separating the new buttons** {.step-title}
@@ -92,11 +117,17 @@ Remove the buttons from their socket. It is recommended to use tweezers.
![Cut buttons](/assets/images/disassembly/IMG_8923.jpg){.step-thumb}
![Cut buttons](/assets/images/disassembly/IMG_8929.jpg){.step-thumb}
Cut up the buttons from the four sets of colors included with your FunKey S.
Cut up the buttons from the four sets of colors included with your
FunKey S.
In this exemple one of the A/B/X/Y button is cut from each color.
!!! warning
When replacing a specific button, for example the top arrow, you need to get the same exact button (top arrow). For example a left arrow should not replace a top arrow or the console might not close properly when reassembling it.
When replacing a specific button, for example the top arrow, you
need to get the same exact button (top arrow). For example a left
arrow should not replace a top arrow or the console might not
close properly when reassembling it.
### **STEP 10 - Assembling the new buttons** {.step-title}
@@ -115,13 +146,14 @@ Reassemble the new cut buttons in their hole.
Insert first the speaker into its location in the casing before
putting the circuit board back in the case, like in the pictures.
Reassemble the console by following the previous steps in reverse order.
Reassemble the console by following the previous steps in reverse
order.
!!! warning
Be careful not to damage the switches on the circuit board when
putting back the L/R plastic buttons.
--8<--
includes/glossary.md
--8<--
--8<--

10
docs/user_manual/tutorials/hardware/flash_change_sd_card.md
View File

@@ -60,9 +60,10 @@ Using a standard **Phillips PH0 screwdriver**, remove the 2 screws on
the back of your FunKey S.
!!! warning
Be careful to use the correct screwdriver head size and type to
prevent damaging the screws (do not use JIS screwdrivers!).
FunKey Project is not responsible for replacing damaged screws.
Be careful to use the correct screwdriver head size and type to
prevent damaging the screws (do not use JIS screwdrivers!).
FunKey Project is not responsible for replacing damaged screws.
### **STEP 2 - Opening up the console** {.step-title}
![Pull up hinge first](/assets/images/disassembly/IMG_8848.jpg){.step-thumb}
@@ -76,6 +77,7 @@ Carefully remove:
2. The keychain lanyard and axis
!!! warning
Be careful not to damage the L/R switches on the circuit board!
### **STEP 3 - Exposing the circuit board** {.step-title}
@@ -102,6 +104,7 @@ the new one (previously flashed as described [in the 1st part of this
tutorial][4]).
!!! note
You may need to use some tweezers and pull with some strength in
order to remove the micro-SD card from its socket, as it is
strongly inserted to prevent loose connections.
@@ -116,6 +119,7 @@ putting the circuit board back in the case, like in the pictures.
Reassemble the console by following the previous steps in reverse order.
!!! warning
Be careful not to damage the switches on the circuit board when
putting back the L/R plastic buttons.

58
docs/user_manual/tutorials/hardware/teardown.md
View File

@@ -3,7 +3,9 @@ pretty straightforward. It only require a standard **Phillips
screwdriver (PH0)** and **tweezers**.
!!! note
FunKey Project is not responsible for any damage done to your console during a teardown.
FunKey Project is not responsible for any damage done to your
console during a teardown.
### **STEP 1 - Removing the screws** {.step-title}
@@ -15,16 +17,18 @@ Using a standard **Phillips PH0 screwdriver**, remove the 2 screws on
the back of your FunKey S.
!!! warning
Be careful to use the correct screwdriver head size and type to
prevent damaging the screws (do not use JIS screwdrivers).
FunKey Project is not responsible for replacing damaged screws.
Be careful to use the correct screwdriver head size and type to
prevent damaging the screws (do not use JIS screwdrivers). FunKey
Project is not responsible for replacing damaged screws.
### **STEP 2 - Opening up the console** {.step-title}
![Pull up hinge first](/assets/images/disassembly/IMG_8848.jpg){.step-thumb}
![Console opened](/assets/images/disassembly/IMG_8989.jpg){.step-thumb}
Carefully remove the plastic back of the console by pulling up the hinge side first
Carefully remove the plastic back of the console by pulling up the
hinge side first
### **STEP 3 - Removing the keychain lanyard** {.step-title}
@@ -32,9 +36,11 @@ Carefully remove the plastic back of the console by pulling up the hinge side fi
![Console opened](/assets/images/disassembly/IMG_8993.jpg){.step-thumb}
![Pull up the plastic buttons](/assets/images/disassembly/IMG_8896.jpg){.step-thumb}
Carefully remove the keychain lanyard and its axis by pulling gently (it may fall off when opening).
Carefully remove the keychain lanyard and its axis by pulling gently
(it may fall off when opening).
!!! warning
The axis is a small part, be careful not to loose it.
### **STEP 4 - Removing the LR buttons** {.step-title}
@@ -43,7 +49,8 @@ Carefully remove the keychain lanyard and its axis by pulling gently (it may fal
![Pull up the plastic buttons](/assets/images/disassembly/IMG_8844.jpg){.step-thumb}
![Pull up the plastic buttons](/assets/images/disassembly/IMG_8900.jpg){.step-thumb}
Carefully remove the L/R plastic buttons by gently pulling them out of their axis
Carefully remove the L/R plastic buttons by gently pulling them out of
their axis.
!!! warning
Be careful not to damage the L/R switches on the circuit board!
@@ -54,10 +61,15 @@ Carefully remove the L/R plastic buttons by gently pulling them out of their axi
![Get the battery out of the way](/assets/images/disassembly/IMG_8828.jpg){.step-thumb}
![Get the battery out of the way](/assets/images/disassembly/IMG_8986_arrow.jpg){.step-thumb}
Lift the battery and pull gently by the top of the circuit board to unplug the battery. The battery may be stuck to the processor with double-sided adhesive, it's perfectly normal if you have to lift with a bit of force to unstick it.
Lift the battery and pull gently by the top of the circuit board to
unplug the battery. The battery may be stuck to the processor with
double-sided adhesive, it's perfectly normal if you have to lift with
a bit of force to unstick it.
!!! warning
Be sure to pull on the connector and **NOT the wires** when removing the battery. It is recommended to use tweezers.
Be sure to pull on the connector and **NOT the wires** when
removing the battery. It is recommended to use tweezers.
### **STEP 6 - Unplugging the screen** {.step-title}
@@ -65,9 +77,13 @@ Lift the battery and pull gently by the top of the circuit board to unplug the b
![Pull PCB by its micro-USB port](/assets/images/disassembly/IMG_8963.jpg){.step-thumb}
![Pull PCB by its micro-USB port](/assets/images/disassembly/IMG_8938.jpg){.step-thumb}
Now that you have access to the circuit board, you can unplug the screen.
Now that you have access to the circuit board, you can unplug the
screen.
!!! warning
This connector is fragile, unplug it vertically without force. It is recommended to use tweezers.
This connector is fragile, unplug it vertically without force. It
is recommended to use tweezers.
### **STEP 7 - Removing the circuit board** {.step-title}
@@ -75,7 +91,8 @@ Now that you have access to the circuit board, you can unplug the screen.
![Pull PCB by its micro-USB port](/assets/images/disassembly/IMG_8943.jpg){.step-thumb}
![Pull PCB by its micro-USB port](/assets/images/disassembly/IMG_8902.jpg){.step-thumb}
By grabbing it **by the hinge side**, gently pull up the circuit board from the plastic casing.
By grabbing it **by the hinge side**, gently pull up the circuit board
from the plastic casing.
### **STEP 8 - Removing the micro-SD card** {.step-title}
@@ -85,11 +102,17 @@ By grabbing it **by the hinge side**, gently pull up the circuit board from the
Remove the micro-SD card from its socket.
!!! note
You may need to use some tweezers and pull with some strength in
order to remove the micro-SD card from its socket, as it is
strongly inserted to prevent loose connections.
!!! warning
During this step be very careful not to damage the L/R switches. Never put the PCB on a flat surface (this would apply force on the LR switches) and do not grab the PCB by these switches.
During this step be very careful not to damage the L/R
switches. Never put the PCB on a flat surface (this would apply
force on the LR switches) and do not grab the PCB by these
switches.
### **STEP 9 - Removing the buttons** {.step-title}
@@ -97,14 +120,15 @@ Remove the micro-SD card from its socket.
![Insert the new micro-SD](/assets/images/disassembly/IMG_8905.jpg){.step-thumb}
![Insert the new micro-SD](/assets/images/disassembly/IMG_8933.jpg){.step-thumb}
Remove the buttons from their socket. It is recommended to use tweezers.
Remove the buttons from their socket. It is recommended to use
tweezers.
### **STEP 10 - Teardown complete** {.step-title}
![Remove the micro-SD](/assets/images/disassembly/IMG_8975.jpg){.step-thumb}
![Insert the new micro-SD](/assets/images/disassembly/IMG_8983.jpg){.step-thumb}
Good job the teardown is complete.
Good job the teardown is complete!
### **STEP 11 - Reassembly** {.step-title}
@@ -117,10 +141,10 @@ putting the circuit board back in the case, like in the pictures.
Reassemble the console by following the previous steps in reverse order.
!!! warning
Be careful not to damage the switches on the circuit board when
putting back the L/R plastic buttons.
--8<--
includes/glossary.md
--8<--
--8<--