蓝牙水控器 FOSS 技术文档

蓝牙水控器 FOSS 技术文档

waterctl 深圳市常工电子“蓝牙水控器”控制程序的开源实现。适用于国内各大高校宿舍热水器。 项目地址: https://gitcode.com/gh_mirrors/wa/waterctl

1. 安装指南

1.1 环境要求

• 支持的操作系统：Windows、Linux、macOS、Android、iOS、ChromeOS
• 浏览器要求：Chrome、Edge

1.2 安装步骤

1. 打开浏览器，访问项目主页。
2. 在地址栏右侧点击“➕”图标，选择“安装到桌面”或“添加到主屏幕”。
3. 安装完成后，即可在桌面或主屏幕上找到应用图标，点击即可启动。

2. 项目的使用说明

2.1 启动应用

• 点击桌面或主屏幕上的应用图标，启动蓝牙水控器 FOSS 应用。
• 应用启动后，会自动检测设备蓝牙连接状态。

2.2 操作界面

• 主界面：显示当前设备状态、水温、流量等信息。
• 控制面板：提供开关、调节水温、流量等功能按钮。
• 设置菜单：包含语言选择、单位设置、蓝牙设备管理等功能。

2.3 使用流程

1. 打开应用，确保设备蓝牙已开启。
2. 在主界面查看设备状态，点击控制面板按钮进行操作。
3. 如需更改设置，进入设置菜单进行调整。

3. 项目API使用文档

3.1 API概述

• API地址：/api/v1/
• 请求方式：GET、POST
• 返回格式：JSON

3.2 常用API

• 获取设备状态：

  • 请求路径：/api/v1/status
  • 请求方式：GET
  • 返回示例：

    {
      "status": "online",
      "temperature": 45,
      "flow_rate": 1.2
    }
    

• 控制设备开关：

  • 请求路径：/api/v1/control
  • 请求方式：POST
  • 请求参数：

    {
      "action": "toggle"
    }
    

  • 返回示例：

    {
      "result": "success",
      "message": "Device toggled successfully"
    }
    

4. 项目安装方式

4.1 从GitHub安装

1. 访问项目GitHub仓库：https://github.com/celesWuff/waterctl。
2. 点击“Code”按钮，选择“Download ZIP”下载项目压缩包。
3. 解压压缩包，进入项目目录。
4. 根据项目README文件中的指引，进行安装和配置。

4.2 使用PWA安装

1. 打开浏览器，访问项目主页。
2. 在地址栏右侧点击“➕”图标，选择“安装到桌面”或“添加到主屏幕”。
3. 安装完成后，即可在桌面或主屏幕上找到应用图标，点击即可启动。

通过以上步骤，您可以顺利安装并使用蓝牙水控器 FOSS 项目。如在使用过程中遇到问题，请参考疑难解答文档或联系项目开发者。

waterctl 深圳市常工电子“蓝牙水控器”控制程序的开源实现。适用于国内各大高校宿舍热水器。 项目地址: https://gitcode.com/gh_mirrors/wa/waterctl