Module: j5e/button

Description

A module for working with buttons.

A push-button or simply button is a simple switch mechanism to control some aspect of a machine or a process. Buttons are typically made out of hard material, usually plastic or metal. The surface is usually flat or shaped to accommodate the human finger or hand, so as to be easily depressed or pushed. Buttons are most often biased switches, although many un-biased buttons still require a spring to return to their un-pushed state. Terms for the "pushing" of a button include pressing, depressing, mashing, slapping, hitting, and punching.Read more on Wikipedia

Requires

• module:j5e/event
• module:j5e/fn

Class: Button

The Button class allows for control of digital buttons

Constructor

new Button(io)

Parameters

Example

// Use a button to control an LED
import Button from "j5e/button";
import LED from "j5e/led";

const button = await new Button(12);
const led = await new LED(13);

button.on("open", function() {
  led.off();
});

button.on("close", function() {
  led.on();
});

Properties

Events

• Button#event:open
• Button#event:close

Methods

button.configure(options);

import Button from "j5e/button";
import LED from "j5e/led";

const button = await new Button(14);
button.configure({
  debounce: 20
});

button.on("open", function() {
  led.off();
});

button.on("close", function() {
  led.on();
});

button.on(event, listener);

button.removeListener(event, listener);

button.emit(event);

button.once(event, listener);