涂鸦 Homebridge 插件使用及品类扩展教程

注册信息准备

涂鸦应用注册信息会在将来用到。
请参考 tuya-iot-app-sdk-python 中的 BeforeUse 章节， 在涂鸦 IoT 平台 上注册账号，创建对应的云开发项目，最后创建该账号下的资产、用户和云应用，获取到对应的用户名、密码、Access ID 和 Access Secret。

硬件准备

软件准备

1. 打开终端工具。
   
2. 参考 Homebridge 官方文档 安装 Homebridge。
3. 安装 Tuya Homebridge 插件。

   注意：如果在安装过程中遇到问题，可尝试在命令行之前加上 sudo，将执行命令角色权限变更为管理员。

   1. 安装插件。

      npm install homebridge-tuya-platform
      

   2. 等待安装完成，判断是否安装成功。详细过程可以参考下面的视频。

      

在使用之前，需要先配置 Homebridge 插件中的 config.json 文件。

1. 进入 homebridge-tuya-platform 目录。

   cd ./node_modules/homebridge-tuya-platform
   

2. 进入 config 目录。

   cd ./config 
   

3. 编辑 config.json 文件。

   vim config.json
   

4. 在 options 中填入注册信息准备过程中获取到的用户名、密码、Access ID 和 Access Secret。其中，lang 默认为 en，endPoint 为当前 Tuya open API 服务的域名。

   区域	endPoint
   美国	https://openapi.tuyaus.com
   中国	https://openapi.tuyacn.com
   欧洲	https://openapi.tuyaeu.com
   印度	https://openapi.tuyain.com
   美国东部	https://openapi-ueaz.tuyaus.com
   西欧	https://openapi-weaz.tuyaeu.com

   
5. 保存并退出编辑。

1. 回到 homebridge-tuya-platform 根目录。

   cd ..
   

2. 启动插件。

   homebridge -D -U ./config/ -P ./ 
   

   

打开苹果设备，在 App Store 中安装苹果官方“家庭” 应用软件，通过扫描启动插件步骤中的二维码，或者输入 8 位数字的 Pin 值（Pin 值也可在 Config.json 文件中找到）来添加配件。

您可以 fork 仓库代码分支，按照安装、配置、使用 tuya 插件的步骤，将代码启动起来。

开发环境搭建

—-VSCode
—-engines
    "node": “>=0.12.0”
    "homebridge": ">=0.2.0"
—-dependencies
    "axios": “^0.21.1",
    "crypto-js": “^4.0.0”, 
    "mqtt": “^4.2.6",
    "uuid": "^8.3.2"

品类扩充

一、插件的实现部分的原理简介

二、需要关注的 js 文件

• 入口文件 index.js。在 addAccessory() 函数中新增你的品类，并创建对应的 xx_accessory.js 文件。
  

• 文件xx_accessory.js。在xx_accessory.js中，只需在 refreshAccessoryServiceIfNeed() 函数中遍历你所新增品类支持的 function，以及根据支持的 function 生成 Service 对应的 Characteristic。
  

• 文件tuyaopenapi.js：设备相关接口。

• 文件tuyamqttapi.js：支持 MQTT 服务。

FAQ

常见安装问题

请见 Homebridge Common Issues。

Tuya Open API

• login(username, password) 登录
• getDeviceList() 获取账号资产下的所有设备（设备对应Accessory）
• get_assets() 获取人员可操作资产列表
• getDeviceIDList(assetID) 查询资产下的设备ID列表
• getDeviceFunctions(deviceID) 获取设备指令集
• getDeviceInfo(deviceID) 获取单个设备信息
• getDeviceListInfo(devIds = []) 批量获取设备信息
• getDeviceStatus(deviceID) 获取单个设备状态
• getDeviceListStatus(devIds = []) 批量获取设备状态
• sendCommand(deviceID, params) 下发设备命令

MQTT

• start() 启动mqtt
• stop() 停止mqtt
• addMessageListener(listener) 添加回调函数
• removeMessageListener(listener) 移除回调函数