williamp/localtuya-modded
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated and reorganized README.md

Browse Source
This commit is contained in:
andrewmeepos
2020-09-04 03:46:06 -07:00
committed by GitHub
parent baa6f78d1e
commit 44f3729a17
1 changed files with 89 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

129
README.md
View File

@@ -1,37 +1,35 @@
# localtuya-homeassistant
Local handling for Tuya Switches under Home-Assistant and Hassio, getting parameters from them (as Power Meters: Voltage, Current, Watt). Supports 3 types of switches: one-gang switches, two-gang switches and wifi plug (with additional USB plugs).
A Home Assistant / Hass.io add-on for local handling of Tuya-based devices.
Also introduced handling for Tuya Covers and Lights, introducing pytuya library 7.0.9.
The following Tuya device types are currently supported:
* 1 gang switches
* 2 gang switches
* Wi-Fi plugs (including those with additional USB plugs)
* Lights
* Covers
Developed substantially by merging the codes of NameLessJedi, mileperhour and TradeFace (see Thanks paragraph).
Energy monitoring (voltage, current, watts, etc.) is supported for compatible devices.
# How it works:
This repository was substantially developed by utilizing and merging code from NameLessJedi, mileperhour and TradeFace. Refer to the "Thanks to" section below.
1. Copy the localtuya folder content, and pytuya handler folder, to /custom_components/localtuya/ folder, inside /config folder (via Samba for HASSIO).
# Installation:
2. Identify on your Home-Assistant logs (putting your logging into debug mode), the different attributes you want to handle by HA.
Copy the localtuya folder and all of its contents into your Home Assistant's custom_components folder. This is often located inside of your /config folder. If you are running Hass.io, use SAMBA to copy the folder over. If you are running Home Assistant Supervised, the custom_components folder might be located at /usr/share/hassio/homeassistant. It is possible that your custom_components folder does not exist. If that is the case, create the folder in the proper location, and then copy the localtuya folder and all of its contents inside the newly created custom_components folder.
Alternatively, you can install localtuya through HACS by adding this repository.
# Usage:
**NOTE: You must have your Tuya device's Key and ID in order to use localtuya. Follow the instructions here (https://github.com/codetheweb/tuyapi/blob/master/docs/SETUP.md) if you still need your Key and ID.**
1. Add the proper entry to your configuration.yaml file. Several example configurations for different device types are provided below. Make sure to save when you are finished editing configuration.yaml.
3. Find in the switch.py file that part, and edit it for ID/DPS that is correct for your device.
```
@property
def device_state_attributes(self):
attrs = {}
try:
attrs[ATTR_CURRENT] = "{}".format(self._status['dps']['104'])
attrs[ATTR_CURRENT_CONSUMPTION] = "{}".format(self._status['dps']['105']/10)
attrs[ATTR_VOLTAGE] = "{}".format(self._status['dps']['106']/10)
except KeyError:
pass
return attrs
```
NOTE: Original data from the device for Voltage and Watt, includes the first decimal. So if the value is 2203, the correct value is 220,3V. By this reason, this values are divided by 10 ('/10' in the script). While Current is sent in mA (int number, no decimals), so it don't need any conversion factor to be added on the declaration.
4. Use this declaration on your configuration.yaml file (you need to get the 'device_id' and 'local_key' parameters for your device, as it can be obtained on other tutorials on the web:
```
##### FOR ONE-GANG SWITCHES #####
switch:
#### 1 GANG SWITCH ####
switch:
- platform: localtuya
host: 192.168.0.1
local_key: 1234567891234567
@@ -42,8 +40,10 @@ switch:
current: 18
current_consumption: 19
voltage: 20
```
##### FOR TWO-GANG SWITCHES / PLUGS #####
```
##### 2 GANG SWITCH / PLUG #####
- platform: localtuya
host: 192.168.0.1
local_key: 1234567891234567
@@ -64,11 +64,56 @@ switch:
friendly_name: USB Plug
id: 7
```
NOTE: (as many switch declared as the device has, take note that: If your device is composed (ex. one switch with a independent led light in it), this led can be declared as a 'switch'. ¡This Python script does not include RGB handling! (RGB Handling is independent and must be declared as a 'light' custom device, you can search web for examples, but i have not test this).
NOTE2: for each switch/subswitch both name and friendly_name must be specified: name will be used as the entity ID, while friendly_name will be used as the name in the frontend.
```
#### COVER ####
cover:
- platform: localtuya #REQUIRED
host: 192.168.0.123 #REQUIRED
local_key: 1234567891234567 #REQUIRED
device_id: 123456789123456789abcd #REQUIRED
name: cover_guests #REQUIRED
friendly_name: Cover guests #REQUIRED
protocol_version: 3.3 #REQUIRED
id: 1 #OPTIONAL
icon: mdi:blinds #OPTIONAL
open_cmd: open #OPTIONAL, default is 'on'
close_cmd: close #OPTIONAL, default is 'off'
stop_cmd: stop #OPTIONAL, default is 'stop'
```
5. Use this declaration on your configuration.yaml file, for stating sensors that handle its attributes:
2. Enable debug logging in your configuration.yaml file.
```
#Logging
logger:
default: info
logs:
custom_components.localtuya: debug
```
3. Restart Home Assistant.
4. Wait until Home Assistant is fully loaded, then access your logs. If localtuya has succesfully connected to your device, you will see a "decrypted result" with all of your device's DPs. See below for a succesful connection log:
```
2020-09-04 02:08:26 DEBUG (SyncWorker_26) [custom_components.localtuya.pytuya] decrypted result='{"devId":"REDACTED","dps":{"1":"stop","2":100,"3":40,"5":false,"7":"closing","8":"cancel","9":0,"10":0}}'
```
5. Make any necessary edits to the python file(s) for your device(s). For example, if you are using a switch device, you may want to edit switch.py to account for the IDs/DPs that are applciable to your specific device.
```
#### switch.py snippet
@property
def device_state_attributes(self):
attrs = {}
try:
attrs[ATTR_CURRENT] = "{}".format(self._status['dps']['104']) # Modify to match your device's DPs
attrs[ATTR_CURRENT_CONSUMPTION] = "{}".format(self._status['dps']['105']/10) # Modify to match your device's DPs
attrs[ATTR_VOLTAGE] = "{}".format(self._status['dps']['106']/10) # Modify to match your device's DPs
except KeyError:
pass
return attrs
```
6. Add any applicable sensors, using the below configuration.yaml entry as a guide:
```
sensor:
- platform: template
@@ -86,31 +131,25 @@ switch:
{{ states.switch.sw01.attributes.current_consumption }}
unit_of_measurement: 'W'
```
6. If all gone OK (your device's parameters local_key and device_id are correct), your switch is working, so the sensors are working too.
NOTE: You can do as changes as you want in scripts ant/or yaml files. But: You can't declare your "custom_component" as "tuya", tuya is a forbidden word from 0.88 version or so. So if you declare a switch.tuya, the embedded (cloud based) Tuya component will be load instead custom_component one.
# Notes:
7. If you are using a cover device, this is the configuration to be used (as explained in cover.py):
```
cover:
- platform: localtuya
host: 192.168.0.123
local_key: 1234567891234567
device_id: 123456789123456789abcd
name: cover_guests
friendly_name: Cover guests
protocol_version: 3.3
id: 1
```
* Do not declare anything as "tuya", such as by initiating a "switch.tuya". Using "tuya" launches Home Assistant's built-in, cloud-based Tuya integration in lieu of localtuya.
* Raw data from Tuya devices for Voltage and Watts includes the first decimal. For example, if the value is 2203, then the correct value is 220,3V. Values are thus divided by 10 ('/10' in the script). Current, however, is sent in mA as an integer with no decimals, so it does not need any conversion factor added on to the declaration.
* If your device is composed (e.g. one switch with an independent LED light in it), this LED can be declared as a 'switch'. However, the Python script does not include RGB handling! In order to use RGB handling, it must be declared as a custom 'light device'. This has not been tested with localtuya, however it may be possible to make it work. Google is your friend.
* For each switch and/or subswitch, name **and** friendly_name must be specified in configuration.yaml. Name will be used as the Entity ID, while friendly_name will be used as the name in the frontend.
# To-do list:
Create a (good and precise) sensor (counter) for Energy (kWh) -not just Power, but based on it-.
* Create a (good and precise) sensor (counter) for Energy (kWh) -not just Power, but based on it-.
Ideas: Use: https://www.home-assistant.io/components/integration/ and https://www.home-assistant.io/components/utility_meter/
RGB integration (for devices integrating both plug switch, power meter, and led light)
* RGB integration (for devices integrating both plug switch, power meter, and led light)
Create a switch for cover backlight (dps 101): pytuya library already supports it
* Create a switch for cover backlight (dps 101): pytuya library already supports it
# Thanks to: