Home Assistant Tuya Local component

This is a Home Assistant add-on to support Wi-fi devices running Tuya firmware without going via the Tuya cloud. Currently only WiFi devices are supported, Tuya also makes Zigbee, BLE and other devices that connect to WiFi using a gateway, such devices are not yet supported.

Using this integration does not stop your devices from sending status to the Tuya cloud, so this should not be seen as a security measure, rather it improves speed and reliability by using local connections, and may unlock some features of your device, or even unlock whole devices, that are not supported by the Tuya cloud API.

A similar but unrelated integration is rospogrigio/localtuya, if your device is not supported by this integration, you may find it easier to set up using that as an alternative.

Device support

Note that devices sometimes get firmware upgrades, or incompatible versions are sold under the same model name, so it is possible that the device will not work despite being listed below.

If your device is not listed, you can find the information required to add a configuration for it in the following locations:

1. When attempting to add the device, if it is not supported, you will either get a message saying the device cannot be recognised at all, or you will be offered a list of devices (maybe a list of length 1) that are partial matches, often simple switch is among them. You can cancel the process at this point, and look in the Home Assistant log - there should be a message there containing the currnet data points (dps) returned by the device.

2. If you have signed up for iot.tuya.com to get your local key, you should also have access to the API Explorer under "Cloud". One of the functions under the "Device Control" section - the last "Get Device Specification Attribute" function listed, returns the dp_id in addition to range information that is needed for integer and enum data types.

3. By following the method described at the link below, you can find information for all the data points supported by your device, including those not listed by the API explorer method above and those that are only returned under specific conditions. Ignore the requirement for a Tuya Zigbee gateway, that is for Zigbee devices, and this integration does not currently support devices connected via a gateway, but the non-Zigbee/gateway specific parts of the procedure apply also to WiFi devices.

https://www.zigbee2mqtt.io/advanced/support-new-devices/03_find_tuya_data_points.html

If you file an issue to request support for a new device, please include the following information:

1. Identification of the device, such as model and brand name.
2. As much information on the datapoints you can gather using the above methods.
3. If manuals or webpages are available online, links to those help understand how to interpret the technical info above - even if they are not in English automatic translations can help, or information in them may help to identify identical devices sold under other brands in other countries that do have English or more detailed information available.

If you submit a pull request, please understand that the config file naming and details of the configuration may get modified before release - for example if your name was too generic, I may rename it to a more specific name, or conversely if the device appears to be generic and sold under many brands, I may change the brand specific name to something more general. So it may be necessary to remove and re-add your device once it has been integrated into a release.

Heaters

• Goldair heater models beginning with the code GPPH, GCPV, GECO
• Kogan Wi-Fi Convection Panel heaters - KAHTP and KAWFHTP models
• Andersson GSH heater
• Eurom Mon Soleil 300,600,800, 350,601,720 and 300,450,720 Verre heaters
• Eurom Wall Designheat 2000 heater
• Purline Hoti M100 heater
• Wetair WCH-750 heater
• Kogan Flame effect heater - KAWHMFP20BA model
• Nedis convection heater - WIFIHTPL20F model
• Ecostrad Accent iQ heating panels
• Ecostrad iQ Ceramic radiators
• Devola Patio heater
• Betterlife BT1500 IR heater
• Kogan Tower Heater - KASTHFP2KWA model

Air Conditioners / Heatpumps

• ElectriQ 12WMINV
• ElectriQ Airflex 15W
• Tadiran Wind 65/3P
• Fersk Vind 2
• Carson CB PA280
• Kogan 2.6kW portable air conditioner
• Eberg Qubo Q40HD
• Eberg Cooly C35HD
• Star-Light air conditioner
• TroniTechnik Hellnar Klimagerät
• Be Cool BC14KL2101F

Pool heaters / heatpumps

• Garden PAC pool heatpump (also works with Summerwave Si Series)

• Madimack Elite V3 pool heatpump

• Madimack(model unknown) pool heatpump (seems to match Fairland IPH45 as well)

• Remora pool heatpump

• BWT FI 45 heatpump

• Poolex Silverline, Q-line and Vertigo heatpumps

• IPS Pro Pool-Systems Heatpump (seems to match Fairland Inver-X as well)

• W'eau Pool Heatpump

