NodeManager.h 45.4 KB
Newer Older
DV's avatar
DV committed
1
2
3
4
5
6
7
8
/*
 * NodeManager
 */
#ifndef NodeManager_h
#define NodeManager_h

#include <Arduino.h>

user2684's avatar
user2684 committed
9
// define NodeManager version
user2684's avatar
user2684 committed
10
#define VERSION "1.6-dev"
DV's avatar
DV committed
11
12
13
14
15
16
17
18
19

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

// define sleep mode
#define IDLE 0
#define SLEEP 1
#define WAIT 2
20
#define ALWAYS_ON 3
DV's avatar
DV committed
21
22
23
24
25
26

// define time unit
#define SECONDS 0
#define MINUTES 1
#define HOURS 2
#define DAYS 3
27
#define CYCLES 4
DV's avatar
DV committed
28

29
30
31
32
// define on/off
#define OFF 0
#define ON 1

DV's avatar
DV committed
33
34
35
36
37
38
39
40
41
// 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

42
43
44
45
46
// define configuration settings that can be saved and loaded from the EEPROM
#define SAVE_SLEEP_MODE 0
#define SAVE_SLEEP_TIME 1
#define SAVE_SLEEP_UNIT 2

DV's avatar
DV committed
47
48
49
50
51
52
// define eeprom addresses
#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
53
54
55
#define EEPROM_USER_START 100

// define requests
DV's avatar
DV committed
56

DV's avatar
DV committed
57
58
59
60
61
/************************************
 * Include user defined configuration settings
 */
 
#include "config.h"
DV's avatar
DV committed
62
63

/***********************************
DV's avatar
DV committed
64
   Default configuration settings
DV's avatar
DV committed
65
*/
66
67
68
69
// if enabled, enable debug messages on serial port
#ifndef DEBUG
  #define DEBUG 1
#endif
DV's avatar
DV committed
70
71

// if enabled, enable the capability to power on sensors with the arduino's pins to save battery while sleeping
DV's avatar
DV committed
72
73
74
#ifndef POWER_MANAGER
  #define POWER_MANAGER 1
#endif
DV's avatar
DV committed
75
// 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
76
77
78
#ifndef BATTERY_MANAGER
  #define BATTERY_MANAGER 1
#endif
DV's avatar
DV committed
79
// if enabled, allow modifying the configuration remotely by interacting with the configuration child id
DV's avatar
DV committed
80
81
82
#ifndef REMOTE_CONFIGURATION
  #define REMOTE_CONFIGURATION 1
#endif
DV's avatar
DV committed
83
// if enabled, persist the configuration settings on EEPROM
DV's avatar
DV committed
84
85
86
#ifndef PERSIST
  #define PERSIST 0
#endif
DV's avatar
DV committed
87
88

// if enabled, send a SLEEPING and AWAKE service messages just before entering and just after leaving a sleep cycle
DV's avatar
DV committed
89
#ifndef SERVICE_MESSAGES
90
  #define SERVICE_MESSAGES 0
DV's avatar
DV committed
91
#endif
DV's avatar
DV committed
92
// 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
93
94
95
#ifndef BATTERY_SENSOR
  #define BATTERY_SENSOR 1
#endif
DV's avatar
DV committed
96

97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
// the child id used to allow remote configuration
#ifndef CONFIGURATION_CHILD_ID
  #define CONFIGURATION_CHILD_ID 200
#endif
// the child id used to report the battery voltage to the controller
#ifndef BATTERY_CHILD_ID
  #define BATTERY_CHILD_ID 201
#endif
// define the maximum number of sensors that can be managed
#ifndef MAX_SENSORS
  #define MAX_SENSORS 10
#endif

/***********************************
   Default module settings
*/

user2684's avatar
user2684 committed
114
// Enable this module to use one of the following sensors: SENSOR_ANALOG_INPUT, SENSOR_LDR, SENSOR_THERMISTOR, SENSOR_ML8511, SENSOR_ACS712, SENSOR_RAIN_GAUGE, SENSOR_RAIN, SENSOR_SOIL_MOISTURE
DV's avatar
DV committed
115
116
117
#ifndef MODULE_ANALOG_INPUT
  #define MODULE_ANALOG_INPUT 0
#endif
DV's avatar
DV committed
118
// Enable this module to use one of the following sensors: SENSOR_DIGITAL_INPUT
DV's avatar
DV committed
119
120
121
#ifndef MODULE_DIGITAL_INPUT
  #define MODULE_DIGITAL_INPUT 0
#endif
DV's avatar
DV committed
122
// Enable this module to use one of the following sensors: SENSOR_DIGITAL_OUTPUT, SENSOR_RELAY, SENSOR_LATCHING_RELAY
DV's avatar
DV committed
123
124
125
#ifndef MODULE_DIGITAL_OUTPUT
  #define MODULE_DIGITAL_OUTPUT 0
#endif
126
// Enable this module to use one of the following sensors: SENSOR_DHT11, SENSOR_DHT22, SENSOR_DHT21
DV's avatar
DV committed
127
128
129
#ifndef MODULE_DHT
  #define MODULE_DHT 0
#endif
user2684's avatar
user2684 committed
130
131
132
133
// Enable this module to use one of the following sensors: SENSOR_SHT21, SENSOR_HTU21D
#ifndef MODULE_SHT21
  #define MODULE_SHT21 0
#endif
DV's avatar
DV committed
134
// Enable this module to use one of the following sensors: SENSOR_SWITCH, SENSOR_DOOR, SENSOR_MOTION
DV's avatar
DV committed
135
136
137
#ifndef MODULE_SWITCH
  #define MODULE_SWITCH 0
