+ All Categories
Home > Documents > nRF Connect LTE Link Monitor -...

nRF Connect LTE Link Monitor -...

Date post: 06-Sep-2019
Category:
Upload: others
View: 4 times
Download: 0 times
Share this document with a friend
12
nRF Connect LTE Link Monitor User Guide v0.7.1 4399_015 v0.7.1 / 2019-05-23
Transcript
Page 1: nRF Connect LTE Link Monitor - infocenter.nordicsemi.cominfocenter.nordicsemi.com/pdf/LTE_Link_Monitor_User_Guide_v0.7.1.pdf · The LTE Link Monitor is installed as an app for nRF

nRF Connect LTE Link Monitor

User Guidev0.7.1

4399_015 v0.7.1 / 2019-05-23

Page 2: nRF Connect LTE Link Monitor - infocenter.nordicsemi.cominfocenter.nordicsemi.com/pdf/LTE_Link_Monitor_User_Guide_v0.7.1.pdf · The LTE Link Monitor is installed as an app for nRF

ContentsRevision history. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2 Installing the LTE Link Monitor. . . . . . . . . . . . . . . . . . . . . . . . . 5

3 LTE Link Monitor functionality. . . . . . . . . . . . . . . . . . . . . . . . . 6

4 Sample code for locationapi.org. . . . . . . . . . . . . . . . . . . . . . . 10

Legal notices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

4399_015 v0.7.1 ii

Page 3: nRF Connect LTE Link Monitor - infocenter.nordicsemi.cominfocenter.nordicsemi.com/pdf/LTE_Link_Monitor_User_Guide_v0.7.1.pdf · The LTE Link Monitor is installed as an app for nRF

Revision history

Date Version Description

May 2019 0.7.1 Updated Installing the LTE Link Monitor on page 5

December 2018 0.7 Updated LTE Link Monitor functionality on page 6 to reflect thePeriodic signal quality requests option.

October 2018 0.5 First release

4399_015 v0.7.1 iii

Page 4: nRF Connect LTE Link Monitor - infocenter.nordicsemi.cominfocenter.nordicsemi.com/pdf/LTE_Link_Monitor_User_Guide_v0.7.1.pdf · The LTE Link Monitor is installed as an app for nRF

1 Introduction

LTE Link Monitor is a modem client application that monitors the modem/link status and activity using ATcommands.

LTE Link Monitor is implemented as an app for the nRF Connect for Desktop application.

Currently, the nRF9160 DK (PCA10090) is the only supported device.

4399_015 v0.7.1 4

Page 5: nRF Connect LTE Link Monitor - infocenter.nordicsemi.cominfocenter.nordicsemi.com/pdf/LTE_Link_Monitor_User_Guide_v0.7.1.pdf · The LTE Link Monitor is installed as an app for nRF

2 Installing the LTE Link Monitor

The LTE Link Monitor is installed as an app for nRF Connect for Desktop.

Before you can install the LTE Link Monitor, you must download and install nRF Connect for Desktop(version 2.6.0 or later).

To install the LTE Link Monitor:1. Open nRF Connect for Desktop.2. Click Add/remove apps.3. Find the LTE Link Monitor and click Install.

Once the app is installed, the green Installed tag is displayed next to the More information button. Youcan now launch the app from the Launch app screen.

For easy access, you can create a desktop shortcut by clicking the arrow down button and selecting Createshortcut.

4399_015 v0.7.1 5

Page 6: nRF Connect LTE Link Monitor - infocenter.nordicsemi.cominfocenter.nordicsemi.com/pdf/LTE_Link_Monitor_User_Guide_v0.7.1.pdf · The LTE Link Monitor is installed as an app for nRF

3 LTE Link Monitor functionality

LTE Link Monitor displays information about connected devices and shows, for example, the signal quality,network information, and the AT communication with the modem.

The following sections describe the different parts of the user interface of LTE Link Monitor.

Top bar

Click the icon to launch another app or check the version and installation information.

The device selector drop-down menu displays all supported devices. When you select a device, you cansee live information about the current session in the main view.

Alternatively, you can open a log file to load the log contents of a previous session. The log file containsthe complete AT communication with the modem. Note that you cannot open a log file when a deviceconnection is open.

Use the Chart and Terminal buttons to switch the main view content.

