TuyaNet 1.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package TuyaNet --version 1.0.0                
NuGet\Install-Package TuyaNet -Version 1.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="TuyaNet" Version="1.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add TuyaNet --version 1.0.0                
#r "nuget: TuyaNet, 1.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install TuyaNet as a Cake Addin
#addin nuget:?package=TuyaNet&version=1.0.0

// Install TuyaNet as a Cake Tool
#tool nuget:?package=TuyaNet&version=1.0.0                

Tuya.Net

.NET Standard 2.0 library to interface with Tuya WiFi smart devices over LAN, without using the cloud.

Description

This library controls and monitors Tuya compatible WiFi Smart Devices (Plugs, Switches, Lights, Window Covers, etc.) using the local area network (LAN). Tuya devices are designed to communicate with the TuyaCloud but most also expose a local area network API, allowing us to directly control the devices without using the cloud.

How communication with Tuya devices works at all

Every Tuya device broadcasts to local network UDP packets with short info about itself. This data is encrypted with AES but the encryption key is the same for every device and it can be easily decrypted. This packet is sent every 5 seconds and contains data with a unique device ID, device type ID and protocol version.

Also, every device can accept TCP connection and proceed requests. Every request contains command code and JSON string. JSON string is encrypted with AES using local key. This key is assigned by the Tuya cloud server and is unique for each device. So you need to create a Tuya developer account and request this key from the server.

Most requests must contain base JSON values:

{
    "gwId": "DEVICE_ID",
    "devId": "DEVICE_ID",
    "uid":  "DEVICE_ID",
    "t": "CURRENT_TIME"
}

Where DEVICE_ID is a device ID and CURRENT_TIME is a Unix timestamp as a string.

Every response contains command code, JSON and return code (0 = success).

Most devices are controlled via data points (DPs). Every data point has a number and a value. Usually you can send DP_QUERY (0x0A) command and receive ra esponse like

{
    "devId": "DEVICE_ID",
    "dps":{
        "1": true,
        "2": false,
        "9": 0,
        "10": 0
    }
}

dps is a dictionary with data points and current values. This is the response from the "2 in 1" smart switch. 1 is a state of switch #1, 2 is a state of switch #2, 9 and 10 are timer values. Please note that DPs numbers are strings. DPs values can be of any type.

Usually you can change DPs values using CONTROL (0x07) command and JSON like:

{
    "gwId": "DEVICE_ID",
    "devId": "DEVICE_ID",
    "uid":  "DEVICE_ID",
    "t": "CURRENT_TIME",
    "dps":{
        "1": false
    }    
}

This request will turn off switch #1.

Don't worry, this library will help you to create requests automatically.

How to obtain local key

  • Download Smart Life mobile app: for Android or for iOS).

  • Register your device using this app.

  • Open iot.tuya.com, create developer account and log in.

  • Click on Cloud

    image

  • Click on the Create Clout Project button

    image

  • Enter any name for your project, select "Smart Home" for industry and development method. You can select any data center but you must remember which one you chose.

    image

  • Skip Configuration Wizard.

    image

  • Copy and save your Access ID and Access Secret.

    image

  • Select Devices.

    image

  • Select Liny Tuya App Account.

    image

  • Click on Add App Account and it will display a QR code.

    image

  • Scan the QR code using your mobile phone and Smart Life app by going to the "Me" tab and clicking on the QR code button [..] in the upper right hand corner of the app. Your account should appear on the list.

    image

  • Now open the Devices tab.

    image

  • You should see list of your devices. Copy and save at least one device ID.

    image

  • Click on the Service API tab.

    image

  • Click on Go to Authorize

    image

  • Add IoT Core API (subscribe to it first).

    image

  • Now you can retrieve local keys of your devices using TuyaApi class:

    var api = new TuyaApi(region: TuyaApi.Region.CentralEurope, accessId: ACCESS_ID, apiSecret: API_SECRET);
    var devices = await api.GetAllDevicesInfoAsync(anyDeviceId: DEVICE_ID);
    foreach(var device in devices)
    {
        Console.WriteLine($"Device: {device.Name}, device ID: {device.Id}, local key: {device.LocalKey}");
    }
    

    region - the region of the data center that you have selected on iot.tuya.com accessID and apiSecret - Access ID and Access Secret from iot.tuya.com anyDeviceId - ID of any of your smart devices (to fetch user ID).