#endif
DV's avatar
DV committed
138
// Enable this module to use one of the following sensors: SENSOR_DS18B20
DV's avatar
DV committed
139
140
141
#ifndef MODULE_DS18B20
  #define MODULE_DS18B20 0
#endif
DV's avatar
DV committed
142
143
144
145
146
147
148
149
// 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
150
151
152
153
// Enable this module to use one of the following sensors: SENSOR_BME280
#ifndef MODULE_BME280
  #define MODULE_BME280 0
#endif
154
155
156
157
158
159
160
161
162
163
164
165
// Enable this module to use one of the following sensors: SENSOR_SONOFF
#ifndef MODULE_SONOFF
  #define MODULE_SONOFF 0
#endif
// Enable this module to use one of the following sensors: SENSOR_BMP085
#ifndef MODULE_BMP085
  #define MODULE_BMP085 0
#endif
// Enable this module to use one of the following sensors: SENSOR_HCSR04
#ifndef MODULE_HCSR04
  #define MODULE_HCSR04 0
#endif
166
167
168
169
// Enable this module to use one of the following sensors: SENSOR_MCP9808
#ifndef MODULE_MCP9808
  #define MODULE_MCP9808 0
#endif
170
171
172
173
// Enable this module to use one of the following sensors: SENSOR_MQ
#ifndef MODULE_MQ
  #define MODULE_MQ 0
#endif
174
175
176
177
// Enable this module to use one of the following sensors: SENSOR_MHZ19
#ifndef MODULE_MHZ19
  #define MODULE_MHZ19 0
#endif
user2684's avatar
user2684 committed
178
179
180
181
182
183
184
185
186
187
188
189
// Enable this module to use one of the following sensors: SENSOR_AM2320
#ifndef MODULE_AM2320
  #define MODULE_AM2320 0
#endif
// Enable this module to use one of the following sensors: SENSOR_TSL2561
#ifndef MODULE_TSL2561
  #define MODULE_TSL2561 0
#endif
// Enable this module to use one of the following sensors: SENSOR_PT100
#ifndef MODULE_PT100
  #define SENSOR_PT100 0
#endif
190

DV's avatar
DV committed
191
/***********************************
192
   Supported Sensors
DV's avatar
DV committed
193
*/
194
195
196
197
198
199
200
201
202
203
204
205
206
207
enum supported_sensors {
  #if MODULE_ANALOG_INPUT == 1
    // Generic analog sensor, return a pin's analog value or its percentage
    SENSOR_ANALOG_INPUT,
    // LDR sensor, return the light level of an attached light resistor in percentage
    SENSOR_LDR,
    // Thermistor sensor, return the temperature based on the attached thermistor
    SENSOR_THERMISTOR,
    // ML8511 UV sensor
    SENSOR_ML8511,
    // Current sensor
    SENSOR_ACS712,
    // rain gauge sensor
    SENSOR_RAIN_GAUGE,
208
209
210
211
    // Rain sensor, return the percentage of rain from an attached analog sensor
    SENSOR_RAIN,
    // Soil moisture sensor, return the percentage of moisture from an attached analog sensor
    SENSOR_SOIL_MOISTURE,
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
  #endif
  #if MODULE_DIGITAL_INPUT == 1
    // Generic digital sensor, return a pin's digital value
    SENSOR_DIGITAL_INPUT,
  #endif
  #if MODULE_DIGITAL_OUTPUT == 1
    // Generic digital output sensor, allows setting the digital output of a pin to the requested value
    SENSOR_DIGITAL_OUTPUT,
    // Relay sensor, allows activating the relay
    SENSOR_RELAY,
    // Latching Relay sensor, allows activating the relay with a pulse
    SENSOR_LATCHING_RELAY,
  #endif
  #if MODULE_DHT == 1
    // DHT11/DHT22 sensors, return temperature/humidity based on the attached DHT sensor
    SENSOR_DHT11,
    SENSOR_DHT22,
229
    SENSOR_DHT21,
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
  #endif
  #if MODULE_SHT21 == 1
    // SHT21 sensor, return temperature/humidity based on the attached SHT21 sensor
    SENSOR_SHT21,
    SENSOR_HTU21D,
  #endif
  #if MODULE_SWITCH == 1
    // Generic switch, wake up the board when a pin changes status
    SENSOR_SWITCH,
    // Door sensor, wake up the board and report when an attached magnetic sensor has been opened/closed
    SENSOR_DOOR,
    // Motion sensor, wake up the board and report when an attached PIR has triggered
    SENSOR_MOTION,
  #endif
  #if MODULE_DS18B20 == 1
    // DS18B20 sensor, return the temperature based on the attached sensor
    SENSOR_DS18B20,
  #endif
  #if MODULE_BH1750 == 1
    // BH1750 sensor, return light in lux
    SENSOR_BH1750,
  #endif
  #if MODULE_MLX90614 == 1
    // MLX90614 sensor, contactless temperature sensor
    SENSOR_MLX90614,
  #endif
  #if MODULE_BME280 == 1
    // MLX90614 sensor, contactless temperature sensor
    SENSOR_BME280,
  #endif
  #if MODULE_SONOFF == 1
    // Sonoff wireless smart switch
    SENSOR_SONOFF,
  #endif
  #if MODULE_BMP085 == 1
    // BMP085/BMP180 sensor, return temperature and pressure
    SENSOR_BMP085,
  #endif
  #if MODULE_HCSR04 == 1
    // HC-SR04 sensor, return the distance between the sensor and an object
    SENSOR_HCSR04,
  #endif
  #if MODULE_MCP9808 == 1
    // MCP9808 sensor, precision temperature sensor
    SENSOR_MCP9808,
  #endif
276
277
278
279
  #if MODULE_MQ == 1
    // MQ2 air quality sensor
    SENSOR_MQ,
  #endif
280
281
282
283
  #if MODULE_MHZ19 == 1
    // MH-Z19 CO2 sensor
    SENSOR_MHZ19,
  #endif
284
285
286
287
288
289
290
291
292
293
294
295
  #if MODULE_TSL2561 == 1
    // TSL2561 sensor, return light in lux
    SENSOR_TSL2561,
  #endif
  #if MODULE_AM2320 == 1
    // AM2320 sensors, return temperature/humidity based on the attached AM2320 sensor
    SENSOR_AM2320,
  #endif
   #if MODULE_PT100 == 1
    // High temperature sensor associated with DFRobot Driver, return the temperature in C° from the attached PT100 sensor
    SENSOR_PT100,
  #endif
296
};
297
 
