-
Notifications
You must be signed in to change notification settings - Fork 0
/
ledhelper.h
184 lines (128 loc) · 5.61 KB
/
ledhelper.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
#ifndef _JAROFLIGHT_LEDHELPER_H_
#define _JAROFLIGHT_LEDHELPER_H_
/*======================================================================
FILE:
ledhelper.h
CREATOR:
Sean Foley
DESCRIPTION:
Helper class that does some simple animation for an LED hooked
up to a micro GPIO pin.
PUBLIC CLASSES AND FUNCTIONS:
LedHelper
Copyright (C) 2017 Sean Foley All Rights Reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted. Enjoy.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
======================================================================*/
//======================================================================
// INCLUDES AND PUBLIC DATA DECLARATIONS
//======================================================================
//----------------------------------------------------------------------
// Defines
//----------------------------------------------------------------------
// None.
//----------------------------------------------------------------------
// Include Files
//----------------------------------------------------------------------
#include <stdint.h>
#include <Arduino.h>
//----------------------------------------------------------------------
// Type Declarations
//----------------------------------------------------------------------
// None.
//----------------------------------------------------------------------
// Global Constant Declarations
//----------------------------------------------------------------------
// None.
//----------------------------------------------------------------------
// Global Data Declarations
//----------------------------------------------------------------------
// None.
//======================================================================
// WARNINGS!!!
//======================================================================
// None.
//======================================================================
// FUNCTION DECLARATIONS
//======================================================================
// None.
//=====================================================================
// EXCEPTION CLASS DEFINITIONS
//=====================================================================
// None.
//======================================================================
// CLASS DEFINITIONS
//======================================================================
/*======================================================================
CLASS:
LedHelper
DESCRIPTION:
Helper class that does some simple animation for an LED hooked
up to a micro GPIO pin.
HOW TO USE:
Construct the object with the GPIO pin and logic level.
Then call the various methods to control the Led.
======================================================================*/
class LedHelper
{
public:
//=================================================================
// TYPE DECLARATIONS AND CONSTANTS
//=================================================================
// None.
//=================================================================
// CLIENT INTERFACE
//=================================================================
LedHelper( const uint8_t gpio, bool invertLogicLevel = true );
void TurnOn();
void TurnOff();
// Toggle will flip/flop the LED - if it is off, it turns on,
// and if it is on, it turns off.
int Toggle();
// This will flash the LED for the given duration in milliseconds
void Flash( const int durationMS = 500 );
protected:
//=================================================================
// SUBCLASS INTERFACE
//=================================================================
// None.
private:
//=================================================================
// CUSTOMIZATION INTERFACE
//=================================================================
// None.
//=================================================================
// IMPLEMENTATION INTERFACE
//=================================================================
// None.
//=================================================================
// DATA MEMBERS
//=================================================================
uint8_t _gpio;
bool _invertLogicLevel;
};
//======================================================================
// INLINE FUNCTION DEFINITIONS
//======================================================================
// C-tor
inline LedHelper::LedHelper( const uint8_t gpio, bool invertLogicLevel )
: _gpio( gpio ), _invertLogicLevel( invertLogicLevel )
{
pinMode( _gpio, OUTPUT );
}
/*======================================================================
// DOCUMENTATION
========================================================================
None.
======================================================================*/
#endif // #ifendif _JAROFLIGHT_LEDHELPER_H_