{"id":14963374,"url":"https://github.com/cp0204/cubefx","last_synced_at":"2025-10-25T02:30:29.604Z","repository":{"id":249658177,"uuid":"826737504","full_name":"Cp0204/CubeFX","owner":"Cp0204","description":"A better ZimaCube light strip system.","archived":false,"fork":false,"pushed_at":"2024-07-31T11:28:46.000Z","size":683,"stargazers_count":15,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-31T04:51:30.592Z","etag":null,"topics":["arduino","esp32","esp32c3","esp32c3-super-mini","ws2812","zimacube","zimaos"],"latest_commit_sha":null,"homepage":"https://play.cuse.eu.org/cubefx","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cp0204.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-10T09:25:17.000Z","updated_at":"2025-01-30T07:03:39.000Z","dependencies_parsed_at":"2024-09-13T19:13:38.668Z","dependency_job_id":"e19ff6cf-7574-4cfa-afad-45efad990015","html_url":"https://github.com/Cp0204/CubeFX","commit_stats":{"total_commits":43,"total_committers":1,"mean_commits":43.0,"dds":0.0,"last_synced_commit":"dd5ac392c0e8b472220d65f762746f934e798a80"},"previous_names":["cp0204/cubefx"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cp0204%2FCubeFX","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cp0204%2FCubeFX/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cp0204%2FCubeFX/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cp0204%2FCubeFX/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cp0204","download_url":"https://codeload.github.com/Cp0204/CubeFX/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238059129,"owners_count":19409601,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arduino","esp32","esp32c3","esp32c3-super-mini","ws2812","zimacube","zimaos"],"created_at":"2024-09-24T13:31:25.258Z","updated_at":"2025-10-25T02:30:29.227Z","avatar_url":"https://github.com/Cp0204.png","language":"C++","funding_links":["https://buymeacoffee.com/cp0204"],"categories":[],"sub_categories":[],"readme":"# CubeFX\n\nInject Colorful lighting into your ZimaCube!\n\nCubeFX 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.\n\n[![GitHub release](https://img.shields.io/github/v/release/Cp0204/CubeFX.svg)](https://github.com/Cp0204/CubeFX/releases/latest) [![GitHub license](https://img.shields.io/github/license/Cp0204/CubeFX.svg)](https://github.com/Cp0204/CubeFX/blob/main/LICENSE)\n\n[![Demo](https://img.youtube.com/vi/K5UVmzoG0bY/mqdefault.jpg)](https://www.youtube.com/watch?v=K5UVmzoG0bY)\n\n[Learn more](https://icewhale.community/t/unleash-the-zimacube-introducing-cubefx-the-open-source-led-strip-firmware/3372)\n\n## Features\n\n* [x] **Multiple Lighting Effects:** Built-in various lighting effects with support for custom effects\n* [x] **Control Interface:** Easy control through a web page\n* [x] **AP Toggle:** Ability to turn off the WiFi AP and reopen it with a button or power cycle\n* [x] **OTA Update Support:** Update firmware wirelessly without disassembly\n* [x] **Multiple Color Formats:** Compatible with RGB, HSV, and HEX color input formats\n* [x] **Power-off Memory:** Automatically saves lighting settings to EEPROM, preserving them after power loss\n* [ ] ~~**ZimaOS Protocol Compatibility:** Controllable lighting effects using ZimaOS (awaiting official documentation)~~\n\n## Usage\n\n### Method 1: OTA Update\n\n* Download the `CubeFX_ota_xxx.bin` firmware from the [Releases](https://github.com/Cp0204/CubeFX/releases/latest) page\n* Connect to the `ZimaCube` AP, the default password is `homecloud`\n* Visit http://172.16.1.1 in your browser\n* Upload the `.bin` file to the ESP32-C3 development board\n\n### Method 2: Web Flashing\n\n* Open the [CubeFX installer](https://play.cuse.eu.org/cubefx)\n* Connect the ESP32-C3 using a Type-C data cable\n* Follow the instructions to update the firmware\n\n\n### Customizing Effects\n\nConnect to the AP and open http://172.16.1.1/post\n\n\u003e [!TIP]\n\u003e\n\u003e It is recommended to use a cell phone to connect as close as possible to the 7th-Bay, because its signal is really weak.\n\u003e\n\u003e If you just can't connect, you can also press **BOOT** key to \"touch the blind box\" and get a random set of effects. 🎲🎊\n\nOr use other program to **POST** data to `http://172.16.1.1/post` in the following format:\n\n```json\n{\n    \"on\": 1,\n    \"id\": 5,\n    \"speed\": 128,\n    \"lightness\": 255,\n    \"data\": [\n        {\n            \"h\": 0,\n            \"s\": 100,\n            \"v\": 100\n        },\n        {\n            \"r\": 0,\n            \"g\": 255,\n            \"b\": 0\n        },\n        \"0000FF\"\n    ]\n}\n```\n\n* **on:** Light switch, optional, [0,1]\n* **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).\n* **speed:** Effect speed, range [0,255]\n* **lightness:** Brightness, range [0,255]\n* **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.\n\n## Donate\n\nEnjoyed the project? Consider buying me a coffee - it helps me keep going!\n\n\u003ca href=\"https://buymeacoffee.com/cp0204\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png\" height=\"50\" width=\"210\" target=\"_blank\"/\u003e\u003c/a\u003e\n\n\n## Thank\n\n- [kitesurfer1404/WS2812FX](https://github.com/kitesurfer1404/WS2812FX)\n- [IceWhaleTech](https://github.com/IceWhaleTech)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcp0204%2Fcubefx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcp0204%2Fcubefx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcp0204%2Fcubefx/lists"}