-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMENWIZ.h
286 lines (253 loc) · 8.43 KB
/
MENWIZ.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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
// ---------------------------------------------------------------------------
// Created by Roberto Brunialti on 20/04/12.
// Copyright 2012 - Under creative commons license 3.0:
// Attribution-ShareAlike CC BY-SA
//
// This software is furnished "as is", without technical support, and with no
// warranty, express or implied, as to its usefulness for any purpose.
//
// Thread Safe: No
// Extendable: Yes
//
// @file MENWIZ.h
// This file implements a basic menu management library in the Arduino SDK
//
// @brief
// This is a menu management library. The library allows user to create
// an intire menu tree with relatively few lines of code.
// The library allows the users to define callbacks able to overload internal
// functions (i.e. navigation device management) or to be executed inside a menu.
// It is possible to define also splash screens and a default user screen to be
// activated after a time interval since the last interactio,
//
// @author R. Brunialti - [email protected]
// ---------------------------------------------------------------------------
#ifndef MENWIZ_h
#define MENWIZ_h
#define EEPROM_SUPPORT //comment if you do'nt want to use the readEeprom and writeEeprom methods!
//#define BUTTON_SUPPORT //comment if you do'nt want to use the Button methods!
#include <Wire.h>
#include <avr/pgmspace.h>
#include <LCD.h>
#ifdef BUTTON_SUPPORT
#include <buttons.h>
#endif
#if (ARDUINO >= 100)
#include <Arduino.h>
#else
#include <WProgram.h>
#endif
#ifdef EEPROM_SUPPORT
#include <EEPROM.h>
extern EEPROMClass EEPROM;
#endif
#define getVer() (char*) MW_ver
extern const char MW_ver[];
// SIZES (DIMENSIONAL LIMITS OF STATICALLY ALLOCATED STRUCTURES)
// ---------------------------------------------------------------------------
#define MAX_MENU 25 //maximum number of nodes (absolute supported max number of addMenu calls)
#define MAX_OPTXMENU 20 //maximum number of options/submenus for each node (max number of addItem call for each menu item)
// OTHER SIZES
// ---------------------------------------------------------------------------
#define MW_FLOAT_DEC 2 //decimal digits in float screen representation
// VALUE TYPES
// ---------------------------------------------------------------------------
#define MW_LIST 11 //OPTION LIST
#define MW_BOOLEAN 12 //ON/OFF TOGGLE
#define MW_BOOLEAN_ACTION 99 //ON/OFF TOGGLE WITH ACTION FIRED IMMEDIATELY UPON VARIABLE CONFIRM
#define MW_AUTO_INT 13 //INTEGER VALUE WITH INCREMENT STEP
#define MW_AUTO_FLOAT 14 //FLOATING POINT VALUE WITH INCREMENT STEP
#define MW_AUTO_BYTE 15 //byte VALUE WITH INCREMENT STEP
#define MW_ACTION 16 //FIRE AN ACTION WHEN CONFIRM BUTTON IS PUSHED
#define MW_LABELED_ACTION 97 //FIRE AN ACTION WHEN CONFIRM BUTTON IS PUSHED, WITH A CUSTOM CONFIRM MESSAGE
#define MW_DISPLAY_TEXT 98 //DISPLAY READ-ONLY TEXT FROM char* FUNCTION CALL
#define MW_EDIT_INT 17 //not implemented yet
#define MW_EDIT_FLOAT 18 //not implemented yet
#define MW_EDIT_TEXT 19 //not implemented yet
#define MW_MAX_CHARLIST 90
#define MW_MIN_CHARLIST 32
// NODE TYPES
// ---------------------------------------------------------------------------
#define MW_ROOT 20 //root menu
#define MW_SUBMENU 21 //submenu
#define MW_VAR 22 //terminal node
// CUR MODE
// ---------------------------------------------------------------------------
#define MW_MODE_SPLASH 30
#define MW_MODE_USRSCREEN 31
#define MW_MODE_MENU 32
// BUTTON CODES
// ---------------------------------------------------------------------------
#define MW_BTNULL 0 //NOBUTTON
#define MW_BTU 2 //UP
#define MW_BTD 3 //DOWN
#define MW_BTL 4 //RIGTH
#define MW_BTR 5 //LEFT
#define MW_BTE 6 //ESCAPE
#define MW_BTC 7 //CONFIRM
// DEREFERENCING OPERATORS
// ---------------------------------------------------------------------------
#define VBOOL(a) *(boolean*)a
#define VINT(a) *(int*)a
#define VBYTE(a) *(byte*)a
#define VFLOAT(a) *(float*)a
#define VFUNC(a) (* a)
// FLAGS CLASS MENWIZ
// ---------------------------------------------------------------------------
#define FL_SPLASH 0
#define FL_SPLASH_DRAW 1
#define FL_USRSCREEN_DRAW 2
#define MW_MENU_INDEX 3
// FLAGS CLASS _MENU
// ---------------------------------------------------------------------------
#define MW_SCROLL_HORIZONTAL 0 //Vertical/Horizontal mode
#define MW_ACTION_CONFIRM 1 //Confirm/no confirm action mode
#define MW_LIST_2COLUMNS 2
#define MW_LIST_3COLUMNS 3
#define MW_MENU_COLLAPSED 4
//user grants
#define MW_GRANT_USER1 5
#define MW_GRANT_USER2 6
#define MW_GRANT_USER3 7
// OTHERS
// ---------------------------------------------------------------------------
//#define MW_EOL_CHAR 0x0A
//#define MW_EOL_CHAR 0x0A
#define MW_EOL_CHAR '\n'
#define MW_TYPE uint8_t
#define MW_LCD LCD // this could help to change the library: your lcd data type
#define MW_LABEL const __FlashStringHelper*
#define MW_FLAGS uint8_t
#define MW_4BTN 0MW_MENU_INDEX
#define MW_6BTN 1
typedef struct{
boolean fl;
void (*fv)();
int (*fi)();
}_cback;
#ifdef BUTTON_SUPPORT
typedef struct{
Button BTU;
Button BTD;
Button BTL;
Button BTR;
Button BTE;
Button BTC;
}_nav;
#endif
typedef struct{
MW_TYPE type;
void* val;
void* old;
void* lower;
void* upper;
void* incr;
char* (*func)();
}_var;
typedef struct{
MW_TYPE type;
MW_LABEL label;
void (*action)();
}_act;
class _option{
public:
_option();
MW_TYPE type;
MW_LABEL label;
byte sbm; //submemu id if type=SUBMENU
};
class _menu{
public:
_menu();
void addVar(MW_TYPE, int*);
void addVar(MW_TYPE, int*, int, int, int);
void addVar(MW_TYPE, float*, float, float, float);
void addVar(MW_TYPE, byte*,byte ,byte ,byte);
void addVar(MW_TYPE, boolean*);
void addVar(MW_TYPE, boolean*, void (*f)());
void addVar(MW_TYPE, void (*f)());
void addVar(MW_TYPE, void (*f)(), MW_LABEL);
void addVar(MW_TYPE t,char *s);
void addVar(MW_TYPE t, char* (*f)());
void setBehaviour(MW_FLAGS,boolean);
_option* addItem(int, MW_LABEL);
MW_TYPE type;
MW_FLAGS flags;
MW_LABEL label;
void *var;
void *varact;
byte cod;
byte parent;
byte cur_item;
byte idx_o; //option index
void* o[MAX_OPTXMENU];
private:
protected:
};
class menwiz{
public:
menwiz();
void begin(void *,int, int);
void addSplash(char *,int);
void addUsrScreen(void (*f)(), unsigned long);
void addUsrNav(int (*f)(), int);
void setBehaviour(MW_FLAGS,boolean);
void setCurrentUser(int);
_menu* addMenu(int, _menu *, MW_LABEL);
void draw();
void drawUsrScreen(char *); //draw user screen(s)
int getErrorMessage(boolean); //if arg=true, err message is printed to the default Serial terminal, otherwise the function returns error code only
int getLastbutton(){return last_button;}
int freeRam();
void cleanup();
#ifdef EEPROM_SUPPORT
void writeEeprom();
void readEeprom();
int eeprom_offset;
#endif
#ifdef BUTTON_SUPPORT
_nav* btx;
void navButtons(int,int,int,int,int,int);
void navButtons(int,int,int,int);
int scanNavButtons();
#endif
MW_FLAGS flags;
MW_LCD* lcd;
char* sbuf; //lcd screen buffer (+ 1 for each line)
_cback usrScreen; //callback
_cback usrNav;
byte idx_m;
_menu* cur_menu;
byte cur_user;
_menu* root;
void actBTE();
_menu m[MAX_MENU];
private:
byte row;
byte col;
byte cur_mode;
int last_button; //last pushed button code
unsigned long tm_push; //last pushed button time
unsigned long tm_start; //start time (set when begin method is invocated)
unsigned long tm_splash; //splash screen duration
unsigned long tm_usrScreen; //lap time before usrscreen
void apply2vars(void (*f)(_menu *));
int actNavButtons(int);
void drawMenu(_menu *);
void drawVar(_menu *);
void drawList(_menu *, int);
void actBTU();
void actBTD();
void actBTL();
void actBTR();
void actBTC();
protected:
};
union Etype{
boolean bl;
byte b;
int i;
float f;
byte bytes[4];
};
#endif