Skip to content

Homebridge plugin for IoT devices that use Tuya Smart's platform

License

Notifications You must be signed in to change notification settings

verisgit/homebridge-tuya-lan

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

homebridge-tuya-lan

Homebridge plugin for IoT devices that use Tuya Smart's platform, allowing them to be exposed to Apple's HomeKit.

Installation

Install this plugin using npm i -g homebridge-tuya-lan.

Update the config.json file of your Homebridge setup, by modifying the sample configuration below. Detailed steps for getting the id and key combinations of your devices can be found on the Setup Instructions page.

Configurations

The configuration parameters to enable your devices would need to be added to platforms section of the Homebridge configuration file.

{
    ...
    "platforms": [
        ...
        /* The block you need to enable this plugin */
        {
            "platform": "TuyaLan",
            "devices": [
                /* The block you need for each device */
                {
                    "name": "Hallway Light",
                    "type": "SimpleLight",
                    "manufacturer": "Cotify",
                    "model": "Smart Wifi Bulb Socket E26",
                    "id": "011233455677899abbcd",
                    "key": "0123456789abcdef"
                }
                /* End of the device definition block */ 
            ]
        }
        /* End of the block needed to enable this plugin */
    ]
    ...
}

Parameters

  • name (required) is anything you'd like to use to identify this device. You can always change the name from within the Home app.
  • type (required) is a case-insensitive identifier that lets the plugin know how to handle your device. Find your device type on the Supported Devices page.
  • manufacturer and model are anything you like; the purpose of them is to help you identify the device.
  • id (required) and key (required) are parameters for your device. If you don't have them, follow the steps found on the Setup Instructions page.

To find out which id belongs to which device, open the Tuya Smart app and check the Device Information by tapping the configuration icon of your devices; it is almost always a tiny icon on the top-right.

Credit

To create this plugin, I learnt a lot from Max Isom's work on his TuyAPI project to create my communication driver.

About

Homebridge plugin for IoT devices that use Tuya Smart's platform

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%