-
Notifications
You must be signed in to change notification settings - Fork 0
/
Settings.h
343 lines (246 loc) · 10.4 KB
/
Settings.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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
#include <Arduino.h>
#include <EEPROM.h>
#include <Ethernet.h>
#include <SPI.h>
#include <SD.h>
#ifndef SETTINGS_H_
#define SETTINGS_H_
/* version of the current code */
#define VERSION "1.3.0"
#if defined(CONTROLLINO_MEGA)
#include <Controllino.h>
#define IN_PINS 37
#define OUT_PINS 37
#define SHADES 10
#define LIGHTS 37
#define ONE_WIRE_PIN 20
#elif defined(CONTROLLINO_MAXI)
#include <Controllino.h>
#define IN_PINS 22
#define OUT_PINS 22
#define SHADES 6
#define LIGHTS 22
#define ONE_WIRE_PIN 20
#elif defined(ARDUINO_AVR_MEGA2560)
#define IN_PINS 28
#define OUT_PINS 28
#define SHADES 14
#define LIGHTS 28
#define ONE_WIRE_PIN 2
#endif
/* max variable values */
#define PLATFORM_MAX_U_INT 65535
#define PLATFORM_MAX_U_LONG 4294967295
/* dummy controllino input pin */
#define CONTROLLINO_DUMMY_PIN 255
/* types of physical button press */
#define PHY_NO_PRESS 10
#define PHY_MOMENTARY_PRESS 11
#define PHY_PRESS_MORE_THAN_2SEC 12
#define PHY_CENTRAL_CTRL_MOMENTARY_PRESS 13
#define PHY_CENTRAL_CTRL_PRESS_MORE_THAN_2SEC 14
#define PHY_COUNTER_TIME_TRIGGER 15
/* indexes for EEPROM information holding (max size available 4096) */
#define EEPROM_IDX_ARDID 0 // length 1
#define EEPROM_IDX_RASPYID 1 // length 1
#define EEPROM_IDX_REG 2 // length 1
#define EEPROM_IDX_RASPYIP 3 // length 6
#define EEPROM_IDX_MODE 9 // length 1
#define EEPROM_IDX_CENT_CTRL 10 // length 1
#define EEPROM_IDX_UID 11 // length 4
#define EEPROM_IDX_MAC 50 // length 6
#define EEPROM_IDX_USE_DEF_MAC 17 // length 1
#define EEPROM_IDX_LIGHTS 512 // length 240 -> 30 (lights) x 7 (1 status + 1 type + 4 timer + 1 input + 1 ctrlON) + 30 (buffer for future use)
#define EEPROM_IDX_SHADES 2048 // length 150 -> 15 (shades) x 9 (4 status + 1 flags + 1 type + 1 pos timer + 2 tilt timer) + 30 (buffer for future use)
/* length (in bytes) of the lights and shades fields */
#define EEPROM_IDX_LIGHTS_LENGTH 8
#define EEPROM_IDX_SHADES_LENGTH 9
/* flags */
#define EEPROM_FLG_SHADE_SYNC 1
#define EEPROM_FLG_SHADE_INMOTION 2
#define EEPROM_FLG_DEF_MAC 1 /* default MAC address is used */
#define EEPROM_FLG_MEM_MAC 2 /* MAC address from memory is used */
/* UID */
#define EEPROM_UID 1283279103
/* functional modes of the entire device */
#define MODE_LIGHTS 0
#define MODE_SHADES 1
#define MODE_FAIL 100 /* returned by EEPROMGetMode() if couldn't load mode from EEPROM */
/* input modes */
#define EEPROM_INPUT_HOLD 0
#define EEPROM_INPUT_RELEASE 1
/* SD Card variables */
#define SD_ARD_MEGA_CS 4
#define SD_INIT_NOHW 0
#define SD_INIT_SUCCESS 1
#define SD_INIT_NOFILE 2
/* macros for setting the bits on/off */
#define GET_BIT(x,bit) ( ((x)>>(bit)) & 1 ) /* get bit-th bit of x */
#define SET_BIT(x,bit) ( (x) |= (1<<(bit)) ) /* set bit-th bit of x */
#define CLEAR_BIT(x,bit) ( (x) &= ~(1<<(bit)) ) /* clear bit-th bit of x */
/* bit definitions */
#define EEPROM_SHADE_BIT_
/* defines how many seconds does it take to move the entire shade from closed to open or vice-versa */
#define EEPROM_SHADE_DEFAULT_POSITION_TIMER 64
/* default tilt range movement length in miliseconds */
#define EEPROM_SHADE_DEFAULT_TILT_TIMER 1000
/* default timer for timer type lights (in seconds) */
#define EEPROM_DIGITOUT_DEFAULT_TIMER 30000
class Settings {
private:
/* The input pin array */
static byte digitIN[IN_PINS];
/* The output pin array */
static byte digitOUT[OUT_PINS];
static byte oneWirePin;
/* read a long value from EEPROM's given address */
static unsigned long EEPROMReadlong(unsigned long address);
/* write a long vlaue into EEPROM at a given address */
static void EEPROMWritelong(int address, unsigned long value);
/* read an int value from EEPROM's given address */
static int Settings::EEPROMReadInt(int address);
/* write an int vlaue into EEPROM at a given address */
static void Settings::EEPROMWriteInt(int address, int value);
public:
/* The input pin devID array */
static byte digitINdevID[IN_PINS];
/* the output pin devID array */
static byte digitOUTdevID[OUT_PINS];
/* the shadeID array */
static byte shadeIDs[SHADES];
/* the LightID array */
static byte lightIDs[LIGHTS];
/* variable sets how much time the shade motor should be running (in seconds) */
static const byte runTimer = 10;
/* variable controlling if the relays are set to NC or NO
* NC - Normally Closed - the digitOUT is by default in LOW state, LightON -> HIGH state (true)
* NO - Normally Open - the digitOUT is by default in HIGH state, LightON -> LOW state (false)
*/
static const bool relaysNC = true;
static bool getLow();
static bool getHigh();
/* Get the Shade PINs based on the shade ID */
static byte getShadeOutPinUp(byte shadeID);
static byte getShadeInPinUp(byte shadeID);
static byte getShadeOutPinDown(byte shadeID);
static byte getShadeInPinDown(byte shadeID);
/* Get the Light PINs based on the shade ID */
static byte Settings::getLightOutPin(byte lightID);
static byte Settings::getLightInPin(byte lightID);
/* set input pin mode (platform independent) */
static void Settings::setInPinMode(uint8_t pin);
/* get input pin value (platform independent) */
static int Settings::getInputPinValue(uint8_t pin);
/* set output pin value (platform independent) */
static void Settings::setOutputPinValue(uint8_t pin, uint8_t value);
/* initialize the platform */
static void Settings::initPlatform();
/*
* EEPROM Storage related functions
*/
/* Get from the EEPROM the ARiF registration status*/
static bool Settings::EEPROMIsRegistered();
/* Get from the EEPROM the ardID value*/
static byte EEPROMGetArdID();
/* Get from the EEPROM the raspy value*/
static byte Settings::EEPROMGetRaspyID();
/* Get from the EEPROM the IP address of the raspy where this arduino is registered */
static IPAddress Settings::EEPROMGetRaspyIP();
/* Write 'deregister' value into the EEPROM */
static void Settings::EEPROMDeregister();
/* Write Raspy IP address into the EEPROM */
static void Settings::EEPROMSetRaspyIP(IPAddress addr);
/* Write all registration data into the EEPROM */
static void Settings::EEPROMRegister(byte ardID, byte raspyID, IPAddress addr);
/* Write System mode into the EEPROM */
static void Settings::EEPROMSetMode(byte mode);
/* Get from the EEPROM System mode */
static byte Settings::EEPROMGetMode();
/* set individual light subject to global ctrlON command */
static void Settings::EEPROMSetLightCtrlON(byte devID, byte value);
/* get individual light setting whether it is subject to global ctrlON command */
static byte Settings::EEPROMGetLightCtrlON(byte devID);
/* Write individual Light settings in the EEPROM */
static void EEPROMSetLightConfig(byte devID, byte type, unsigned long timer);
/* Get from the EEPROM Light type */
static byte EEPROMGetLightType(byte devID);
/* Write light type into the EEPROM */
static void EEPROMSetLightType(byte devID, byte type);
/* Get from the EEPROM Light timer */
static unsigned long EEPROMGetLightTimer(byte devID);
/* Write light timer into the EEPROM */
static void EEPROMSetLightTimer(byte devID, unsigned long timer);
/* Write light status into the EEPROM */
static void EEPROMSetLightStatus(byte devID, byte status);
/* Write light input type into the EEPROM */
static byte EEPROMGetLightInputType(byte devID);
/* Read light input type from the EEPROM */
static void EEPROMSetLightInputType(byte devID, byte inputType);
/* get last devID from the array of lightIDs */
static byte getLastLightDevID();
/* Write Central Control mode to the EEPROM */
static void EEPROMSetLightCentral(byte mode);
/* Read Central Control mode from the EEPROM */
static byte EEPROMGetLightCentral();
/* Set shade unsync flag indicator */
static void EEPROMSetShadeSyncFlag(byte devID);
/* Clear shade unsync flag indicator */
static bool EEPROMGetShadeSyncFlag(byte devID);
/* Get shade unsync flag indicator */
static void EEPROMClearShadeSyncFlag(byte devID);
/* Get shade reported position */
static void EEPROMSetShadeReachedPosition(byte devID, byte reachedPosition);
/* Set shade reported position (0, 25, 50, 75, 100) */
static byte EEPROMGetShadeReachedPosition(byte devID);
/* Set shade position */
static void EEPROMSetShadePosition(byte devID, int position);
/* Get shade position */
static int EEPROMGetShadePosition(byte devID);
/* Set shade tilt */
static void EEPROMSetShadeTilt(byte devID, byte tilt);
/* Get shade tilt */
static byte EEPROMGetShadeTilt(byte devID);
/* Write Shade type into memory */
static void EEPROMSetShadeType(byte devID, byte type);
/* Write Shade tilt timer into memory */
static void EEPROMSetShadeTiltTimer(byte devID, int timer);
/* Write Shade position timer into memory */
static void EEPROMSetShadePosTimer(byte devID, byte timer);
/* Read Shade type from memory */
static byte EEPROMGetShadeType(byte devID);
/* Read Shade tilt timer from memory */
static int EEPROMGetShadeTiltTimer(byte devID);
/* Read Shade position timer from memory */
static byte EEPROMGetShadePosTimer(byte devID);
/* save MAC address to memory */
static void EEPROMSetMAC(byte *mac);
/* Get MAC address from memory*/
static void EEPROMGetMAC(byte *mac);
/* set status if default MAC should be used or from memory */
static void EEPROMSetUseDefMAC(byte status);
/* get status if default MAC should be used or from memory */
static byte EEPROMGetUseDefMAC();
/* Put UID into EEPROM */
static void EEPROMSetUID();
/* check if UID is in the EEPROM */
static bool EEPROMIsUIDSet();
/* clear the UID from the EEPROM */
static bool EEPROMClearUID();
/* clear EEPROM to factory defaults */
static void EEPROMRaze();
/*
* SD Card related functions
*/
/* initialize the SD Card */
static byte SDCardInit();
/* Open selected file */
static File SDCardFileOpen(char *filename);
/* Close the file */
static void SDCardFileClose(File file);
/*
* 1-wire related functions:
*/
static byte getOneWirePin();
};
extern Settings Platform;
#endif