NodeManager.h 24 KB
Newer Older
DV's avatar
DV committed
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
/*
 * NodeManager
 */
 
#ifndef NodeManager_h
#define NodeManager_h

#include <Arduino.h>


/***********************************
   Constants
*/

// define sleep mode
#define IDLE 0
#define SLEEP 1
#define WAIT 2

// define time unit
#define SECONDS 0
#define MINUTES 1
#define HOURS 2
#define DAYS 3

// define value type
#define TYPE_INTEGER 0
#define TYPE_FLOAT 1
#define TYPE_STRING 2

// define interrupt pins
#define INTERRUPT_PIN_1 3
#define INTERRUPT_PIN_2 2

// define eeprom addresses
#define EEPROM_LAST_ID 4
#define EEPROM_SLEEP_SAVED 0
#define EEPROM_SLEEP_MODE 1
#define EEPROM_SLEEP_TIME_MAJOR 2
#define EEPROM_SLEEP_TIME_MINOR 3
#define EEPROM_SLEEP_UNIT 4

// define NodeManager version
user2684's avatar
user2684 committed
44
#define VERSION 1.4
DV's avatar
DV committed
45
46
47
48
49
50

/************************************
 * Include user defined configuration settings
 */
 
#include "config.h"
DV's avatar
DV committed
51
52

/***********************************
DV's avatar
DV committed
53
   Default configuration settings
DV's avatar
DV committed
54
55
56
*/

// if enabled, will load the sleep manager library. Sleep mode and sleep interval have to be configured to make the board sleeping/waiting
DV's avatar
DV committed
57
58
59
#ifndef SLEEP_MANAGER
  #define SLEEP_MANAGER 1
#endif
DV's avatar
DV committed
60
// if enabled, enable the capability to power on sensors with the arduino's pins to save battery while sleeping
DV's avatar
DV committed
61
62
63
#ifndef POWER_MANAGER
  #define POWER_MANAGER 1
#endif
DV's avatar
DV committed
64
// if enabled, will load the battery manager library to allow the battery level to be reported automatically or on demand
DV's avatar
DV committed
65
66
67
#ifndef BATTERY_MANAGER
  #define BATTERY_MANAGER 1
#endif
DV's avatar
DV committed
68
// if enabled, allow modifying the configuration remotely by interacting with the configuration child id
DV's avatar
DV committed
69
70
71
#ifndef REMOTE_CONFIGURATION
  #define REMOTE_CONFIGURATION 1
#endif
DV's avatar
DV committed
72
// if enabled, persist the configuration settings on EEPROM
DV's avatar
DV committed
73
74
75
#ifndef PERSIST
  #define PERSIST 0
#endif
DV's avatar
DV committed
76
77

// if enabled, enable debug messages on serial port
DV's avatar
DV committed
78
79
80
#ifndef DEBUG
  #define DEBUG 1
#endif
DV's avatar
DV committed
81
82

// if enabled, send a SLEEPING and AWAKE service messages just before entering and just after leaving a sleep cycle
DV's avatar
DV committed
83
84
85
#ifndef SERVICE_MESSAGES
  #define SERVICE_MESSAGES 1
#endif
DV's avatar
DV committed
86
// if enabled, a battery sensor will be created at BATTERY_CHILD_ID and will report vcc voltage together with the battery level percentage
DV's avatar
DV committed
87
88
89
#ifndef BATTERY_SENSOR
  #define BATTERY_SENSOR 1
#endif
DV's avatar
DV committed
90
91

// the child id used to allow remote configuration
DV's avatar
DV committed
92
93
94
#ifndef CONFIGURATION_CHILD_ID
  #define CONFIGURATION_CHILD_ID 200
#endif
DV's avatar
DV committed
95
// the child id used to report the battery voltage to the controller
DV's avatar
DV committed
96
97
98
#ifndef BATTERY_CHILD_ID
  #define BATTERY_CHILD_ID 201
