Pixoo REST API 使用教程

Pixoo REST API 使用教程

1. 项目介绍

Pixoo REST API 是一个用于与 Wi-Fi 启用的 Divoom Pixoo 设备进行交互的 RESTful API。该项目旨在通过提供一个易于使用的 Swagger UI 界面，简化与 Pixoo 设备的交互。用户可以通过该 API 轻松地绘制像素、线条、矩形和文本，快速上传图像，播放 GIF 动画，以及设置设备的频道、亮度等参数。

2. 项目快速启动

2.1 克隆项目

首先，克隆 Pixoo REST API 项目到本地：

git clone https://github.com/4ch1m/pixoo-rest.git
cd pixoo-rest

2.2 配置环境变量

在项目根目录下创建一个 .env 文件，并根据需要配置以下环境变量：

PIXOO_DEVICE_IP=192.168.1.100  # Pixoo 设备的 IP 地址
PIXOO_SCREEN_SIZE=64           # 屏幕尺寸，默认为 64
PIXOO_REST_DEBUG=true          # 启用 Flask 调试模式
PIXOO_REST_HOST=0.0.0.0        # 监听的主机名，默认为 127.0.0.1
PIXOO_REST_PORT=5000           # 监听的端口，默认为 5000
PIXOO_TEST_CONNECTION_RETRIES=10  # 连接 Pixoo 设备的重试次数
SCRIPT_NAME=/pixoo-rest        # 基础路径/前缀 URL（如果需要）

2.3 运行项目

使用 Docker 运行项目：

docker-compose up -d

或者直接运行 Python 应用：

pip install -r requirements.txt
python app.py

2.4 访问 Swagger UI

启动后，访问 http://localhost:5000/swagger 即可使用 Swagger UI 与 Pixoo 设备进行交互。

3. 应用案例和最佳实践

3.1 绘制像素和文本

通过 Swagger UI，用户可以轻松地绘制像素、线条、矩形和文本。例如，发送以下 JSON 请求到 /draw/text 端点：

{
  "x": 10,
  "y": 20,
  "text": "Hello Pixoo",
  "color": [255, 0, 0]
}

3.2 上传图像

用户可以通过 /upload/image 端点上传图像到 Pixoo 设备：

{
  "image_url": "https://example.com/image.png"
}

3.3 播放 GIF 动画

通过 /play/animation 端点播放 GIF 动画：

{
  "gif_url": "https://example.com/animation.gif"
}

4. 典型生态项目

4.1 Pixoo Python Library

Pixoo REST API 基于 Pixoo Python Library，该库提供了与 Pixoo 设备交互的核心功能，包括图像转换、动画播放等。

4.2 Home Assistant 集成

用户可以将 Pixoo REST API 集成到 Home Assistant 中，通过自动化任务控制 Pixoo 设备，例如在特定时间显示天气信息或家庭通知。

4.3 自定义应用开发

开发者可以使用 Pixoo REST API 构建自定义应用，例如家庭监控系统、游戏控制面板等，通过 RESTful API 与 Pixoo 设备进行交互。

通过以上步骤，您可以快速上手并充分利用 Pixoo REST API 的功能，实现与 Divoom Pixoo 设备的便捷交互。