DV's avatar
DV committed
298
299
300
301
/***********************************
  Libraries
*/

302
303
304
305
306
307
308
309
// include supporting libraries
#ifdef MY_USE_UDP
    #include <WiFiUdp.h>
#endif
#ifdef MY_GATEWAY_ESP8266
  #include <ESP8266WiFi.h>
#endif

DV's avatar
DV committed
310
311
// include MySensors libraries
#include <core/MySensorsCore.h>
312
#include <core/MyCapabilities.h>
DV's avatar
DV committed
313
314
315
316
317
318
319
320
321
322
323
324
325

// 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
326
327
328
329
330
331
332
333
#if MODULE_BH1750 == 1
  #include <BH1750.h>
  #include <Wire.h>
#endif
#if MODULE_MLX90614 == 1
  #include <Wire.h>
  #include <Adafruit_MLX90614.h>
#endif
334
335
336
337
338
339
#if MODULE_BME280 == 1
  #include <Wire.h>
  #include <SPI.h>
  #include <Adafruit_Sensor.h>
  #include <Adafruit_BME280.h>
#endif
340
341
342
343
344
345
346
347
348
349
#if MODULE_SONOFF == 1
  #include <Bounce2.h>
#endif
#if MODULE_BMP085 == 1
  #include <Wire.h>
  #include <Adafruit_BMP085.h>
#endif
#if MODULE_HCSR04 == 1
  #include <NewPing.h>
#endif
350
351
352
353
#if MODULE_MCP9808 == 1
  #include <Wire.h>
  #include "Adafruit_MCP9808.h"
#endif
354
355
356
#if MODULE_MHZ19 == 1
  #include <SoftwareSerial.h>
#endif
357
358
359
360
361
362
363
364
365
366
367
#if MODULE_AM2320 == 1
  #include <Wire.h>
  #include <AM2320.h>
#endif
#if MODULE_TSL2561 == 1
  #include <TSL2561.h>
  #include <Wire.h>
#endif
#if MODULE_PT100 == 1
  #include<DFRobotHighTemperatureSensor.h>
#endif
DV's avatar
DV committed
368

369
/*******************************************************************
DV's avatar
DV committed
370
371
   Classes
*/
372
class NodeManager;
DV's avatar
DV committed
373
374
375
376
377
378
379
380
381

/*
   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
user2684's avatar
user2684 committed
382
    void setPowerPins(int ground_pin, int vcc_pin, int wait_time = 50);
383
    // turns the power pins on
DV's avatar
DV committed
384
    void powerOn();
385
    // turns the power pins on
DV's avatar
DV committed
386
387
388
389
390
391
392
    void powerOff();
  private:
    int _vcc_pin = -1;
    int _ground_pin = -1;
    long _wait = 0;
};

393
394
395
/*
   Timer
*/
DV's avatar
DV committed
396

397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
class Timer {
  public:
    Timer(NodeManager* node_manager);
    // start the timer which will be over when interval passes by. Unit can be either CYCLES or MINUTES
    void start(long target, int unit);
    void start();
    // stop the timer
    void stop();
    // set the timer configuration but do not start it
    void set(long target, int unit);
    // update the timer. To be called at every cycle
    void update();
    // returns true if the time is over
    bool isOver();
    // return true if the timer is running
    bool isRunning();
    // returns true if the timer has been configured
    bool isConfigured();
    // reset the timer and start over
    void restart();
    // return the current elapsed time
    float getElapsed();
    // return the configured unit
    int getUnit();
    // return the configured target
    int getTarget();
   private:
    NodeManager* _node_manager;
    long _target = 0;
    int _unit = 0;
    float _elapsed = 0;
    bool _use_millis = false;
    long _last_millis = 0;
    float _sleep_time = 0;
    bool _is_running = false;
    bool _is_configured = false;
};
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455

/*
   Request
*/

class Request {
  public:
    Request(const char* string);
    // return the parsed function
    int getFunction();
    // return the value as an int
    int getValueInt();
    // return the value as a float
    float getValueFloat();
    // return the value as a string
    char* getValueString();
   private:
    NodeManager* _node_manager;
    int _function;
    char* _value;
};