#endif
DV's avatar
DV committed
99

user2684's avatar
user2684 committed
100
// Enable this module to use one of the following sensors: SENSOR_ANALOG_INPUT, SENSOR_LDR, SENSOR_THERMISTOR, SENSOR_MQ
DV's avatar
DV committed
101
102
103
#ifndef MODULE_ANALOG_INPUT
  #define MODULE_ANALOG_INPUT 0
#endif
DV's avatar
DV committed
104
// Enable this module to use one of the following sensors: SENSOR_DIGITAL_INPUT
DV's avatar
DV committed
105
106
107
#ifndef MODULE_DIGITAL_INPUT
  #define MODULE_DIGITAL_INPUT 0
#endif
DV's avatar
DV committed
108
// Enable this module to use one of the following sensors: SENSOR_DIGITAL_OUTPUT, SENSOR_RELAY, SENSOR_LATCHING_RELAY
DV's avatar
DV committed
109
110
111
#ifndef MODULE_DIGITAL_OUTPUT
  #define MODULE_DIGITAL_OUTPUT 0
#endif
DV's avatar
DV committed
112
// Enable this module to use one of the following sensors: SENSOR_SHT21, SENSOR_HTU21D
DV's avatar
DV committed
113
114
115
#ifndef MODULE_SHT21
  #define MODULE_SHT21 0
#endif
DV's avatar
DV committed
116
// Enable this module to use one of the following sensors: SENSOR_DHT11, SENSOR_DHT22
DV's avatar
DV committed
117
118
119
#ifndef MODULE_DHT
  #define MODULE_DHT 0
#endif
DV's avatar
DV committed
120
// Enable this module to use one of the following sensors: SENSOR_SWITCH, SENSOR_DOOR, SENSOR_MOTION
DV's avatar
DV committed
121
122
123
#ifndef MODULE_SWITCH
  #define MODULE_SWITCH 0
#endif
DV's avatar
DV committed
124
// Enable this module to use one of the following sensors: SENSOR_DS18B20
DV's avatar
DV committed
125
126
127
#ifndef MODULE_DS18B20
  #define MODULE_DS18B20 0
#endif
DV's avatar
DV committed
128
129
130
131
132
133
134
135
// Enable this module to use one of the following sensors: SENSOR_BH1750
#ifndef MODULE_BH1750
  #define MODULE_BH1750 0
#endif
// Enable this module to use one of the following sensors: SENSOR_MLX90614
#ifndef MODULE_MLX90614
  #define MODULE_MLX90614 0
#endif
136
137
138
139
// Enable this module to use one of the following sensors: SENSOR_BME280
#ifndef MODULE_BME280
  #define MODULE_BME280 0
#endif
DV's avatar
DV committed
140
141
142
143
144
145
146
147
148
149
/***********************************
   Sensors types
*/
#if MODULE_ANALOG_INPUT == 1
  // Generic analog sensor, return a pin's analog value or its percentage
  #define SENSOR_ANALOG_INPUT 1
  // LDR sensor, return the light level of an attached light resistor in percentage
  #define SENSOR_LDR 2
  // Thermistor sensor, return the temperature based on the attached thermistor
  #define SENSOR_THERMISTOR 3
user2684's avatar
user2684 committed
150
151
  // MQ2 air quality sensor
  #define SENSOR_MQ 19
DV's avatar
DV committed
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
#endif
#if MODULE_DIGITAL_INPUT == 1
  // Generic digital sensor, return a pin's digital value
  #define SENSOR_DIGITAL_INPUT 4
#endif
#if MODULE_DIGITAL_OUTPUT == 1
  // Generic digital output sensor, allows setting the digital output of a pin to the requested value
  #define SENSOR_DIGITAL_OUTPUT 5
  // Relay sensor, allows activating the relay
  #define SENSOR_RELAY 6
  // Latching Relay sensor, allows activating the relay with a pulse
  #define SENSOR_LATCHING_RELAY 7
