Table of Contents:

1. The use of this guideline

This configure instruction is for Dragino NB-IoT models with -NB or -NS suffix, for example DDS75-NB. These models use the same NB-IoT Module BC660K-GL and has the same software structure. The have the same configure instruction to different IoT servers. Use can follow the instruction here to see how to configure to connect to those servers.

2. Attach Network

2.1 General Configure to attach network

To attache NB-IoT sensors to NB-IoT Network, You need to:

  1. Get a NB-IoT SIM card from Service Provider. (Not the same as the SIM card we use in mobile phone)
  2. Power Off End Node ( See below for the power off/on position)
  3. Insert the SIM card to Sensor. ( See below for direction)
  4. Power On End Node
  5. Configure APN in the sensor (AT+APN=<APN>), example AT+APN=iot.1nce.net

image-20240208102804-1.png

image-20230808205045-1.png

After doing above, the NB-IoT Sensors should be able to attach to NB-IoT network .

The -NB and -NS models support LTE Cat NB2, with below frequency band: multiple frequency bands of B1/B2/B3/B4/B5/B8/B12/B13/B14/B17/B18/B19/B20/B25/B28/B66/B70/B85 . Make sure you use a the NB-IoT SIM card.

SIM ProviderAT+APN=NB-IoT CoverageComments
1NCEiot.1nce.net

Coverage Reference Link

Austria, Belgium, Bulgaria, Croatia, Czech Republic, Denmark, Finland, Germany, Great Britain, Greece, Hungary, Ireland, Italy, Latvia, Malta, Netherlands, Norway, Puerto Rico, Russia, Slovak , Republic, Slovenia, Spain, Sweden, Switzerland, Taiwan, USA, UK, US Virgin Islands

UK: Band20
China MobileNo need configureChina Mainland, HongKong 
China TelecomctnbChina Mainland 

2.2 Speed Up Network Attach time

BC660K-GL supports multi bands B1/B2/B3/B4/B5/B8/B12/B13/B14/B17/B18/B19/B20/B25/B28/B66/B70/B85.  It will search one by one and try to attach, this will take a lot of time and even cause attach fail and show Signal Strenght:99. User can lock the band to specify band for its operator to make this faster. 

AT+QBAND?        // Check what is the current used frequency band
AT+QBAND=1,4     // Set to use 1 frequency band. Band4
Europe General AT+QBAND=2,8,20  // Set to use 2 frequency bands. Band 8 and Band 20
Global General : AT+QBAND=10,8,20,28,2,4,12,13,66,85,5

Verizon       AT+QBAND=1,13
AT&T           AT+QBAND=3,12,4,2
Telstra        AT+QBAND=1,28
Softband     AT+QBAND=2,3,8

After connection is successful, user can use AT+QENG=0  to check which band is actually in used.

See bands used for different provider: NB-IoT Deployment , Bands, Operator list

3. Configure to connect to different servers

3.1 General UDP Connection

The NB-IoT Sensor can send packet to server use UDP protocol. 

3.1.1 Simulate UDP Connection by PC tool

We can use PC tool to simulate UDP connection to make sure server works ok. 

image-20230802112413-1.png

3.1.2 Configure NB-IoT Sensor

3.1.2.1 AT Commands

AT Commands:

  • AT+PRO=2,0         //  Set to use UDP protocol to uplink ,Payload Type select Hex payload
  • AT+SERVADDR=120.24.4.116,5601      //  Set UDP server address and port

image-20230802112413-2.png

3.1.2.2 Uplink Example

image-20230802112413-3.png

3.2 General MQTT Connection

The NB-IoT Sensor can send packet to server use MQTT protocol. 

Below are the commands.

AT Commands:

  • AT+PRO=3,0      //  Set to use MQTT protocol to uplink, Payload Type select Hex payload.
  • AT+SERVADDR=120.24.4.116,1883        //  Set MQTT server address and port
  • AT+CLIENT=CLIENT                                 //  Set up the CLIENT of MQTT
  • AT+UNAME=UNAME                              //  Set the username of MQTT
  • AT+PWD=PWD                                        //  Set the password of MQTT
  • AT+PUBTOPIC=NSE01_PUB                    //  Set the sending topic of MQTT
  • AT+SUBTOPIC=NSE01_SUB                    //  Set the subscription topic of MQTT

image-20230802112413-4.png

