ArduinoLibs
BlinkLED.h
00001 /*
00002  * Copyright (C) 2012 Southern Storm Software, Pty Ltd.
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a
00005  * copy of this software and associated documentation files (the "Software"),
00006  * to deal in the Software without restriction, including without limitation
00007  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008  * and/or sell copies of the Software, and to permit persons to whom the
00009  * Software is furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included
00012  * in all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
00019  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
00020  * DEALINGS IN THE SOFTWARE.
00021  */
00022 
00023 #ifndef BlinkLED_h
00024 #define BlinkLED_h
00025 
00026 #include <inttypes.h>
00027 
00028 class BlinkLED
00029 {
00030 public:
00031     BlinkLED(uint8_t pin, unsigned long onTime, unsigned long offTime, bool initialState = false);
00032 
00033     void loop();
00034 
00035     unsigned long onTime() const { return _onTime; }
00036     unsigned long offTime() const { return _offTime; }
00037     void setBlinkRate(unsigned long onTime, unsigned long offTime);
00038 
00039     bool state() const { return _state; }
00040     void setState(bool state);
00041 
00042     void pause() { _paused = true; }
00043     void resume();
00044     bool isPaused() const { return _paused; }
00045 
00046 private:
00047     uint8_t _pin;
00048     bool _state;
00049     bool _paused;
00050     unsigned long _onTime;
00051     unsigned long _offTime;
00052     unsigned long _lastChange;
00053 };
00054 
00055 #endif
 All Classes Files Functions Variables Enumerations Enumerator