This manual describes how to use the HW revision 1.2 of the NB | DESK with installed firmware version 3.10.0.
Micro USB connector
Power supply
Charge attached battery
Used to power hardware in case no battery is connected
Serial connection (see NB | DESK 211/280 User Manual (FW v3.10.0)#Advanced Features)
Power Up / Power Down complete hardware
Positions:
OFF: Switch next to the corner of the device
ON: Switch next to USB Power
If set to OFF position, the battery cannot be charged
NB-Iot micro SIM card
NB-IoT nano-SIM card with adapter
LED1: turned on if the device is powered on
LED2: turned on if the microcontroller is reading & updating sensor values
LED3: turned on if the modem is attached to an NB-IoT cell
LED4: turned on if a modem procedure (attach, transmit, receive, ...) is ongoing
Button 1:
triggers the transmission (short TX) of all new sensor values; if no value has changed since the last successful transmission no TX will be triggered
if the modem is powered off it will power on the modem
if the modem is detached it will try to attach to an NB-IoT cell
if the modem is attached it will trigger sending the sensor data to the Exelonix cloud
if the sensor data has been transmitted an additional transmission containing the latest cell info will be triggered
Button 2:
if a modem procedure (attaching, transmitting, ...) is ongoing it will abort this procedure
if the modem is attached to a cell it will detach the modem from this cell
if the modem is already detached, then it will power down the modem
Button 3:
Switches the display to the previous page
if the current page is page 1 then the last page will be shown next
Button 4:
Switches the display to the next page
if the current page is the last page then the first page will be shown next
The display has an orange backlight to increase readability. After the device is powered on or after a button was pressed the backlight will turn on.
It will automatically turn off again after 1min if the device is only powered by battery or after 5min if the device is powered by USB.
The footer indicates in the middle the currently displayed page number and left/right to that with small letters the functionality of the buttons
"TX" - Transmission triggered via button 1
"D" - Disconnect triggered via button 2
"<<" - Switch to previous display page
">>" - Switch to next display page
Some display pages have their own behaviour for button 1 and button 2, which are described in the corresponding sections.
This page is only shown during boot-up of the device after turning on the power switch.
It displays the installed NB | DESK software version and after the modem booted also the unique identifier (in this case the modem IMEI) of the device and the supported NB-IoT bands.
This page is used to select a network operator via his PLMN (Public land mobile network) identifier. A manual selection can reduce the time to do an attach compared to an automatic attachment.
The PLMN setting can only be changed if the NB-IoT modem is detached. In this state, the display shows the country and the operator name of the given PLMN.
Button 2 (indicated with "P" in the footer) can be used to alternate between the various operators and the automatic mode. Currently, the following operators are available:
Display (PLMN - Country - Operator) | Operator |
|---|---|
| Deutsche Telekom AG |
| Vodafone Germany |
| Vodafone Germany (IoT Future Lab) |
| Vodafone Spain |
If the NB-IoT modem is in any other state than detached (e.g. attached, transmitting, ...) the page only displays the current selected PLMN and a hint that you first need to be detached in order to change the PLMN.
Also, the behaviour of button 2 is changed to default, which is to detach from the cell (indicated with "D" in the footer)
The selected PLMN will be stored in the non-volatile memory and will be automatically reloaded every time the device is rebooted.
The "TX Mode" display page can be used the enable periodic transmission behaviour. This page also changes the behaviour of the first two buttons:
Button 1 (indicated with "M" in the footer) is used the change the TX mode between "manual" and "automatic".
Button 2 (indicated with "I" in the footer) is used to cycle through the predefined periodic send intervals (1 min → 5 min → 10 min → 20 min → 30 min → 1 h → 2 h → 6 h → 12 h → 24 h)
The preselected default after booting is the manual transmission mode. In this mode, the NB|DESK will only transmit data if explicitly triggered through button 1 on any other display page.
If the TX mode was set to "automatic" an internal timer will start with the given interval time (e.g. 10 min). The display will also indicate the remaining time until the next transmission attempt (e.g. "Next TX: 9 min").
After the timer has expired the NB|DESK will try to trigger a transmission of the sensor values (and cell info) with the same logic which is used on a manual transmission (e.g. attaching, if the modem is not attached etc.)
During the automatic TX mode, an additional (manual) transmission can always be triggered with button 1 on any other display page without interfering with the timer.
But if an interval change is triggered (button 2), the TX mode will be set to "manual" and the internal timer will be stopped!
The selected TX mode will be stored in the non-volatile memory and will be automatically reloaded every time the device is rebooted.
The NB-IoT page displays the current status of the NB-IoT modem and the result of the last NB-IoT transmission (not shown if the device is not attached or transmission is currently ongoing).
The following example shows the modem in the attached state and the last triggered transmission result was successful.
The modem state machine is described in the following diagram.
Modem States:
Power Off: The modem is not powered on. In case button 1 is pressed the device will be powered on, starting to attach to the network and transmit the sensor values.
Powering Up: The modem is currently powering on .
Powering Down: The modem is currently powering down.
Detached: The modem is powered on and still not attachted to the network. In case button 1 is pressed the device will start to attach to the network and transmit the sensor values.
Attaching: The modem is currently trying to attach to the network. Depending on the network conditions this can take a while. If this is failing immediately, this could mean that no SIM card is installed. For more information see the troubleshooting chapter.
Attached: The modem is attached to the server; an transmission can be started.
Detaching: The modem is currently detaching from the network.
Transmitting: The modem is transmitting the sensor data or latest cell info
Receiving: The modem is waiting for the Acknowledgment from the server
The "Last TX result" can have the following values:
Success: everything went fine; the server received the latest sensor values
Attach failure: The modem was unable to attach to the network, so no transmission was possible
No SIM card: The modem was unable to attach to the network as no SIM is inserted into the device or the SIM card is invalid
TX failure: The modem was unable to trigger the transmission
RX timeout: The modem did not receive an acknowledgment from the server; It is unknown if the transmission was successful or not
RX failure: The server answered with an error, so the transmission was not successful
Please note: If a TX failure occurs the modem will detach from the network in order to reset the connection and UDP socket configuration.
This page shows the basic cell parameters if the modem is attached to a cell.
EARFCN: E-UTRA Absolute Radio Frequency Channel Number
Cell ID: Global cell identifier
PCI: Physical cell ID
This page shows the current power values of the cell connection if the modem is attached to a cell.
RSSI: Receive Signal Strength Indicator in dBm
RSRP: Referenz Signal Received Power in dBm
RSRQ: Reference Signal Received Quality in dB
SNR: Signal-To-Noise ratio in dB
This page shows additional values of the cell connection if the modem is attached to a cell.
Signal bars: Indicates the strength of the received signal; more bars indicate a better signal quality.
0: no connection
1: bad
2: marginal
3: OK
4: good
5: excellent
ECL: NB-IoT coverage enhancement level; range: level 0 to level 2. It is up to the network, how many CE levels are defined.
Level 0 corresponds to normal coverage
Level 2 corresponds to the worst case, where the coverage may be assumed to be very poor.
RX time: active time of the modem RF to receive signals
TX time: active time of the modem RF to transmit signals
This page show data associated with the power safe mode and the active time and periodic TAU values as determined by the base station.
RRC: The state of the Radio Resource Control (RRC). It defines if the modem is connected with the NB-IoT base station: Idle or Connected
PSM: After the T3324 time runs out the modem enters the power safe mode
T3324: Maximum active time timer value as set by the base station
T3412: Maximum periodic TAU timer value as set by the base station
One can observe how the modem goes into idle mode as shown by RRC and how the PSM is entered after the time given under T3324 has elapsed
This page displays the last read sensor values.
Brightness: Percentage of the maximum measurable brightness of the attached sensor. (0% darkest, 100% brightest)
Humidity: Percentage of relative humidity at current temperature (see below)
Temperature: current temperature in Celcius. Could be higher than the current room temperature due to heat output by the device
Pressure: Atmospheric pressure in hPa (hector Pascal)
Proper acceleration is given as a vector (x,y,z) measured due to Earth's gravity g = 9.81 m/s2
The GPS module is powered on together with the modem. After that, the GPS automatically starts searching for the current position.
The number of GPS satellites in view is shown to indicate the quality/progress of the ongoing search.
Depending on the GPS signal strength the initial positioning can take more than one hour.
The result shows the timestamp of the last GPS signal reception, the longitude, latitude and altitude (in meter).
The battery page shows the current status of the attached battery.
The battery status can be:
Absent: e.g. the battery cable is not connected anymore or the battery/cable is broken
Discharging: the USB power is not attached - the device is powered only by the battery
Charging: the USB power is attached - the battery is charged
Level too low: the USB power is not attached and the battery level is too low to power the device; the device will power down in a few seconds the save the battery from completely discharging
Powering Down: the device is powering down - the display will be turned off
→ attach the USB power and turn the device off and on again
The battery level is given in the range of 0 ... 100%.
If the level is higher than 4100mV, the level will be set to 99%
If the level is lower than 3300mV, the level will be set to 1% and the battery status switches to "Level too low"
It is possible to have a look at the internal debug messages and talk with the U-blox SARA N2XX modem directly via AT commands.
To do this the NB|DESK USB needs to be connected to a PC via a USB cable. Then the device is recognized as a COM port with the name "Silicon Labs Dual CP210x USB to UART Bridge: Standard COM Port".
The OS driver can be found on the Silicon Labs Website.
Open a serial console (e.g. U-blox m-center) on the attached PC with the following COM port settings:
Baud rate: 115200
Flow control: none
Data bits: 8
Stop bits: 1
Parity: none
After the COM port is connected the NB|DESK prints EASY-IF (see the section below) messages on the console.
By default, the device is configured to automatically update its sensor values. It is possible to disable/enable these by sending the lower case letter "l" via console to the device.
After the modem has booted it is possible to send AT commands (starting with "AT+") directly to the modem.
The AT manual can be found on U-blox website: SARA-N2_ATCommands_(UBX-16014887).pdf
If you don't want to use any of the NB|DESK functionality (automatic connection, sending of sensor data) and only want to talk to the modem via AT commands you can put the device in a so-called "tunnel mode".
This can be achieved by sending character "a" via serial console after the device booted. From now on everything typed in the console will be sent directly to the modem and everything received from the modem will be printed out as is.
These are the basic AT commands you need to attach to a cell and transmit data via UDP:
Turn on the module’s radio functionality: AT+CFUN=1
trigger automatic attach: AT+CGATT=1
Check the registration status (0-notConnected,1-registeredHome,2-searchingCell,5-registeredRoaming): AT+CEREG?
Create a UDP socket: AT+NSOCR=DGRAM,17,<localport>
Sending data: AT+NSOST=0,<remote_address>,<remote_port>,<length>,<dataInHexString>
Check cell information: AT+NUESTATS?
See the AT manual for more information.
Starting with Firmware version 3.2 the NB|DESK device supports the Exelonix EASY interface to control the NB IoT modem via the USB UART interface. For more details see the EASY-IF specification.
In case the device does not react anymore (e.g. button 3 does not switch display page) the device can be rebooted by turning it off and on again.
NB-IoT Connection Issues
From our experience, there is no need to set the APN by hand, as it is done automatically by the modem.
The installed U-blox SARA N2 modem only supports specific frequency bands. Check the U-blox SARA-N2 website to see which SARA module support which band.
If the device connects for the first time to the network it can take up to 1h before the attach is successful. After that, the next attaches are much faster (in most cases it takes no longer than 30s).
By default, the modem is configured to support the 3GPP CRs 0354/0338 & 0859. This can be checked by sending "AT+NCONFIG?". Please check if these are supported by your cell. If not the config can be changed with:
AT+NCONFIG="CR_0354_0338_SCRAMBLING","FALSE"
AT+NCONFIG="CR_0859_SI_AVOID", "FALSE"