• Fairland IPHCR15 pool heatpump (matches others above, but allows control of heat/cool modes while others seem to be fixed to auto only)

• these seem to use a small number of common controllers with minor variations, and many other Pool heatpumps will work using the above configurations. Report issues if there are any differences in presets or other features, or if any of the "unknown" values that are returned as attributes can be figured out.

Thermostats

• Inkbird ITC306A thermostat smartplug
• Inkbird ITC308 thermostat smartplug
• Beca BHP-6000 Room Heat Pump control thermostat
• Beca BHT-6000/8000 Floor Heating thermostat
• Beca BHT-002/3000 Floor Heating thermostat (with external temp sensor)
• Moes BHT-002 thermostat (without external temp sensor)
• Beca BAC-002 thermostat
• Awow/Mi-heat TH213 thermostat (two variants)
• Siswell T29UTW thermostat
• Siswell C16 thermostat (rebadged as Warmme, Klima and others)
• Minco MH-1823D thermostat
• Owon PCT513 thermostat
• Beok TR9B thermostat (rebadged as Vancoo and perhaps others)
• Hysen HY08WE-2 thermostat
• Nashone MTS-700-WB thermostat smartplug
• Jiahong ET-72W thermostat
• Moes MS-103 Temperature and Humidity Switch (partial functions, temperature only)
• Beok TGR81 thermostat

Fans

• Goldair GCPF315 fan
• Anko HEGSM40 fan
• Lexy F501 fan
• Deta fan controller
• Arlec Grid Connect Smart Ceiling Fan (with and without light)
• Stirling FS1-40DC Pedestal fan
• Aspen ASP 200 fan
• TMWF02 fan controller
• Ledkia Fan and Light controller

Air Purifiers

• Renpho RP-AP001S air purifier
• Poiema One air purifier
• Himox H05 and H06 air purifiers
• Tesla Pro and Mini air purifiers
• Vork VK6067AW air purifier
• essentials portable air purifier

Dehumidifiers

• Goldair GPDH420 dehumidifier
• ElectriQ CD12PW dehumidifier
• ElectriQ CD12PWv2 dehumidifier
• ElectriQ CD20PRO-LE-V2 dehumidifier
• ElectriQ CD25PRO-LE-V2 dehumidifier
• ElectriQ DESD9LW dehumidifier
• Kogan SmarterHome 7L Desiccant dehumidifier
• JJPro JPD01 dehumidifer
• JJPro JPD02 dehumidifier
• Eesee Adam dehumidifier
• Hyundai Sahara dehumidifier
• AlecoAir D14 Purifying Dehumidifier

Humidifiers

• Eanons QT-JS2014 Purifying humidifier
• Wetair WAW-H1210LW humidifier
• Wilfa Haze HU400BC humidifier

Kitchen Appliances

• Kogan Glass 1.7L Smart Kettle (not reliably detected)
• Inkbird Sous Vide Cooker

Smart Meter/Circuit Breaker

• SmartMCB SMT006 Energy Meter
• PC321-TY 3 phase Power Clamp meter
• Compteur Digital Electric (single phase)

Battery Charger

• Parkside PLGS 2012 A1 Smart Charger for powertools

SmartPlugs/Wall sockets

• Generic Smartplug with Energy monitoring (older models) confirmed as working with Kogan and Blitzwolf Single Smartplugs

• Generic Smartplug with Energy monitoring (newer models) confirmed working with Kogan single smartplug with USB and Rillpac smartplugs

• Generic Smartplug with more advanced energy monitoring confirmed working with CBE smartplugs

• Generic Smartplug with some additional encoded schedule info. confirmed working as a simple switch and timer with Kashimura KJ-173

• Mirabella Genio Smart plug with USB

• Grid Connect double outlet with Energy Monitoring, Master and Individual switches and Child Lock.

• DIGOO DG-SP202 dual smartplug with energy monitoring and timers.

• DIGOO DG-SP01 USB smartplug with night light.

• Grid Connect double outlet wall socket

• Woox R4028/DIGOO DG-PS01 3 outlet + USB powerstrip with individual timers.

• ES01 3 outlet + USB powerstrip with individual timers. Other brands may work with the above configurations

• MoesHouse Smartplug with RGBW nightlight

