mhop/tuya-mqtt
1
0
Fork 0
mirror of https://github.com/lehanspb/tuya-mqtt.git synced 2025-12-16 17:54:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Alex M
2023-02-13 17:04:58 +03:00
committed by GitHub
parent 36f3854ca9
commit 59d1131db5
1 changed files with 21 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -14,9 +14,6 @@ To acquire keys for your device please see the instructions at the TuyAPI projec
**Acquiring device keys is outside the scope of this project!** Issues opened regarding acquiring keys will likely be closed without comment. Please verify that your device can be queried and controlled via tuya-cli before opening any issue. If your device can't be controlled by tuya-cli then it cannot be used with this project.
**!!!!!!!!!! Important information regarding the 3.0 release !!!!!!!!!!**\
The 3.0.0 release (Oct 17th, 2020) is a major refactor of the tuya-mqtt project and, as such, is a breaking release for all users of previous versions. Almost everything about the project is different, including configuration method, topic names, etc. Upgrading users should carefully read the instructions below and assume they are starting over from scratch.
## Installation
Download this project to your system into any directory (example below uses /opt/tuya-mqtt) and install tuyapi from the same folder that the tuya-mqtt.js is in
```
@@ -24,7 +21,7 @@ Download this project to your system into any directory (example below uses /opt
cd /opt
// clone this project
git clone https://github.com/TheAgentK/tuya-mqtt
git clone https://github.com/lehanspb/tuya-mqtt
// change directory to the project directory
cd tuya-mqtt
@@ -51,13 +48,27 @@ If you use the "tuya-cli wizard" method to acquire your device keys you can leve
[
{
name: 'Tuya Device 1',
version: '3.3',
ip: '192.168.20.251',
id: '86435357d8b123456789',
key: '8b2a69c9876543210'
},
{
name: 'Tuya Device 2',
version: '3.3',
ip: '192.168.20.252',
id: 'eb532eea7d12345678abc',
key: '899810012345678'
key: '899810012345678',
subDevices:
[ { name: 'subdevice1',
id: 'zt431eda8d12345678awc',
cid: '1a24fkfffe6b4e24'
},
{ name: 'subdevice1',
id: 'rb737qea7v15342678aq3',
cid: '1a24fkfffe0t2c29'
}
]
}
]
```
@@ -74,6 +85,9 @@ node tuya-mqtt.js
To enable debugging output (required when opening an issue):
```
DEBUG=tuya-mqtt:* tuya-mqtt.js
or
DEBUG=* tuya-mqtt.js
for full debugging
```
### Updating devices.conf with new and/or changed devices:
@@ -144,18 +158,7 @@ openHAB examples are [here](docs/openHAB.md).
## Contributors
- [TheAgentK](https://github.com/TheAgentK)
- [tsightler](https://github.com/tsightler)
- [Tycale](https://github.com/Tycale)
- [crashdummymch](https://github.com/crashdummymch)
- [GadgetAngel](https://github.com/GadgetAngel)
- [dkrahmer](https://github.com/dkrahmer)
## Related Projects:
- https://github.com/codetheweb/tuyapi
- https://github.com/unparagoned/njsTuya
- https://github.com/clach04/python-tuya
- https://github.com/Marcus-L/m4rcus.TuyaCore
- Specs: https://docs.tuya.com/en/cloudapi/cloud_access.html
[![forthebadge](https://forthebadge.com/images/badges/made-with-javascript.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)