Main viewThe main view can either display the Chart view or the Terminal view. You can switch between these viewsusing the buttons in the top bar.

4399_015 v0.7.1 6

Page 7: nRF Connect LTE Link Monitor - infocenter.nordicsemi.cominfocenter.nordicsemi.com/pdf/LTE_Link_Monitor_User_Guide_v0.7.1.pdf · The LTE Link Monitor is installed as an app for nRF

LTE Link Monitor functionality

Chart

Figure 1: LTE Link Monitor Chart view

You can hover over the events in the chart to display the list of events under the mouse cursor. Tonavigate the chart, drag it horizontally. You can zoom in or out using the mouse wheel or the rightmouse button. Notice that the chart stops displaying the latest incoming events when you zoom ordrag. Click Live Scroll under the chart to make sure incoming events are displayed.

The time-based chart displays signal quality and modem events. The signal quality reported by themodem is the received signal reference power (RSRP) in dBm, displayed on the left axis. The modemevents are unsolicited result codes and responses to different commands, separated into differentcategories displayed on the right axis.

4399_015 v0.7.1 7

Page 8: nRF Connect LTE Link Monitor - infocenter.nordicsemi.cominfocenter.nordicsemi.com/pdf/LTE_Link_Monitor_User_Guide_v0.7.1.pdf · The LTE Link Monitor is installed as an app for nRF

LTE Link Monitor functionality

Terminal

Figure 2: LTE Link Monitor Terminal view

The terminal displays the AT communication with the modem. Colors are used to differentiatebetween transmitted commands (yellow), received responses (white), and received unsolicitedresults (light blue). The abbreviations of control characters are also displayed in gray. They are,however, not selectable.

The terminal's auto-scrolling behavior can be toggled in the Settings section of the side panel.

You can enter text in the command line located directly below the terminal and then send it to themodem by pressing Enter or clicking Send. The CR LF line ending is automatically appended to theline.

The ten buttons below the command line are macro buttons which can be configured by draggingand dropping text onto them. Clicking these buttons sends their stored content to the modem.

Side panelThe side panel displays information related to the modem, network, and mobile cell.

The first line of indicators helps to visualize the connection state by displaying the indicators in differentcolors. Hovering over these indicators lists the possible colors and their meanings.

The modem state is listed in the next section followed by the network and the packet domain group.

In the network group, only the connected network is listed automatically. Click Search networks to displaya complete list of available networks. Be aware that this is a long and blocking operation.

4399_015 v0.7.1 8

Page 9: nRF Connect LTE Link Monitor - infocenter.nordicsemi.cominfocenter.nordicsemi.com/pdf/LTE_Link_Monitor_User_Guide_v0.7.1.pdf · The LTE Link Monitor is installed as an app for nRF

LTE Link Monitor functionality

If the connected cell can be resolved by the locationapi.org service, you can click Show serving stationlocation to open a small map with the range of the serving station.

Settings

The Settings section of the side panel offers the following options:

• Automatic requests: Toggles the LTE Link Monitor's internal logic which is required to gatherinformation listed in the side panel.

Note: Any information displayed in LTE Link Monitor is an interpretation of the responsesfrom the modem. Therefore, turning off automatic requests affects the validity of theinformation.

• Periodic signal quality requests: Enable this option to send a CESQ command in a specifiedinterval. Requires Automatic requests to be enabled.

• Terminal auto scroll• LocationAPI token: Used for accessing the online service. The initial token belongs to a free

limited account so it is recommended to create an account and change the token by following thelink in the user interface.

Log viewThe log displays info and error level messages from the application. Click Open to view the full log file.

4399_015 v0.7.1 9

Page 10: nRF Connect LTE Link Monitor - infocenter.nordicsemi.cominfocenter.nordicsemi.com/pdf/LTE_Link_Monitor_User_Guide_v0.7.1.pdf · The LTE Link Monitor is installed as an app for nRF

4 Sample code for locationapi.org

The provided code snippet demonstrates the usage of the locationapi.org service.

Note:

• This code only handles expected successful responses.• The location request can be further enhanced for better accuracy by specifying neighboring

cells, for which you can directly use the response to the AT%NBRGRSRP command.

const SerialPort = require('serialport');

const fetch = require('node-fetch');

const port = new SerialPort('COM8', {

autoOpen: false,

baudRate: 115200,

dataBits: 8,

parity: 'none',

stopBits: 1,

});

