Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ClusterM authored Jun 1, 2023
1 parent 7833951 commit e321c40
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You'll need a few low-cost components.
### Components
1. **PCB**

TODO: add PCB photo
![image](https://github.com/ClusterM/fdskey/assets/4236181/476d0b8a-ceb0-43a4-9af6-49b70bd346fb)

The PCB is designed in the [DipTrace](https://diptrace.com/) software.

Expand All @@ -51,6 +51,12 @@ You can easily find it on [mouser.com](https://www.mouser.com/c/?q=STM32G0B0CET)

It's a very popular OLED display, search for **SSD1306 0.91-inch OLED 128x32 4-pin** on [aliexpress.com](https://aliexpress.com), [ebay.com](https://ebay.com), [amazon.com](https://amazon.com) or [taobao.com](https://taobao.com). These displays are available in different colors: blue, white and yellow, you can select the one you prefer.

Solder it like this:

![image](https://github.com/ClusterM/fdskey/assets/4236181/838d6eda-314d-4413-b7a4-7afc750db767)

It's recommended to put something soft under the display on the right side.

**WARNING**: some unscrupulous sellers may sell you used, burned-in displays.

4. **microSD card socket (push-push, 8-pin + card detect pin = 9-pin)**
Expand Down Expand Up @@ -92,6 +98,12 @@ You can print plastic case with a 3D printer. You can find .stl files in the [ca
* [For FDM 3D printers](case_3d_models/fdm) - can be printed on a affordable home 3D printer, the bottom and top parts of the case must be glued together
* [For MJF 3D printers](case_3d_models/mjf) (recommended) - for industrial 3D printing, you can order it from a manufacturing service (e.g. [jlcpcb.com](https://jlcpcb.com)), this version features latches

![image](https://github.com/ClusterM/fdskey/assets/4236181/63e137a9-f813-465d-b8eb-892db9b8c92a)

What does it look like when everything is assembled:
![image](https://github.com/ClusterM/fdskey/assets/4236181/89b203e7-0c53-416a-bfa9-5ffd49e8fffc)


## Flashing the firmware
There are five TH pads (actually 6 but 1 is unused) on the PCB to connect a ST-Link programmer (GND, VCC, SWD, SWCLK and NRST). First, you need to write the bootloader - **bootloader.bin** file. Then you can put the main firmware file - **fdskey.bin** on your SD card (FAT/FAT32/exFAT formatted) and hold all four buttons on power-on, e.g. connect FDSKey to RAM adaptor, hold buttons and turn a Famicom on. You can use the same method to update the main firmware in the future without additional hardware.

Expand Down Expand Up @@ -145,6 +157,13 @@ This is a reverse operation of dumping: you can use disk copiers homebrew applic
5. Disconnect a physical FDS drive and connect FDSKey
6. Repeat steps 3, 4, and 5 until the copy operation is completed

## Firmware updates
You can always download the latest version at https://github.com/ClusterM/fdskey/releases.

Also, you can download automatic interim builds at http://clusterm.github.io/fdskey/.

Remember, you can update the firmware by putting **fdskey.bin** on your SD card and holding all four buttons on power-on.

## Donate
* PayPal: cluster@cluster.wtf
* [Donation Alerts](https://www.donationalerts.com/r/clustermeerkat)
Expand Down

0 comments on commit e321c40

Please sign in to comment.