Use and Develop Tuya Homebridge Plugin

Registration

See the section Before use in tuya-iot-app-sdk-python, register an account on the Tuya IoT Platform, and get the required information. Basically, you need to create a Cloud project and complete the configuration of asset, user, and application. Then, you will get the username, password, Access ID, and Access Secret.

Hardware preparation

Software preparation

1. Open the Terminal.

   

2. See the official Homebridge docs and install Homebridge on your system.

3. Install Tuya Homebridge plugin.

   Note: If you encounter any problems with the installation, you may need to preface this command with sudo to make it run as an administrator.

   1. Install plugins.

      npm install homebridge-tuya-platform
      

   2. Wait for the plugin to install and check whether the installation is successful. For more information, see the video below.

      

Before use, you need to configure the config.json file in the Homebridge plugin.

1. Go to the directory homebridge-tuya-platform.

   cd ./node_modules/homebridge-tuya-platform
   

2. Go to the directory config.

   cd ./config 
   

3. Edit the config.json file.

   vim config.json
   

4. In options, enter the username, password, accessId, and accessKey that you get from the Tuya IoT Platform. The lang defaults to en. The endPoint is the domain name of the currently used Tuya Open API.

   Region	endPoint
   America	https://openapi.tuyaus.com
   China	https://openapi.tuyacn.com
   Europe	https://openapi.tuyaeu.com
   India	https://openapi.tuyain.com
   Eastern America	https://openapi-ueaz.tuyaus.com
   Western Europe	https://openapi-weaz.tuyaeu.com

   

5. Save and exit.

1. Go back to the directory homebridge-tuya-platform.

   cd ..
   

2. Start the plugin.

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

   

Open the Home app on your Apple device. Pair with Homebridge by scanning the QR code printed in the step of starting the plugin, or entering the 8-digit PIN code. You can find the PIN code in the config.json file.

Fork Tuya’s Homebridge repo in GitHub and follow the step-by-step tutorial to start the plugin service.

Set up development environment

—-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"

Support more accessory types

How a plugin works

Important JSON files

• The entry file index.js. Add your desired accessory type to the addAccessory() function and create the xx_accessy.js file.
  

• The xx_accessory.js file. In this file, traverse your newly created function in refreshAccessoryServiceIfNeed() and get the Characteristic corresponding to a service.
  

• The tuyaopenapi.js file contains device related APIs.

• The tuyamqttapi.js file supports the MQTT service.

Common issues

For more information about Homebridge installation, see the Common Issues in the Homebridge repo.

Tuya Open API

• login(username, password): Login to the Tuya IoT Platform.
• getDeviceList(): Gets all the devices under an account’s asset. (The term device corresponds to the term accessory in the HomeKit ecosystem)
• get_assets(): Gets the available assets.
• getDeviceIDList(assetID): Queries the list of device IDs under an asset.
• getDeviceFunctions(deviceID): Gets the instruction set.
• getDeviceInfo(deviceID): Gets the information of a single device.
• getDeviceListInfo(devIds = []): Gets the information of multiple devices.
• getDeviceStatus(deviceID): Gets the status of a single device.
• getDeviceListStatus(devIds = []): Gets the status of multiple devices.
• sendCommand(deviceID, params): Sends commands to a device.

MQTT

• start(): Starts MQTT.
• stop(): Stops MQTT.
• addMessageListener(listener): Adds callbacks.
• removeMessageListener(listener): Removes callbacks.