22. nqLte

The nqLte object is a built-in object for obtaining LTE connection information.

Functional overview:

Provides the function to acquire the LTE connection information.
Provides the function to acquire the unique information of the LTE module.
Provides the function to acquire location information using the GPS function of the LTE module.
Provides the function to display the antenna level status using the system LED.

Limitations:

Available only for the neqto: Bridge LTE Module.
If you use GPS function, please check the hardware specifications in advance.
- neqto: Bridge LTE-1 Module
- neqto: Bridge LTE-M/NB Module

nqLte Global object

Methods()/Properties	Summary	Version
nqLte.gpsOn()	Enables the GPS function.	01.00.00+
nqLte.gpsOff()	Disables the GPS function.	01.00.00+
nqLte.getPosition()	Gets location information.	01.00.00+
nqLte.getSignalQuality()	Gets LTE signal quality information.	00.00.15+
nqLte.getIDs()	Gets LTE module identification information.	00.00.15+
nqLte.setAntennaLed()	Sets the antenna level display.	00.00.28+
nqLte.set()	Sets the parameters related to the given argument.	00.00.27+
nqLte.get()	Gets the parameters related to the given argument.	00.00.27+
nqLte.on()	Registers an event handler.	01.00.00+

Details

nqLte.gpsOn([mode][,callback])

Enables the GPS function.

Name	Type	M/O	Summary
mode	number	optional	GPS positioning mode 1: Standalone 2: Based (Not supported) 3: Assisted (Not supported) The default value is 1.
callback(status)	function	optional	Execute the callback process when GPS positioning starts. status : {number} GPS positioning start result 0 or more: Success -1: Failure
return	undefined	-	-

nqLte.gpsOff()

Disables the GPS function.

Name	Type	M/O	Summary	Note
return	undefined	-	-

nqLte.getPosition([timer,]callback)

Gets location information.
GPS function must be enabled before using this method.
When the GPS function is enabled, the location information is constantly updated every second. This method returns the latest location information when it was called.

Name	Type	M/O	Summary
timer	number	optional	Waiting time for successful positioning [ms] Specify the time to continue monitoring until the positioning is successful. Monitoring is performed at 10-second intervals from the time this method is called until the positioning result is successful. When the positioning success is detected or the waiting time expires, the callback is executed and the process is completed. If 0 is specified, the latest positioning result will be called back immediately without waiting for successful positioning. Range: 0 - 4,294,967,295 (Version 01.01.00+) Range: 0 - 250,000 (Previous Versions) The default value is 0.
callback(loc)	function	mandatory	Executes the callback processing when positioning is successful or positioning fails (When the success waiting time expires). loc : {Location} GPS location information
return	undefined	-	-

{Location}

Name	Type	Summary
.fix	number	Received information 0: NoFix 1: NoFix 2: 2DFix 3: 3DFix When the fix argument is 2, 3, the following location information is valid.
.datetime	string	Received date and time (GMT) The format is a 12-digit character string of "YYMMDDhhmmss". It will be blank if GPS cannot be received. i.e. : "190125100658" for January 25, 2019 at 10:06:58 AM.
.latitude	number	Latitude (+ for north latitude, - for south latitude) [degrees] It will be blank if GPS cannot be received. i.e. : 39.701843
.longitude	number	Longitude (+ for East, - for West) [degrees] It will be blank if GPS cannot be received. i.e. : 141.136268
.altitude	number	Altitude [m] It will be blank if GPS cannot be received. i.e. : 115.0

nqLte.getSignalQuality(callback)

Gets LTE signal quality information.

Name	Type	M/O	Summary	Note
callback(sq)	function	mandatory	Executes callback processing when information acquisition is completed. sq : {SignalQuality} LTE signal quality information
return	undefined	-	-

{SignalQuality}

Name	Type	Summary	Note
.time	number	Updated date and time (Unixtime)
.registered	number	Registration status of the serving cell 0: Not registered 1: Registered If acquisition fails, it will be 0.
.signal	number	Antenna level Range: 0 - 5 If acquisition fails, it will be 0.
.service	number	Out of service area status 0: Out of service area 1: Within service area If acquisition fails, it will be 0.
.roaming	number	Roaming state 0: Home 1: Roaming If acquisition fails, it will be 0.	When roaming connection, it will be 1.
.rssi	number	RSSI [dBm] Range: -113 - -51 -255: Unknown If acquisition fails, it will be -255.
.ber	number	BER Range: 0 - 7, 99 If acquisition fails, it will be 99.	Not use.
.sysmode	number	System mode 0: NOSERVICE 7: CAT-1 8: CAT-M1 9: CAT-NB1 If acquisition fails, it will be 0.
.rsrp	number	RSRP [dBm] Range: -141 - -44 -255: Unknown If acquisition fails, it will be -255.
.rsrq	number	RSRQ [dB] Range: -20 - -3 -255: Unknown If acquisition fails, it will be -255.
.sinr	number	SINR [dB] Range: -20 - 30 -21: Unknown If acquisition fails, it will be -21.	Version 00.00.23+
.tac	number	TAC (Tracking Area Code) If acquisition fails, it will be 0.	Version 00.00.23+ This value is valid when 'registered' is 1.
.ci	number	CI (Cell ID) If acquisition fails, it will be 0.	Version 00.00.23+ This value is valid when 'registered' is 1.
.mcc	number	MCC (Mobile Country Code) If acquisition fails, it will be 0.	Version 00.00.23+ This value is valid when 'registered' is 1.
.mnc	number	MNC (Mobile Network Code) If acquisition fails, it will be 0.	Version 00.00.23+ - Supports up to 2 digits Version 01.00.00+ - Supports up to 3 digits This value is valid when 'registered' is 1.

