Instance of NB device access realized on the basis of M5310 module

Contents in this page

1. Power on initialization

2.UDP Data sending and receiving

• 2.1 Create UDP Socket
• 2.2 Send UDP data
• 2.3 Receive UDP data
• 2.4 Close UDP

3.OneNET Data sending and receiving

• 3.1 OneNET Device created on the platform side
• 3.2 Device registration process
• 3.3 Data reporting process
• 3.4 Device Bootstrap process
• 3.5 Device management process
• 3.6 Device logout process

1. Power on initialization

Note: There should be a time interval between each AT command

Note: It is necessary to confirm that the network is in registered status before the subsequent data sending and receiving operation. In case the automatic reporting function is not used,
AT+CEREG? The command can be used to query the current registration status until it becomes registered. The current test starting up registration time ranges from 20s to 120s 。

2. UDP data sending and receiving

2.1 Create UDP Socket

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

For example:

2.2 Send UDP data

Send a command that AT+NSOST or AT+NSOSTF can be used by data to the destination UDP address as below,
AT+NSOST=`<socket>`,`<remote_addr>`,`<remote_port>`,`<length>`,`<data>`

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

For example:

2.3 Receive UDP data

When UDP data is received, AT+NSORF can be used to read it, and when the read length is greater than the actual received length, the actual data length received by the buffer will be returned

Note: The test server of this instance, which is the internal test server of China Mobile Internet of Things Company, can automatically reply “[Remote IP: Port] Receive data”. It is only used for test purposes, and the function of the server is not guaranteed.

2.4 Close UDP

3. OneNET data sending and receiving

3.1 OneNET Device created on the platform side

Visit the OneNET portal website: http://open.iot.10086.cn/ , and create NB-IOT products and devices.
The authentication information, imei, and imsi, used to create the device should be recorded and used in terminal registration. The returned device_id is the device access identification created on the platform side.
In case it is necessary to query the device information, the device id is required to be provided

3.2 Device registration process

(1)Version unification and creation of the basic communication suite

(2) Add an object group to the communication suite

The LwM2M specification defines that each specific functional entity object and instance of the client to which the object corresponds represent different instances of the object.
A specified object instance can be confirmed by objectid and Instanceid; but there can be multiple resource attribute data under each object.
For example, in case the value of a device with a chip temperature sensor an external temperature sensor must be reported, the temperature sensor is a kind of object,
But instanceid is required to discern specific temperature sensors; the unit, temperature, and other values corresponding to the temperature sensor can be regarded as its resource attribute
For specific coding specifications, refer to the IPSO Specification or the OMA Model Specification http://www.openmobilealliance.org/wp/OMNA/LwM2M/LwM2MRegistry.html .

The terminal side is registered on the OneNet platform side, check the discover request sent on the OneNet platform side. In case the discover request contains 3303 and 3306, it will be judged that the addition is successful.

(3) Send registration request

A、Registration operation

The device sends a registration request to the platform side. After receiving the registration information sent by the device, the platform side will check the device registration situation.

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