#endif
#if MODULE_DHT == 1
  // DHT11/DHT22 sensors, return temperature/humidity based on the attached DHT sensor
  #define SENSOR_DHT11 8
  #define SENSOR_DHT22 9
#endif
#if MODULE_SHT21 == 1
  // SHT21 sensor, return temperature/humidity based on the attached SHT21 sensor
  #define SENSOR_SHT21 10
DV's avatar
DV committed
173
  #define SENSOR_HTU21D 15
DV's avatar
DV committed
174
175
176
177
178
179
180
181
182
183
184
185
186
#endif
#if MODULE_SWITCH == 1
  // Generic switch, wake up the board when a pin changes status
  #define SENSOR_SWITCH 11
  // Door sensor, wake up the board and report when an attached magnetic sensor has been opened/closed
  #define SENSOR_DOOR 12
  // Motion sensor, wake up the board and report when an attached PIR has triggered
  #define SENSOR_MOTION 13
#endif
#if MODULE_DS18B20 == 1
  // DS18B20 sensor, return the temperature based on the attached sensor
  #define SENSOR_DS18B20 14
#endif
DV's avatar
DV committed
187
188
189
190
191
192
193
194
#if MODULE_BH1750 == 1
  // BH1750 sensor, return light in lux
  #define SENSOR_BH1750 16
#endif
#if MODULE_MLX90614 == 1
  // MLX90614 sensor, contactless temperature sensor
  #define SENSOR_MLX90614 17
#endif
195
196
197
198
#if MODULE_BME280 == 1
  // MLX90614 sensor, contactless temperature sensor
  #define SENSOR_BME280 18
#endif
user2684's avatar
user2684 committed
199
// last Id: 19
DV's avatar
DV committed
200
201
202
203
204
205
206
/***********************************
  Libraries
*/

// include MySensors libraries
#include <core/MySensorsCore.h>
#include <core/MyHwAVR.h>
207
//#include <core/MyHwATMega328.h>
DV's avatar
DV committed
208
209
210
211
212
213
214
215
216
217
218
219
220

// include third party libraries
#if MODULE_DHT == 1
  #include <DHT.h>
#endif
#if MODULE_SHT21 == 1
  #include <Wire.h>
  #include <Sodaq_SHT2x.h>
#endif
#if MODULE_DS18B20 == 1
  #include <OneWire.h>
  #include <DallasTemperature.h>
#endif
DV's avatar
DV committed
221
222
223
224
225
226
227
228
#if MODULE_BH1750 == 1
  #include <BH1750.h>
  #include <Wire.h>
#endif
#if MODULE_MLX90614 == 1
  #include <Wire.h>
  #include <Adafruit_MLX90614.h>
#endif
229
230
231
232
233
234
#if MODULE_BME280 == 1
  #include <Wire.h>
  #include <SPI.h>
  #include <Adafruit_Sensor.h>
  #include <Adafruit_BME280.h>
#endif
DV's avatar
DV committed
235
236
237
238
239
240
241
242
243
244
245
246
247

/**************************************
   Classes
*/

/*
   PowerManager
*/

class PowerManager {
  public:
    PowerManager() {};
    // to save battery the sensor can be optionally connected to two pins which will act as vcc and ground and activated on demand
248
    void setPowerPins(int ground_pin, int vcc_pin, long wait = 50);
DV's avatar
DV committed
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
    void powerOn();
    void powerOff();
  private:
    int _vcc_pin = -1;
    int _ground_pin = -1;
    long _wait = 0;
    bool _hasPowerManager();
};


