NEQTO Docs
  • Languages iconEnglish
    • 日本語
  • Docs
  • Region API
  • Global API
  • FAQ

›neqto.js

Getting Started

  • NEQTO Hello World!
  • Step 1. Console Settings
  • Step 2. Device Setting & Start Service

    • When using NEQTO Bridge
    • When using Spresense
  • Step 3. Using Sensors

NEQTO

  • NEQTO Account Registration
  • API Usage
  • Batch Registration
  • Support Guidelines

NEQTO Console

  • Introduction
  • Fundamentals
  • Administrative Actions
  • Device Management
  • Scripts
  • Actions and Contacts
  • NEQTO Apps
  • Machine Driver
  • Recommended Browsers
  • Billing Information

SPRESENSE

    Hardware Specifications

    • 01. About Spresense

    Software Specifications

    • 01. Operational Flow
    • 02. Initial Installation
    • 03. Spresense Wi-Fi Initial Setup
    • 05. Debug Log Acquisition
    • 06. System LED Indications
    • 07. Event Messages
    • 08. Updating Firmware

    neqto.js

    • 01. About neqto.js
    • 02. Log
    • 03. Timers
    • 04. HTTP
    • 05. HTTPS
    • 06. MQTT
    • 07. Secure
    • 08. Storage
    • 10. RTC
    • 12. GPIO
    • 13. UART
    • 15. I2C
    • 17. Camera
    • 18. nqSpresense
    • 19. nqService
    • 20. nqMqtt
    • 21. nqFOTA
    • 22. nqWiFi

NEQTO Bridge Series

    Hardware Specifications

    • 01. NEQTO Bridge Module
    • 02. NEQTO Bridge Wi-Fi Module
    • 03. NEQTO Bridge LTE-1 Module
    • 04. NEQTO Bridge LTE-M/NB Module
    • 05. NEQTO Bridge IO Board
    • 06. NEQTO Bridge Digital IO Board

    Software Specifications

    • 01. Operational Flow
    • 02. NEQTO Bridge Wi-Fi Module Initial Setup
    • 03. NEQTO Bridge LTE Module Initial Setup
    • 04. Debug Log Acquisition
    • 05. System LED Indications
    • 06. Event Messages
    • 07. Updating Firmware

    neqto.js

    • 01. About neqto.js
    • 02. Log
    • 03. Timers
    • 04. HTTP
    • 05. HTTPS
    • 06. MQTT
    • 07. Secure
    • 08. Storage
    • 09. Sleep
    • 10. RTC
    • 11. UserSW
    • 12. GPIO
    • 13. UART
    • 14. SPI
    • 15. I2C
    • 16. ADC
    • 17. BLE
    • 18. nqBridge
    • 19. nqService
    • 20. nqMqtt
    • 21. nqFOTA
    • 22. nqWiFi
    • 23. nqLte
    • 24. nqLAN
    • 25. nqEx

neqto.js Libraries

    I2C

    • LIS2DW12 v2 Accelerometer
    • HTS221 v2 Temperature and Humidity Sensor
    • [Archive] LIS2DW12 Accelerometer
    • [Archive] HTS221 Temperature and Humidity Sensor

    Integration

    • AWS IoT Core v2 Library
    • AWS S3 v2 Library
    • Azure IoT v2 Library
    • GCP IoT Core Library
    • [Archive] AWS S3 Library
    • [Archive] AWS IoT Core Library

neqto.js Snippets

  • DataDog Snippet
  • Dropbox Snippet
  • Google Sheets Snippet
  • InfluxDB Snippet
  • Oracle Cloud Object Storage Snippet
  • Salesforce Snippet
  • SAP Cloud Platform Internet of Things Snippet
  • Splunk Snippet
  • Niagara Snippet

Release Notes

  • NEQTO Console Updates
  • NEQTO Firmware (Bridge Wi-Fi/LTE Module) Releases
  • NEQTO Firmware (Spresense Wi-Fi) Releases

23. 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()/PropertiesSummaryVersionNote
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.

NameTypeM/OSummaryNote
modenumberoptionalGPS positioning mode
1: Standalone
2: Based (Not supported)
3: Assisted (Not supported)
The default value is 1.
callback(status)functionoptionalExecute the callback process when GPS positioning starts.
status : {number}
GPS positioning start result
0 or more: Success
-1: Failure
returnundefined--

nqLte.gpsOff()

Disables the GPS function.

NameTypeM/OSummaryNote
returnundefined--

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.

NameTypeM/OSummaryNote
timernumberoptionalWaiting 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)functionmandatoryExecutes the callback processing when positioning is successful or positioning fails (When the success waiting time expires).
loc : {Location}
GPS location information
returnundefined--

{Location}

NameTypeSummaryNote
.fixnumberReceived information
0: NoFix
1: NoFix
2: 2DFix
3: 3DFix
When the fix argument is 2, 3, the following location information is valid.
.datetimestringReceived 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.
.latitudenumberLatitude (+ for north latitude, - for south latitude) [degrees]
It will be blank if GPS cannot be received.
i.e. : 39.701843
.longitudenumberLongitude (+ for East, - for West) [degrees]
It will be blank if GPS cannot be received.
i.e. : 141.136268
.altitudenumberAltitude [m]
It will be blank if GPS cannot be received.
i.e. : 115.0

nqLte.getSignalQuality(callback)

