Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cp0204/cubefx
A better ZimaCube light strip system.
https://github.com/cp0204/cubefx
arduino esp32 esp32c3 esp32c3-super-mini ws2812 zimacube zimaos
Last synced: 3 months ago
JSON representation
A better ZimaCube light strip system.
- Host: GitHub
- URL: https://github.com/cp0204/cubefx
- Owner: Cp0204
- License: apache-2.0
- Created: 2024-07-10T09:25:17.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-31T11:28:46.000Z (5 months ago)
- Last Synced: 2024-10-10T14:01:26.311Z (3 months ago)
- Topics: arduino, esp32, esp32c3, esp32c3-super-mini, ws2812, zimacube, zimaos
- Language: C++
- Homepage: https://play.cuse.eu.org/cubefx
- Size: 667 KB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CubeFX
Inject Colorful lighting into your ZimaCube!
CubeFX is a **third-party open-source lighting control system** designed for the ZimaCube, based on the ESP32-C3 and WS2812B LED strips. It allows you to customize lighting effects, colors, and speed, and control them through a web page or buttons.
[](https://github.com/Cp0204/CubeFX/releases/latest) [](https://github.com/Cp0204/CubeFX/blob/main/LICENSE)
[](https://www.youtube.com/watch?v=K5UVmzoG0bY)
[Learn more](https://icewhale.community/t/unleash-the-zimacube-introducing-cubefx-the-open-source-led-strip-firmware/3372)
## Features
* [x] **Multiple Lighting Effects:** Built-in various lighting effects with support for custom effects
* [x] **Control Interface:** Easy control through a web page
* [x] **AP Toggle:** Ability to turn off the WiFi AP and reopen it with a button or power cycle
* [x] **OTA Update Support:** Update firmware wirelessly without disassembly
* [x] **Multiple Color Formats:** Compatible with RGB, HSV, and HEX color input formats
* [x] **Power-off Memory:** Automatically saves lighting settings to EEPROM, preserving them after power loss
* [ ] ~~**ZimaOS Protocol Compatibility:** Controllable lighting effects using ZimaOS (awaiting official documentation)~~
## Usage
### Method 1: OTA Update
* Download the `CubeFX_ota_xxx.bin` firmware from the [Releases](https://github.com/Cp0204/CubeFX/releases/latest) page
* Connect to the `ZimaCube` AP, the default password is `homecloud`
* Visit http://172.16.1.1 in your browser
* Upload the `.bin` file to the ESP32-C3 development board
### Method 2: Web Flashing
* Open the [CubeFX installer](https://play.cuse.eu.org/cubefx)
* Connect the ESP32-C3 using a Type-C data cable
* Follow the instructions to update the firmware
### Customizing Effects
Connect to the AP and open http://172.16.1.1/post
> [!TIP]
>
> It is recommended to use a cell phone to connect as close as possible to the 7th-Bay, because its signal is really weak.
>
> If you just can't connect, you can also press **BOOT** key to "touch the blind box" and get a random set of effects. 🎲🎊
Or use other program to **POST** data to `http://172.16.1.1/post` in the following format:
```json
{
"on": 1,
"id": 5,
"speed": 128,
"lightness": 255,
"data": [
{
"h": 0,
"s": 100,
"v": 100
},
{
"r": 0,
"g": 255,
"b": 0
},
"0000FF"
]
}
```
* **on:** Light switch, optional, [0,1]
* **id:** Lighting effect, currently valid range is [-71,5]. Each bead color can be customized when id=5, other effects allow a base color to be defined (but not every effect is supported).
* **speed:** Effect speed, range [0,255]
* **lightness:** Brightness, range [0,255]
* **data:** Supports RGB, HSV, and HEX color input formats, where HEX is a 6-digit hexadecimal color value. HSV format is planned for deprecation, please use RGB or HEX format.
## Donate
Enjoyed the project? Consider buying me a coffee - it helps me keep going!
## Thank
- [kitesurfer1404/WS2812FX](https://github.com/kitesurfer1404/WS2812FX)
- [IceWhaleTech](https://github.com/IceWhaleTech)