ArduinoLibs
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
BlinkLED.h
1 /*
2  * Copyright (C) 2012 Southern Storm Software, Pty Ltd.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20  * DEALINGS IN THE SOFTWARE.
21  */
22 
23 #ifndef BlinkLED_h
24 #define BlinkLED_h
25 
26 #include <inttypes.h>
27 
28 class BlinkLED
29 {
30 public:
31  BlinkLED(uint8_t pin, unsigned long onTime, unsigned long offTime, bool initialState = false);
32 
33  void loop();
34 
35  unsigned long onTime() const { return _onTime; }
36  unsigned long offTime() const { return _offTime; }
37  void setBlinkRate(unsigned long onTime, unsigned long offTime);
38 
39  bool state() const { return _state; }
40  void setState(bool state);
41 
42  void pause() { _paused = true; }
43  void resume();
44  bool isPaused() const { return _paused; }
45 
46 private:
47  uint8_t _pin;
48  bool _state;
49  bool _paused;
50  unsigned long _onTime;
51  unsigned long _offTime;
52  unsigned long _lastChange;
53 };
54 
55 #endif
void resume()
Resumes the LED blink cycle after a pause().
Definition: BlinkLED.cpp:170
void loop()
Definition: BlinkLED.cpp:79
unsigned long offTime() const
Returns the number of milliseconds the LED will be off.
Definition: BlinkLED.h:36
void pause()
Pauses the LED blink cycle in its current state().
Definition: BlinkLED.h:42
void setState(bool state)
Sets the current state of the LED, where true is on, false is off.
Definition: BlinkLED.cpp:145
void setBlinkRate(unsigned long onTime, unsigned long offTime)
Sets the onTime and offTime (in milliseconds).
Definition: BlinkLED.cpp:122
Blink a LED on a digital output pin.
Definition: BlinkLED.h:28
bool state() const
Returns the current state of the LED; true is on, false is off.
Definition: BlinkLED.h:39
unsigned long onTime() const
Returns the number of milliseconds the LED will be on.
Definition: BlinkLED.h:35
BlinkLED(uint8_t pin, unsigned long onTime, unsigned long offTime, bool initialState=false)
Initialize a blinking LED on the specified pin.
Definition: BlinkLED.cpp:64
bool isPaused() const
Returns true if the LED blink cycle is paused; false otherwise.
Definition: BlinkLED.h:44