Gets LTE signal quality information.

NameTypeM/OSummaryNote
callback(sq)functionmandatoryExecutes callback processing when information acquisition is completed.
sq : {SignalQuality}
LTE signal quality information
returnundefined--

{SignalQuality}

NameTypeSummaryNote
.timenumberUpdated date and time (Unixtime)
.registerednumberRegistration status of the serving cell
0: Not registered
1: Registered
If acquisition fails, it will be 0.
.signalnumberAntenna level
Range: 0 - 5
If acquisition fails, it will be 0.
.servicenumberOut of service area status
0: Out of service area
1: Within service area
If acquisition fails, it will be 0.
.roamingnumberRoaming state
0: Home
1: Roaming
If acquisition fails, it will be 0.
When roaming connection, it will be 1.
.rssinumberRSSI [dBm]
Range: -113 - -51
-255: Unknown
If acquisition fails, it will be -255.
.bernumberBER
Range: 0 - 7, 99
If acquisition fails, it will be 99.
Not use.
.sysmodenumberSystem mode
0: NOSERVICE
7: CAT-1
8: CAT-M1
9: CAT-NB1
If acquisition fails, it will be 0.
.rsrpnumberRSRP [dBm]
Range: -141 - -44
-255: Unknown
If acquisition fails, it will be -255.
.rsrqnumberRSRQ [dB]
Range: -20 - -3
-255: Unknown
If acquisition fails, it will be -255.
.sinrnumberSINR [dB]
Range: -20 - 30
-21: Unknown
If acquisition fails, it will be -21.
Version 00.00.23+
.tacnumberTAC (Tracking Area Code)
If acquisition fails, it will be 0.
Version 00.00.23+
This value is valid when 'registered' is 1.
.cinumberCI (Cell ID)
If acquisition fails, it will be 0.
Version 00.00.23+
This value is valid when 'registered' is 1.
.mccnumberMCC (Mobile Country Code)
If acquisition fails, it will be 0.
Version 00.00.23+
This value is valid when 'registered' is 1.
.mncnumberMNC (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.

NameTypeM/OSummaryNote
return{LteID}-{LteID} : LTE module identification information

{LteID}

NameTypeSummaryNote
.imeistringIMEI (International Mobile Equipment Identity)
It will be a 15-digit character string.
.imsistringIMSI (International Mobile Subscriber Identity)
It will be a 15-digit character string.
If SIM is not detected, it will be blank.
.msisdnstringMSISDN (Mobile Station International Subscriber Directory Number)
If SIM is not detected, it will be blank.
.iccidstringICCID (IC Card ID)
It will be a 19-20 digit character string.
If SIM is not detected, it will be blank.
.modelstringLTE 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.

NameTypeM/OSummaryNote
ctlbooleanmandatoryLED 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.
returnundefined--

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

Sets the parameters related to the given argument.

NameTypeM/OSummaryNote
namestringmandatoryThe name of the parameter to set
Names that can be used are; ooswatchdog
argsstring, numberoptionalArguments used when setting the value
returnundefined--

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.

NameTypeM/OSummaryNote
’ooswatchdog’stringmandatoryName for setting the out-of-service watchdog timer
timernumbermandatoryThe out-of-service watchdog timer value
Range: 0 - 24 [hour]
If 0 is specified, it becomes disabled.
The default value is 0.
returnundefined--

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

Gets the parameters related to the given argument.

NameTypeM/OSummaryNote
namestringmandatoryThe name of the parameter to get
Names that can be used are; ooswatchdog
argsstring, numberoptionalArguments used when getting the value
returnstring, 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.

NameTypeM/OSummaryNote
’ooswatchdog’stringmandatoryName to get the out-of-service watchdog timer value
returnnumber-The out-of-service watchdog timer value

nqLte.on(event,callback)

Registers an event handler.

NameTypeM/OSummaryNote
eventstringmandatoryEvent name
Names that can be used are; reboot
callback()functionmandatoryExecutes callback processing when an event occurs.
returnundefined--

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:

ArgumentsTypeSummaryNote
causeObjectcause 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: 2021-02-19
← 22. nqWiFi24. nqLAN →
  • nqLte Global object
  • Details
    • nqLte.gpsOn([mode][,callback])
    • nqLte.gpsOff()
    • nqLte.getPosition([timer,]callback)
    • {Location}
    • nqLte.getSignalQuality(callback)
    • {SignalQuality}
    • nqLte.getIDs()
    • {LteID}
    • nqLte.setAntennaLed(ctl)
    • nqLte.set(name[,args...])
    • nqLte.set(’ooswatchdog’,timer)
    • nqLte.get(name[,args...])
    • nqLte.get(’ooswatchdog’)
    • nqLte.on(event,callback)
    • event : ’reboot’
  • Object Usage Examples
    • Sample 1
    • Sample 2
    • Sample 3
AboutNewsProductsFAQPrivacy Policy}
NEQTO Console
IntroductionFundamentalsAdministrative ActionsDevice Management NEQTO Apps
NEQTO Bridge Series
NEQTO Bridge ModuleNEQTO Bridge Wi-Fi ModuleNEQTO Bridge LTE-1 ModuleError Logging Event Messages
API Documentation
API UsageGlobal APIRegional APIAPI Terms of Service
Jigsaw, Inc.
© 2021 JIG-SAW INC.