设备接入 IoTDA设备接入 IoTDA

计算
弹性云服务器 ECS
裸金属服务器 BMS
云手机 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器 HECS
VR云渲游平台 CVR
特惠算力专区
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属企业存储服务
云存储网关 CSG
专属分布式存储服务 DSS
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘小站 IES
智能边缘平台 IEF
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
园区智能体 CampusGo
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
视频分析服务 VAS
语音交互服务 SIS
知识图谱 KG
人证核身服务 IVS
IoT物联网
设备接入 IoTDA
设备管理 IoTDM(联通用户专用)
全球SIM联接 GSL
IoT数据分析
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
开发与运维
软件开发平台 DevCloud
项目管理 ProjectMan
代码托管 CodeHub
流水线 CloudPipeline
代码检查 CodeCheck
编译构建 CloudBuild
部署 CloudDeploy
云测 CloudTest
发布 CloudRelease
移动应用测试 MobileAPPTest
CloudIDE
Classroom
开源镜像站 Mirrors
应用魔方 AppCube
云性能测试服务 CPTS
应用管理与运维平台 ServiceStage
云应用引擎 CAE
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
资源管理服务 RMS
应用身份管理服务 OneAccess
区块链
区块链服务 BCS
可信跨链服务 TCS
可信分布式身份服务
智能协作
IdeaHub
开发者工具
SDK开发指南
API签名指南
DevStar
HCloud CLI
Terraform
Ansible
云生态
云市场
合作伙伴中心
华为云培训中心
其他
管理控制台
消息中心
产品价格详情
系统权限
我的凭证
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
应用编排服务 AOS
多云容器平台 MCP
基因容器 GCS
容器洞察引擎 CIE
云原生服务中心 OSC
容器批量计算 BCE
容器交付流水线 ContainerOps
应用服务网格 ASM
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB (for openGauss)
云数据库 GaussDB(for MySQL)
云数据库 GaussDB NoSQL
数据管理服务 DAS
数据库和应用迁移 UGO
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据湖治理中心 DGC
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
API网关 APIG
分布式缓存服务 DCS
分布式消息服务RocketMQ版
企业应用
域名注册服务 Domains
云解析服务 DNS
云速建站 CloudSite
网站备案
商标注册
华为云WeLink
会议
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMAExchange
API全生命周期管理 ROMA API
安全与合规
安全技术与应用
DDoS防护 ADS
Web应用防火墙 WAF
云防火墙 CFW
应用信任中心 ATC
企业主机安全 HSS
容器安全服务 CGS
云堡垒机 CBH
数据库安全服务 DBSS
数据加密服务 DEW
数据安全中心 DSC
云证书管理服务 CCM
SSL证书管理 SCM
漏洞扫描服务 VSS
态势感知 SA
威胁检测服务 MTD
管理检测与响应 MDR
安全治理云图 Compass
认证测试中心 CTC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
专属云
专属计算集群 DCC
解决方案
高性能计算 HPC
SAP
混合云灾备
华为工业云平台 IMC
价格
成本优化最佳实践
专属云商业逻辑
用户服务
帐号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
更新时间:2021-12-24 GMT+08:00
分享

C# Demo使用说明

概述

本文以C#语言为例,介绍设备通过MQTTS/MQTT协议接入平台,通过平台接口实现“数据上报”“命令下发”的功能。如需其他语言接入,请参考资源获取

前提条件

准备工作

  • 访问Microsoft官网,选择合适系统的版本下载Microsoft Visual Studio。(本文以windows 64-bit系统,Microsoft Visual Studio 2017和.NET Framework 4.5.1为例)。
  • 下载完成后,运行安装文件,根据界面提示安装。

