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

23. nqWiFi

The nqWiFi object is a built-in object for obtaining WiFi connection information.

Functional overview:

  • Provides the function to acquire the WiFi connection information.
  • Provides the function to acquire the unique information of the WiFi module.
  • Provides the function to indicate the antenna level status using the system LED.

Limitations:

  • Available only for the NEQTO Bridge Wi-Fi Module.



nqWiFi Global Object

Methods()/PropertiesSummaryVersionNote
nqWiFi.getIDs()Gets the unique information of the WiFi module.00.00.16+
nqWiFi.getSignalQuality()Gets the connected WiFi-AP information.00.00.16+
nqWiFi.getScanList()Gets nearby WiFi-AP information.00.00.16+
nqWiFi.setAntennaLed()Sets the antenna level indication.00.00.28+
nqWiFi.isConnected()Gets the Wi-Fi communication status.02.00.00+



Details

nqWiFi.getIDs(callback)

Gets the unique information of the WiFi module.

NameTypeM/OSummaryNote
callback(id)functionoptionalExecutes callback processing when information acquisition is completed.
id : {WifiID}
WiFi module unique information
returnundefined--

{WifiID}

NameTypeM/ONote
.macAddrstringWiFi MAC addressWhen not yet acquired, it becomes 00:00:00:00:00:00.

nqWiFi.getSignalQuality(callback)

Gets the connected WiFi-AP information.

NameTypeM/OSummaryNote
callback(sq)functionmandatoryExecutes callback processing when information acquisition is completed.
sq : {SignalQuality}
Connected WiFi-AP information
returnundefined--

{SignalQuality}

NameTypeSummaryNote
.macAddrstringWiFi MAC address
When not yet connected, it becomes 00:00:00:00:00:00.
.ssidstringSSID of WiFi-AP
Blank when not connected.
.rssinumberCurrent received signal strength indicator [dBm]
It is -255 when not connected. (Version 02.00.00+)
It is -32768 when not connected. (Previous version)

nqWiFi.getScanList(callback[,option])

Gets nearby WiFi-AP information.

NameTypeM/OSummaryNote
callback(apList)functionmandatoryExecutes callback processing when information acquisition is completed.
apList : {ApList}
WiFi-AP information nearby
optionstringoptionalOption
When 'stealth' is specified, stealth AP is also listed.
Version 00.00.18+
returnundefined--

{ApList}

NameTypeSummaryNote
.resultbooleanAcquisition result
If acquisition fails, it will be false.
[ ]{ApInfo}({array}) of {ApInfo}
Get up to 10 nearby WiFi-AP information.

{ApInfo}

NameTypeSummaryNote
.macAddrstringWiFi MAC address
.ssidstringSSID of WiFi-AP
.rssinumberReceived signal strength indicator [dBm]

nqWiFi.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
The default value is false.
For LED display patterns, please refer to System LED Indications.
returnundefined--

nqWiFi.isConnected()

Gets the Wi-Fi communication status.

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



Object Usage Examples

Sample 1

This is a sample to get and display own WiFi MAC address.

nqWiFi.getIDs(function(id){
  print(id.macAddr);
});

Sample 2

This is a sample that acquires and displays the connected WiFi-AP information.

nqWiFi.getSignalQuality(function(sq){
  print("MAC  --> " + sq.macAddr);
  print("SSID --> " + sq.ssid);
  print("RSSI --> " + sq.rssi);
});

Sample 3

This is a sample that acquires and displays nearby WiFi-AP information.

nqWiFi.getScanList(function(aplist){
  if (false != aplist.result) {
    for(n = 0; n < aplist.length; n++) {
      print("-----");
      print("MAC  --> " + aplist[n].macAddr);
      print("SSID --> " + aplist[n].ssid);
      print("RSSI --> " + aplist[n].rssi);
    }
  }
});



Updated: 2022-06-24
← 22. nqFOTA24. nqLte →
  • nqWiFi Global Object
  • Details
    • nqWiFi.getIDs(callback)
    • {WifiID}
    • nqWiFi.getSignalQuality(callback)
    • {SignalQuality}
    • nqWiFi.getScanList(callback[,option])
    • {ApList}
    • {ApInfo}
    • nqWiFi.setAntennaLed(ctl)
    • nqWiFi.isConnected()
  • Object Usage Examples
    • Sample 1
    • Sample 2
    • Sample 3
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.