DV's avatar
DV committed
456
457
458
459
460
/***************************************
   Sensor: generic sensor class
*/
class Sensor {
  public:
461
    Sensor(NodeManager* node_manager, int child_id, int pin);
462
    // [1] where the sensor is attached to (default: not set)
DV's avatar
DV committed
463
464
    void setPin(int value);
    int getPin();
465
    // [2] child_id of this sensor (default: not set)
DV's avatar
DV committed
466
467
468
469
470
    void setChildId(int value);
    int getChildId();
    // presentation of this sensor (default: S_CUSTOM)
    void setPresentation(int value);
    int getPresentation();
471
    // [3] type of this sensor (default: V_CUSTOM)
DV's avatar
DV committed
472
473
    void setType(int value);
    int getType();
474
    // [4] description of the sensor (default: '')
user2684's avatar
user2684 committed
475
    void setDescription(char *value);
476
    // [5] For some sensors, the measurement can be queried multiple times and an average is returned (default: 1)
DV's avatar
DV committed
477
    void setSamples(int value);
478
    // [6] If more then one sample has to be taken, set the interval in milliseconds between measurements (default: 0)
DV's avatar
DV committed
479
    void setSamplesInterval(int value);
480
    // [7] if true will report the measure only if different than the previous one (default: false)
481
    void setTrackLastValue(bool value);
482
    // [8] if track last value is enabled, force to send an update after the configured number of cycles (default: -1)
DV's avatar
DV committed
483
    void setForceUpdate(int value);
484
    void setForceUpdateCycles(int value);
485
    // [9] if track last value is enabled, force to send an update after the configured number of minutes (default: -1)
486
    void setForceUpdateMinutes(int value);
487
    // [10] the value type of this sensor (default: TYPE_INTEGER)
DV's avatar
DV committed
488
    void setValueType(int value);
489
    int getValueType();
490
491
    // [11] for float values, set the float precision (default: 2)
    void  setFloatPrecision(int value);
DV's avatar
DV committed
492
493
    #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
user2684's avatar
user2684 committed
494
      void setPowerPins(int ground_pin, int vcc_pin, int wait_time = 50);
495
      // [12] if enabled the pins will be automatically powered on while awake and off during sleeping (default: true)
DV's avatar
DV committed
496
      void setAutoPowerPins(bool value);
497
      // [13] manually turn the power on
DV's avatar
DV committed
498
      void powerOn();
499
      // [14] manually turn the power off
DV's avatar
DV committed
500
501
      void powerOff();
    #endif
502
503
504
505
    // get the latest recorded value from the sensor
    int getValueInt();
    float getValueFloat();
    char* getValueString();
506
    // [15] After how many cycles the sensor will report back its measure (default: 1 cycle)
507
    void setReportIntervalCycles(int value);
508
    // [16] After how many minutes the sensor will report back its measure (default: 1 cycle)
509
    void setReportIntervalMinutes(int value);
510
511
    // process a remote request
    void process(Request & request);
512
513
    // return the pin the interrupt is attached to
    int getInterruptPin();
514
515
    // listen for interrupts on the given pin so interrupt() will be called when occurring
    void setInterrupt(int pin, int mode, int initial);
DV's avatar
DV committed
516
517
518
    // define what to do at each stage of the sketch
    virtual void before();
    virtual void presentation();
user2684's avatar
user2684 committed
519
    virtual void setup();
DV's avatar
DV committed
520
    virtual void loop(const MyMessage & message);
521
    virtual void interrupt();
DV's avatar
DV committed
522
523
524
    virtual void receive(const MyMessage & message);
    // abstract functions, subclasses need to implement
    virtual void onBefore() = 0;
user2684's avatar
user2684 committed
525
    virtual void onSetup() = 0;
DV's avatar
DV committed
526
527
    virtual void onLoop() = 0;
    virtual void onReceive(const MyMessage & message) = 0;
528
    virtual void onProcess(Request & request) = 0;
529
    virtual void onInterrupt() = 0;
DV's avatar
DV committed
530
531
  protected:
    MyMessage _msg;
532
    MyMessage _msg_service;
533
    NodeManager* _node_manager;
DV's avatar
DV committed
534
535
536
537
    int _pin = -1;
    int _child_id;
    int _presentation = S_CUSTOM;
    int _type = V_CUSTOM;
user2684's avatar
user2684 committed
538
    char* _description = "";
DV's avatar
DV committed
539
540
541
542
543
544
545
546
547
548
549
    int _samples = 1;
    int _samples_interval = 0;
    bool _track_last_value = false;
    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 = "";
550
551
552
553
554
    int _interrupt_pin = -1;
    #if POWER_MANAGER  == 1
      PowerManager _powerManager;
      bool _auto_power_pins = true;
    #endif
555
556
    Timer* _report_timer;
    Timer* _force_update_timer;
557
    void _send(MyMessage & msg);
558
559
    bool _isReceive(const MyMessage & message);
    bool _isWorthSending(bool comparison);
DV's avatar
DV committed
560
561
};

562
#if MODULE_ANALOG_INPUT == 1
DV's avatar
DV committed
563
564
565
566
567
/*
   SensorAnalogInput: read the analog input of a configured pin
*/
class SensorAnalogInput: public Sensor {
  public:
568
    SensorAnalogInput(NodeManager* node_manager, int child_id, int pin);
569
    // [101] the analog reference to use (default: not set, can be either INTERNAL or DEFAULT)
DV's avatar
DV committed
570
    void setReference(int value);
571
    // [102] reverse the value or the percentage (e.g. 70% -> 30%) (default: false)
DV's avatar
DV committed
572
    void setReverse(bool value);
573
    // [103] when true returns the value as a percentage (default: true)
DV's avatar
DV committed
574
    void setOutputPercentage(bool value);
575
    // [104] minimum value for calculating the percentage (default: 0)
DV's avatar
DV committed
576
    void setRangeMin(int value);
577
    // [105] maximum value for calculating the percentage (default: 1024)
DV's avatar
DV committed
578
579
580
    void setRangeMax(int value);
    // 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
    void onLoop();
    void onReceive(const MyMessage & message);
584
    void onProcess(Request & request);
585
    void onInterrupt();
DV's avatar
DV committed
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
  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:
601
    SensorLDR(NodeManager* node_manager, int child_id, int pin);
DV's avatar
DV committed
602
603
604
605
606
607
608
};

