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()/Properties | Summary | Version | Note |
|---|---|---|---|
| new GPIO() | Creates a GPIO instance. | 00.00.15+ |
{GPIO} Instance
| Methods()/Properties | Summary | Version | Note |
|---|---|---|---|
| .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+ | |
| .gpioNo | GPIO number | 00.00.15+ | |
| .mode | GPIO operation mode | 00.00.15+ |
Details
new GPIO(gpioNo,mode)
Creates a GPIO instance.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| gpioNo | number | mandatory | Specify the GPIO number. Please refer to Pinout. | |
| mode | number | mandatory | Specify the GPIO operation mode. Please refer to GPIO operation mode details. | |
| return | {GPIO} | - | {GPIO} : Generated {GPIO} |
GPIO operation mode details
| mode | I/O | Summary | Note |
|---|---|---|---|
| 0 | IN | PULL-UP | - |
| 1 | IN | PULL-DOWN | - |
| 2 | IN | - | |
| 3 | OUT | PUSH-PULL PULL-UP | - |
| 4 | OUT | PUSH-PULL PULL-DOWN | - |
| 5 | OUT | PUSH-PULL | - |
| 6 | OUT | OPEN-DRAIN PULL-UP | - |
| 7 | OUT | OPEN-DRAIN PULL-DOWN | - |
| 8 | OUT | OPEN-DRAIN | - |
| 9 | OUT | PWM | Please refer to Pinout for the ports that can use the PWM function. |
.setMode(mode)
Sets the GPIO operation mode.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| mode | number | mandatory | GPIO operation mode Please refer to GPIO operation mode details. | |
| return | boolean | - | true: Success false: Failure |
.getValue()
Gets the IO port state.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| return | number | - | IO port status 0: Low 1: High |
.setValue(value)
Sets the IO port output.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| value | number | mandatory | IO port output value 0: Low 1: High | |
| return | boolean | - | 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.
For the ports that can use the interrupt function, refer to Pinout.
This function can be used for up to 4 ports.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| edge | number | mandatory | Interrupt condition 1: Rising edge 2: Falling edge 3: Rising / Falling edge | |
| callback(value) | function | mandatory | Executes callback processing when an interrupt event occurs. value : {number} IO port status at event occurrence 0: Low 1: High | |
| return | boolean | - | true: Success false: Failure |
.disableIrq()
Invalidates the IO port input interrupt event set by .setIrq().
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| return | boolean | - | 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.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| period | number | mandatory | Pulse period [x100us] Range: 1 - 10000 | Some ports have restrictions on the range. Please refer to Pinout and check the notes. |
| pulse | number | mandatory | Pulse width [x100us] Range: 0 - 10000 | Pulse must be less than the period. |
| return | boolean | - | 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.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| return | boolean | - | 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 (restart).
For the ports that can use the wakeup function, refer to Pinout.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| edge | number | mandatory | Set the wakeup trigger. 0: Invalid 1: Rising edge 2: Falling edge | Disabled by default. |
| return | undefined | - | - |
.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.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| value1 | number | mandatory | 1st signal;Specify the value to be output to the IO port. 0: Low 1: High | |
| width1 | number | mandatory | 1st signal;Specify the output time [ms] of the IO port. Range: 0 - 100 | If 0 is specified, it will be about 1.2us. |
| value2 | number | mandatory | 2nd signal;Specify the value to be output to the IO port. 0: Low 1: High | |
| width2 | number | mandatory | 2nd signal;Specify the output time [ms] of the IO port. Range: 0 - 100 | If 0 is specified, it will be about 1.2us. |
| return | boolean | - | 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();