/***************************************
   Sensor: generic sensor class
*/
class Sensor {
  public:
    Sensor(int child_id, int pin);
    // where the sensor is attached to (default: not set)
    void setPin(int value);
    int getPin();
    // child_id of this sensor (default: not set)
    void setChildId(int value);
    int getChildId();
    // presentation of this sensor (default: S_CUSTOM)
    void setPresentation(int value);
    int getPresentation();
    // type of this sensor (default: V_CUSTOM)
    void setType(int value);
    int getType();
    // when queried, send the message multiple times (default: 1)
    void setRetries(int value);
    // For some sensors, the measurement can be queried multiple times and an average is returned (default: 1)
    void setSamples(int value);
    // If more then one sample has to be taken, set the interval in milliseconds between measurements (default: 0)
    void setSamplesInterval(int value);
    // if true will report the measure only if different then the previous one (default: false)
    void setTackLastValue(bool value);
    // if track last value is enabled, force to send an update after the configured number of cycles (default: -1)
    void setForceUpdate(int value);
    // the value type of this sensor (default: TYPE_INTEGER)
    void setValueType(int value);
    // for float values, set the float precision (default: 2)
    void setFloatPrecision(int value);
DV's avatar
DV committed
291
292
    // optionally sleep interval in milliseconds before sending each message to the radio network (default: 0)
    void setSleepBetweenSend(int value);
DV's avatar
DV committed
293
294
    #if POWER_MANAGER == 1
      // to save battery the sensor can be optionally connected to two pins which will act as vcc and ground and activated on demand
295
      void setPowerPins(int ground_pin, int vcc_pin, long wait = 50);
DV's avatar
DV committed
296
297
298
      // if enabled the pins will be automatically powered on while awake and off during sleeping (default: true)
      void setAutoPowerPins(bool value);
      // manually turn the power on
DV's avatar
DV committed
299
      void powerOn();
DV's avatar
DV committed
300
      // manually turn the power off
DV's avatar
DV committed
301
302
303
304
305
      void powerOff();
    #endif
    // define what to do at each stage of the sketch
    virtual void before();
    virtual void presentation();
user2684's avatar
user2684 committed
306
    virtual void setup();
DV's avatar
DV committed
307
308
309
310
    virtual void loop(const MyMessage & message);
    virtual void receive(const MyMessage & message);
    // abstract functions, subclasses need to implement
    virtual void onBefore() = 0;
user2684's avatar
user2684 committed
311
    virtual void onSetup() = 0;
DV's avatar
DV committed
312
313
314
315
    virtual void onLoop() = 0;
    virtual void onReceive(const MyMessage & message) = 0;
  protected:
    MyMessage _msg;
DV's avatar
DV committed
316
    int _sleep_between_send = 0;
DV's avatar
DV committed
317
318
319
320
321
322
323
324
325
326
327
328
329
    int _pin = -1;
    int _child_id;
    int _presentation = S_CUSTOM;
    int _type = V_CUSTOM;
    int _retries = 1;
    int _samples = 1;
    int _samples_interval = 0;
    bool _track_last_value = false;
    int _cycles = 0;
    int _force_update = -1;
    void _send(MyMessage & msg);
    #if POWER_MANAGER  == 1
      PowerManager _powerManager;
DV's avatar
DV committed
330
      bool _auto_power_pins = true;
DV's avatar
DV committed
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
    #endif
    int _value_type = TYPE_INTEGER;
    int _float_precision = 2;
    int _value_int = -1;
    float _value_float = -1;
    char * _value_string = "";
    int _last_value_int = -1;
    float _last_value_float = -1;
    char * _last_value_string = "";
};

/*
   SensorAnalogInput: read the analog input of a configured pin
*/
class SensorAnalogInput: public Sensor {
  public:
    SensorAnalogInput(int child_id, int pin);
    // the analog reference to use (default: not set, can be either INTERNAL or DEFAULT)
    void setReference(int value);
    // reverse the value or the percentage (e.g. 70% -> 30%) (default: false)
    void setReverse(bool value);
    // when true returns the value as a percentage (default: true)
    void setOutputPercentage(bool value);
    // minimum value for calculating the percentage (default: 0)
    void setRangeMin(int value);
    // maximum value for calculating the percentage (default: 1024)
    void setRangeMax(int value);
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
360
    void onSetup();
DV's avatar
DV committed
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
    void onLoop();
    void onReceive(const MyMessage & message);
  protected:
    int _reference = -1;
    bool _reverse = false;
    bool _output_percentage = true;
    int _range_min = 0;
    int _range_max = 1024;
    int _getPercentage(int value);
    int _getAnalogRead();
};

