Skip to content

Commit

Permalink
📝 docs: Update README
Browse files Browse the repository at this point in the history
- Update the description of the "id" parameter in the POST request format.
- Add a tip about using the BOOT key to get random effects.
  • Loading branch information
Cp0204 committed Jul 22, 2024
1 parent cb9cfda commit df4bdd9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,15 @@ CubeFX is a **third-party open-source lighting control system** designed for the
* Follow the instructions to update the firmware


### Customizing LED Colors
### 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:

Expand All @@ -68,7 +71,7 @@ Or use other program to **POST** data to `http://172.16.1.1/post` in the followi
```

* **on:** Light switch, optional, [0,1]
* **id:** Lighting effect, currently valid range is [-71,5]
* **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.
Expand Down
7 changes: 5 additions & 2 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,15 @@ CubeFX 是一个为 ZimaCube 设计的**第三方开源灯光控制系统**,
* 根据引导进行固件更新


### 自定义灯珠颜色
### 自定义效果

连接热点打开 http://172.16.1.1/post

> [!TIP]
>
> 建议用手机尽量靠近第七盘连接,因为它的信号相当弱。
>
> 如果你实在没法连接,你也可以按 BOOT 键摸盲盒,随机得到一组效果。🎲🎊
或使用其它程序 **POST** 数据到 `http://172.16.1.1/post` ,数据格式如下:

Expand All @@ -68,7 +71,7 @@ CubeFX 是一个为 ZimaCube 设计的**第三方开源灯光控制系统**,
```

* **on:** 灯光开关,可选,[0,1]
* **id:** 灯光效果,目前的有效范围是 [-71,5]
* **id:** 灯光效果,目前的有效范围是 [-71,5] 。当 id=5 时可以自定义每个灯珠颜色,其它效果允许定义一个基础颜色(但并非每个效果都支持)。
* **speed:** 效果速度,范围 [0,255]
* **lightness:** 亮度,范围 [0,255]
* **data:** 支持 RGB, HSV, HEX 三种颜色提交格式,其中 HEX 为 6 位十六进制颜色值。HSV 计划淘汰,请使用 RGB 或 HEX 格式。
Expand Down

0 comments on commit df4bdd9

Please sign in to comment.