• Logicom Strippy 4 way power strip with USB

• 4 way power monitoring strip

• Simple Switch - a switch only, can be a fallback for many other unsupported devices, to allow just power to be switched on/off.

• Simple Switch with Timer - a single switch and timer, will probably work for a lot of smart switches that are not covered by the more advanced configs above.

• Simple Switch with Timer v2 - the above with timer moved from dp 11 to 9, confirmed with a Nexxt 220V smart switch.

Lights

• Generic RGBCW/RGBWW lightbulb (confirmed with Lijun branded bulb, expected to match others also)

Covers

• Simple Garage Door
• Simple Blind Controller
• Dongguan Garage Door
• Kogan Garage Door with tilt sensor
• QS-WIFI-C01(BK) Curtain Module
• M027 Curtain Module (sold under several brands, including zemismart, meterk and others)
• Avatto Roller Blinds controller

Vacuum Cleaners

• Lefant M213 Vacuum Cleaner (also works for Lefant M213S and APOSEN A550)
• Kyvol E30 Vacuum Cleaner

Locks

• Orion Grid Connect Smart Lock

Sirens

• Orion Grid Connect Outdoor Siren

Miscellaneous

• Qoto 03 Smart Water Valve / Sprinkler Controller
• SD123 HPR01 Human Presence Radar
• Universal Remote Control (supports sensors only)
• Catit Pixi Smart Fountain
• Bresser Smart 7-in-1 Weather Station

Installation

Installation is via the Home Assistant Community Store (HACS), which is the best place to get third-party integrations for Home Assistant. Once you have HACS set up, simply follow the instructions for adding a custom repository and then the integration will be available to install like any other.

Configuration

You can easily configure your devices using the Integrations configuration UI.

Stage One

The first stage of configuration is to provide the information needed to connect to the device.

You will need to provide your device's IP address or hostname, device ID and local key; the last two can be found using the instructions below.

host

    (string) (Required) IP or hostname of the device.

device_id

    (string) (Required) Device ID retrieved as per the instructions below.

local_key

    (string) (Required) Local key retrieved as per the instructions below.

At the end of this step, an attempt is made to connect to the device and see if it returns any data. For tuya protocol version 3.3 devices, success at this point indicates that all settings you have supplied are correct, but for protocol version 3.1 devices, the local key is only used for sending commands to the device, so if your local key is incorrect the setup will appear to work, and you will not see any problems until you try to control your device. Note that each time you pair the device, the local key changes, so if you obtained the local key using the instructions linked above, then repaired with your manufacturer's app, then the key will have changed already.

Stage Two

The second stage of configuration is to select which device you are connecting. The list of devices offered will be limited to devices which appear to be at least a partial match to the data returned by the device.

type

    (string) (Optional) The type of Tuya device. Select from the available options.

If you pick the wrong type, you will need to delete the device and set it up again.

Stage Three

The final stage is to choose a name for the device in Home Assistant.

If you have multiple devices of the same type, you may want to change the name to make it easier to distinguish them.

name

    (string) (Required) Any unique name for the device. This will be used as the base for the entitiy names in Home Assistant. Although Home Assistant allows you to change the name later, it will only change the name used in the UI, not the name of the entities.

(entities)

    (boolean) (Optional) Additional options may be available for deprecated entities exposed by the device. They will be named for the platform type and an optional name for the entity as a suffix (eg climate, humidifier, lock_child_lock) Setting them to True will expose the entity in Home Assistant.

It is strongly recommended that you do not enable deprecated entities when setting up a new device. They are only retained for users who set up the device before support was added for the actual entity matching the device, or when a function was misunderstood, and will not be retained forever.

As of 0.18.0, there are no longer any deprecated entities, but they may be reintroduced in future if better representations of existing devices emerge again.

Offline operation gotchas

Many Tuya devices will stop responding if unable to connect to the Tuya servers for an extended period. Reportedly, some devices act better offline if DNS as well as TCP connections is blocked.

Heater gotchas

Goldair GPPH heaters have individual target temperatures for their Comfort and Eco modes, whereas Home Assistant only supports a single target temperature. Therefore, when you're in Comfort mode you will set the Comfort temperature (5-35), and when you're in Eco mode you will set the Eco temperature (5-21), just like you were using the heater's own control panel. Bear this in mind when writing automations that change the operation mode and set a temperature at the same time: you must change the operation mode before setting the new target temperature, otherwise you will set the current thermostat rather than the new one.

