Skip to content

Commit

Permalink
📝 docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Cp0204 committed Jul 14, 2024
1 parent 1c865a4 commit 2dd162b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ CubeFX is a **third-party** open-source lighting control system designed for the

### Method 1: OTA Update

* Download the `CubeFX_ota_xxx.bin` firmware from the [Releases](/releases) page
* Download the `CubeFX_ota_xxx.bin` firmware from the [Releases](https://github.com/Cp0204/CubeFX/releases/latest) page
* Connect to the `ZimaCube` hotspot, the default password is `homecloud`
* Visit http://172.16.1.1 in your browser
* Upload the `.bin` file to the ESP32-C3 development board
Expand All @@ -35,7 +35,9 @@ CubeFX is a **third-party** open-source lighting control system designed for the

### Customizing LED Colors

Connect to the hotspot and send a POST request to http://172.16.1.1/post with the following data format:
Connect to the hotspot and open http://172.16.1.1/post

Or use other software to POST data to `http://172.16.1.1/post` in the following format:

```json
{
Expand All @@ -60,7 +62,7 @@ Connect to the hotspot and send a POST request to http://172.16.1.1/post with th
```

* **on:** Light switch, optional, [0,1]
* **id:** Lighting effect, currently valid range is [-74,5]
* **id:** Lighting effect, currently valid range is [-71,5]
* **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
8 changes: 5 additions & 3 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ CubeFX 是一个为 ZimaCube 设计的**第三方**开源灯光控制系统,

### 方式一:OTA更新

*[Releases](/releases) 页面下载 `CubeFX_ota_xxx.bin` 固件
*[Releases](https://github.com/Cp0204/CubeFX/releases/latest) 页面下载 `CubeFX_ota_xxx.bin` 固件
* 连接 `ZimaCube` 热点,默认密码 `homecloud`
* 浏览器访问 http://172.16.1.1
*`.bin` 文件上传到 ESP32-C3 开发板
Expand All @@ -35,7 +35,9 @@ CubeFX 是一个为 ZimaCube 设计的**第三方**开源灯光控制系统,

### 自定义灯珠颜色

连接热点 POST 数据到 http://172.16.1.1/post ,数据格式如下:
连接热点打开 http://172.16.1.1/post

或使用其它软件 POST 数据到 `http://172.16.1.1/post` ,数据格式如下:

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

* **on:** 灯光开关,可选,[0,1]
* **id:** 灯光效果,目前的有效范围是 [-74,5]
* **id:** 灯光效果,目前的有效范围是 [-71,5]
* **speed:** 效果速度,范围 [0,255]
* **lightness:** 亮度,范围 [0,255]
* **data:** 支持 RGB, HSV, HEX 三种颜色提交格式,其中 HEX 为 6 位十六进制颜色值。HSV 计划淘汰,请使用 RGB 或 HEX 格式。
Expand Down

0 comments on commit 2dd162b

Please sign in to comment.