/*
   SensorThermistor: read the temperature from a thermistor
*/
class SensorThermistor: public Sensor {
  public:
609
    SensorThermistor(NodeManager* node_manager, int child_id, int pin);
610
    // [101] resistance at 25 degrees C (default: 10000)
611
    void setNominalResistor(long value);
612
    // [102] temperature for nominal resistance (default: 25)
DV's avatar
DV committed
613
    void setNominalTemperature(int value);
614
    // [103] The beta coefficient of the thermistor (default: 3950)
DV's avatar
DV committed
615
    void setBCoefficient(int value);
616
    // [104] the value of the resistor in series with the thermistor (default: 10000)
617
    void setSeriesResistor(long value);
618
    // [105] set a temperature offset
DV's avatar
DV committed
619
620
621
    void setOffset(float value);
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
622
    void onSetup();
DV's avatar
DV committed
623
624
    void onLoop();
    void onReceive(const MyMessage & message);
625
    void onProcess(Request & request);
626
    void onInterrupt();
DV's avatar
DV committed
627
  protected:
628
    long _nominal_resistor = 10000;
DV's avatar
DV committed
629
630
    int _nominal_temperature = 25;
    int _b_coefficient = 3950;
631
    long _series_resistor = 10000;
DV's avatar
DV committed
632
633
634
    float _offset = 0;
};

635
636
/*
    SensorML8511
637
*/
638
639
640

class SensorML8511: public Sensor {
  public:
641
    SensorML8511(NodeManager* node_manager, int child_id, int pin);
642
643
644
645
646
    // define what to do at each stage of the sketch
    void onBefore();
    void onSetup();
    void onLoop();
    void onReceive(const MyMessage & message);
647
    void onProcess(Request & request);
648
    void onInterrupt();
649
650
651
  protected:
    float _mapfloat(float x, float in_min, float in_max, float out_min, float out_max);
};
652
653
654
655
656
657
658

/*
    SensorACS712
*/

class SensorACS712: public Sensor {
  public:
659
    SensorACS712(NodeManager* node_manager, int child_id, int pin);
660
    // [101] set how many mV are equivalent to 1 Amp. The value depends on the module (100 for 20A Module, 66 for 30A Module) (default: 185);
661
    void setmVPerAmp(int value);
662
    // [102] set ACS offset (default: 2500);
663
664
665
666
667
668
    void setOffset(int value);
    // define what to do at each stage of the sketch
    void onBefore();
    void onSetup();
    void onLoop();
    void onReceive(const MyMessage & message);
669
    void onProcess(Request & request);
670
    void onInterrupt();
671
672
673
674
  protected:
    int _ACS_offset = 2500;
    int _mv_per_amp = 185;
};
675
676
677
678
679
680
681

/*
    SensorRainGauge
*/

class SensorRainGauge: public Sensor {
  public:
682
    SensorRainGauge(NodeManager* node_manager, int child_id, int pin);
683
    // [102] set how many mm of rain to count for each tip (default: 0.11)
684
    void setSingleTip(float value);
685
686
    // set initial value - internal pull up (default: HIGH)
    void setInitialValue(int value);
687
688
689
690
691
    // define what to do at each stage of the sketch
    void onBefore();
    void onSetup();
    void onLoop();
    void onReceive(const MyMessage & message);
692
    void onProcess(Request & request);
693
    void onInterrupt();
694
  protected:
695
    long _count = 0;
696
    float _single_tip = 0.11;
697
    int _initial_value = HIGH;
698
};
699

700
701
702
703
704
/*
   SensorRain
*/
class SensorRain: public SensorAnalogInput {
  public:
705
    SensorRain(NodeManager* node_manager, int child_id, int pin);
706
707
708
709
710
711
712
};

/*
   SensorSoilMoisture
*/
class SensorSoilMoisture: public SensorAnalogInput {
  public:
713
    SensorSoilMoisture(NodeManager* node_manager, int child_id, int pin);
714
};
715
#endif
716

717
718

#if MODULE_DIGITAL_INPUT == 1
DV's avatar
DV committed
719
720
721
722
723
/*
   SensorDigitalInput: read the digital input of the configured pin
*/
class SensorDigitalInput: public Sensor {
  public:
724
    SensorDigitalInput(NodeManager* node_manager, int child_id, int pin);
DV's avatar
DV committed
725
726
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
727
    void onSetup();
DV's avatar
DV committed
728
729
    void onLoop();
    void onReceive(const MyMessage & message);
730
    void onProcess(Request & request);
731
    void onInterrupt();
DV's avatar
DV committed
732
};
733
#endif
DV's avatar
DV committed
734