/*
   SensorLDR: return the percentage of light from a Light dependent resistor
*/
class SensorLDR: public SensorAnalogInput {
  public:
    SensorLDR(int child_id, int pin);
};

/*
   SensorThermistor: read the temperature from a thermistor
*/
class SensorThermistor: public Sensor {
  public:
    SensorThermistor(int child_id, int pin);
    // resistance at 25 degrees C (default: 10000)
    void setNominalResistor(int value);
    // temperature for nominal resistance (default: 25)
    void setNominalTemperature(int value);
    // The beta coefficient of the thermistor (default: 3950)
    void setBCoefficient(int value);
    // the value of the resistor in series with the thermistor (default: 10000)
    void setSeriesResistor(int value);
    // set a temperature offset
    void setOffset(float value);
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
399
    void onSetup();
DV's avatar
DV committed
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
    void onLoop();
    void onReceive(const MyMessage & message);
  protected:
    int _nominal_resistor = 10000;
    int _nominal_temperature = 25;
    int _b_coefficient = 3950;
    int _series_resistor = 10000;
    float _offset = 0;
};

/*
   SensorDigitalInput: read the digital input of the configured pin
*/
class SensorDigitalInput: public Sensor {
  public:
    SensorDigitalInput(int child_id, int pin);
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
418
    void onSetup();
DV's avatar
DV committed
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
    void onLoop();
    void onReceive(const MyMessage & message);
};

/*
   SensorDigitalOutput: control a digital output of the configured pin
*/
class SensorDigitalOutput: public Sensor {
  public:
    SensorDigitalOutput(int child_id, int pin);
    // set how to initialize the output (default: LOW)
    void setInitialValue(int value);
    // if greater than 0, send a pulse of the given duration in ms and then restore the output back to the original value (default: 0)
    void setPulseWidth(int value);
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
435
    void onSetup();
DV's avatar
DV committed
436
437
438
439
440
441
442
443
444
445
446
447
448
449
    void onLoop();
    void onReceive(const MyMessage & message);
  protected:
    int _initial_value = LOW;
    int _pulse_width = 0;
};


/*
   SensorRelay
*/
class SensorRelay: public SensorDigitalOutput {
  public:
    SensorRelay(int child_id, int pin);
DV's avatar
DV committed
450
451
    // define what to do at each stage of the sketch
    void onLoop();
DV's avatar
DV committed
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
};

/*
   SensorLatchingRelay
*/
class SensorLatchingRelay: public SensorRelay {
  public:
    SensorLatchingRelay(int child_id, int pin);
};

/*
   SensorDHT
*/
#if MODULE_DHT == 1
class SensorDHT: public Sensor {
  public:
    SensorDHT(int child_id, int pin, DHT* dht, int sensor_type, int dht_type);
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
471
    void onSetup();
DV's avatar
DV committed
472
473
474
475
476
477
478
479
480
481
482
    void onLoop();
    void onReceive(const MyMessage & message);
  protected:
    DHT* _dht;
    int _dht_type = DHT11;
    float _offset = 0;
    int _sensor_type = 0;
};
#endif

/*
DV's avatar
DV committed
483
   SensorSHT21: temperature and humidity sensor
DV's avatar
DV committed
484
485
486
487
488
489
490
*/
#if MODULE_SHT21 == 1
class SensorSHT21: public Sensor {
  public:
    SensorSHT21(int child_id, int sensor_type);
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
491
    void onSetup();
DV's avatar
DV committed
492
493
494
495
496
497
    void onLoop();
    void onReceive(const MyMessage & message);
  protected:
    float _offset = 0;
    int _sensor_type = 0;
};
DV's avatar
DV committed
498
499
500
501
502
503
504
505
506

