هذه الصفحة غير متوفرة حاليًا بلغتك المحلية. نحن نعمل جاهدين على إضافة المزيد من اللغات. شاكرين تفهمك ودعمك المستمر لنا.

Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
Software Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

C# Demo Usage Guide

Updated on 2024-11-04 GMT+08:00

Overview

This topic uses C# as an example to describe how to connect a device to the platform over MQTTS or MQTT and how to use platform APIs to report properties and subscribe to a topic for receiving commands.

NOTE:

The code snippets in this document are only examples and are for trial use only. To put them into commercial use, obtain the IoT Device SDKs of the corresponding language for integration by referring to Obtaining Resources.

Prerequisites

Preparations

  • Go to the Microsoft website to download and install Microsoft Visual Studio of a desired version. (The following uses Windows 64-bit, Microsoft Visual Studio 2017, and .NET Framework 4.5.1 as examples.)
  • After the download is complete, run the installation file and install Microsoft Visual Studio as prompted.

Importing Sample Code

  1. Download the sample code quickStart(C#).
  2. Run Microsoft Visual Studio 2017, click Open Project/Solution, and select the sample code downloaded.

  3. Import the sample code.

    Description of the directories:

    • App.config: configuration file containing the server address and device information
    • C#: C# code of the project

      EncryptUtil.cs: auxiliary class for device secret encryption

      FrmMqttDemo.cs: window UI

      Program.cs: entry for starting the demo

    • dll: third-party libraries used in the project

      MQTTnet v3.0.11 is a high-performance, open-source .NET library based on MQTT. It supports both MQTT servers and clients. The reference library files include MQTTnet.dll.

      MQTTnet.Extensions.ManagedClient v3.0.11 is an extension library that uses MQTTnet to provide additional functions for the managed MQTT client.

  4. Set the project parameters in the demo.

    • App.config: Set the server address, device ID, and device secret. When the demo is started, the information is automatically written to the demo main page.

      <add key="serverUri" value="serveruri"/>

      <add key="deviceId" value="deviceid"/>

      <add key="deviceSecret" value="secret"/>

      <add key="PortIsSsl" value="8883"/>

      <add key="PortNotSsl" value="1883"/>

UI Display

  1. The FrmMqttDemo class provides a UI. By default, the FrmMqttDemo class automatically obtains the server address, device ID, and device secret from the App.config file after startup. Set the parameters based on the actual device information.
  2. In the example, enter the server address. (The server address must match and be used together with the corresponding certificate file during SSL-encrypted access.)
    <add key="serverUri" value="iot-mqtts.cn-north-4.myhuaweicloud.com"/>;
  3. Select SSL encryption or no encryption when establishing a connection on the device side and set the QoS mode to 0 or 1. Currently, QoS 2 is not supported. For details, see Constraints.

Establishing a Connection

To connect a device or gateway to the platform, upload the device information to bind the device or gateway to the platform.

  1. The FrmMqttDemo class provides methods for establishing MQTT or MQTTS connections. By default, MQTT uses port 1883, and MQTTS uses port 8883. (In the case of MQTTS connections, you must load the DigiCertGlobalRootCA.crt.pem certificate for verifying the platform identity. This certificate is used for login authentication when the device connects to the platform. You can download the certificate file from Obtaining Resources.) Call the ManagedMqttClientOptionsBuilder class to set the initial KeepAlivePeriod. The recommended heartbeat interval for MQTT connections is 120 seconds. For details, see Constraints.
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    int portIsSsl = int.Parse(ConfigurationManager.AppSettings["PortIsSsl"]);
    int portNotSsl = int.Parse(ConfigurationManager.AppSettings["PortNotSsl"]);
    
    if (client == null)
    {
    	client = new MqttFactory().CreateManagedMqttClient();
    }
    
    string timestamp = DateTime.Now.ToString("yyyyMMddHH");
    string clientID = txtDeviceId.Text + "_0_0_" + timestamp;
    
    // Encrypt passwords using HMAC SHA256.
    string secret = string.Empty;
    if (!string.IsNullOrEmpty(txtDeviceSecret.Text))
    {
    	secret = EncryptUtil.HmacSHA256(txtDeviceSecret.Text, timestamp);
    }
    
    // Check whether the connection is secure.
    if (!cbSSLConnect.Checked)
    {
    	options = new ManagedMqttClientOptionsBuilder()
    	.WithAutoReconnectDelay(TimeSpan.FromSeconds(RECONNECT_TIME))
    	.WithClientOptions(new MqttClientOptionsBuilder()
    		.WithTcpServer(txtServerUri.Text, portNotSsl)
    		.WithCommunicationTimeout(TimeSpan.FromSeconds(DEFAULT_CONNECT_TIMEOUT))
    		.WithCredentials(txtDeviceId.Text, secret)
    		.WithClientId(clientID)
    		.WithKeepAlivePeriod(TimeSpan.FromSeconds(DEFAULT_KEEPLIVE))
    		.WithCleanSession(false)
    		.WithProtocolVersion(MqttProtocolVersion.V311)
    		.Build())
    	.Build();
    }
    else
    {
    	string caCertPath = Environment.CurrentDirectory + @"\certificate\rootcert.pem";
    	X509Certificate2 crt = new X509Certificate2(caCertPath);
    
    	options = new ManagedMqttClientOptionsBuilder()
    	.WithAutoReconnectDelay(TimeSpan.FromSeconds(RECONNECT_TIME))
    	.WithClientOptions(new MqttClientOptionsBuilder()
    		.WithTcpServer(txtServerUri.Text, portIsSsl)
    		.WithCommunicationTimeout(TimeSpan.FromSeconds(DEFAULT_CONNECT_TIMEOUT))
    		.WithCredentials(txtDeviceId.Text, secret)
    		.WithClientId(clientID)
    		.WithKeepAlivePeriod(TimeSpan.FromSeconds(DEFAULT_KEEPLIVE))
    		.WithCleanSession(false)
    		.WithTls(new MqttClientOptionsBuilderTlsParameters()
    		{
    			AllowUntrustedCertificates = true,
    			UseTls = true,
    			Certificates = new List<X509Certificate> { crt },
    			CertificateValidationHandler = delegate { return true; },
    			IgnoreCertificateChainErrors = false,
    			IgnoreCertificateRevocationErrors = false
    		})
    		.WithProtocolVersion(MqttProtocolVersion.V311)
    		.Build())
    	.Build();
    }
    
  2. Call the StartAsync method in the FrmMqttDemo class to set up a connection. After the connection is set up, the OnMqttClientConnected is called to print connection success logs.
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    Invoke((new Action(() =>
    {
    	ShowLogs($"{"try to connect to server " + txtServerUri.Text}{Environment.NewLine}");
    })));
    
    if (client.IsStarted)
    {
    	await client.StopAsync();
    }
    
    // Register an event.
    client.ApplicationMessageProcessedHandler = new ApplicationMessageProcessedHandlerDelegate(new Action<ApplicationMessageProcessedEventArgs>(ApplicationMessageProcessedHandlerMethod)); // Called when a message is published.
    
    client.ApplicationMessageReceivedHandler = new MqttApplicationMessageReceivedHandlerDelegate(new Action<MqttApplicationMessageReceivedEventArgs>(MqttApplicationMessageReceived)); // Called when a command is delivered.
    
    client.ConnectedHandler = new MqttClientConnectedHandlerDelegate(new Action<MqttClientConnectedEventArgs>(OnMqttClientConnected)); // Called when a connection is set up.
    
    Callback function when the client.DisconnectedHandler = new MqttClientDisconnectedHandlerDelegate(new Action<MqttClientDisconnectedEventArgs>(OnMqttClientDisconnected)); // Called when a connection is released.
    
    // Connect to the platform.
    await client.StartAsync(options);
    

    If the connection fails, the OnMqttClientDisconnected function executes backoff reconnection. Sample code:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    private void OnMqttClientDisconnected(MqttClientDisconnectedEventArgs e)
    {
    	try {
    		Invoke((new Action(() =>
    		{
    			ShowLogs("mqtt server is disconnected" + Environment.NewLine);
    
    			txtSubTopic.Enabled = true;
    			btnConnect.Enabled = true;
    			btnDisconnect.Enabled = false;
    			btnPublish.Enabled = false;
    			btnSubscribe.Enabled = false;
    		})));
    		
    		if (cbReconnect.Checked)
    		{
    			Invoke((new Action(() =>
    			{
    				ShowLogs("reconnect is starting" + Environment.NewLine);
    			})));
    
    			// Backoff reconnection
    			int lowBound = (int)(defaultBackoff * 0.8);
    			int highBound = (int)(defaultBackoff * 1.2);
    			long randomBackOff = random.Next(highBound - lowBound);
    			long backOffWithJitter = (int)(Math.Pow(2.0, retryTimes)) * (randomBackOff + lowBound);
    			long waitTImeUtilNextRetry = (int)(minBackoff + backOffWithJitter) > maxBackoff ? maxBackoff : (minBackoff + backOffWithJitter);
    
    			Invoke((new Action(() =>
    			{
    				ShowLogs("next retry time: " + waitTImeUtilNextRetry + Environment.NewLine);
    			})));
    
    			Thread.Sleep((int)waitTImeUtilNextRetry);
    
    			retryTimes++;
    
    			Task.Run(async () => { await ConnectMqttServerAsync(); });
    		}
    	}
    	catch (Exception ex)
    	{
    		Invoke((new Action(() =>
    		{
    			ShowLogs("mqtt demo error: " + ex.Message + Environment.NewLine);
    		})));
    	}
    }
    

Subscribing to a Topic

Only devices that subscribe to a specific topic can receive messages about the topic published by the broker. For details on the preset topics, see Topics.

The FrmMqttDemo class provides the method for delivering subscription commands to topics.

List<MqttTopicFilter> listTopic = new List<MqttTopicFilter>();

var topicFilterBulderPreTopic = new MqttTopicFilterBuilder().WithTopic(topic).Build();
listTopic.Add(topicFilterBulderPreTopic);

// Subscribe to a topic.
client.SubscribeAsync(listTopic.ToArray()).Wait();

After the connection is established and a topic is subscribed, the following information is displayed in the log area on the home page of the demo:

Receiving a Command

The FrmMqttDemo class provides the method for receiving commands delivered by the platform. After an MQTT connection is established and a topic is subscribed, you can deliver a command on the device details page of the IoTDA console or by using the demo on the application side. After the command is delivered, the MQTT callback receives the command delivered by the platform.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
private void MqttApplicationMessageReceived(MqttApplicationMessageReceivedEventArgs e)
{
	Invoke((new Action(() =>
	{
		ShowLogs($"received message is {Encoding.UTF8.GetString(e.ApplicationMessage.Payload)}{Environment.NewLine}");

		string msg = "{\"result_code\": 0,\"response_name\": \"COMMAND_RESPONSE\",\"paras\": {\"result\": \"success\"}}";

		string topic = "$oc/devices/" + txtDeviceId.Text + "/sys/commands/response/request_id=" + e.ApplicationMessage.Topic.Split('=')[1];

		ShowLogs($"{"response message msg = " + msg}{Environment.NewLine}");
		
		var appMsg = new MqttApplicationMessage();
		appMsg.Payload = Encoding.UTF8.GetBytes(msg);
		appMsg.Topic = topic;
		appMsg.QualityOfServiceLevel = int.Parse(cbOosSelect.SelectedValue.ToString()) == 0 ? MqttQualityOfServiceLevel.AtMostOnce : MqttQualityOfServiceLevel.AtLeastOnce;
		appMsg.Retain = false;

		// Return the upstream response.
		client.PublishAsync(appMsg).Wait();
	})));
}

For example, deliver a command carrying the parameter name SmokeDetectorControl: SILENCE and parameter value 50.

Figure 1 Command delivery - Synchronous command delivery

After the command is delivered, the following information is displayed on the demo page:

Publishing a Topic

Publishing a topic means that a device proactively reports its properties or messages to the platform. For details, see the API Device Reporting Properties.

The FrmMqttDemo class implements the property reporting topic and property reporting.

1
2
3
4
5
6
7
8
var appMsg = new MqttApplicationMessage();
appMsg.Payload = Encoding.UTF8.GetBytes(inputString);
appMsg.Topic = topic;
appMsg.QualityOfServiceLevel = int.Parse(cbOosSelect.SelectedValue.ToString()) == 0 ? MqttQualityOfServiceLevel.AtMostOnce : MqttQualityOfServiceLevel.AtLeastOnce;
appMsg.Retain = false;

// Return the upstream response.
client.PublishAsync(appMsg).Wait();

After a topic is published, the following information is displayed on the demo page:

If the reporting is successful, the reported device properties are displayed on the device details page.

Figure 2 Viewing reported data - Demo_smokeDetector
NOTE:

If no latest data is displayed on the device details page, modify the services and properties in the product model to ensure that the reported services and properties are the same as those defined in the product model. Alternatively, go to the product details page and delete all services.

NOTE:

Synchronous commands require device responses. For details, see Upstream Response Parameters.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback