跳到主要内容

NBIOT M5311 TCP Client通信

前言：虽然在如今的物联网开发中，像MQTT，COAP这些专门为了物联网而诞生的协议逐渐成为主流，但其实TCP做为最基本的通信方式，依然可以解决大部分的物联通信需求。所以我们在选择物联网协议时，也没必要一味的追求人云亦云，尤其是新手容易产生一种误区，别人都用MQTT那我也要用MQTT，其实您要做的是静下心来了解TCP和MQTT或者COAP这样的协议在通信方式，架构上的区别，然后和您的服务端开发人员在一起商议，结合物联网设备数量规模、设备是否长时间在线以及服务器容量和部署成本等特性来决定用什么协议。

一、本例程实现功能​

Core通过M5311 NB-IOT模块和指定的服务器建立TCP连接，Core每5秒向服务器发送一个数据包(5字节)，服务器每2秒钟向Core发送一个数据包(5字节)。

二、 Core提供的TCP功能介绍​

Core已将TCP的操作封装成三个简单的API函数，分别为：LIB_NbTcpConfig()，LIB_NbTcpRecv()，LIB_NbTcpSend()。您只需要调用这三个API即可将NB-IOT模块远程连接上server端开始收发数据。并且Core会自动处理通信中的异常情况并尝试重新恢复通信（比如和server的tcp连接异常断开，网络异常等），您无需考虑这些复杂的情况即可实现NBIOT模块长期稳定的在线通讯。

三、接线图​

layout

四、材料清单​

名称推荐购买链接（或者您可以自己制作）模块/芯片硬件资料下载
M5311模块请自行某宝搜索M5311下载地址
声明：这里推荐的购买链接仅供参考，您完全可以去其他商家或渠道购买，只要功能相似即可，如果需要更低的成本建议自己开发硬件模块或定制。

product1

五、完整代码​

Core通过M5311 NB-IOT模块和指定的服务器建立TCP连接，Core每5秒向服务器发送一个数据包(5字节)，服务器每2秒钟向Core发送一个数据包(5字节)。

--配置USB以虚拟串口模式工作，这样调用print()函数就会在电脑串口终端打印输出
LIB_UsbConfig("CDC")
--使能系统10毫秒定时器开始工作
LIB_10msTimerConfig("ENABLE")
--设置m5311 NB模块占用TX0、RX0、D5、D6引脚，TCP Client模式
--tcp服务器IP:"103.46.128.49" 端口号:28438
--心跳包间隔时间0秒(不使用心跳机制)。如果需要使用请在ApiDoc文档中查阅关于LIB_NbTcpConfig函数的p8参数详细介绍
LIB_NbTcpConfig("UART0","D5","HIGH","D6","HIGH","103.46.128.49",28438,0)
--变量初始化
cnt_10ms = 0
cnt1_10ms = 0
send_tab = {0x01,0x02,0x03,0x04,0x05} --需要发送给server端的数据
--定义10ms中断回调函数
function LIB_10msTimerCallback()
    cnt_10ms = cnt_10ms + 1
	cnt1_10ms = cnt1_10ms + 1
end
--开始大循环
while(GC(1) == true)
do
    --查询是否收到server下发的数据，如果收到就print输出收到的数据
    recv_flag,recv_tab = LIB_NbTcpRecv()
    if recv_flag == 1 then
        print(string.format("tcp client receive %d bytes", #recv_tab))
        for k,v in ipairs(recv_tab) do
            print(k,v)
        end
    end
    --每5秒发送一包数据给server
    if cnt_10ms >= 500 then  --5000ms
        cnt_10ms = 0
        LIB_NbTcpSend(send_tab)
    end
	--每12秒打印一次NBIOT模组信息(包含sim卡)
	--注意：这里只是为了演示，实际应用中您可以根据您的需求查询即可，不需要一直查询
    if cnt1_10ms >= 1200 then  --12000ms
        cnt1_10ms = 0
        State,IMEI,IMSI,ICCID,RSSI = LIB_NbStatusQuery()
		print(string.format("module state: %s", State))
		print(string.format("module IMEI: %s", IMEI))
		print(string.format("module IMSI: %s", IMSI))
		print(string.format("module ICCID: %s", ICCID))
		print(string.format("module RSSI: %d dBM", RSSI))
    end
end
如果感兴趣，上面代码中出现的LIB开头的库函数可以在 API文档 中通过Ctrl+F查询。

代码运行结果​

如果您没有自己的独立服务器IP地址的话，我们可以在自己的电脑上本地运行一个TCP服务器，然后借助花生壳内网穿透工具赋予本地TCP服务器一个可远程访问的公有IP地址和端口号，内网穿透的具体方法在下一章节中我们会介绍。搭建好内网穿透环境后，我们就可以在自己的电脑(192.168.1.100：5678)上运行《网络调试助手》软件来模拟Tcp 服务器端进行调试。

（1）Server端数据接收如下：

result0

（2）Client端(Core)数据接收如下：

result1

（3）Core每12秒打印的模块信息如下：

result2

六、 利用花生壳内网穿透工具，让运行在自己电脑上的Tcp Server具备独立的域名和端口号​

  1. 在 https://hsk.oray.com/ 花生壳官网注册账号

  2. 初次体验，可选购个人免费版，后期结合您个人需求可升级付费的

    huashengke0

  3. 下载花生壳客户端安装并运行

  4. 在域名管理列表中建立新的域名，域名有免费的也有收费的，选免费的即可

  5. 将域名和本机TCP Server(网络调试助手)的IP地址和端口建立映射关系即可，下图就是上一章节中用到的已建立好的内网穿透映射，192.168.1.100: 5678就是我本机电脑上运行的网络调试助手的IP地址和端口号。

    huashengke2

huashengke1

最后虽然我们本地的IP地址192.168.1.100和域名 320084j2v7.zicp.vip建立了内网穿透映射关系，但我们还不知道 320084j2v7.zicp.vip的IP地址，这里我们只需ping一下该域名即可获取其公网IP地址，如下图：

huashengke3

到这里我们就为我们本地的网络调试助手(192.168.1.100:5678)绑定了一个可以远程访问的公网地址：

IP地址：103.46.128.49

端口号：28438