基於M5310模組實現NB設備接入實例

本頁目錄

1.上電初始化

2.UDP數據收發

• 2.1創建UDP Socket
• 2.2 發送UDP數據
• 2.3 接收UDP數據
• 2.4 关闭UDP

3.OneNET數據收發

• 3.1 OneNET 平台端創建設備
• 3.2 設備註冊流程
• 3.3 數據上報流程
• 3.4 設備管理流程
• 3.5 設備登出流程

1. 上電初始化

注意：每個AT命令之間應該留有一定時間間隔

注：需要確認入網狀態為已註冊才能進行後續數據收發操作，如果不使用自動上可使用AT+CEREG? 命令主動查詢當前註冊狀態直到變為已註冊，
目前測試開機註冊時間範圍為20s-120s。

2. UDP數據收發

2.1 創建UDP Socket

AT+NSOCR=`<type>`,`<protocol>`,`<listen prt>`[,`<receive control>`]

例如：

2.2 發送UDP數據

向目的UDP地址發送數據可使用AT+NSOST或AT+NSOSTF命令，如下，
AT+NSOST=`<socket>`,`<remote_addr>`,`<remote_port>`,`<length>`,`<data>`

AT+NSOSTF=`<socket>`,`<remote_addr>`,`<remote_port>`,`<flag>`,`<length>`,`<data>`

例如：

2.3 接收UDP數據

當接收到UDP數據時，可以使用AT+NSORF讀取，當讀取長度大於實際接收長度時，返回緩衝區實際接收數據長度

注：本示例的測試服務器為中移物聯網公司內部測試服務器，會自動回复”[遠程IP:端口]接收數據”，只做測試用途，不保證服務器功能。

2.4 關閉UDP

3. OneNET數據收發

3.1 OneNET 平台端創建設備

訪問OneNET門戶網站：http://onenet.hk.chinamobile.com，創建NB-IOT產品及設備。創建設備所使用的鑑權信息imei及imsi需要記錄並在終端登錄時使用，返回的device_id為平台端創建的設備接入標識，如果需要查詢設備信息，需要提供設備id

3.2 設備註冊流程

（1）版本統一與創建基礎通信套件

（2）向通信套件添加object組

LwM2M規範定義了每個對像對應客戶端的某個特定功能實體object，instance代表著這個object的不同實例。
通過objectid和instanceid可以確認到一個指定的object實例；而每個object下可以有多個resource屬性數據。
例如一個設備有芯片溫度傳感器與外界溫度傳感器的值須上報，溫度傳感器便是一種object對象，
而具體到某個溫度傳感器則需要instanceid來區分；某個溫度傳感器所對應的單位、溫度等數值可視為其resource屬性，
具體的編碼規範可參照IPSO規範或OMA模型規範http://www.openmobilealliance.org/wp/OMNA/LwM2M/LwM2MRegistry.html 。

終端側向OneNet平台側註冊，檢查OneNet平台側下發的discover請求，discover請求中包含3303、3306則判定添加成功。

（3）發起註冊請求

A、註冊操作

設備發送註冊請求到平台側，平台側接收到設備發送的註冊信息，在平台側檢查設備註冊情況。

AT+MIPLOPEN=0,3600,30

OK

+MIPLEVENT: 0,6

+MIPLDISCOVER:0,msgid,3303

+MIPLDISCOVER:0,msgid,3306

+MIPLOBSERVE:0,msgid,1,3303,0,-1

+MIPLOBSERVE:0,msgid,1,3303,1,-1

+MIPLOBSERVE:0,msgid,1,3306,0,-1