When switching to Anti-freeze mode, the heater will set the current power level to 1 as if you had manually chosen it. When you switch back to other modes, you will no longer be in Auto and will have to set it again if this is what you wanted. This could be worked around in code however it would require storing state that may be cleared if HA is restarted and due to this unreliability it's probably best that you just factor it into your automations.

When child lock is enabled, the heater's display will flash with the child lock symbol ([]) whenever you change something in HA. This can be confusing because it's the same behaviour as when you try to change something via the heater's own control panel and the change is rejected due to being locked, however rest assured that the changes are taking effect.

When setting the target temperature, different heaters have different behaviour, which you may need to compensate for. From observation, GPPH heaters allow the temperature to reach 3 degrees higher than the set temperature before turning off, and 1 degree lower before turning on again. Kogan Heaters on the other hand turn off when the temperature reaches 1 degree over the targetin LOW mode, and turn on again 3 degrees below the target. To make these heaters act the same in LOW power mode, you need to set the Kogan thermostat 2 degrees higher than the GPPH thermostat. In HIGH power mode however, they seem to act the same as the GPPH heaters.

The Inkbird thermostat switch does not seem to work for setting anything. If you can figure out how to make setting temperatures and presets work, please leave feedback in Issue #19.

Fan gotchas

Reportedly, Goldair fans can be a bit flaky. If they become unresponsive, give them about 60 seconds to wake up again.

Anko fans mostly work, except setting the speed does not seem to work. If you can figure out how to set the speed through the Tuya protocol for these devices, please leave feedback on Issue #22.

Smart Switch gotchas

It has been observed after a while that the current and power readings from the switch were returning 0 when there was clearly a load on the switch. After unplugging and replugging, the switch started returning only dps 1 and 2 (switch status and timer). If HomeAssistant is restarted in that state, the switch detection would fail, however as Home Assistant was left running, it continued to work with no readings for the current, power and voltage. I unplugged the switch overnight, and in the morning it was working correctly.

Cumulative Energy readings seem to be reset whenever the reading is successfully sent to the server. This leads to the energy usage never moving from the minimum reporting level of 0.1kWh, which isn't very useful. It may be possible to get useful readings by blocking the switch from accessing the internet, otherwise an integration sensor based on the Power sensor will need to be set up on the Home Assistant side, and the Energy sensor ignored.

Kogan Kettle gotchas

Although these look like simple devices, their behaviour is not consistant so they are difficult to detect. Sometimes they are misdetected as a simple switch, other times they only output the temperature sensor so are not detected at all.

Beca thermostat gotchas

These devices support switching between Celcius and Fahrenheit on the control panel, but do not provide any information over the Tuya local protocol about which units are selected. Two configurations for this device are provided, beca_bhp6000_thermostat_c and beca_bhp6000_thermostat_f, please select the appropriate one for the temperature units you use. If you change the units on the device control panel, you will need to delete the device from Home Assistant and set it up again.

Siswell C19 thermostat gotchas

These support configuration as either heating or cooling controllers, but only have one output. The HVAC mode is provided as an indicator of which mode they are in, but are set to readonly so that you cannot accidentally switch the thermostat to the wrong mode from HA.

Finding your device ID and local key

You can find these keys the same way as you would for any Tuya local integration. You'll need the Goldair app or the Tuya Tuya Smart app (the Goldair app is just a rebranded Tuya app), then follow these instructions.

• Instructions for iOS
• Instructions for Android

Next steps

1. This component is mosty unit-tested thanks to the upstream project, but there are a few more to complete. Feel free to use existing specs as inspiration and the Sonar Cloud analysis to see where the gaps are.
2. Once unit tests are complete, the next task is to complete the Home Assistant quality checklist before considering submission to the HA team for inclusion in standard installations.
3. Discovery seems possible with the new tinytuya library, though the steps to get a local key will most likely remain manual. Discovery also returns a productKey, which might help make the device detection more reliable where different devices use the same dps mapping but different names for the presets for example.

Please report any issues and feel free to raise pull requests. Many others have contributed their help already.