Check the online status of the terminal (the icon is green) on the OneNet platform side (http://api.heclouds.com). In case the terminal is online, the device will be judged to be registered successfully.

API message instance for judging registration operations on the control platform

GET http://api.heclouds.com/devices/status?imei=$IMEI&devIds=$DEVICE_ID HTTP/1.1   
Host: api.heclouds.com/  
api-key: api-key assigned by OneNet
Content-Length: 0  
Expected reply of the terminal side: online : true

B、Parameter-free updated registration

AT+MIPLUPDATE=0,0,0
OK
+MIPLEVENT:0,11
The terminal side sends the updated registration information without parameters to the platform side within this lifetime period,
The platform side responds to the updated registration information to confirm and check whether the terminal side has received the response from the platform side.

C、Parameter-changing updated registration

AT+MIPLUPDATE=0,3600,1
OK
+MIPLEVENT:0,11
The terminal side sends the updated registration information with parameters to the platform side within this lifetime period,
The platform side responds to and confirms the updated registration information and checks whether the terminal side has received the response from the platform side.

3.3 Data reporting process

3.4 Device Bootstrap process

Under the condition that the device has been initialized, the basic communication suite (the configuration information contains the Bootstrap server address coap://183.230.40.39:5683) has been successfully created, the object and instance (3303, 3306) have been added to the basic communication suite, and the Bootstrap server is ready,
The client side sends a registration to the platform side to trigger the Bootstrap process and check whether the Bootstrap process is successful.

AT+MIPLOPEN=0,3600,30

OK

+MIPLEVENT: 0,1

+MIPLEVENT: 0,2

+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

The online status of the terminal is checked on the OneNet platform side (http://api.heclouds.com) (the icon is green). In case the terminal is online, the Bootstrap process will be judged to be successful.

API message instance for determining Bootstrap operation on the control platform

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

Host: api.heclouds.com/

api-key: api-key assigned by OneNet

Content-Length: 0

Expected reply of the terminal side: online : true

3.5 Device management process

6 operations are provided by the current version of device management：discover、read、write、execute、write-attributes、observe、

MCU should report the corresponding operation result within a few seconds after executing the specified operation sent by the platform (3s is recommended), otherwise, the transmission information may be lost.

（1） discover operation

The device sends a registration request to the platform side, checks Discover request information on the platform side information received by the device, replies to the Discover request, and checks the device resources situation on the platform side.

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

Check the terminal resources list on the OneNet platform side. In case the instance and resource information of the terminal device is fully displayed, it will be judged successful

API message instance obtaining discover status on the control platform:

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

Host: api.heclouds.com/

api-key: Api-key assigned by OneNet

Content-Length: 0

Expected result:

Complete object, instance, resource list information of the terminal device.

(2)read operation

A、Read resource request

The platform side device sends a Read operation request of the specified resource. After the device receives the message, the terminal communication suite obtains the resource value information of the device and returns it to the platform side for checking the read results.

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

OK

Expected results of the OneNet platform side：

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

API message instance for reading operations on the control platform:

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

Host: api.heclouds.com/

api-key: Api-key assigned by OneNet

Content-Length: 0

Expected reply of the terminal side:

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

B、Read instance request

The platform side device sends a Read operation request of the specified instance. After the device receives the message, the terminal communication suite obtains the instance resource information of the device and returns it to the platform side for checking the read results.

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

Expected reply of the terminal side：

{   "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 message instance for reading operations on the control platform:

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

Host: api.heclouds.com/

api-key: Api-key assigned by OneNet

Content-Length: 0

Expected reply of the terminal side:

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

C、Read object request

The platform side device sends a Read operation request of the specified object. After the device receives the message, the terminal communication suite obtains the object and instance resource information of the device and returns it to the platform side for checking the read results.

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

Expected reply of the terminal side：

{
    "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 message instance for reading operations on the control platform:

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

Host: api.heclouds.com/

api-key: Api-key assigned by OneNet

Content-Length: 0

Expected reply of the terminal side:

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

API message protocol for resource read is as follows：

Note: After each read operation, the length of the COAP message reported by the module response should be less than 512Bytes.

（3） write operation

A、Write the source request

The platform side device sends a Write operation request of the specified resource. After the device receives the message, the terminal communication suite writes the specified value to the specified resource and checks the write result on the terminal side.

AT+MIPLWRITERSP=0,msgid,2

OK

Expected reply of the terminal side：

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

API message instance for writing operations on the control platform:

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

Host: api.heclouds.com/  

api-key: Api-key assigned by OneNet  

Content-Length: 47       //The value is modified based on the actual body size of the HTTP message  

Content-Type:application/json  

HTTP content:{"data":[{"res_id":5850,"val":1}]}

Expected reply of the terminal side:

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

B、Write the instance request

The platform side device sends a Write operation request of the specified instance. After the device receives the message, the terminal communication suite writes the specified value to the resource under the specified instance and checks the write result on the terminal side.

AT+MIPLWRITERSP=0,msgid,2

OK

Expected reply of the terminal side：

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

API message instance for writing operations on the control platform:

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

Host: api.heclouds.com/

api-key: Api-key assigned by OneNet

Content-Length: 47       //The value is modified based on the actual body size of the HTTP message  

Content-Type:application/json

HTTP content:{"data":[{"res_id":5850,"val":1},{"res_id":5851,"val":22}]}

Expected reply of the terminal side:

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

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

API message protocol of resource write-in is as follows:

Note: The length of COAP message sent for each write operation should be less than 512Bytes, so the maximum length of the data segment should be 480Bytes.

（4） execute operation

The platform side device sends an Exec operation request of the specified resource. After the device receives the message, the terminal communication suite writes the operation value to the specified resource and checks the execution result on the terminal side.

AT+MIPLEXECUTERSP=0,msgid,2

OK

Expected reply of the terminal side：

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

API message instance for sending execute message on the control platform:

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

api-key:Api-key assigned by OneNet

Host: api.heclouds.com

Content-Length: 21       //The value is modified based on the actual body size of the HTTP message

Content-Type:application/json

HTTP content:{"args":"reset"}

Expected reply of the terminal side:

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

API message protocol of resource execution is as follows:

Note: The length of COAP message sent by each execute operation should be less than 512Bytes, so the maximum length of the data segment should be 480Bytes.

（5） Write-Attributes operation

The platform side device sends a Write-Attributes operation request of the specified resource. After the device receives the message, the terminal communication suite writes the attribute value to the specified resource and checks the execution result on the terminal side.

AT+MIPLPARAMETERRSP=0,msgid1,2

AT+MIPLPARAMETERRSP=0,msgid2,2

OK

OK

Expected reply of the terminal side：

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

API message instance for sending the Write-Attributes message on the control platform:

POST http://api.heclouds.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.heclouds.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:Api-key assigned by OneNet

Host: api.heclouds.com

Content-Length: 21       //The value is modified based on the actual body size of the HTTP message

Content-Type:application/json

{"args": " reset "}

Expected reply of the terminal side:

+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 operation

A、Observe resource request

The platform side device sends an Observe operation request of the specified resource. After the device receives the message, the terminal communication suite subscribes to the specified resource and checks the execution result on the terminal side.

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

Expected reply of the terminal side：

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

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

API message instance for observing operations on the control platform

GET http://api.heclouds.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.heclouds.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:Api-key assigned by OneNet

Host: api.heclouds.com

Content-Length: 21       //The value is modified based on the actual body size of the HTTP message

Content-Type:application/json

Expected reply of the terminal side:

+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、Observe instance request

The platform side device sends an Observe operation request of the specified instance. After the device receives the message, the terminal communication suite subscribes to the specified instance and checks the execution result on the terminal side.

AT+MIPLOBSERVERSP=0,msgid,1

OK

Expected reply of the terminal side：

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

API message instance for observing operations on the control platform:

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

api-key:Api-key assigned by OneNet

Host: api.heclouds.com

Content-Length: 21       //The value is modified based on the actual body size of the HTTP message

Content-Type:application/json

Expected reply of the terminal side:

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

C、Observe the object request

The platform side device sends an Observe operation request of the specified object. After the device receives the message, the terminal communication suite subscribes to the specified object and checks the execution result on the terminal side.

AT+MIPLOBSERVERSP=0,msgid,1

OK

Expected reply of the terminal side：

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

API message instance for observing operations on the control platform:

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

api-key:Api-key assigned by OneNet

Host: api.heclouds.com

Content-Length: 21       //The value is modified based on the actual body size of the HTTP message

Content-Type:application/json

Expected reply of the terminal side:

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

D、Request to cancel the observation of resource

The platform side device sends an operation request to cancel the observation of a specified resource. After the device receives the message, the terminal communication suite cancels to subscribe to the specified resource and checks the execution result on the terminal side.

AT+MIPLOBSERVERSP=0,msgid,1

OK

Expected reply of the terminal side：

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

API message instance for canceling observation operations on the control platform:

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

api-key:Api-key assigned by OneNet

Host: api.heclouds.com

Content-Length: 21       //The value is modified based on the actual body size of the HTTP message

Content-Type:application/json

Expected reply of the terminal side:

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

E、Request to cancel the observation of instance

The platform side device sends an operation request to cancel the observation of a specified instance. After the device receives the message, the terminal communication suite cancels to subscribe to the specified instance and checks the execution result on the terminal side.

AT+MIPLOBSERVERSP=0,msgid,1

OK

Expected reply of the terminal side：

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

API message instance for canceling observation operations on the control platform:

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

api-key:Api-key assigned by OneNet

Host: api.heclouds.com

Content-Length: 21       //The value is modified based on the actual body size of the HTTP message

Content-Type:application/json

Expected reply of the terminal side:

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

F、Request to cancel the observation of odject

The platform side device sends an operation request to cancel the observation of a specified object. After the device receives the message, the terminal communication suite cancels to subscribe to the specified object and checks the execution result on the terminal side.

AT+MIPLOBSERVERSP=0,msgid,1

OK

Expected reply of the terminal side：

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

API message instance for canceling observation operations on the control platform:

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

api-key:Api-key assigned by OneNet

Host: api.heclouds.com

Content-Length: 21       //The value is modified based on the actual body size of the HTTP message

Content-Type:application/json

Expected reply of the terminal side:

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

3.6 Device logout process

AT+MIPLCLOSE=0

OK

Check the offline status of the terminal on the OneNet platform side (the icon is gray). In case the terminal is offline, the logout will be judged to be successful.

AT+MIPLDELETE=0(the ref value is usually 0)

OK

The terminal side sends the registration process to the OneNet platform side. In case the registration fails, the communication suite will be registered to be deleted successfully.

AT+MIPLDELOBJ=0,3306

OK

The terminal side is re-registered after it is logged out on the OneNet platform side. Check the discover request sent on the OneNet platform side. In case the discover request does not contain 3306, it will be judged that the object 3306 has been deleted successfully

API message instance for judging logout operations on the control platform

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

Host: api.heclouds.com/

api-key: Api-key assigned by OneNet

Content-Length: 0

Expected reply of the terminal side:

online : false

Note: Users can also execute the destroy instance after sending a logout request to the platform when the module will automatically delete all objects.

Users can also directly execute the destroy instance when the module will delete the object after making a logout request to the platform and then destroy the object and communication instance.