导入代码样例

  1. 下载quickStart(C#)样例。
  2. 运行Microsoft Visual Studio 2017,单击“打开项目/解决方案”,选择步骤1中下载的样例。

  3. 完成代码导入。

    代码目录简述:

    • App.config:Server地址和设备信息配置文件;
    • C#项目C#代码

      EncryptUtil.cs:设备密钥加密辅助类;

      FrmMqttDemo.cs:窗体界面;

      Program.cs:Demo程序启动入口。

    • dll项目中使用到了第三方库

      MQTTnet:v3.0.11,是一个基于 MQTT 通信的高性能 .NET 开源库,它同时支持 MQTT 服务器端和客户端,引用库文件包含MQTTnet.dll。

      MQTTnet.Extensions.ManagedClient:v3.0.11,这是一个扩展库,它使用MQTTnet为托管MQTT客户机提供附加功能。

  4. Demo里的工程配置参数。

    • App.config:需要配置服务器地址、设备ID和设备密钥,用于启动Demo程序的时候,程序将此信息自动写到Demo主界面。

      <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"/>

界面展示

  1. FrmMqttDemo主要提供了界面显示,默认启动后自动从App.config中获取Server地址、设备ID、设备密钥。请根据实际创建的设备信息填写。
  2. 示例中App.config默认写了设备侧接入的Server地址(SSL加密接入时该Server地址要与对应的证书文件匹配使用)。
    <add key="serverUri" value="iot-mqtts.cn-north-4.myhuaweicloud.com
    "/>;
  3. 用户可以选择设备侧建链时是否为SSL加密,选择Qos方式是0还是1,当前不支持Qos2,可参考使用限制

新建连接

设备或网关在接入物联网平台时首先需要和平台建立连接,从而将设备或网关与平台进行关联。开发者通过传入设备信息,将设备或网关连接到物联网平台。

  1. FrmMqttDemo类主要提供建立MQTT/MQTTS连接等方法,MQTT默认使用1883端口,MQTTS默认使用8883端口(需要加载设备校验平台身份的证书DigiCertGlobalRootCA.crt.pem,用于设备侧接入物联网平台登录鉴权使用,可以在资源获取中下载证书文件),ManagedMqttClientOptionsBuilder中提供了设置初始化KeepAlivePeriod的属性。mqtt连接心跳时间的建议值是120秒,有使用限制
     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;
    
    // 对密码进行HmacSHA256加密
    string secret = string.Empty;
    if (!string.IsNullOrEmpty(txtDeviceSecret.Text))
    {
    	secret = EncryptUtil.HmacSHA256(txtDeviceSecret.Text, timestamp);
    }
    
    // 判断是否为安全连接
    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. FrmMqttDemo类提供了Mqtt客户端建立连接的的方法StartAsync,连接成功后会通过回调函数OnMqttClientConnected打印连接成功日志。
     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();
    }
    
    // 注册事件
    client.ApplicationMessageProcessedHandler = new ApplicationMessageProcessedHandlerDelegate(new Action<ApplicationMessageProcessedEventArgs>(ApplicationMessageProcessedHandlerMethod)); // 消息发布回调
    
    client.ApplicationMessageReceivedHandler = new MqttApplicationMessageReceivedHandlerDelegate(new Action<MqttApplicationMessageReceivedEventArgs>(MqttApplicationMessageReceived)); // 命令下发回调
    
    client.ConnectedHandler = new MqttClientConnectedHandlerDelegate(new Action<MqttClientConnectedEventArgs>(OnMqttClientConnected)); // 连接成功回调
    
    client.DisconnectedHandler = new MqttClientDisconnectedHandlerDelegate(new Action<MqttClientDisconnectedEventArgs>(OnMqttClientDisconnected)); // 连接断开回调
    
    // 连接平台设备
    await client.StartAsync(options);
    

    注:如果连接失败,在OnMqttClientDisconnected函数中已实现退避重连,代码样例如下:

     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);
    			})));
    
    			//退避重连
    			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);
    		})));
    	}
    }
    

订阅Topic

订阅某topic的设备才能接收broker发布的关于该topic的消息,关于平台预置topic可参考Topic定义

在FrmMqttDemo类中提供了订阅命令下发topic的功能:

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

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

// 订阅Topic
client.SubscribeAsync(listTopic.ToArray()).Wait();

建链后,如果成功订阅Topic,主界面日志栏显示如下信息:

接收下发命令

在FrmMqttDemo类中提供了接收平台下发命令的功能,在MQTT建链完成并成功订阅Topic后,可以在控制台设备详情中命令下发或使用应用侧Demo对该设备ID进行命令下发。下发成功后,在MQTT的回调函数中接收到平台下发给设备的命令。

 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;

		// 上行响应
		client.PublishAsync(appMsg).Wait();
	})));
}

例如下发参数名为smokeDetector: SILENCE,参数值为50的命令。

命令下发成功后,Demo界面显示如下:

发布Topic

发布Topic是指设备主动向平台上报自己的属性或消息,详细见设备属性上报接口文档。

在FrmMqttDemo中实现了上报Topic、属性上报功能。

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;

// 上行响应
client.PublishAsync(appMsg).Wait();

发布Topic后,Demo界面显示如下:

设备上报属性成功后可在设备详情页面查看到上报的属性:

如果在“设备详情”页面没有最新上报数据,请修改产品模型中服务和属性的内容,确保设备上报的服务/属性和产品模型中的服务/属性一致,或者进入产品 > 模型定义页面,删除所有服务。

分享:

    相关文档

    相关产品

关闭导读