735
#if MODULE_DIGITAL_OUTPUT == 1
DV's avatar
DV committed
736
737
738
739
740
/*
   SensorDigitalOutput: control a digital output of the configured pin
*/
class SensorDigitalOutput: public Sensor {
  public:
741
    SensorDigitalOutput(NodeManager* node_manager, int child_id, int pin);
742
    // [103] define which value to set to the output when set to on (default: HIGH)
743
    void setOnValue(int value);
744
    // [104] when legacy mode is enabled expect a REQ message to trigger, otherwise the default SET (default: false)
745
    void setLegacyMode(bool value);
746
    // [105] automatically turn the output off after the given number of minutes
747
    void setSafeguard(int value);
748
    // [106] if true the input value becomes a duration in minutes after which the output will be automatically turned off (default: false)
749
    void setInputIsElapsed(bool value);
750
751
    // [107] optionally wait for the given number of milliseconds after changing the status (default: 0)
    void setWaitAfterSet(int value);
752
    // manually switch the output to the provided value
753
    void setStatus(int value);
754
    // get the current state
755
    int getStatus();
DV's avatar
DV committed
756
757
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
758
    void onSetup();
DV's avatar
DV committed
759
760
    void onLoop();
    void onReceive(const MyMessage & message);
761
    void onProcess(Request & request);
762
    void onInterrupt();
DV's avatar
DV committed
763
  protected:
764
    int _on_value = HIGH;
765
    int _status = OFF;
766
    bool _legacy_mode = false;
767
    bool _input_is_elapsed = false;
768
    int _wait_after_set = 0;
769
    Timer* _safeguard_timer;
770
771
772
    void _setupPin(int pin);
    virtual void _setStatus(int value);
    int _getValueToWrite(int value);
DV's avatar
DV committed
773
774
775
776
777
778
779
780
};


/*
   SensorRelay
*/
class SensorRelay: public SensorDigitalOutput {
  public:
781
    SensorRelay(NodeManager* node_manager, int child_id, int pin);
DV's avatar
DV committed
782
783
784
785
786
787
788
};

/*
   SensorLatchingRelay
*/
class SensorLatchingRelay: public SensorRelay {
  public:
789
    SensorLatchingRelay(NodeManager* node_manager, int child_id, int pin);
790
791
792
793
794
795
796
797
798
799
800
801
802
803
    // [201] set the duration of the pulse to send in ms to activate the relay (default: 50)
    void setPulseWidth(int value);
    // [202] set the pin which turns the relay off (default: the pin provided while registering the sensor)
    void setPinOff(int value);
    // [203] set the pin which turns the relay on (default: the pin provided while registering the sensor + 1)
    void setPinOn(int value);
    // define what to do at each stage of the sketch
    void onBefore();
    void onProcess(Request & request);
  protected:
    int _pin_on;
    int _pin_off;
    int _pulse_width = 50;
    void _setStatus(int value);
DV's avatar
DV committed
804
};
805
#endif
DV's avatar
DV committed
806
807
808
809
810
811
812

/*
   SensorDHT
*/
#if MODULE_DHT == 1
class SensorDHT: public Sensor {
  public:
813
    SensorDHT(NodeManager* node_manager, int child_id, int pin, DHT* dht, int sensor_type, int dht_type);
DV's avatar
DV committed
814
815
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
816
    void onSetup();
DV's avatar
DV committed
817
818
    void onLoop();
    void onReceive(const MyMessage & message);
819
    void onProcess(Request & request);
820
    void onInterrupt();
821
822
823
    // constants
    const static int TEMPERATURE = 0;
    const static int HUMIDITY = 1;
DV's avatar
DV committed
824
825
826
827
828
829
830
831
832
  protected:
    DHT* _dht;
    int _dht_type = DHT11;
    float _offset = 0;
    int _sensor_type = 0;
};
#endif

/*
DV's avatar
DV committed
833
   SensorSHT21: temperature and humidity sensor
DV's avatar
DV committed
834
835
836
837
*/
#if MODULE_SHT21 == 1
class SensorSHT21: public Sensor {
  public:
838
    SensorSHT21(NodeManager* node_manager, int child_id, int sensor_type);
DV's avatar
DV committed
839
840
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
841
    void onSetup();
DV's avatar
DV committed
842
843
    void onLoop();
    void onReceive(const MyMessage & message);
844
    void onProcess(Request & request);
845
    void onInterrupt();
846
847
848
    // constants
    const static int TEMPERATURE = 0;
    const static int HUMIDITY = 1;
DV's avatar
DV committed
849
850
851
852
  protected:
    float _offset = 0;
    int _sensor_type = 0;
};
DV's avatar
DV committed
853
854
855
856
857
858
859

/*
   SensorHTU21D: temperature and humidity sensor
*/

class SensorHTU21D: public SensorSHT21 {
  public:
860
    SensorHTU21D(NodeManager* node_manager, int child_id, int pin);
DV's avatar
DV committed
861
};
DV's avatar
DV committed
862
863
864
865
866
#endif

/*
 * SensorSwitch
 */
867
#if MODULE_SWITCH == 1
DV's avatar
DV committed
868
869
class SensorSwitch: public Sensor {
  public:
870
    SensorSwitch(NodeManager* node_manager, int child_id, int pin);
871
    // [101] set the interrupt mode. Can be CHANGE, RISING, FALLING (default: CHANGE)
DV's avatar
DV committed
872
    void setMode(int value);
873
    // [102] milliseconds to wait before reading the input (default: 0)
DV's avatar
DV committed
874
    void setDebounce(int value);
875
    // [103] time to wait in milliseconds after a change is detected to allow the signal to be restored to its normal value (default: 0)
DV's avatar
DV committed
876
    void setTriggerTime(int value);
877
    // [104] Set initial value on the interrupt pin (default: HIGH)
878
    void setInitial(int value);
DV's avatar
DV committed
879
880
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
881
    void onSetup();
DV's avatar
DV committed
882
883
    void onLoop();
    void onReceive(const MyMessage & message);
884
    void onProcess(Request & request);
885
    void onInterrupt();
DV's avatar
DV committed
886
887
888
889
  protected:
    int _debounce = 0;
    int _trigger_time = 0;
    int _mode = CHANGE;
890
    int _initial = HIGH;
DV's avatar
DV committed
891
892
893
894
895
896
897
};

