设备孪生：如何在 C# 中读/写属性

Question

我已经在 IoT 中注册了设备，客户端应用程序（设备）可以读取/更新报告的孪生属性。

属性如下：

"EbbyVersion": {
"Major": 2,
"Minor": 1,
"Revision": 0
},

"Telemetry": {
"CachingInterval": 60,
"SendingInterval": 480,
"UploadTimeout": 10
},

"Power": {
"MaximumAvailable": 3500,
"Thresholds": {
    "Low": 2500,
    "Medium": 3000,
    "High": 3500
}
},

"Lighting": {
"R": 32,
"G": 64,
"B": 128,
"W": 255
},

我编写了以下代码来连接到 IoT Device Twin ：

var registryManager = RegistryManager.CreateFromConnectionString(AppSettings.KeyIoT);
var twin = await registryManager.GetTwinAsync(dto.DeviceIdorId);

现在，我必须从后端应用程序（在 C# 中）读取/更新所需的孪生属性。 需要帮忙。

Answer 1

希望TwinCollection类会有所帮助。 请参阅此讨论C# 如何更新 Azure IoT 中心设备的所需孪生属性

Answer 2

你可能已经想通了，但我想把它写下来是值得的。

我们至少有两种方法可以做到这一点：

1. 使用 Azure IoT 服务 SDK：

   • 阅读：使用RegistryManager.GetTwinAsync方法
   • 写入：使用RegistryManager.UpdateTwinAsync方法

2. 使用 Azure IoT API：

   • 阅读：使用Get Twin
   • 编写：使用更新孪生

1 - 使用 Azure IoT SDK 读取孪生

    using Microsoft.Azure.Devices;
    ...

    static RegistryManager registryManager;
    static string connectionString = "<Enter the IoT Hub Connection String>";
    ...

    string deviceid = "<deviceid>";
    registryManager = RegistryManager.CreateFromConnectionString(connectionString);  
    var twin = await registryManager.GetTwinAsync(deviceid);
    Console.WriteLine(twin.ToJson())

注意：您也可以在Twin 类的实例上检索孪生。 你只需要添加

    using Microsoft.Azure.Devices.Shared;
    ...
    Twin twin = await registryManager.GetTwinAsync(deviceid);

1 - 使用 Azure IoT API 读取孪生

就像使用 HTTP 客户端（如 Postman）一样，您需要发出GET请求以：

https://YOUR_IOT_HUB_NAME.azure-devices.net/twins/{deviceid}?api-version=2020-05-31-preview

在撰写本文时，Microsoft Official Docs 指出服务 IoT Hub 的最新 API 版本是：“2020-05-31-preview”，因此这会随时间而变化。

您还需要提供具有有效 SAS 令牌值的Authorization标头。

所有这一切的一个例子，使用HttpWebRequest看起来像这样：

string deviceid = "<deviceid>";
string URL = $"https://YOUR_IOT_HUB_NAME.azure-devices.net/twins/{deviceid}?api-version=2020-05-31-preview"
string SAS_TOKEN = "<IOT_SAS_TOKEN>";
...

try
{ 
    string resultStr = string.Empty;
    HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
    request.AutomaticDecompression = DecompressionMethods.GZip;
    request.Headers.Add("Authorization", SAS_TOKEN);
    request.ContentType = "application/json";
 
    using (HttpWebResponse response = (HttpWebResponse)request.GetResponse())
    using (Stream stream = response.GetResponseStream())
    using (StreamReader reader = new StreamReader(stream))
    {
        resultStr = reader.ReadToEnd();
    }

    Console.WriteLine(resultStr);
}
catch (Exception e)
{
    throw e;
}

2 - 使用 Azure IoT SDK 更新孪生

    using Microsoft.Azure.Devices;
    ...

    static RegistryManager registryManager;
    static string connectionString = "<Enter the IoT Hub Connection String>";
    ...
    
    registryManager = RegistryManager.CreateFromConnectionString(connectionString);  

    string deviceid = "<deviceid>";
    string etag = "<twinETag>"; // You could also get this value from the twin if you previously read it, by doing twin.ETag

    // This is the piece of the twin tags we want to update
    var patch = @"{
        tags: {
            info: {  
                origin: 'Argentina',  
                version: '14.01'  
            }  
        }  
    }";  

    await registryManager.UpdateTwinAsync(deviceid, patch, twinETag);  

2 - 使用 Azure IoT API 更新孪生

与步骤“ 1 - 使用 Azure IoT API 读取孪生”完全一样，您需要使用相同的 URL

https://YOUR_IOT_HUB_NAME.azure-devices.net/twins/{deviceid}?api-version=2020-05-31-preview

并添加带有 IoT SAS Token 值的Authorization标头，您现在需要使用PATCH方法。 这意味着在正文中，您需要发送要更新的片段。

重要提示：不要无意中使用POST方法，因为这将用您发送的内容替换您的整个双胞胎。 仅当您发送整个新孪生体作为正文时，才应使用 POST 方法。 我们现在不这样做。

同样，所有这些的示例，使用HttpWebRequest将如下所示：

string deviceid = "<deviceid>";
string URL = $"https://YOUR_IOT_HUB_NAME.azure-devices.net/twins/{deviceid}?api-version=2020-05-31-preview"
string SAS_TOKEN = "<IOT_SAS_TOKEN>";

...

var patch = @"{
    tags: {
        info: {  
            origin: 'Argentina',  
            version: '14.01'  
        }  
    }  
}";  

try
    {
        
        HttpWebRequest request = (HttpWebRequest)WebRequest.Create(GetDeviceTwinURL(deviceid));
        req.Method = "PATCH";
        req.Headers.Add("Authorization", SAS_TOKEN);
        req.ContentType = "application/json";
        Stream stream = req.GetRequestStream();
        byte[] buffer = Encoding.UTF8.GetBytes(patch);
        stream.Write(buffer, 0, buffer.Length);
        HttpWebResponse res = (HttpWebResponse)req.GetResponse();
    }
    catch (Exception e)
    {
        throw e;
    }

请注意，每当我使用 'string URL = $"...{deviceid}..."' 时，我都会将 deviceid 变量替换为我之前使用字符串插值定义的 deviceid。

你可以在这里找到另一个很好的例子。

Answer 3

一种方法是：

1. 将 Desired 或 Reported json 反序列化为一个类
2. 根据需要修改对象
3. 序列化回 json（确保包含空值）
4. 使用新的 json 更新孪生。