image-20230802112413-5.png

Notice: MQTT protocol has a much higher power consumption compare with UDP/CoAP protocol. Please check the power analyze document and adjust the uplink  period to a suitable interval.

3.3 ThingSpeak (via MQTT)

3.3.1 Get MQTT Credentials

ThingSpeak connection uses MQTT Connection. So we need to get MQTT Credentials first. You need to point MQTT Devices to ThingSpeak Channel as well. 

image-20230802112413-6.png

image-20230802112413-7.png

3.3.2 Simulate with MQTT.fx

3.3.2.1 Establish MQTT Connection

After we got MQTT Credentials, we can first simulate with PC tool MQTT.fx tool to see if the Credentials and settings are fine. 

image-20230802112413-8.png

  • Broker Address: mqtt3.thingspeak.com
  • Broker Port: 1883
  • Client ID: <Your ThingSpeak MQTT ClientID>
  • User Name: <Your ThingSpeak MQTT User Name>
  • Password: <Your ThingSpeak MQTT Password>

3.3.2.2 Publish Data to ThingSpeak Channel

image-20230802112413-9.png

image-20230802112413-10.png

In MQTT.fx, we can publish below info:

  • Topic: channels/YOUR_CHANNEL_ID/publish
  • Payload: field1=63&field2=67&status=MQTTPUBLISH 

Where 63 and 67 are the value to be published to field1 & field2. 

Result: 

image-20230802112413-11.png

3.3.3 Configure NB-IoT Sensor for connection

3.3.3.1 AT Commands:

In the NB-IoT, we can run below commands so to publish the channels like MQTT.fx

  • AT+PRO=3,1     // Set to use ThingSpeak Server and Related Payload
  • AT+CLIENT=<Your ThingSpeak MQTT ClientID>
  • AT+UNAME=<Your ThingSpeak MQTT User Name>
  • AT+PWD=<Your ThingSpeak MQTT Password>
  • AT+PUBTOPIC=<YOUR_CHANNEL_ID>
  • AT+SUBTOPIC=<YOUR_CHANNEL_ID>

3.3.3.2 Uplink Examples

image-20230816201942-1.png

For SE01-NB

For DDS20-NB

For DDS45-NB

For DDS75-NB

For NMDS120-NB

For SPH01-NB

For NLM01-NB

For NMDS200-NB

For CPN01-NB

For DS03A-NB

For SN50V3-NB

3.3.3.3 Map fields to sensor value

When NB-IoT sensor upload to ThingSpeak. The payload already specify which fileds related to which sensor value. Use need to create fileds in Channels Settings. with name so to see the value correctly. 

image-20230802112413-12.png

image-20230802112413-13.png

Below is the NB-IoT Product Table show the mapping. 

 Field1Field2Field3Field4Field5Field6Field7Field8Field9Field10
S31x-NBTemperature HumidityBatteryRSSI      
SE01-NBTemperature Humidityconductdielectric_constantBatteryRSSI    
DDS20-NBdistanceBatteryRSSI       
DDS45-NBdistanceBatteryRSSI       
DDS75-NBdistanceBatteryRSSI       
NMDS120-NBdistanceBatteryRSSI       
SPH01-NBphTemperatureBatteryRSSI      
NLM01-NBHumidityTemperatureBatteryRSSI      
NMDS200-NBdistance1distance2BatteryRSSI      
CPN01-NBalarmcountdoor open durationcalc flagBatteryRSSI    
DS03A-NBlevelalarmpb14door open numpb14 last open timepb15 level statuspb15 alarm statuspb15 door open numpb15 last open timeBatteryRSSI
SN50V3-NB mod1modBatteryRSSIDS18B20 Tempexit_state/input PA4adc0Temperature Humidity  
SN50V3-NB mod2modBatteryRSSIDS18B20 Tempexit_state/input PA4adc0distance   
SN50V3-NB mod3modBatteryRSSIadc0exit_state/input PA4adc1TemperatureHumidityadc4 
SN50V3-NB mod4modBatteryRSSIDS18B20 Tempadc0exit_state/input PA4DS18B20 Temp2DS18B20 Temp3  
SN50V3-NB mod5modBatteryRSSIDS18B20 Tempadc0exit_state/input PA4Weight   
SN50V3-NB mod6modBatteryRSSIcount      

3.4 Datacake