/*
 * SensorDoor
 */
class SensorDoor: public SensorSwitch {
  public:
898
    SensorDoor(NodeManager* node_manager, int child_id, int pin);
DV's avatar
DV committed
899
900
901
902
903
904
905
};

/*
 * SensorMotion
 */
class SensorMotion: public SensorSwitch {
  public:
906
    SensorMotion(NodeManager* node_manager, int child_id, int pin);
DV's avatar
DV committed
907
};
908
#endif
DV's avatar
DV committed
909
910
911
912
913
914
/*
   SensorDs18b20
*/
#if MODULE_DS18B20 == 1
class SensorDs18b20: public Sensor {
  public:
915
    SensorDs18b20(NodeManager* node_manager, int child_id, int pin, DallasTemperature* sensors, int index);
user2684's avatar
user2684 committed
916
917
    // returns the sensor's resolution in bits
    int getResolution();
918
    // [101] set the sensor's resolution in bits
user2684's avatar
user2684 committed
919
    void setResolution(int value);
920
    // [102] sleep while DS18B20 calculates temperature (default: false)
921
    void setSleepDuringConversion(bool value);
922
923
    // return the sensors' device address
    DeviceAddress* getDeviceAddress();
924
925
926
927
928
    // define what to do at each stage of the sketch
    void onBefore();
    void onSetup();
    void onLoop();
    void onReceive(const MyMessage & message);
929
    void onProcess(Request & request);
930
    void onInterrupt();
DV's avatar
DV committed
931
932
933
  protected:
    float _offset = 0;
    int _index;
934
    bool _sleep_during_conversion = false;
DV's avatar
DV committed
935
    DallasTemperature* _sensors;
user2684's avatar
user2684 committed
936
    DeviceAddress _device_address;
DV's avatar
DV committed
937
938
939
};
#endif

DV's avatar
DV committed
940
941
942
943
944
945
/*
   SensorBH1750
*/
#if MODULE_BH1750 == 1
class SensorBH1750: public Sensor {
  public:
946
    SensorBH1750(NodeManager* node_manager, int child_id);
DV's avatar
DV committed
947
948
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
949
    void onSetup();
DV's avatar
DV committed
950
951
    void onLoop();
    void onReceive(const MyMessage & message);
952
    void onProcess(Request & request);
953
    void onInterrupt();
DV's avatar
DV committed
954
955
956
957
958
959
960
961
962
963
964
  protected:
    BH1750* _lightSensor;
};
#endif

/*
   SensorMLX90614
*/
#if MODULE_MLX90614 == 1
class SensorMLX90614: public Sensor {
  public:
965
    SensorMLX90614(NodeManager* node_manager, int child_id, Adafruit_MLX90614* mlx, int sensor_type);
DV's avatar
DV committed
966
967
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
968
    void onSetup();
DV's avatar
DV committed
969
970
    void onLoop();
    void onReceive(const MyMessage & message);
971
    void onProcess(Request & request);
972
    void onInterrupt();
973
974
975
    // constants
    const static int TEMPERATURE_AMBIENT = 0;
    const static int TEMPERATURE_OBJECT = 1;
DV's avatar
DV committed
976
977
978
979
980
  protected:
    Adafruit_MLX90614* _mlx;
    int _sensor_type;
};
#endif
DV's avatar
DV committed
981

982

983
/*
984
 * SensorBosch
985
*/
986
987
988

#if MODULE_BME280 == 1 || MODULE_BMP085 == 1
class SensorBosch: public Sensor {
989
  public:
990
    SensorBosch(NodeManager* node_manager, int child_id, int sensor_type);
991
    // [101] define how many pressure samples to keep track of for calculating the forecast (default: 5)
user2684's avatar
user2684 committed
992
    void setForecastSamplesCount(int value);
993
994
    // define what to do at each stage of the sketch
    void onBefore();
user2684's avatar
user2684 committed
995
    void onSetup();
996
997
    void onLoop();
    void onReceive(const MyMessage & message);
998
    void onProcess(Request & request);
999
    void onInterrupt();
1000
1001
1002
1003
1004
1005
    // constants
    const static int TEMPERATURE = 0;
    const static int HUMIDITY = 1;
    const static int PRESSURE = 2;
    const static int FORECAST = 3;
    static uint8_t GetI2CAddress(uint8_t chip_id);
1006
1007
  protected:
    int _sensor_type;
user2684's avatar
user2684 committed
1008
1009
1010
1011
1012
1013
1014
1015
1016
    char* _weather[6] = { "stable", "sunny", "cloudy", "unstable", "thunderstorm", "unknown" };
    int _forecast_samples_count = 5;
    float* _forecast_samples;
    int _minute_count = 0;
    float _pressure_avg;
    float _pressure_avg2;
    float _dP_dt;
    bool _first_round = true;
    float _getLastPressureSamplesAverage();
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
    void _forecast(float pressure);
};
#endif

/*
   SensorBME280
*/
#if MODULE_BME280 == 1
class SensorBME280: public SensorBosch {
  public:
1027
    SensorBME280(NodeManager* node_manager, int child_id, Adafruit_BME280* bme, int sensor_type);
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
    void onLoop();
  protected:
    Adafruit_BME280* _bme;
};
#endif

/*
   SensorBMP085
*/
#if MODULE_BMP085 == 1
class SensorBMP085: public SensorBosch {
  public:
1040
    SensorBMP085(NodeManager* node_manager, int child_id, Adafruit_BMP085* bmp, int sensor_type);
1041
1042
1043
    void onLoop();
  protected:
    Adafruit_BMP085* _bmp;
1044
1045
1046
};
#endif

