Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/irayankhan/homebridge-tuya
A Homebridge plugin to control Tuya devices locally.
https://github.com/irayankhan/homebridge-tuya
homebridge-plugin homebridge-tuya tuya
Last synced: about 1 month ago
JSON representation
A Homebridge plugin to control Tuya devices locally.
- Host: GitHub
- URL: https://github.com/irayankhan/homebridge-tuya
- Owner: iRayanKhan
- License: mit
- Created: 2018-08-13T23:24:41.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-06-28T17:58:10.000Z (5 months ago)
- Last Synced: 2024-09-21T13:02:57.382Z (about 2 months ago)
- Topics: homebridge-plugin, homebridge-tuya, tuya
- Language: JavaScript
- Homepage:
- Size: 636 KB
- Stars: 392
- Watchers: 22
- Forks: 164
- Open Issues: 142
-
Metadata Files:
- Readme: Readme.MD
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# Homebridge-Tuya
[](https://www.npmjs.com/package/homebridge-tuya)
[](https://www.npmjs.com/package/homebridge-tuya)
[](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
Control your supported Tuya accessories locally in HomeKit
* [Supported Device Types](#supported-device-types)
* [Installation Instructions](#installation-instructions)
* [Configuration](#configuration)
* [Known Issues](#known-issues)
* [Troubleshooting](#troubleshooting)
* [Credits](#credits)
* [License](#license)
* [Donating](#donating)
## Supported Device Types
> Click the number next to your device to find the possible DataPoint "DP" values, then add as needed to your config.
* Air Conditioner[1](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types#air-conditioners)
* Air Purifiers[2]()
* Convectors[3](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types#heat-convectors)
* Dehumidifers[4](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types)
* Dimmers[5](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types#simple-dimmers)
* Fan[6](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types)
* Fan v2[7](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types)
* Garages[8](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types#garage-doors)
* Heaters[9](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types)
* Lights
* On/Off[10](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types)
* Brightness[11](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types#tunable-white-light-bulbs)
* Color[12](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types#white-and-color-light-bulbs) (Hue, Saturation, Adaptive Lighting)
* Oil Diffusers[13](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types)
* Outlets[14](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types#outlets)
* Switches[15](https://github.com/iRayanKhan/homebridge-tuya/wiki/Supported-Device-Types)
Note: Motion, and other sensor types don't behave well with responce requests, so they will not be added.
## Installation Instructions
#### Option 1: Install via Homebridge Config UI X:
Search for "Tuya" in [homebridge-config-ui-x](https://github.com/oznu/homebridge-config-ui-x) and install `homebridge-tuya`.
#### Option 2: Manually Install:
```
sudo npm install -g homebridge-tuya
```
## Configuration
> UI
1. Navigate to the Plugins page in [homebridge-config-ui-x](https://github.com/oznu/homebridge-config-ui-x).
2. Click the **Settings** button for the Tuya plugin.
3. Add your device types
4. Add device parameters[10](apple.com/)
5. Restart Homebridge for the changes to take effect.
> Manual
1. Edit the config.json file to add your device types, and parameters.
2. Restart Homebridge
## Known Issues
1. If your devices add, but you can't control them, make sure you entered the DataPoint "DP" values for your device.
## Troubleshooting
1. Make sure the plugin is up-to date
2. Check for existing issues
## Contributing
If you have new accessory logic for a new device, please add a function defined by manufacturer, and describe your changes in the readME file.
## Credits
* [AMoo-Miki](https://github.com/AMoo-Miki) - developer of the [Tuya-Lan](https://github.com/AMoo-Miki/homebridge-tuya-lan) plugin which this plugin is based off.
* mxDanger - Plugin branding.
* [CodeTheWeb](https://github.com/CodeTheWeb) - developer of [TuyaApi](https://github.com/codetheweb/tuyapi), who gratiously provided this repo's name.
* [Oznu](https://github.com/oznu) - developer of Homebridge, added ```config.schema.json``` , fixed dependencies, and helped inspire this readME off his [gsh](https://github.com/oznu/homebridge-gsh) plugin.
## License
## Donating
Please donate to a local pet shelter, or food pantry. It's been a wild time, but we can do our part by helping others.