let mcc;

let mnc;

// open the port and execute an AT+COPS? request

new Promise(resolve => port.open(resolve))

.then(() => new Promise(resolve => {

port.once('data', buf => resolve(buf.toString())).write('AT+COPS?\r');

}))

// pick the 3rd argument of COPS response

.then(plmn => (/COPS: [0-2],[0-2],"([^"]*)"/.exec(plmn).pop()))

.then(mccmnc => {

mcc = parseInt(mccmnc.substring(0, 3), 10);

mnc = parseInt(mccmnc.substring(3), 10);

})

// execute an AT+CEREG? request

.then(() => new Promise(resolve => {

port.once('data', buf => resolve(buf.toString())).write('AT+CEREG?\r');

}))

// pick the 3rd and 4th field from the response

.then(registration => (/CEREG: \d,\d+,"([0-9A-F]{1,4})","([0-9A-F]

{1,8})"/.exec(registration).slice(-2)))

.then(([tac, ci]) => ({

lac: parseInt(tac, 16),

cid: parseInt(ci, 16),

}))

// construct the locationapi request

4399_015 v0.7.1 10

Page 11: nRF Connect LTE Link Monitor - infocenter.nordicsemi.cominfocenter.nordicsemi.com/pdf/LTE_Link_Monitor_User_Guide_v0.7.1.pdf · The LTE Link Monitor is installed as an app for nRF

Sample code for locationapi.org

.then(({ lac, cid }) => ({

token: 'pk.c748a4d4e6ce0bfd5491dcfb01ba9b10',

radio: 'lte',

mcc,

mnc,

cells: [{ lac, cid }],

address: 1,

}))

.then(body => console.log(body) || body)

// fetch the result

.then(body => fetch('https://eu1.unwiredlabs.com/v2/process.php', {

method: 'POST',

headers: { 'Content-Type': 'application/json' },

body: JSON.stringify(body),

}))

.then(response => response.json())

.then(console.log)

.then(() => process.exit());

4399_015 v0.7.1 11

Page 12: nRF Connect LTE Link Monitor - infocenter.nordicsemi.cominfocenter.nordicsemi.com/pdf/LTE_Link_Monitor_User_Guide_v0.7.1.pdf · The LTE Link Monitor is installed as an app for nRF

Legal noticesBy using this documentation you agree to our terms and conditions of use. Nordic Semiconductor maychange these terms and conditions at any time without notice.

Liability disclaimerNordic Semiconductor ASA reserves the right to make changes without further notice to the product toimprove reliability, function, or design. Nordic Semiconductor ASA does not assume any liability arising outof the application or use of any product or circuits described herein.

Nordic Semiconductor ASA does not give any representations or warranties, expressed or implied, as tothe accuracy or completeness of such information and shall have no liability for the consequences of useof such information. If there are any discrepancies, ambiguities or conflicts in Nordic Semiconductor’sdocumentation, the Product Specification prevails.

Nordic Semiconductor ASA reserves the right to make corrections, enhancements, and other changes tothis document without notice.

Life support applicationsNordic Semiconductor products are not designed for use in life support appliances, devices, or systemswhere malfunction of these products can reasonably be expected to result in personal injury.

Nordic Semiconductor ASA customers using or selling these products for use in such applications do soat their own risk and agree to fully indemnify Nordic Semiconductor ASA for any damages resulting fromsuch improper use or sale.

RoHS and REACH statementNordic Semiconductor products meet the requirements of Directive 2011/65/EU of the EuropeanParliament and of the Council on the Restriction of Hazardous Substances (RoHS 2) and the requirementsof the REACH regulation (EC 1907/2006) on Registration, Evaluation, Authorization and Restriction ofChemicals.

The SVHC (Substances of Very High Concern) candidate list is continually being updated. Completehazardous substance reports, material composition reports and latest version of Nordic's REACHstatement can be found on our website www.nordicsemi.com.

TrademarksAll trademarks, service marks, trade names, product names, and logos appearing in this documentationare the property of their respective owners.

Copyright notice© 2019 Nordic Semiconductor ASA. All rights are reserved. Reproduction in whole or in part is prohibitedwithout the prior written permission of the copyright holder.

4399_015 v0.7.1 12


Recommended