1047
1048
1049
1050
1051
1052
/*
   SensorHCSR04
*/
#if MODULE_HCSR04 == 1
class SensorHCSR04: public Sensor {
  public:
1053
    SensorHCSR04(NodeManager* node_manager, int child_id, int pin);
1054
    // [101] Arduino pin tied to trigger pin on the ultrasonic sensor (default: the pin set while registering the sensor)
1055
    void setTriggerPin(int value);
1056
    // [102] Arduino pin tied to echo pin on the ultrasonic sensor (default: the pin set while registering the sensor)
1057
    void setEchoPin(int value);
1058
    // [103] Maximum distance we want to ping for (in centimeters) (default: 300)
1059
1060
1061
1062
1063
1064
    void setMaxDistance(int value);
    // define what to do at each stage of the sketch
    void onBefore();
    void onSetup();
    void onLoop();
    void onReceive(const MyMessage & message);
1065
    void onProcess(Request & request);
1066
    void onInterrupt();
1067
1068
1069
1070
1071
1072
1073
  protected:
    int _trigger_pin;
    int _echo_pin;
    int _max_distance = 300;
    NewPing* _sonar;
};
#endif
1074

1075
1076
1077
1078
1079
1080
/*
   SensorSonoff
*/
#if MODULE_SONOFF == 1
class SensorSonoff: public Sensor {
  public:
1081
    SensorSonoff(NodeManager* node_manager, int child_id);
1082
    // [101] set the button's pin (default: 0)
1083
    void setButtonPin(int value);
1084
    // [102] set the relay's pin (default: 12)
1085
    void setRelayPin(int value);
1086
    // [103] set the led's pin (default: 13)
1087
1088
1089
1090
1091
1092
    void setLedPin(int value);
    // define what to do at each stage of the sketch
    void onBefore();
    void onSetup();
    void onLoop();
    void onReceive(const MyMessage & message);
1093
    void onProcess(Request & request);
1094
    void onInterrupt();
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
  protected:
    Bounce _debouncer = Bounce();
    int _button_pin = 0;
    int _relay_pin = 12;
    int _led_pin = 13;
    int _old_value = 0;
    bool _state = false;
    int _relay_on = 1;
    int _relay_off = 0;
    int _led_on = 0;
    int _led_off = 1;
    void _blink();
    void _toggle();
};
#endif

1111
1112
1113
1114
1115
1116
/*
   SensorMCP9808
*/
#if MODULE_MCP9808 == 1
class SensorMCP9808: public Sensor {
  public:
1117
    SensorMCP9808(NodeManager* node_manager, int child_id, Adafruit_MCP9808* mcp);
1118
1119
1120
1121
1122
    // define what to do at each stage of the sketch
    void onBefore();
    void onSetup();
    void onLoop();
    void onReceive(const MyMessage & message);
1123
    void onProcess(Request & request);
1124
    void onInterrupt();
1125
1126
1127
1128
1129
  protected:
    Adafruit_MCP9808* _mcp;
};
#endif

1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
/*
    SensorMQ
 */
 #if MODULE_MQ == 1
class SensorMQ: public Sensor {
  public:
    SensorMQ(NodeManager* node_manager, int child_id, int pin);
    // [101] define the target gas whose ppm has to be returned. 0: LPG, 1: CO, 2: Smoke (default: 1);
    void setTargetGas(int value);
    // [102] define the load resistance on the board, in kilo ohms (default: 1);
    void setRlValue(float value);
    // [103] define the Ro resistance on the board (default: 10000);
    void setRoValue(float value);
    // [104] Sensor resistance in clean air (default: 9.83);
    void setCleanAirFactor(float value);
    // [105] define how many samples you are going to take in the calibration phase (default: 50);
    void setCalibrationSampleTimes(int value);
    // [106] define the time interal(in milisecond) between each samples in the cablibration phase (default: 500);
    void setCalibrationSampleInterval(int value);
    // [107] define how many samples you are going to take in normal operation (default: 50);
    void setReadSampleTimes(int value);
    // [108] 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);
    void onProcess(Request & request);
1165
    void onInterrupt();
1166
1167
1168
1169
1170
1171
1172
1173
  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;
1174
1175
1176
1177
1178
1179
    static float _default_LPGCurve[3];
    static float _default_COCurve[3];
    static float _default_SmokeCurve[3];
    float *_LPGCurve;
    float *_COCurve;
    float *_SmokeCurve;
1180
1181
1182
1183
1184
    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);
1185
1186
1187
    const static int _gas_lpg = 0;
    const static int _gas_co = 1;
    const static int _gas_smoke = 2;
1188
1189
1190
    int _target_gas = _gas_co;
};
#endif
user2684's avatar
user2684 committed
1191

1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
/*
   SensorMHZ19
*/
#if MODULE_MHZ19 == 1
class SensorMHZ19: public Sensor {
  public:
    SensorMHZ19(NodeManager* node_manager, int child_id, int pin);
    // set the pins for RX and TX of the SoftwareSerial (default: Rx=6, Tx=7)
    void setRxTx(int rxpin, int txpin);
    // define what to do at each stage of the sketch
    void onBefore();
    void onSetup();
    void onLoop();
    void onReceive(const MyMessage & message);
    void onProcess(Request & request);
    int readCO2();
  protected:
    SoftwareSerial* _ser;
    int _tx_pin = 6;
    int _rx_pin = 7;
};
#endif

1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256