/*
   SensorHTU21D: temperature and humidity sensor
*/

class SensorHTU21D: public SensorSHT21 {
  public:
    SensorHTU21D(int child_id, int pin);
};
DV's avatar
DV committed
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
#endif

/*
 * SensorSwitch
 */
class SensorSwitch: public Sensor {
  public:
    SensorSwitch(int child_id, int pin);
    // set the interrupt mode. Can be CHANGE, RISING, FALLING (default: CHANGE)
    void setMode(int value);
    int getMode();
    // milliseconds to wait before reading the input (default: 0)
    void setDebounce(int value);
    // time to wait in milliseconds after a change is detected to allow the signal to be restored to its normal value (default: 0)
    void setTriggerTime(int value);
522
523
524
    // Set initial value on the interrupt pin (default: HIGH)
    void setInitial(int value);
    int getInitial();
DV's avatar
DV committed
525
526
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
527
    void onSetup();
DV's avatar
DV committed
528
529
530
531
532
533
    void onLoop();
    void onReceive(const MyMessage & message);
  protected:
    int _debounce = 0;
    int _trigger_time = 0;
    int _mode = CHANGE;
534
    int _initial = HIGH;
DV's avatar
DV committed
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
};

/*
 * SensorDoor
 */
class SensorDoor: public SensorSwitch {
  public:
    SensorDoor(int child_id, int pin);
};

/*
 * SensorMotion
 */
class SensorMotion: public SensorSwitch {
  public:
    SensorMotion(int child_id, int pin);
};

/*
   SensorDs18b20
*/
#if MODULE_DS18B20 == 1
class SensorDs18b20: public Sensor {
  public:
    SensorDs18b20(int child_id, int pin, DallasTemperature* sensors, int index);
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
562
    void onSetup();
DV's avatar
DV committed
563
564
565
566
567
568
569
570
571
    void onLoop();
    void onReceive(const MyMessage & message);
  protected:
    float _offset = 0;
    int _index;
    DallasTemperature* _sensors;
};
#endif

DV's avatar
DV committed
572
573
574
575
576
577
578
579
580
/*
   SensorBH1750
*/
#if MODULE_BH1750 == 1
class SensorBH1750: public Sensor {
  public:
    SensorBH1750(int child_id);
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
581
    void onSetup();
DV's avatar
DV committed
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
    void onLoop();
    void onReceive(const MyMessage & message);
  protected:
    BH1750* _lightSensor;
};
#endif

/*
   SensorMLX90614
*/
#if MODULE_MLX90614 == 1
class SensorMLX90614: public Sensor {
  public:
    SensorMLX90614(int child_id, Adafruit_MLX90614* mlx, int sensor_type);
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
598
    void onSetup();
DV's avatar
DV committed
599
600
601
602
603
604
605
    void onLoop();
    void onReceive(const MyMessage & message);
  protected:
    Adafruit_MLX90614* _mlx;
    int _sensor_type;
};
#endif
DV's avatar
DV committed
606

607
608
609
610
611
612
613
614
615
/*
   SensorBME280
*/
#if MODULE_BME280 == 1
class SensorBME280: public Sensor {
  public:
    SensorBME280(int child_id, Adafruit_BME280* bme, int sensor_type);
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
616
    void onSetup();
617
618
619
620
621
622
623
624
    void onLoop();
    void onReceive(const MyMessage & message);
  protected:
    Adafruit_BME280* _bme;
    int _sensor_type;
};
#endif

user2684's avatar
user2684 committed
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
/*
    SensorMQ
 */