Dragino NB-IoT sensors has its template in Datacake Platform. There are two version for NB Sensor,

As example for S31B-NB. there are two versions: S31B-NB-1D and S31B-NB-GE.

  • S31B-NB-1D: This version have pre-configure DataCake connection. User just need to Power on this device, it will auto connect send data to DataCake Server.
  • S31B-NB-GE: This verson doesn't have pre-configure Datacake connection. User need to enter the AT Commands to connect to Datacake. See below for instruction. 

3.4.1 For device Already has template

3.4.1.1 Create Device

Add Device in DataCake.

image-20230808162301-1.png

image-20230808162342-2.png

Choose the correct model from template.

image-20230808162421-3.png

Fill Device ID. The device ID needs to be filled in with IMEI, and a prefix of 'f' needs to be added.

image-20230808163612-7.png

image-20230808163035-5.png

image-20230808163049-6.png

3.4.2 For Device already registered in DataCake before shipped

3.4.2.1 Scan QR Code to get the device info

Users can use their phones or computers to scan QR codes to obtain device data information.

image-20230808170051-8.png

image-20230808170548-9.png

3.4.2.2 Claim Device to User Account

By Default, the device is registered in Dragino's DataCake Account. User can Claim it to his account.

3.4.3 Manual Add Decoder in DataCake ( don't use the template in DataCake)

Step1: Add a device

image-20240129170024-1.png

Step2: Choose your device type,please select dragino NB-IOT device

image-20240129170216-2.png

Step3: Choose to create a new device

image-20240129170539-3.png

Step4: Fill in the device ID of your NB device

image-20240202111546-1.png

Step5: Please select your device plan according to your needs and complete the creation of the device

image-20240129171236-6.png

Step6: Please add the decoder at the payload decoder of the device configuration.

Decoder location:dragino-end-node-decoder/Datacake-Dragino_NB at main · dragino/dragino-end-node-decoder (github.com)

image-20240129172056-7.png

image-20240129173116-9.png

Step7: Add the output of the decoder as a field

image-20240129173541-10.png

Step8: Customize the dashboard and use fields as parameters of the dashboard

image-20240129174518-11.png

image-20240129174657-12.png

image-20240129174840-13.png

3.4.4 For device have not configured to connect to DataCake

Use AT command for connecting to DataCake

AT+PRO=2,0

AT+SERVADDR=67.207.76.90,4445

3.5 Node-Red (via MQTT)

3.5.1 Configure Node-Red

Take S31-NB UDP protocol as an example.

Dragino provides input flow examples for the sensors.

User can download the required JSON file through Dragino Node-RED input flow template.

Download sample JSON file link: https://www.dropbox.com/sh/mduw85jcuwsua22/AAAvwPhg9z6dLjJhmZjqBf_ma?dl=0

We can directly import the template.

The templates for S31-NB and NB95S31B are the same.

image-20230809173127-4.png

Please select the NB95S31B template.

image-20230809173310-5.png

image-20230809173438-6.png

image-20230809173800-7.png

Successfully imported template.

image-20230809173835-8.png

Users can set UDP port.

image-20230809174053-9.png

3.5.2 Simulate Connection

We have completed the configuration of UDP. We can try sending packets to node red.

image-20230810083934-1.png

image-20230810084048-2.png

3.5.3 Configure NB-IoT Sensors

  • AT+PRO=3,0 or 3,5     // hex format or json format
  • AT+SUBTOPIC=<device name>or User Defined 
  • AT+PUBTOPIC=<device name>or User Defined
  • AT+CLIENT=<device name> or User Defined
  • AT+UNAME=<device name> or User Defined
  • AT+PWD=“Your device token”

3.6 ThingsBoard.Cloud (via MQTT)

3.6.1 Configure ThingsBoard

3.6.1.1 Create Device

Create a New Device in ThingsBoard. Record Device Name which is used for MQTT connection.

image-20230802112413-32.png

3.6.1.2 Create Uplink & Downlink Converter

Uplink Converter

The purpose of the decoder function is to parse the incoming data and metadata to a format that ThingsBoard can consume. deviceName and deviceType are required, while attributes and telemetry are optional. Attributes and telemetry are flat key-value objects. Nested objects are not supported.

To create an uplink converter go to the Integrations center -> Data converters page and click “plus” button. Name it “MQTT Uplink Converter” and select type "Uplink". Use debug mode for now.

image-20230802112413-33.png

Downlink Converter

The Downlink converter transforming outgoing RPC message and then the Integration sends it to external MQTT broke

image-20230802112413-34.png

Note: Our device payload is already human readable data. Therefore, users do not need to write decoders. Simply create by default.

3.6.1.3 MQTT Integration Setup

Go to the Integrations center -> Integrations page and click plus icon to add a new integration. Name it “MQTT Integration”, select type MQTT;

image-20230802112413-35.png

  • The next steps is to add the recently created uplink and downlink converters;

image-20230802112413-36.png

image-20230802112413-37.png

Add a topic filter:

Consistent with the theme of the node setting.

You can also select an MQTT QoS level. We use MQTT QoS level 0 (At most once) by default;

image-20230802112413-38.png

3.6.2 Simulate with MQTT.fx

image-20230802112413-39.png

image-20230802112413-40.png

3.6.3 Configure NB-IoT Sensor

AT Commands

  • AT+PRO=3,3    // Use MQTT to connect to ThingsBoard. Payload Type set to 3.
  • AT+SUBTOPIC=<device name> 
  • AT+PUBTOPIC=<device name>
  • AT+CLIENT=<device name> or User Defined
  • AT+UNAME=<device name> or User Defined
  • AT+PWD=<device name> or User Defined

Test Uplink by click the button for 1 second

image-20230802112413-41.png

image-20230802112413-42.png

image-20230802112413-43.png

3.7 Tago.io (via MQTT)

3.7.1 Create device & Get Credentials

We use MQTT Connection to send data to Tago.io. We need to Create Device and Get MQTT Credentials first. 

image-20230802112413-44.png

image-20230802112413-45.png

Go to the Device section and create a device. Then, go to the section tokens and copy your device-token.

image-20230802112413-46.png

The device needs to enable the TLS mode and set the AT+TLSMOD=1,0 command.

On the Connection Profile window, set the following information:

  • Profile Name: “Any name”
  • Broker Address: mqtt.tago.io
  • Broker Port: 8883
  • Client ID: “Any value”

On the section User credentials, set the following information:

  • User Name: “Any value”       // Tago validates your user by the token only
  • Password: “Your device token”
  • PUBTOPIC: “Any value”
  • SUBTOPIC: “Any value”

AT command:

  • AT+PRO=3,0 or 3,5     // hex format or json format
  • AT+SUBTOPIC=<device name>or User Defined 
  • AT+PUBTOPIC=<device name>or User Defined
  • AT+CLIENT=<device name> or User Defined
  • AT+UNAME=<device name> or User Defined
  • AT+PWD=“Your device token”

3.7.2 Simulate with MQTT.fx

image-20230802112413-52.png

image-20230808105300-2.png

Users can run the AT+PRO=3,5 command, and the payload will be converted to JSON format.

image-20230808105217-1.png

image-20230808105329-3.png

3.7.3 tago data

image-20230802112413-50.png

image-20230802112413-51.png

3.8 TCP Connection

AT command:

  • AT+PRO=4,0     // Set to use TCP protocol to uplink(HEX format)
  • AT+PRO=4,1     // Set to use TCP protocol to uplink(JSON format)
  • AT+SERVADDR=120.24.4.116,5600    // to set TCP server address and port

Sensor Console Output when Uplink:

image-20230807233631-1.png

See result in TCP Server:

image-20230807233631-2.png

4. MQTT/UDP/TCP downlink

4.1 MQTT (via MQTT.fx)

Configure MQTT connections properly and send downlink commands to configure nodes through the Publish function of MQTT.fx.

1. Configure node MQTT connection (via MQTT.fx):

AT command:

  • AT+PRO=3,0 or 3,5   // hex format or json format
  • AT+SUBTOPIC=User Defined 
  • AT+PUBTOPIC=User Defined
  • AT+UNAME=<device name> or User Defined
  • AT+PWD=<device name> or User Defined
  • AT+SERVADDR=8.217.91.207,1883    // to set MQTT server address and port

Note: To uplink and downlink via MQTT.fx, we need set the publish topic and subscribe topic different, for example: AT+SUBTOPIC=SE01_SUB & AT+PUBTOPIC=SE01_PUB.

image-20240417180145-2.pngimage-20240417180737-3.png

2. When the node uplink packets, we can observe the data in MQTT.fx.

image-20240418144337-1.png

3. The downlink command can be successfully sent only when the downlink port is open.

    The downlink port is opened for about 3 seconds after uplink packets are sent.

    Therefore, when we see the node uplink packets in the Subscribe window, we need to immediately switch to the publish window to publish the hex format command.

image-20240418150435-3.png

image-20240418150932-4.png

Note: Users can edit the hex command in advance. When the node uplink, directly click the publish button several times to increase the success rate of command configuration.

5. FAQ

5.1 What is the usage of Multi Sampling and One Uplink?

The NB series has the feature for Multi Sampling and one uplink. See one of them

http://wiki.dragino.com/xwiki/bin/view/Main/User%20Manual%20for%20LoRaWAN%20End%20Nodes/SN50v3-NB_BN-IoT_Sensor_Node_User_Manual/#H2.5Multi-SamplingsandOneuplink

User can use this feature for below purpose:

  1. Reduce power consumption. The NB-IoT transmit power is much more higher than the sensor sampling power. To save battery life, we can sampling often and send in one uplink.
  2. Give more sampling data points.
  3. Increase reliable in transmission. For example. If user set
    • AT+TR=1800        // The unit is seconds, and the default is to record data once every 1800 seconds (30 minutes, the minimum can be set to 180 seconds)
    • AT+NOUD=24    //  The device uploads 24 sets of recorded data by default. Up to 32 sets of record data can be uploaded.
    • AT+TDC=7200  // Uplink every 2 hours.
    • this will mean each uplink will actually include the 6 uplink data (24 set data which cover 12 hours). So if device doesn't lost 6 continue data. There will not data lost.

5.2 Why the uplink JSON format is not standard?

The json format in uplink packet is not standard Json format. Below is the example. This is to make the payload as short as possible, due to NB-IoT transmit limition, a standard Json is not able to include 32 sets of sensors data with timestamp.

The firmware version released after 2024, Mar will use change back to use Json format. Detail please check changelog.

image-20240229233154-1.png

6. Trouble Shooting:

6.1 Checklist for debuging Network Connection issue. Signal Strenght:99 issue.

There are many different providers provide NB-IoT service in the world. They might use different band, different APN & different operator configuration. Which makes connection to NB-IoT network is complicate.

If end device successfully attached NB-IoT Network, User can normally see the signal strengh as below (between 0~31)

image-20240207002003-1.png

If fail to attach network, it will shows signal 99. as below:

image-20240207002129-2.png

When see this issue, below are the checklist:

  • Does your SIM card support NB-IoT network? If SIM card doesn't not specify support NB-IoT clearly, normally it doesn't support. You need to confirm with your operator.
  • Do you configure the correct APN? Check here for APN settings.
  • Do you lock the frequency band? This is the most case we see. Explain and Instruction.
  • Check if the device is attached to Carrier network but reject. (need to check with operator).
  • Check if the antenna is connected firmly.

If you have check all above and still fail. please send console log files (as many as possible) to support@dragino.com so we can check.

6.2 Issue: "NBIOT did not respond"

11:24:22.397 [44596]NBIOT did not respond.
11:24:24.315 [46530]NBIOT did not respond.
11:24:26.256 [48464]NBIOT did not respond.
11:24:28.196 [50398]NBIOT did not respond.
11:24:30.115 [52332]NBIOT did not respond.
11:24:32.127 [54266]NBIOT did not respond.
11:24:32.127 [54299]Restart the module...
11:24:39.181 [61332]No response when shutting down

This issue might due to initiate issue for NB-IoT module. In this case, please try:

1) Open Enclosure

2) Power off device by pull out the power on Jumper

3) Power on device by connect back the power jumper.

4) push reset button.

image-20240208001740-1.png

6.3 Issue: "Failed to readI MSI number"

[18170]Failed to read IMSI:1umber.
[20109]Failed to read IMSI numoer.
[22048]Failed to read IMSI number.
[29842lRestart the module...

Make sure that the SIM card is insert in correct direction and device is power off/on during insert. Here is reference link: Insert SIM Card.

6.4 Why sometime the AT Command is slow in reponse?

When the MCU is communicating with the NB-IoT module, the MCU response of AT Command will become slower, it might takes several seconds to response.

image-20240226111928-1.png

Tags:
Created by Edwin Chen on 2023/07/21 12:31
    
Copyright ©2010-2022 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0