NB|EASY is a software tool developed to use Vodafone NB devices via a PC.The NB device, connected via USB to the PC, can be triggered to attach to the Vodafone NB-IoT network.

After the connection is successfully done, the device is able to transmit and collect data via the NB-IoT network.

The application is split into five main parts. Each can be selected by clicking on the corresponding tab. The following sections describe these tabs.

Table of Content

Version History

The following table shows the changes done with every NB | EASY version:

Software Installation

Basic software requirements

• Java 8 runtime environment.

• NB-Vodafone driver (available in NB|EASY installation package, or as a stand alone version ).

Windows

• Use the windows executable from the Software & Drivers for Vodafone LPWA Products to install NB | EASY software.

  • The installer will take care of installing the Java environment and the required drivers.

  • Start the program via the desktop shortcut or start menu entry.

Linux

• The required UART driver has been distributed as part of the Linux kernel since v4.4.132.

• Check whether the required kernel module is loaded: lsmod | grep option.

• Check whether you have read/write access to the USB-UART bridge: ls -la /dev/ttyUSB*.

Device Selection

After starting the application, the Device Selection tab is shown first. Here the to be controlled NB device can be selected.

1. The Refresh button starts a new search of connected NB devices via COM port5. An ongoing search is indicated by a moving progress bar below the button.

2. After the search is finished all available device are displayed. By clicking on the NB|DEV KIT, it will be selected for usage. After that the Quick Start tab is shown.

Figure 1:Device selection tab

Quick Start

The Quick Start tab presents a simplified way to get familiar with the connected NB device and the NB-IoT network.
Here the device can be triggered to attach to the NB-IoT network and transmit sample data to the cloud.

Figure 2 : Quick start tab

Device State

The top area of the application shows the selected device and its current state.

1. Device name and its parameters

   1. Name of selected NB device and its hardware revision

   2. Firmware version installed on the NB device

   3. EASY interface version used by the NB device EASY interface

   4. IMEI: International mobile equipment identity.

2. Modem Status: shows the current status of the device.

3. Attach to network: triggers an Attach or Detach of the device depending on the modem status

Figure 3 : Device State description

Modem Status

The modem status indicates the following states:

Figure 4: Modem status description

Detached

In the detached state, the device is not able to transmit data to the NB-IoT network. First, an attach procedure needs to be triggered, including the following steps:

1. Select the NB-IoT network in the drop down menu.

2. Click on the Attach to network button to start the attachment procedure to the selected NB-IoT network

Note: Be aware that the inserted SIM card must correspond to the selected network, otherwise the attach procedure will fail.

Figure 5 : Detached state description

Attached

In the attached state the device is now able to transmit data via the NB-IoT network.

1. Button to start a transmission to the cloud of the entered text ( 2 in figure 6) as well as the current cell information.

2. Text field to enter example text to be transmitted when button (1 in figure 6) is pressed.

3. Button to start a cell information update.

4. List which shows all received cell information of the last successful cell information update (see Displayed parameters in figure 8 below).

5. Button to open IoT Manager website to view all successfully transmitted values as described in figure 7.

Figure 6 : Attached state description

Figure 7 : IoT Manager web site

Tab 1: Displayed network parameters

Control Center

The control center is a more advanced and detailed view of how the NB|EASY tool communicates with the NB device.
Here the user can compose a message and send it to the device.The incoming messages are also monitored.

The NB|DEV KIT supports both the EASY interface and the AT commands mode .The user can switch from the EASY interface to the AT commands mode .(figure 10 below)

Once switched to the AT commands , the device cannot switch back to the EASY mode to do it , you need to unplug the device and restart the connection .

1. Switch between "AT" and "Easy" mode.

2. Message send by the device or the host.

3. Button to empty the list view (2 in figure 9)

4. The complete communication log history is recorded and can be saved in a text file.

5. List of AT commands

6. Select a single AT command to be sent to the device. The message string will be copied to message text field (8 in figure 9 ) .

7. Button to start sending of the AT command (8 in figure 9) to the device.

8. Message text field. The message to be sent to the device can be edited further.

Figure 9 : Control center

Figure 10 : AT Command mode

Change Endpoint

Devices send data to the Vodafone backend by default. If you want your devices to send data to another backend, you can change the IP destination address.
Switch to Control Center and select EASY+TX from the right list of commands and fill in IP and Port of the backend you want to send data to. Add the payload to the Data field and adjust the DataLength field.

The default IP address of Vodafone is 213.136.85.114 and the Port is 9876.

Figure 11 : Change Endpoint

Automatic TX mode

This tab allows to set automatic data transmission events. The event interval period is configurable.

The transmission status is displayed as detailed in the Tab 1 and the sent data can be verified on the cloud.(see figure 7 above )

Figure 12 : Automatic TX mode

NB-IoT Performance

The NB-IoT Performance tab compares the NB-IoT RAT (Radio Access Technology) with other common RATs like LTE Cat1, UMTS and GSM used for transmitting small amount of data.
To acces the NB-IoT Performance tab the device needs to be attached to the NB-Iot network first, othrewise the tab is disabled.

The tool uses live data from the NB-IoT network to calculate the expected battery lifetime, energy consumption and datarate.

1. Button to start the NB-IoT performance calculation.
   The application sends real test data to the Cloud via NB-IoT to be able to record the needed time and energy consumption in the current NB-IoT cell.

2. Button to get more information about the performance calculation and its assumptions in more detail. Performance Tab

Figure 13 : NB-IoT performance

Abbreviations

Tab 2 : Abbreviations