LedSwitchRK (community library)

Summary

Name Value
Name LedSwitchRK
Version 0.0.2
Installs 273
License MIT
Author Rick Kaseguma rickkas7@rickk.com
URL https://github.com/rickkas7/LedSwitchRK
Repository https://github.com/rickkas7/LedSwitchRK.git
Download .tar.gz
All Versions 0.0.2, 0.0.1

Handy library for the SparkFun tactile switch with LED with debouncing

Example Build Testing

Device OS Version:

This table is generated from an automated build. Success only indicates that the code compiled successfully.

Library Read Me

This content is provided by the library maintainer and has not been validated or approved.

LedSwitchRK

Handy library for the SparkFun tactile switch with LED with debouncing

SparkFun has a line of these nice tactile momentary button with various colored caps and built-in LEDs.

[image unavailable]

This library is a simple wrapper around this and the Debounce library to detect when the button is pressed and manipulate the LED.

Usage

You normally instantiate a global LedSwitch object for each switch you have. The constructor takes the led PIN and the switch pin.

The LED pin is intended to be connected to the + side of the LED switch. The other side of the LED connects to GND with a current limiting resistor (68 ohms).

The switch pin is intended to be connected to the momentary switch. The other side of the switch connects to GND. The internal pull-up is used so you don't need an external pull-up resistor.

Call the pressed() method on each call to loop(). If it returns true, then the button has been pressed. The press is debounced. There is no support for multiple presses (double click, etc.) at this time.

There are methods to manipulate the LED:

  • ledOn()
  • ledOff()
  • ledToggle()

Example 1 - Single

#include "LedSwitchRK.h"

LedSwitch ledSwitch(D4, D5); // led, switch

void setup() {
}

void loop() {
if (ledSwitch.pressed()) {
ledSwitch.ledToggle();
}
}

Example 2 - Multiple

#include "LedSwitchRK.h"

LedSwitch switches[4] = {
// { LED pin, switch pin }
LedSwitch(D5, D6),
LedSwitch(A3, A2),
LedSwitch(D3, D4),
LedSwitch(A1, A0)
};

void setup() {
}

void loop() {

for(size_t ii = 0; ii < (sizeof(switches) / sizeof(switches[0])); ii++) {
if (switches[ii].pressed()) {
switches[ii].ledToggle();
}
}
}

Browse Library Files