Skip to content

Commit

Permalink
Update README to include link to Whale microcontroller
Browse files Browse the repository at this point in the history
  • Loading branch information
@staticintlucas
staticintlucas committed May 15, 2022
1 parent 488fa66 commit 2be9e98
Showing 1 changed file with 56 additions and 83 deletions.
139 changes: 56 additions & 83 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,15 @@

# Goldfish

Goldfish is a Pro Micro compatible board designed for use in mechanical keyboards.
It is based on the same ATMega32U4 chip and is programmable using the Arduino IDE or a keyboard specific firmware such as TMK or QMK.

*Of course it is perfectly usable for any other electronics projects as well.*

Goldfish is a Pro Micro compatible board designed for use in mechanical keyboards. It is based on the same ATMega32U4 chip and is programmable using the Arduino IDE or a keyboard specific firmware such as TMK or QMK. Of course it is perfectly usable for any other electronics projects too, not just keyboards.

![Preview]

## Links

---
- [PCB Source Files]

**⸢ [PCB] ⸥ ⸢ [Schematic] ⸥**

---
- [Schematic]

## Advantages

Expand All @@ -25,121 +20,99 @@ It is based on the same ATMega32U4 chip and is programmable using the Arduino ID
- Pin-compatible with the original Pro Micro.
- Sturdier through-hole USB connector.

---

## Disadvantages

- Less choice for custom cables for USB-C compared to Mini-B / Micro-B.
- More expensive, depending on order quantity.
- No onboard RX, TX, LEDs.
- No onboard Voltage Regulator
This is irrelevant for keyboards.
External power supplies of > 5.5V require one.


---
- No onboard Voltage Regulator (this makes no difference for keyboards; a regulator is only required when power supplies of over 5.5V are used)

## Known Issues

- `Rev 0` | `Rev A`:

**Fixed:** `Rev B`

Same problem as the **[Green Pro Micro]**,
making it unsuitable for `Split Keyboards`.
#### VBUS connected to VCC — fixed in Rev. B
- Similar problem as the [Green Pro Micro clone] making it unsuitable for certain split keyboards. \
- Applies to Rev. 0 and Rev. A

## Changelog

---
#### Rev C

## Vendors
- Changed layout of the bottom edge pins to match the Elite-C.

**Selling Goldfish**
#### Rev B

- `Rev C` \| Available on **[BeeKeeb]**.
- Fixed split keyboard issue.
- Tidied up parts of the layout, including the removal of signal lines from under the crystal.

- `Comet` \| Modified design \| Available on **[Tokas' Kable Works]**.
#### Rev A

*Please let me know if any are missing from this list.*
- Changed the footprint of C6 from 0402 to 0603 to reduce component cost by a few cent.

### Note
#### Rev 0

These products are sold by **3rd Party Vendors**
and are not 'officially' endorsed by me.
- Initial Design.

*I'm simply listing them here for convenience.*
## Vendors Selling Goldfish

---
#### Rev. C

## License
- [BeeKeeb]

**[Creative Commons Attribution Share-Alike 4.0 License][License]**.
#### Comet (modified design based on Goldfish; see related projects)

- [Tokas' Kable Works]

**-** Original `Arduino Mini` design by **Team Arduino**.
**-** Arduino `Pro Mini` design by **Spark Fun Electronics**.
**-** `Pro Micro` design by **Spark Fun Electronics**.
**-** `Goldfish` design by **Dr Derivative**.
**Note:** These products are sold by 3rd party vendors and are not 'officially' endorsed by me. I'm simply listing them here for convenience.

---
*(Also please let me know if anything is missing from this list)*

## Related Projects

- **[Alvaro]** by **Ariamelon**
A modified goldfish using `0603` components instead of `0402`.
#### [Alvaro] by Ariamelon

- **[Comet]** by **Tokas**
A modified goldfish using a different `USB-C` connector.
- A modified Goldfish using 0603 components instead of 0402.

- **[Goldfish-clone-JLCPCB]** by **Jeremy J Starcher**
A modified goldfish designed to meet **JLCPCB**'s assembly requirements.
#### [Comet] by Tokas

* **[Elite-C]** from `keeb.io`
An unrelated and ***closed source*** project with similar design goals.
- A modified Goldfish using a HRO TYPE-C-31-M-12 connector.

#### [Whale] by Jia Geng Chang

- A modified Goldfish using a Jing 918-418K2024S40000 connector.

*Be sure to let me know if anything is missing form this list.*
#### [Goldfish-clone-JLCPCB] by Jeremy J Starcher

---
- A modified Goldfish designed to meet JLCPCB's assembly requirements.

## Changelog

#### Rev C
#### [Elite-C] from keeb.io

Changed layout of the bottom edge pins to match the `Elite-C`.
- An unrelated and closed source project with similar design goals.

#### Rev B

Fixed split keyboard issue.

Tidied up parts of the layout, including the
removal of signal lines from under the crystal.

#### Rev A

Changed the footprint of `C6` from `0402` to
`0603` to reduce component cost by a few cent.

#### Rev 0

Initial Design.
*(Please let me know if anything is missing form this list)*

## License

Released under the Creative Commons Attribution Share-Alike 4.0 License.
https://creativecommons.org/licenses/by-sa/4.0/

<!----------------------------------------------------------------------------->
Original Arduino Mini Design by Team Arduino.
Arduino Pro Mini Design by Spark Fun Electronics.
Pro Micro Design by Spark Fun Electronics.
Goldfish Design by Lucas Jansen.

[Schematic]: docs/schematic.pdf
[Preview]: docs/preview.png
[PCB]: cad
<!-- Links -->

[Green Pro Micro]: http://www.40percent.club/2017/09/green-pro-micro.html
[License]: https://creativecommons.org/licenses/by-sa/4.0/
[schematic]: docs/schematic.pdf
[preview]: docs/preview.png
[pcb source files]: cad

[Alvaro]: https://github.com/Ariamelon/Alvaro
[Comet]: https://github.com/vattern/comet
[Elite-C]: https://keeb.io/products/elite-c-low-profile-version-usb-c-pro-micro-replacement-atmega32u4
[Goldfish-clone-JLCPCB]: https://github.com/JeremyJStarcher/Goldfish-clone-JLCPCB
[green pro micro clone]: http://www.40percent.club/2017/09/green-pro-micro.html

<!---------------------------------{ Vendors }--------------------------------->
[beekeeb]: https://shop.beekeeb.com/product/goldfish-rev-c-open-source-pro-micro-replacement/
[tokas' kable works]: https://shop.tokas.co.uk/product/comet-usb-c-microcontroller/

[BeeKeeb]: https://shop.beekeeb.com/product/goldfish-rev-c-open-source-pro-micro-replacement/
[Tokas' Kable Works]: https://shop.tokas.co.uk/product/comet-usb-c-microcontroller/
[alvaro]: https://github.com/Ariamelon/Alvaro
[comet]: https://github.com/vattern/comet
[whale]: https://github.com/JiaGengChang/Whale
[elite-c]: https://keeb.io/products/elite-c-low-profile-version-usb-c-pro-micro-replacement-atmega32u4
[goldfish-clone-jlcpcb]: https://github.com/JeremyJStarcher/Goldfish-clone-JLCPCB

0 comments on commit 2be9e98

Please sign in to comment.