在OneNet平台側(http://onenet.hk.chinamobile.com/) 查看終端在線狀態(圖標為綠色)，終端在線則判定設備註冊成功。

控制平台下判斷註冊操作的API報文示例

GET http://api.onenet.hk.chinamobile.com/devices/status?imei=$IMEI&devIds=$DEVICE_ID HTTP/1.1   
Host: api.onenet.hk.chinamobile.com
api-key: OneNet分配的api-key  
Content-Length: 0  
終端側預期回復：online : true

B、無參數更新註冊

AT+MIPLUPDATE=0,0,0
OK
+MIPLEVENT:0,11
終端側在本次lifetime週期之內發送不攜帶參數的更新註冊信息到平台側, 
平台側對該更新註冊信息回應,確認檢查終端側是否收到平台側的回應。

C、參數變動更新註冊

AT+MIPLUPDATE=0,3600,1
OK
+MIPLEVENT:0,11
終端側在本次lifetime週期之內發送攜帶參數的更新註冊信息到平台側，
平台側對該更新註冊信息回應確認，檢查終端側是否收到平台側的回應。

3.3 數據上報流程

用戶上報數據

AT+MIPLNOTIFY=0,msgid1,3303,0,5700,4,4,98,0,0

OK

AT+MIPLNOTIFY=0,msgid2,3303,0,5601,4,4,88,0,0

OK

在OneNet平台側查看終端上報最新數據和歷史數據，數據完整且正確則判定成功。

控制平台下判斷註銷操作的API報文示例

GET http://api.onenet.hk.chinamobile.com/devices/$DEVICE_ID/datapoints?imei=$IMEI

HTTP/1.1

Host: api.onenet.hk.chinamobile.com

api-key: OneNet分配的api-key

Content-Length: 0

終端側預期回復：

{"errno":0,"data":{5700和5601最新數據},"error":"succ"}

3.4 設備管理流程

設備管理目前版本提供6操作：discover、read、write、execute、write-attributes、observe、

MCU應在執行平台下發的規定操作後數秒內（建議3s）上報對應操作結果，否則傳輸信息可能丟失。

（1） discover操作

設備發送註冊請求到平台側，檢查設備接收到的平台側信息中的discover 請求信息，並回應discover請求，在平台側檢查設備資源情況。

AT+MIPLOPEN=0,3600,30

OK

+MIPLEVENT: 0,6

+MIPLDISCOVER:0,msgid1,3303

+MIPLDISCOVER:0,msgid2,3306

+MIPLOBSERVE:0,msgid3,1,3303,0,-1

+MIPLOBSERVE:0,msgid4,1,3303,1,-1

+MIPLOBSERVE:0,msgid5,1,3306,0,-1

AT+MIPLDISCOVERRSP=0,msgid1,1,34,"5700;5701;5601;5602;5603;5604;5605"

AT+MIPLDISCOVERRSP=0,msgid2,1,24,"5850;5851;5852;5853;5750"

OK

在OneNet平台側查看終端資源列表，完整顯示終端設備的實例和資源信息則判定成功。

控制平台下獲取discover狀態的API報文示例:

GET http://api.onenet.hk.chinamobile.com/nbiot/resources?imei=$IMEI&obj_id=3303&obj_inst_id=0 HTTP/1.1

Host: api.onenet.hk.chinamobile.com

api-key: OneNet分配的api-key

Content-Length: 0

預期結果：

終端設備的完整對象、實例、資源列表信息。

（2）read操作

A、讀取resource請求

平台側向設備發送指定資源的Read操作請求，設備收到消息後，終端通信套件獲取設備的資源值信息返回給平台側，在平台側檢查讀取結果。

AT+MIPLREADRSP=0,msgid,1,3303,0,5700,4,4,20.123,0,0

OK

OneNet平台側預期結果：

{"errno":0,"data":[{"res":[{"val":20.123,"res_id":5700}],"obj_inst_id":0}],"error":"succ"}

控制平台下讀操作的API報文示例:

GET http://api.onenet.hk.chinamobile.com/nbiot?imei=$IMEI&obj_id=3303&obj_inst_id=0&res_id=5700 HTTP/1.1

Host: api.onenet.hk.chinamobile.com

api-key: OneNet分配的api-key

Content-Length: 0

終端側預期回復：

+MIPLREAD:0,msgid,3303,0,5700

B、讀取instance請求

平台側向設備發送指定實例的Read操作請求，設備收到消息後，終端通信套件獲取設備的實例資源信息返回給平台側，在平台側檢查讀取結果。

AT+MIPLREADRSP=0,msgid,1,3303,0,5700,4,4,20.123,5,0

AT+MIPLREADRSP=0,msgid,1,3303,0,5701,1,3, "Cel",4,0

AT+MIPLREADRSP=0,msgid,1,3303,0,5601,4,4,10.123,3,0

AT+MIPLREADRSP=0,msgid,1,3303,0,5602,4,4,60.2,2,0

AT+MIPLREADRSP=0,msgid,1,3303,0,5603,4,4,0.0,1,0

AT+MIPLREADRSP=0,msgid,1,3303,0,5604,4,4,99.0,0,0

OK

OK

OneNet平台側預期結果：

{   "errno":0,
    "data":[
      {
          "res":[
                 {"val":20.123,"res_id":5700},
                 {"val":"Cel","res_id":5701},
                 {"val":10.123,"res_id":5601},
                 {"val":60.2,"res_id":5602},
                 {"val":0.0,"res_id":5603},
                 {"val":99.0,"res_id":5604}
                ],
          "obj_inst_id":0}
          ],
    "error":"succ"
    }

控制平台下读操作的API报文示例:

GET http://api.onenet.hk.chinamobile.com/nbiot?imei=$IMEI&obj_id=3303&obj_inst_id=0 HTTP/1.1

Host: api.onenet.hk.chinamobile.com

api-key: OneNet分配的api-key

Content-Length: 0

終端側預期回復：

+MIPLREAD:0,msgid,3303,0,-1

C、讀取object請求

平台側向設備發送指定物件的Read操作請求設備收到消息後，終端通信套件獲取設備的物件實例資源信息返回給平台側在平台側檢查讀取結果。

AT+MIPLREADRSP=0,msgid,1,3303,0,5701,1,3, "Cel",3,0

AT+MIPLREADRSP=0,msgid,1,3303,0,5602,4,4,50.123,2,0

AT+MIPLREADRSP=0,msgid,1,3303,1,5701,1,3, "Cel",1,0

AT+MIPLREADRSP=0,msgid,1,3303,1,5602,4,4,55.123,0,0

OK

OK

OK

OK

OneNET平台側預期結果：

{
    "errno":0,
    "data":[
        {
            "res":[
                    {"val":"Cel","res_id":5701},
                    {"val":50.123,"res_id":5602}],
             "obj_inst_id":0
            },
             {"res":[
                 {"val":"Cel","res_id":5701},
                 {"val":55.123,"res_id":5602}
                 ],
                 "obj_inst_id":1}
        ],
    "error":"succ"
    }

控制平台下讀操作的API報文示例:

GET http://api.onenet.hk.chinamobile.com/nbiot?imei=$IMEI&obj_id=3303 HTTP/1.1

Host: api.onenet.hk.chinamobile.com

api-key: OneNet分配的api-key

Content-Length: 0

終端側預期回復：

+MIPLREAD:0,msgid,3303,-1,-1

資源讀取API報文協議如下：

注：每次read操作後模組回應上報COAP報文長度應小於512Bytes。

（3） write操作

A、寫入source請求

平台側向設備發送指定資源的Write操作請求，設備收到消息後，終端通信套件將指定值寫入指定資源，在終端側檢查寫入結果。

AT+MIPLWRITERSP=0,msgid,2

OK

OneNet平台側預期結果：

{"errno":0,"error":"succ"}

控制平台下寫操作的API報文示例：

POST http://api.onenet.hk.chinamobile.com/nbiot?imei=$IMEI&obj_id=3306&obj_inst_id=0&mode=2 HTTP/1.1  

Host: api.onenet.hk.chinamobile.com

api-key: OneNet分配的api-key  

Content-Length: 47       //數值根據HTTP報文實際body大小修改  

Content-Type:application/json  

HTTP内容：{"data":[{"res_id":5850,"val":1}]}

終端側預期回復：

+MIPLWRITE:0,msgid,3306,0,5850,2,1,01,0,0

B、寫入instance請求

平台側向設備發送指定實例的Write操作請求，設備收到消息後，終端通信套件將指定值寫入指定實例下的資源，在終端側檢查寫入結果。

AT+MIPLWRITERSP=0,msgid,2

OK

OneNet平台側預期結果：

{"errno":0,"error":"succ"}

控制平台下寫操作的API報文示例：

POST http://api.onenet.hk.chinamobile.com/nbiot?imei=$IMEI&obj_id=3306&obj_inst_id=0&mode=2 HTTP/1.1

Host: api.onenet.hk.chinamobile.com

api-key: OneNet分配的api-key

Content-Length: 47       //數值根據HTTP報文實際body大小修改

Content-Type:application/json

HTTP内容：{"data":[{"res_id":5850,"val":1},{"res_id":5851,"val":22}]}

終端側預期回復：

+MIPLWRITE:0,msgid,3306,0,5850,2,1,01,0,1

+MIPLWRITE:0,msgid,3306,0,5851,2,1,16,0,0

資源寫入API報文協議如下:

注：每次write操作下發COAP報文長度應小於512Bytes，故下發數據段長度最大480Bytes。

（4） execute操作

平台側向設備發送指定資源的Exec操作請求，設備收到消息後，終端通信套件將操作值寫入指定資源，在終端側檢查執行結果。

AT+MIPLEXECUTERSP=0,msgid,2

OK

OneNET平台側預期結果：

{"errno":0,"error":"succ"}

控制平台下發execute消息的API報文示例：

POST http://api.onenet.hk.chinamobile.com/nbiot/execute?imei=$IMEI&obj_id=3303&obj_inst_id=0&res_id=5605 HTTP/1.1

api-key:OneNet分配的api-key

Host: api.onenet.hk.chinamobile.com

Content-Length: 21       //數值根據HTTP報文實際body大小修改

Content-Type:application/json

HTTP内容：{"args":"reset"}

終端側預期回復：

+MIPLEXECUTE:0,msgid,3303,0,5605,5, "reset"

資源執行API報文協議如下：

注:每次execute操作下發COAP報文長度應小於512Bytes，故下發數據段長度最大480Bytes。

（5） Write-Attributes操作

平台側向設備發送指定資源的Write-Attr butes操作請求，設備收到消息後，終端通信套件將屬性值寫入指定資源，在終端側檢查執行結果。

AT+MIPLPARAMETERRSP=0,msgid1,2

AT+MIPLPARAMETERRSP=0,msgid2,2

OK

OK

OneNet平台側預期結果：

{"errno":0,"error":"succ"} {"errno":0,"error":"succ"}

控制平台下發Write-Attributes消息的API報文示例：

POST http://api.onenet.hk.chinamobile.com/nbiot/observe?imei=$IMEI&cancel=false&obj_id=3303&obj_inst_id=0
&res_id=5700&pmin=15&pmax=60&gt=50&lt=0&st=2 HTTP/1.1

POST http://api.onenet.hk.chinamobile.com/nbiot/observe?imei=$IMEI&cancel=false&obj_id=3303&obj_inst_id=0
&res_id=5601&pmin=18&pmax=90&gt=60&lt=0&st=2 HTTP/1.1

api-key:OneNet分配的api-key

Host: api.onenet.hk.chinamobile.com

Content-Length: 21       //數值根據HTTP報文實際body大小修改

Content-Type:application/json

{"args": " reset "}

終端側預期回復：

+MIPLPARAMETER:0,msgid1,3303,0,5700,37,"pmin=15;pmax=60;lt=0.0;gt=50.0;st=2.0"

+MIPLPARAMETER:0,msgid2,3303,0,5601,37,"pmin=18;pmax=90;lt=0.0;gt=60.0;st=2.0"

（6） Observe操作

A、觀察resource請求

平台側向設備發送指定資源的Observe操作請求，設備收到消息後，終端通信套件訂閱指定資源，在終端側檢查執行結果。

AT+MIPLPARAMETERRSP=0,msgid1,2

AT+MIPLPARAMETERRSP=0,msgid2,2

OK

OK

+MIPLOBSERVE:0,msgid3,1,3303,0,5700

+MIPLOBSERVE:0,msgid4,1,3303,0,5601

AT+MIPLOBSERVERSP=0,msgid3,1

AT+MIPLOBSERVERSP=0,msgid4,1

OK

OK

OneNet平台側預期結果：

{"errno":0,"error":"succ"}

{"errno":0,"error":"succ"}

控制平台下觀察操作的API報文示例:

GET http://api.onenet.hk.chinamobile.com/nbiot/observe?imei=$IMEI&cancel=false&obj_id=3303&obj_inst_id=0
&res_id=5700&pmin=15&pmax=60&gt=50&lt=0&st=2 HTTP/1.1

GET http://api.onenet.hk.chinamobile.com/nbiot/observe?imei=$IMEI&cancel=false&obj_id=3303&obj_inst_id=0
&res_id=5601&pmin=18&pmax=90&gt=60&lt=0&st=2 HTTP/1.1

api-key:OneNet分配的api-key

Host: api.onenet.hk.chinamobile.com

Content-Length: 21       //數值根據HTTP報文實際body大小修改

Content-Type:application/json

終端側預期回復：

+MIPLPARAMETER:0,msgid1,3303,0,5700,37,"pmin=15;pmax=60;lt=0.0;gt=50.0;st=2.0"

+MIPLPARAMETER:0,msgid2,3303,0,5601,37,"pmin=18;pmax=90;lt=0.0;gt=60.0;st=2.0"

B、觀察instance請求

平台側向設備發送指定實例的Observe操作請求，設備收到消息後，終端通信套件訂閱指定實例，在終端側檢查執行結果。

AT+MIPLOBSERVERSP=0,msgid,1

OK

OneNet平台側預期結果：

{"errno":0,"error":"succ"}

控制平台下觀察操作的API報文示例:

GET http://api.onenet.hk.chinamobile.com/nbiot/observe?imei=$IMEI&cancel=false&obj_id=3303&obj_inst_id=0 HTTP/1.1

api-key:OneNet分配的api-key

Host: api.onenet.hk.chinamobile.com

Content-Length: 21       //數值根據HTTP報文實際body大小修改

Content-Type:application/json

終端側預期回復：

+MIPLOBSERVE:0,msgid,1,3303,0,-1

C、觀察object請求

平台側向設備發送指定物件的Observe操作請求，設備收到消息後，終端通信套件訂閱指定物件，在終端側檢查執行結果。

AT+MIPLOBSERVERSP=0,msgid,1

OK

OneNet平台側預期結果：

{"errno":0,"error":"succ"}

控制平台下觀察操作的API報文示例:

GET http://api.onenet.hk.chinamobile.com/nbiot/observe?imei=$IMEI&cancel=false&obj_id=3303 HTTP/1.1

api-key:OneNet分配的api-key

Host: api.onenet.hk.chinamobile.com

Content-Length: 21       //數值根據HTTP報文實際body大小修改

Content-Type:application/json

終端側預期回復：

+MIPLOBSERVE:0,msgid,1,3303,-1,-1

D、取消觀察resource請求

平台側向設備發送指定資源的取消觀察的操作請求，設備收到消息後，終端通信套件取消訂閱指定資源，在終端側檢查執行結果。

AT+MIPLOBSERVERSP=0,msgid,1

OK

OneNet平台側預期結果：

{"errno":0,"error":"succ"}

控制平台下取消觀察操作的API報文示例:

GET http://api.onenet.hk.chinamobile.com/nbiot/observe?imei=$IMEI&cancel=true&obj_id=3303&obj_inst_id=0&res_id=5700 HTTP/1.1

api-key:OneNet分配的api-key

Host: api.onenet.hk.chinamobile.com

Content-Length: 21       //數值根據HTTP報文實際body大小修改

Content-Type:application/json

終端側預期回復：

+MIPLOBSERVE:0,msgid,0,3303,0,5700

E、取消觀察instance請求

平台側向設備發送指定實例的取消觀察的操作請求，設備收到消息後，終端通信套件取消訂閱指定實例，在終端側檢查執行結果。

AT+MIPLOBSERVERSP=0,msgid,1

OK

OneNet平台側預期結果：

{"errno":0,"error":"succ"}

控制平台下取消觀察操作的API報文示例:

GET http://api.onenet.hk.chinamobile.com/nbiot/observe?imei=$IMEI&cancel=true&obj_id=3303&obj_inst_id=0 HTTP/1.1

api-key:OneNet分配的api-key

Host: api.onenet.hk.chinamobile.com

Content-Length: 21       //數值根據HTTP報文實際body大小修改

Content-Type:application/json

終端側預期回復：

+MIPLOBSERVE:0,msgid,0,3303,0,-1

F、取消觀察odject請求

平台側向設備發送指定物件的取消觀察的操作請求，設備收到消息後，終端通信套件取消訂閱指定物件，在終端側檢查執行結果。

AT+MIPLOBSERVERSP=0,msgid,1

OK

OneNet平台側預期結果：

{"errno":0,"error":"succ"}

控制平台下取消觀察操作的API報文示例:

GET http://api.onenet.hk.chinamobile.com/nbiot/observe?imei=$IMEI&cancel=true&obj_id=3303 HTTP/1.1

api-key:OneNet分配的api-key

Host: api.onenet.hk.chinamobile.com

Content-Length: 21       //數值根據HTTP報文實際body大小修改

Content-Type:application/json

終端側預期回復：

+MIPLOBSERVE:0,msgid,0,3303,-1,-1

3.5 設備登出流程

AT+MIPLCLOSE=0

OK

在OneNet平台側查看終端離線狀態(圖示為灰色)，終端離線則判定登出成功。

AT+MIPLDELETE=0（ref值通常為0）

OK

終端側向OneNet平台側發起註冊過程，註冊失敗則判定刪除通信套件成功。

AT+MIPLDELOBJ=0,3306

OK

終端側向OneNet平台側註銷後再次註冊，檢查OneNet平台側下發的discover請求，discover請求中不包含3306則判定對象3306刪除成功。

控制平台下判斷註銷操作的API報文示例

GET http://api.onenet.hk.chinamobile.com/devices/status?imei=$IMEI&devIds=DEVICE_ID HTTP/1.1

Host: api.onenet.hk.chinamobile.com

api-key: OneNet分配的api-key

Content-Length: 0

終端側預期回復：

online : false

注：用戶亦可在向平台發送註銷請求後執行銷毀實例，此時模組會自動刪除所有object。
用戶亦可直接執行銷毀實例，模組將會在向平台提出註銷請求後刪除object再銷毀Object以及通信實例。