class SensorMQ: public Sensor {
  public:
    SensorMQ(int child_id, int pin);
    // define the target gas whose ppm has to be returned. 0: LPG, 1: CO, 2: Smoke (default: 1);
    void setTargetGas(int value);
    // define the load resistance on the board, in kilo ohms (default: 1);
    void setRlValue(float value);
    // define the Ro resistance on the board (default: 10000);
    void setRoValue(float value);
    // Sensor resistance in clean air (default: 9.83);
    void setCleanAirFactor(float value);
    // define how many samples you are going to take in the calibration phase (default: 50);
    void setCalibrationSampleTimes(int value);
    // define the time interal(in milisecond) between each samples in the cablibration phase (default: 500);
    void setCalibrationSampleInterval(int value);
    // define how many samples you are going to take in normal operation (default: 50);
    void setReadSampleTimes(int value);
    // define the time interal(in milisecond) between each samples in the normal operations (default: 5);
    void setReadSampleInterval(int value);
    // set the LPGCurve array (default: {2.3,0.21,-0.47})
    void setLPGCurve(float *value);
    // set the COCurve array (default: {2.3,0.72,-0.34})
    void setCOCurve(float *value);
    // set the SmokeCurve array (default: {2.3,0.53,-0.44})
    void setSmokeCurve(float *value);
    // define what to do at each stage of the sketch
    void onBefore();
    void onSetup();
    void onLoop();
    void onReceive(const MyMessage & message);
  protected:
    float _rl_value = 1.0;
    float _ro_clean_air_factor = 9.83;
    int _calibration_sample_times = 50;
    int _calibration_sample_interval = 500;
    int _read_sample_interval = 50;
    int _read_sample_times = 5;
    float _ro = 10000.0;
    float _LPGCurve[3] = {2.3,0.21,-0.47};
    float _COCurve[3] = {2.3,0.72,-0.34};
    float _SmokeCurve[3] = {2.3,0.53,-0.44};
    float _MQResistanceCalculation(int raw_adc);
    float _MQCalibration();
    float _MQRead();
    int _MQGetGasPercentage(float rs_ro_ratio, int gas_id);
    int  _MQGetPercentage(float rs_ro_ratio, float *pcurve);
    int _gas_lpg = 0;
    int _gas_co = 1;
    int _gas_smoke = 2;
    int _target_gas = _gas_co;
};

