-
Notifications
You must be signed in to change notification settings - Fork 0
/
Speedometer.h
218 lines (183 loc) · 5.64 KB
/
Speedometer.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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/**
* ----------------------------------------------------------------
* Copyright (C) 2020 Luis Acosta <zerfoinder@gmail.com>
*
* Speedometer library, This is a library to emulte Back to the
* Future Delorean digital speedometer with a 7-Segment 4 digit display
* to run from 0 to 88mph. It uses a TM1637 display.
*
* www.github.com/Zerfoinder/TimeMachine_Speedometer (github as default source provider)
*
* This file is part of Speedometer library.
*
* Speedometer is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Speedometer is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
* ----------------------------------------------------------------
*/
/**
* name: Speedometer
* version: 0.1.1
* Author: Luis Acosta <zerfoinder@gmail.com>
* Date: 2020-07-23
* Description: Speedometer is a library to emulte Back to the Future
* Delorean time machine digital speedometer using a 7-Segment 4
* digit display to run from 0 to 88mph. It uses TM1637 display.
*/
#ifndef TIMEMACHINE_SPEEDOMETER_H
#define TIMEMACHINE_SPEEDOMETER_H
#include <Arduino.h>
#include <TM1637Display.h>
namespace bttf::timemachine {
struct SpeedoPins {
byte clock;
byte data;
};
enum SpeedoBrightLevel {
low = 0,
medium = 2,
high = 5
};
enum SpeedoState {
off = 0,
on = 1,
bright = 2,
blinking = 3,
moving = 4
};
/**
* @brief This class describes a Speedometer.
*
* The Speedometer is displayed in a 7-Segment 4 digit display.
*
* It moves from 0 to 88mph.
*
* In order to keep major screen accuracy. We only use first
* three digits.
*/
class Speedometer {
TM1637Display tm_display;
static const int maxSpeedometerValue = 880;
static const int minSpeedometerValue = 0;
static const int blinkIntervals[][11];
public:
/**
* @brief Constructs a new instance.
*/
Speedometer(SpeedoPins speedoPins);
/**
* @brief Initializes the object.
* @warning It should ALWAYS run in setup() section.
*/
void init(void);
/**
* @brief Turns on Speedometer.
*/
void on(void);
/**
* @brief Turns on Speedometer brighter.
*
* @param[in] duration milliseconds duration of bright.
*
* @note after duration, display returns to previous state.
*/
void brighter(unsigned long duration);
/**
* @brief Turns on Speedometer blinking.
*/
void blink(void);
/**
* @brief Turns off Speedometer.
*/
void off(void);
/**
* @brief Get the current state of Speedometer.
*
* @return SpeedoState
*/
SpeedoState state(void);
/**
* @brief Sets the value to display.
*
* @param[in] value The value to display
*/
void setValue(int value);
/**
* @brief Gets the speedometer value.
*
* @return The current value.
*/
int getValue(void);
/**
* @brief Moves from current value to new value
*
* @param[in] newValue The new value
* @param[in] duration Milliseconds to move to new value.
*/
void moveTo(int newValue, unsigned long duration);
/**
* @brief function used to manage concurrent actions
*
* @warning it should be ALWAYS added in the end of sketch loop() method.
*/
void loop(void);
protected:
private:
/************ METHODS ***************/
/**
* @brief Updates Speedometer state.
*/
void _update(void);
/**
* @brief Clears the display.
*/
void _clear(void);
/**
* @brief Validate new value
*
* @param[in] newValue The new value
*
* @return validated new value.
*/
int _validateNewValue(int newValue);
/**
* @brief
*
* @param[in] blinkstep The blinkstep
*/
void _displayBlink(byte blinkstep);
/************ VARIABLES ***************/
/**
* Speedometer state
*/
SpeedoState _state;
/**
* current Speedometer value
*/
int _value;
/**
* new Speedometer value
*/
int _newValue;
int _moveToIncrement;
int _moveToInterval;
byte _blinkIntervalIndex;
/**
* local variable used to save last loop millis()
*/
unsigned long _lastLoopMillis;
/**
* local variable used to brighter() method
*/
unsigned long _brightInterval;
}; // end class Speedometer
} // end namespace bttf::timemachine
#endif // TIMEMACHINE_SPEEDOMETER_H