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

›neqto.js

Getting Started

  • NEQTO Hello World!
  • Tutorial Step 1. NEQTO Console Setting
  • Tutorial Step 2. Device Settings & Launching Service (NEQTO Bridge)
  • Tutorial Step 2. Device Settings & Launching Service (STM32 Discovery)
  • Tutorial Step 2. Device Settings & Launching Service (SPRESENSE)
  • Tutorial Step 3. Application development using scripts

NEQTO

  • NEQTO Account Registration
  • Sub-accounts
  • API Usage
  • NEQTO CloudSync for GCP
  • NEQTO Engine Firmware List
  • Support Guidelines

NEQTO Console

  • Introduction
  • Fundamentals
  • Administrative Actions
  • Device Management
  • Linux-based Device Management
  • Batch Registration
  • Scripts
  • Actions and Contacts
  • View Data from the Console
  • NEQTO Apps

    • About NEQTO Apps
    • NEQTO Infinitypool
    • NEQTO Insights
    • NEQTO Custodia
    • NEQTO Flow
  • 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
    • 04. Spresense LTE-M 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
    • 09. Sleep
    • 10. RTC
    • 11. GPIO
    • 12. UART
    • 13. SPI
    • 14. I2C
    • 15. ADC
    • 16. GNSS
    • 17. Camera
    • 18. Utils
    • 19. nqSpresense
    • 20. nqService
    • 21. nqMqtt
    • 22. nqFOTA
    • 23. nqWiFi
    • 24. nqLte

STM32 Discovery

    Hardware Specifications

    • 01. About STM32 Discovery Kit (B-L4S5I-IOT01A)

    Software Specifications

    • 01. Operational Flow
    • 02. Initial Installation
    • 03. STM32 Discovery Wi-Fi 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
    • 18. Utils
    • 19. nqDiscovery
    • 20. nqService
    • 21. nqMqtt
    • 22. nqFOTA
    • 23. nqWiFi

NEQTO Bridge

    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
    • 07. NEQTO Bridge Connector 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. Utils
    • 19. nqBridge
    • 20. nqService
    • 21. nqMqtt
    • 22. nqFOTA
    • 23. nqWiFi
    • 24. nqLte
    • 25. nqLAN
    • 26. nqEx

Linux-based device

    Software Specifications

    • 01. System Requirements
    • 02. Installation
    • 03. Software Configurations
    • 04. Operational Flow
    • 05. Debug Log Acquisition
    • 06. Event Messages
    • 07. Updating Software

    neqto.js

    • 01. About neqto.js
    • 02. Log
    • 03. Timers
    • 04. HTTP
    • 05. HTTPS
    • 06. MQTT
    • 07. Secure
    • 08. Storage
    • 09. RTC
    • 10. UNIXSocket
    • 11. FileSystem
    • 12. SubProcess
    • 13. Utils
    • 14. nqLinux
    • 15. nqService
    • 16. nqMqtt
    • 17. nqFOTA
    • 18. nqLAN

neqto.js Libraries

  • About neqto.js Libraries
  • UART

    • GM65 Barcode Reader
    • SRF Ultrasonic Range Finder - Serial Mode

    I2C

    • HTS221 v2 Temperature and Humidity Sensor
    • LIS2DW12 v2 Accelerometer
    • SRF Ultrasonic Range Finder - I2C Mode
    • [Archive] HTS221 Temperature and Humidity Sensor
    • [Archive] LIS2DW12 Accelerometer

    Utils

    • RTC Alarm Synchronized Scheduler

    Integration

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

neqto.js Snippets

  • About neqto.js Snippets
  • DataDog
  • Dropbox
  • Google Sheets
  • InfluxDB
  • Oracle Cloud Object Storage
  • Salesforce
  • SAP Cloud Platform Internet of Things
  • Splunk
  • Niagara

Release Notes

  • NEQTO Console Updates
  • NEQTO Firmware (Bridge Wi-Fi/LTE Module) Releases
  • NEQTO Firmware (STM32 Discovery Wi-Fi) Releases
  • NEQTO Firmware (Spresense Wi-Fi/LTE-M) Releases
  • NEQTO Engine for Linux Releases

24. 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 indicate the antenna level status using the system LED.

Limitations:

  • Available only for the Spresense LTE-M configuration.



nqLte Global object

Methods()/PropertiesSummaryVersionNote
nqLte.getSignalQuality()Gets LTE signal quality information.01.03.00+
nqLte.getIDs()Gets LTE module identification information.01.03.00+
nqLte.setAntennaLed()Sets the antenna level indication.01.03.00+
nqLte.set()Sets the parameters related to the given argument.01.03.00+
nqLte.get()Gets the parameters related to the given argument.01.03.00+
nqLte.on()Registers an event handler.01.03.00+
nqLte.isConnected()Gets the LTE communication status.02.00.00+



Details

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.
.tacnumberTAC (Tracking Area Code)*Not supported; Always returns 0.
.cinumberCI (Cell ID)*Not supported; Always returns 0.
.mccnumberMCC (Mobile Country Code)
If acquisition fails, it will be 0.
This value is valid when 'registered' is 1.
.mncnumberMNC (Mobile Network Code)
If acquisition fails, it will be 0.
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
'1250'
If the module is not started, it will be blank.

nqLte.setAntennaLed(ctl)

Sets the antenna level indication.
Use the system LED to indicate the antenna level status.

NameTypeM/OSummaryNote
ctlbooleanmandatoryLED antenna level indication 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’

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
causenumbercause is the cause of reboot.
0: recovery
1: failure
2: ooswatchdog

nqLte.isConnected()

Gets the LTE communication status.

NameTypeM/OSummaryNote
returnboolean-LTE communication status
true: Available for communication
false: Not available for communication



Object Usage Examples

Sample 1

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: 2022-06-02
← 23. nqWiFi01. About STM32 Discovery Kit (B-L4S5I-IOT01A) →
  • nqLte Global object
  • Details
    • 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’
    • nqLte.isConnected()
  • Object Usage Examples
    • Sample 1
AboutNewsProductsFAQPrivacy Policy}
NEQTO Console
IntroductionFundamentalsAdministrative ActionsDevice Management NEQTO Apps
NEQTO Bridge
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.
© 2023 JIG-SAW INC.