DV's avatar
DV committed
680
681
682
683
684
685
686
687
/***************************************
   NodeManager: manages all the aspects of the node
*/
class NodeManager {
  public:
    NodeManager();
    // the pin to connect to the RST pin to reboot the board (default: 4)
    void setRebootPin(int value);
DV's avatar
DV committed
688
689
    // send the same service message multiple times (default: 1)
    void setRetries(int value);
DV's avatar
DV committed
690
691
692
693
694
    #if BATTERY_MANAGER == 1
      // the expected vcc when the batter is fully discharged, used to calculate the percentage (default: 2.7)
      void setBatteryMin(float value);
      // the expected vcc when the batter is fully charged, used to calculate the percentage (default: 3.3)
      void setBatteryMax(float value);
695
      // after how many sleeping cycles report the battery level to the controller. When reset the battery is always reported (default: 10)
DV's avatar
DV committed
696
      void setBatteryReportCycles(int value);
697
698
699
700
701
702
      // if true, the battery level will be evaluated by measuring the internal vcc without the need to connect any pin, if false the voltage divider methon will be used (default: true)
      void setBatteryInternalVcc(bool value);
      // if setBatteryInternalVcc() is set to false, the analog pin to which the battery's vcc is attached (https://www.mysensors.org/build/battery) (default: -1)
      void setBatteryPin(int value);
      // if setBatteryInternalVcc() is set to false, the volts per bit ratio used to calculate the battery voltage (default: 0.003363075)
      void setBatteryVoltsPerBit(float value);
DV's avatar
DV committed
703
704
    #endif
    #if SLEEP_MANAGER == 1
705
      // define if the board has to sleep every time entering loop (default: IDLE). It can be IDLE (no sleep), SLEEP (sleep at every cycle), WAIT (wait at every cycle)
DV's avatar
DV committed
706
707
708
709
710
711
712
713
714
715
716
      void setSleepMode(int value);
      // define for how long the board will sleep (default: 0)
      void setSleepTime(int value);
      // define the unit of SLEEP_TIME. It can be SECONDS, MINUTES, HOURS or DAYS (default: MINUTES)
      void setSleep(int value1, int value2, int value3);
      void setSleepUnit(int value);
      // if enabled, when waking up from the interrupt, the board stops sleeping. Disable it when attaching e.g. a motion sensor (default: true)
      void setSleepInterruptPin(int value);
    #endif
    // configure the interrupt pin and mode. Mode can be CHANGE, RISING, FALLING (default: MODE_NOT_DEFINED)
    void setInterrupt(int pin, int mode, int pull = -1);
DV's avatar
DV committed
717
718
    // optionally sleep interval in milliseconds before sending each message to the radio network (default: 0)
    void setSleepBetweenSend(int value);
DV's avatar
DV committed
719
720
721
722
723
724
725
726
    // register a built-in sensor
    int registerSensor(int sensor_type, int pin = -1, int child_id = -1);
    // register a custom sensor
    int registerSensor(Sensor* sensor);
    // return a sensor by its index
    Sensor* get(int sensor_index);
    #if POWER_MANAGER == 1
      // to save battery the sensor can be optionally connected to two pins which will act as vcc and ground and activated on demand
727
      void setPowerPins(int ground_pin, int vcc_pin, long wait = 50);
DV's avatar
DV committed
728
729
730
      // if enabled the pins will be automatically powered on while awake and off during sleeping (default: true)
      void setAutoPowerPins(bool value);
      // manually turn the power on
DV's avatar
DV committed
731
      void powerOn();
DV's avatar
DV committed
732
      // manually turn the power off
DV's avatar
DV committed
733
734
735
736
737
      void powerOff();
    #endif
    // hook into the main sketch functions
    void before();
    void presentation();
DV's avatar
DV committed
738
    void setup();
DV's avatar
DV committed
739
740
741
742
743
744
745
746
747
748
749
750
751
    void loop();
    void receive(const MyMessage & msg);
  private:
    #if SLEEP_MANAGER == 1
      int _sleep_mode = IDLE;
      int _sleep_time = 0;
      int _sleep_unit = MINUTES;
      int _sleep_interrupt_pin = -1;
    #endif
    #if BATTERY_MANAGER == 1
      float _battery_min = 2.6;
      float _battery_max = 3.3;
      int _battery_report_cycles = 10;
752
753
754
      bool _battery_internal_vcc = true;
      int _battery_pin = -1;
      float _battery_volts_per_bit = 0.003363075;
DV's avatar
DV committed
755
756
757
758
759
760
      int _cycles = 0;
      float _getVcc();
    #endif
    #if POWER_MANAGER == 1
      // to optionally controller power pins
      PowerManager _powerManager;
DV's avatar
DV committed
761
      bool _auto_power_pins = true;
DV's avatar
DV committed
762
763
    #endif
    MyMessage _msg;
DV's avatar
DV committed
764
765
766
    void _send(MyMessage & msg);
    int _sleep_between_send = 0;
    int _retries = 1;
DV's avatar
DV committed
767
768
769
770
771
772
773
774
775
776
777
778
779
    int _interrupt_1_mode = MODE_NOT_DEFINED;
    int _interrupt_2_mode = MODE_NOT_DEFINED;
    int _interrupt_1_pull = -1;
    int _interrupt_2_pull = -1;
    int _reboot_pin = -1;
    Sensor* _sensors[255] = {0};
    void _process(const char * message);
    void _sleep();
    int _getAvailableChildId();
    int _getInterruptInitialValue(int mode);
};

#endif