Network scanner for Tuya devices

You can use TuyaScanner class to catch and decode broadcast UDP packets from devices:

static void Main(string[] args)
{
    var scanner = new TuyaScanner();
    scanner.OnNewDeviceInfoReceived += Scanner_OnNewDeviceInfoReceived;
    Console.WriteLine("Scanning local network for Tuya devices, press any key to stop.");
    scanner.Start();
    Console.ReadKey();
    scanner.Stop();
}

private static void Scanner_OnNewDeviceInfoReceived(object sender, TuyaDeviceScanInfo e)
{
    Console.WriteLine($"New device found! IP: {e.IP}, ID: {e.GwId}, version: {e.Version}");
}

You can use it to retrieve the device's IP address, ID, and protocol version. Remember that your computer must be on the same network as your devices to receive broadcasts.

How to communicate with devices

You should now have:

  • Device IP address - from scanner or from your router
  • Device local encryption key - retrieved via TuyaApi
  • Device ID - from scanner or from iot.tuya.com

There is TuyaDevice class, you need create instance of it:

var dev = new TuyaDevice(ip: DEVICE_IP, localKey: DEVICE_KEY, deviceId: DEVICE_ID);

It uses protocol version 3.3 by default but you can specify version 3.1 as well:

TuyaDevice dev = new TuyaDevice(ip: DEVICE_IP, localKey: DEVICE_KEY, deviceId: DEVICE_ID, protocolVersion: TuyaProtocolVersion.V31);

Now you can encode requests:

byte[] request = device.EncodeRequest(TuyaCommand.DP_QUERY, "{\"gwId\":\"DEVICE_ID\",\"devId\":\"DEVICE_ID\",\"uid\":\"DEVICE_ID\",\"t\":\"CURRENT_TIME\"}");

Send it:

byte[] encryptedResponse = await device.SendAsync(request);

And decode response:

TuyaLocalResponse response = device.DecodeResponse(encryptedResponse);
Console.WriteLine($"Response JSON: {response.JSON}");

How to set DPs:

byte[] request = device.EncodeRequest(TuyaCommand.CONTROL, "{\"gwId\":\"DEVICE_ID\",\"devId\":\"DEVICE_ID\",\"uid\":\"DEVICE_ID\",\"t\":\"CURRENT_TIME\"},\"dps\":{\"1\":false}}");
byte[] encryptedResponse = await device.SendAsync(request);
TuyaLocalResponse response = device.DecodeResponse(encryptedResponse);
Console.WriteLine($"Response JSON: {response.JSON}");

Too complicated, isn't it? There is more simple way. You can use FillJson() method to fill standard fields automatically:

byte[] request = device.EncodeRequest(TuyaCommand.CONTROL, device.FillJson("{\"dps\":{\"1\":false}}"));
byte[] encryptedResponse = await device.SendAsync(request);
TuyaLocalResponse response = device.DecodeResponse(encryptedResponse);
Console.WriteLine($"Response JSON: {response.JSON}");

Also, there is SendAsync() overload that accepts command ID with JSON, encodes it, and returns decoded data:

TuyaLocalResponse response = await device.SendAsync(TuyaCommand.CONTROL, device.FillJson("{\"dps\":{\"1\":false}}"));

Finally, there are GetDps() and SetDps() methods:

Dictionary<int, object> dps = await device.GetDps();
// Change multiple values at once
Dictionary<int, object> newDps = await device.SetDps(new Dictionary<int, object> { { 1, false }, { 2, true } });
// Change single value
newDps = await device.SetDps(1, true);

Credits

Contacts

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.3 3,372 7/11/2022
1.0.2 533 4/7/2022
1.0.1 489 11/13/2021
1.0.0 385 10/29/2021