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

12. GPIO

GPIO objects provide GPIO control functions.

Functional overview:

  • Provides a function to set and control the input / output of the GPIO port.
  • Provides PWM output function.



Abstracts

Methods()/PropertiesSummaryVersionNote
new GPIO()Creates a GPIO instance.00.00.15+

{GPIO} Instance

Methods()/PropertiesSummaryVersionNote
.setMode()Sets the GPIO operation mode.00.00.15+
.getValue()Gets the IO port state.00.00.15+
.setValue()Sets the IO port output.00.00.15+
.setIrq()Sets the IO port input interrupt event.00.00.15+
.disableIrq()Invalidates the IO port input interrupt event set by .setIrq().00.00.15+
.setPwm()Sets the PWM output.00.00.15+
.releasePwm()Stops and invalidates the PWM output set by .setPwm()00.00.15+
.configureWakeup()Sets the wakeup trigger.00.00.23+
.setOnePulse()Outputs one arbitrary pulse.00.00.24+


Details

new GPIO(gpioNo,mode)

Creates a GPIO instance.

NameTypeM/OSummaryNote
gpioNonumbermandatorySpecify the GPIO number.
Please refer to Pinout.
modenumbermandatorySpecify the GPIO operation mode.
Please refer to GPIO operation mode details.
return{GPIO}-{GPIO} : Generated {GPIO}

GPIO operation mode details

modeI/OSummaryNote
0INPULL-UP-
1INPULL-DOWN-
2IN-
3OUTPUSH-PULL PULL-UP-
4OUTPUSH-PULL PULL-DOWN-
5OUTPUSH-PULL-
6OUTOPEN-DRAIN PULL-UP-
7OUTOPEN-DRAIN PULL-DOWN-
8OUTOPEN-DRAIN-
9OUTPWMPlease refer to Pinout for the ports that can use the PWM function.

.setMode(mode)

Sets the GPIO operation mode.

NameTypeM/OSummaryNote
modenumbermandatoryGPIO operation mode
Please refer to GPIO operation mode details.
returnboolean-true: Success
false: Failure

.getValue()

Gets the IO port state.

NameTypeM/OSummaryNote
returnnumber-IO port status
0: Low
1: High

.setValue(value)

Sets the IO port output.

NameTypeM/OSummaryNote
valuenumbermandatoryIO port output value
0: Low
1: High
returnboolean-true: Success
false: Failure

.setIrq(edge,callback)

Sets the IO port input interrupt event.
When the specified interrupt condition occurs, the hardware interrupt is triggered and the callback is executed.
It is also used as a resume trigger in stop mode.
For the ports that can use the interrupt function, refer to Pinout.
This function can be used for up to 4 ports.

NameTypeM/OSummaryNote
edgenumbermandatoryInterrupt condition
1: Rising edge
2: Falling edge
3: Rising / Falling edge
callback(value)functionmandatoryExecutes callback processing when an interrupt event occurs.
value : {number}
IO port status at event occurrence
0: Low
1: High
returnboolean-true: Success
false: Failure

.disableIrq()

Invalidates the IO port input interrupt event set by .setIrq().

NameTypeM/OSummaryNote
returnboolean-true: Success
false: Failure

.setPwm(period,pulse)

Sets the PWM (Pulse Width Modulation) output.
Outputs a periodic pulse specified by the period and width.
Specify GPIO operation mode 9 in advance.

NameTypeM/OSummaryNote
periodnumbermandatoryPulse period [x100us]
Range: 1 - 10000
Some ports have restrictions on the range. Please refer to Pinout and check the notes.
pulsenumbermandatoryPulse width [x100us]
Range: 0 - 10000
Pulse must be less than the period.
returnboolean-true: Success
false: Failure

.releasePwm()

Stops and invalidates the PWM output set by .setPwm().
To enable the PWM control again, specify GPIO operation mode 9 again.

NameTypeM/OSummaryNote
returnboolean-true: Success
false: Failure

.configureWakeup(edge)

Sets the wakeup trigger.
During standby mode, when the wakeup trigger is valid and the specified edge change has occurred, the system will resume.
For the ports that can use the wakeup function, refer to Pinout.

NameTypeM/OSummaryNote
edgenumbermandatorySet the wakeup trigger.
0: Invalid
1: Rising edge
2: Falling edge
Disabled by default.
returnundefined--

.setOnePulse(value1,width1,value2,width2)

Outputs one arbitrary pulse.
This function outputs an arbitrary pulse generated by block type processing by software.
The cycle is not strictly guaranteed like PWM, so please use it after evaluating it.

NameTypeM/OSummaryNote
value1numbermandatory1st signal;
Specify the value to be output to the IO port.
0: Low
1: High
width1numbermandatory1st signal;
Specify the output time [ms] of the IO port.
Range: 0 - 100
If 0 is specified, it will be about 1.2us.
value2numbermandatory2nd signal;
Specify the value to be output to the IO port.
0: Low
1: High
width2numbermandatory2nd signal;
Specify the output time [ms] of the IO port.
Range: 0 - 100
If 0 is specified, it will be about 1.2us.
returnboolean-true: Success
false: Failure



Object Usage Examples

Sample 1

This is a sample that uses interrupts.
When the level of GPIO13 changes from H to L, the callback is executed.

var gp = new GPIO(13,2);
gp.setIrq(2, function(sts){
    print('status fall.');
});
gp.disableIrq();

Sample 2

This is a sample that uses PWM control.
Using GPIO11, PWM output of 10ms period and 5ms pulse width is executed for 10 seconds.

var gp = new GPIO(11,9);
gp.setPwm(100, 50);
setTimeout(function(){gp.releasePwm();}, 10000).wait();



Updated: 2021-02-01
← 11. UserSW13. UART →
  • Abstracts
    • {GPIO} Instance
  • Details
    • new GPIO(gpioNo,mode)
    • GPIO operation mode details
    • .setMode(mode)
    • .getValue()
    • .setValue(value)
    • .setIrq(edge,callback)
    • .disableIrq()
    • .setPwm(period,pulse)
    • .releasePwm()
    • .configureWakeup(edge)
    • .setOnePulse(value1,width1,value2,width2)
  • Object Usage Examples
    • Sample 1
    • Sample 2
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.