denki-kurage - GitLite

KO | EN

gitlite — search

#hacktoberfest #typescript #machine-learning #rust #deep-learning #docker #macos #awesome #cli #kubernetes #awesome-list #ios #openai #open-source

denki-kurage

(★ 91)

A sort of an artificial jellyfish on CYD (Cheap Yellow Display, ESP32).

File Explorer

Download Latest Version (.zip)

- - build-deploy-pages.yml
- denki-kurage.png
- denki_kurage_back.jpg
- denki_kurage_front_3.jpg
- denki_kurage_ops_4x3.jpg
- denki_kurage_side.jpg
- - dk_stand_bottom.jpg
  - dk_stand_thumb.png
  - models.png
- - BOSL2
  - denki-kurage.svg
  - dk.scad
- dk_stand.3mf
- dk_stand.scad
- dk_stand.stl
- Makefile
- README.md
- README
- README
- config.h
- input_handler.cpp
- input_handler.h
- jellyfish.cpp
- jellyfish.h
- main.cpp
- math_3d.cpp
- math_3d.h
- types.h
- README
- - manifest.json
- - manifest.json
- cover.jpg
- denki-kurage.png
- favicon.svg
- index.html
.gitignore
.gitmodules
LICENSE
platformio.ini
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<video src="https://github.com/user-attachments/assets/62c911e7-4eb1-4285-9e28-48d6acbe1837" height="300px" autoplay loop muted playsinline></video>

# <img src="./assets/denki-kurage.png" height="32px"> Denki Kurage

`Denki Kurage` (ja: 電気くらげ, electric jellyfish)

A sort of an artificial jellyfish on CYD (Cheap Yellow Display, ESP32).

- Retro, low-poly 3D jellyfish animation for the CYD, an ESP32 development board with an integrated screen.
- Touch the screen to change color modes or adjust the water current speed.
- Customizable enclosure designed with OpenSCAD.
- **Just watch the jellyfish swimming and chill.**

_This project is currently only for the CYD2USB (CYD variants with a USB-C port)._

## BOM

| Component                        | Quantity | Notes                                                  |
| :------------------------------- | :------- | :----------------------------------------------------- |
| ESP32-2432S028 (CYD2USB variant) | 1        | 2.8" TFT "Cheap Yellow Display" with USB-C + Micro USB |
| M2x3 Self-Tapping screw          | 4        |                                                        |

## Getting Started

1. Print the enclosure: Use the 3MF files in [`./enclosure`](./enclosure) to 3D print the stand.
2. Flash the firmware: Use the [Web Flasher](https://likeablob.github.io/denki-kurage/) to flash the latest firmware directly from your browser.
3. Assemble: Put the CYD into the enclosure and secure it with four M2x3 self-tapping screws.

## 3D Printed Parts

For .3mf and .scad files, see [`./enclosure`](./enclosure).

<img src="./enclosure/images/dk_stand_bottom.jpg" height="150px">

## Controls (Touch)

<video src="https://github.com/user-attachments/assets/3129b887-57ab-4135-a686-5584df11771e" height="300px" autoplay loop muted playsinline></video>

| Area                                 | Action             |
| :----------------------------------- | :----------------- |
| Top / Bottom strip (Left side)       | **Move Up / Down** |
| Middle left / Middle right           | **Rotate Camera**  |
| Center area                          | **Cycle Colors**   |
| Top-right corner (Solid / Wireframe) | **Toggle Mode**    |
| Bottom-right corner                  | **Debug Info**     |

## Building from source

Built and flashed using [PlatformIO](https://platformio.org/).

```bash
pio run -t upload
```

## Gallery

<div>
<img src="https://github.com/user-attachments/assets/675966a4-f1ad-4030-b379-b8d63ea308b7" height="300px">
<img src="./assets/denki_kurage_front_3.jpg" height="300px">
<img src="./assets/denki_kurage_side.jpg" height="300px">
<img src="./assets/denki_kurage_back.jpg" height="300px">
<video src="https://github.com/user-attachments/assets/8bef5e71-7549-4883-ab79-739655af0c46" height="300px" autoplay loop muted playsinline></video>
</div>

## Acknowledgements

- [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI) by Bodmer
- [XPT2046_Touchscreen](https://github.com/PaulStoffregen/XPT2046_Touchscreen) by Paul Stoffregen
- [ESP32-Cheap-Yellow-Display](https://github.com/witnessmenow/ESP32-Cheap-Yellow-Display) by Witnessmenow
- [BOSL2](https://github.com/BelfrySCAD/BOSL2) library for enclosure design
- [M+ FONTS](https://mplusfonts.github.io/) for typography
- [人工くらげ](https://jnc-klg.sakura.ne.jp/) for the inspiration
- A reference to Philip K. Dick's [Electric Sheep](https://en.wikipedia.org/wiki/Do_Androids_Dream_of_Electric_Sheep%3F) (ja: 電気羊)

## License

- **Software**: MIT
- **Font (M+ FONTS)**: [SIL Open Font License](https://scripts.sil.org/OFL). M+ FONTS are free to use, modify, and redistribute.