nqLte.getIDs()

Gets LTE module identification information.

Name	Type	M/O	Summary	Note
return	{LteID}	-	{LteID} : LTE module identification information

{LteID}

Name	Type	Summary	Note
.imei	string	IMEI (International Mobile Equipment Identity) It will be a 15-digit character string.
.imsi	string	IMSI (International Mobile Subscriber Identity) It will be a 15-digit character string. If SIM is not detected, it will be blank.
.msisdn	string	MSISDN (Mobile Station International Subscriber Directory Number) If SIM is not detected, it will be blank.
.iccid	string	ICCID (IC Card ID) It will be a 19-20 digit character string. If SIM is not detected, it will be blank.
.model	string	LTE module model name `'BG96'`, `'SIMCOM_SIM7500JC'` If the module is not started, it will be blank.	Version 00.00.23+

nqLte.setAntennaLed(ctl)

Sets the antenna level display.
Use the system LED to display the antenna level status.

Name	Type	M/O	Summary	Note
ctl	boolean	mandatory	LED antenna level display setting true: The LED indicates the antenna level. false: Normal operation Default value is false.	For LED display patterns, please refer to System LED Indications.
return	undefined	-	-

nqLte.set(name[,args...])

Sets the parameters related to the given argument.

Name	Type	M/O	Summary
name	string	mandatory	The name of the parameter to set Names that can be used are; ooswatchdog
args	string, number	optional	Arguments used when setting the value
return	undefined	-	-

nqLte.set(’ooswatchdog’,timer)

Sets the out-of-service watchdog timer.
This timer starts when it detects out-of-service and stops when it detects within-service.
If out-of-service continues and a timer expired, only the LTE modem will restart.
Attempts to recover from a continuous loss of communication due to an unexpected LTE modem failure.

Name	Type	M/O	Summary
’ooswatchdog’	string	mandatory	Name for setting the out-of-service watchdog timer
timer	number	mandatory	The out-of-service watchdog timer value Range: 0 - 24 [hour] If 0 is specified, it becomes disabled. The default value is 0.
return	undefined	-	-

nqLte.get(name[,args...])

Gets the parameters related to the given argument.

Name	Type	M/O	Summary
name	string	mandatory	The name of the parameter to get Names that can be used are; ooswatchdog
args	string, number	optional	Arguments used when getting the value
return	string, number, undefined	-	string : The requested string data number : The requested number data undefined : Failure due to request error

nqLte.get(’ooswatchdog’)

Gets the out-of-service watchdog timer settings.

Name	Type	M/O	Summary	Note
’ooswatchdog’	string	mandatory	Name to get the out-of-service watchdog timer value
return	number	-	The out-of-service watchdog timer value

nqLte.on(event,callback)

Registers an event handler.

Name	Type	M/O	Summary
event	string	mandatory	Event name Names that can be used are; reboot
callback()	function	mandatory	Executes callback processing when an event occurs.
return	undefined	-	-

event : ’reboot’

Registers a reboot event handler.
Executes callback when the LTE module is reboot due to out-of-service watchdog or failure detection, and when returning from the reboot.
The arguments for the callback are as follows:

Arguments	Type	Summary	Note
cause	Object	cause is the cause of reboot. 0: recovery 1: failure 2: ooswatchdog

Object Usage Examples

Sample 1

This is a sample that acquires and displays GPS information every 20 seconds.

var getEvent = 0;

var to = setInterval(function() {
    getEvent = 1;
},20000);

nqLte.gpsOn(1);

while(1){
    if(getEvent){
        getEvent = 0;
        nqLte.getPosition(function(loc){
            if(2 <= loc.fix) {
                print('GPS information');
                print('datetime: ' + loc.datetime);
                print('latitude: ' + loc.latitude.toFixed(6));
                print('longitude: ' + loc.longitude.toFixed(6));
                print('altitude: ' + loc.altitude.toFixed(1));
            } else {
                print('GPS no fix');
            }
        });
    }
}

Sample 2

This is a sample that waits 180 seconds until GPS information is obtained.
GPS is turned off after displaying the acquired information.

nqLte.gpsOn();
nqLte.getPosition(180000,function(loc){
    print('getPositionCb');
    print('fix:'+loc.fix.toString());
    print('datetime:'+loc.datetime);
    print('latitude:'+loc.latitude.toFixed(6));
    print('longitude:'+loc.longitude.toFixed(6));
    print('altitude:'+loc.altitude.toFixed(6));
    nqLte.gpsOff();
});

Sample 3

This is a sample that acquires and displays signal quality information and identification information.

var ids = nqLte.getIDs();
print('imei: '+ids.imei);
print('imsi: '+ids.imsi);
print('msisdn: '+ids.msisdn);
print('iccid: '+ids.iccid);
print('model: '+ids.model);
nqLte.getSignalQuality(function(sq){
    print('registered: '+sq.registered.toString());
    print('signal: '+sq.signal.toString());
    print('service: '+sq.service.toString());
    print('roaming: '+sq.roaming.toString());
    print('rssi: '+sq.rssi.toString());
    print('sysmode: '+sq.sysmode.toString());
    print('rsrp: '+sq.rsrp.toString());
    print('rsrq: '+sq.rsrq.toString());
    print('sinr: '+sq.sinr.toString());
    print('tac: '+sq.tac.toString());
    print('ci: '+sq.ci.toString());
    print('mcc: '+sq.mcc.toString());
    print('mnc: '+sq.mnc.toString());
});

Updated: 2020/7/31

Hardware Specifications

Software Specifications

neqto.js