From 14bac1d5c06014b6fcae540331ef76e0f6fc6870 Mon Sep 17 00:00:00 2001 From: James Fowkes Date: Tue, 30 Oct 2018 14:41:16 +0000 Subject: [PATCH] Add basic summary of each library to README. --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index a0f4b99..a74119b 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,30 @@ ArduLibraries Useful libraries for Arduino You can download single libraries from "Releases" folder by clicking in the library and then clicking "raw". + +DimmerOne +------------- + +Implements a dimmer based on zero-crossing detection of an AC signal, with adjustable frequency and firing angle. Uses interrupts and TIMER1 for accurate timing. + +EasyButton +------------- + +A button debouncing library. You can configure the debounce time, pullup options and a callback function that can be called on any combination of push, pushed, release and released. + +The update() method must be called by the user's application at a greater rate than the set debounce time. + +ShiftEasier +------------- + +Sets/reads shift registers, like the Arduino shiftOut and shiftIn functions but combined into a class to support an arbitrary number of bytes + +SimpleList +------------- + +A class designed to act list std::vector from the C++ STL. Implements iterator semantics (for looping), but not [] operator access to the array. + +TaskAction +------------- + +A class that implements a repeating task every X milliseconds or microseconds. The task is set by passing a function pointer to the class constructor.