NodeManager.cpp 108 KB
Newer Older
DV's avatar
DV committed
1
2
3
4
5
6
7
8
9
10
11
/*
 * NodeManager
 */

#include "NodeManager.h"

/***************************************
   PowerManager
*/

// set the vcc and ground pin the sensor is connected to
user2684's avatar
user2684 committed
12
void PowerManager::setPowerPins(int ground_pin, int vcc_pin, int wait_time) {
13
14
  _ground_pin = ground_pin;
  _vcc_pin = vcc_pin;
DV's avatar
DV committed
15
  #if DEBUG == 1
16
    Serial.print(F("PWR G="));
17
    Serial.print(_ground_pin);
18
    Serial.print(F(" V="));
19
    Serial.println(_vcc_pin);
DV's avatar
DV committed
20
  #endif
21
22
23
24
25
26
27
28
29
30
31
  if (_ground_pin > 0) {
    // configure the ground pin as output and initialize to low
    pinMode(_ground_pin, OUTPUT);
    digitalWrite(_ground_pin, LOW);
  }
  if (_vcc_pin > 0) {
    // configure the vcc pin as output and initialize to high (power on)
    pinMode(_vcc_pin, OUTPUT);
    digitalWrite(_vcc_pin, HIGH);
  }
  // save wait time
user2684's avatar
user2684 committed
32
  _wait = wait_time;
DV's avatar
DV committed
33
34
35
36
37
}


// turn on the sensor by activating its power pins
void PowerManager::powerOn() {
38
  if (_vcc_pin == -1) return;
DV's avatar
DV committed
39
  #if DEBUG == 1
40
    Serial.print(F("ON P="));
DV's avatar
DV committed
41
42
43
44
45
    Serial.println(_vcc_pin);
  #endif
  // power on the sensor by turning high the vcc pin
  digitalWrite(_vcc_pin, HIGH);
  // wait a bit for the device to settle down
46
  if (_wait > 0) wait(_wait);
DV's avatar
DV committed
47
48
49
50
}

// turn off the sensor
void PowerManager::powerOff() {
51
  if (_vcc_pin == -1) return;
DV's avatar
DV committed
52
  #if DEBUG == 1
53
    Serial.print(F("OFF P="));
DV's avatar
DV committed
54
55
56
57
58
59
    Serial.println(_vcc_pin);
  #endif
  // power off the sensor by turning low the vcc pin
  digitalWrite(_vcc_pin, LOW);
}

60
61
62
63
64
65
66
67
68
/******************************************
    Timer
*/

Timer::Timer(NodeManager* node_manager) {
  _node_manager = node_manager;
}

// start the timer
69
void Timer::start(int target, int unit) {
70
71
72
73
74
75
76
77
78
79
80
81
  set(target,unit);
  start();
}
void Timer::start() {
  if (_is_configured) _is_running = true;
}

// stop the timer
void Timer::stop() {
  _is_running = false;
}

82
83
// reset the timer
void Timer::reset() {
84
85
86
  // reset the timer
  _elapsed = 0;
  _last_millis = 0;
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
}

// restart the timer
void Timer::restart() {
  if (! isRunning()) return;
  stop();
  reset();
  // if using millis(), keep track of the current timestamp for calculating the difference
  if (! _node_manager->isSleepingNode()) _last_millis = millis();
  start();
}

// setup the timer
void Timer::set(int target, int unit) {
  reset();
102
103
  // save the settings
  _target = target;
104
105
106
107
108
109
110
111
112
113
  if (unit == MINUTES) _target = _target * 60;
  else if (unit == HOURS) _target = _target * 60 *60;
  else if (unit == DAYS) _target = _target * 60 * 60 *24;
  _is_running = false;
  _is_configured = true;
}

// unset the timer
void Timer::unset() {
  stop();
114
115
116
117
118
119
  _is_configured = true;
}

// update the timer at every cycle
void Timer::update() {
  if (! isRunning()) return;
120
121
122
123
124
125
  if (_node_manager->isSleepingNode()) {
    // millis() is not reliable while sleeping so calculate how long a sleep cycle would last in seconds and update the elapsed time
    _elapsed += _node_manager->getSleepSeconds();
  } else {
    // use millis() to calculate the elapsed time in seconds
    _elapsed = (long)((millis() - _last_millis)/1000);
126
  }
127
  _first_run = false;
128
129
130
131
132
133
134
135
136
137
138
139
140
141
}

// return true if the time is over
bool Timer::isOver() {
  if (! isRunning()) return false;
  // time has elapsed
  if (_elapsed >= _target) return true;
  // millis has started over
  if (_elapsed < 0 ) return true;
  return false;
}

// return true if the timer is running
bool Timer::isRunning() {
142
  if (! isConfigured()) return false;
143
144
145
146
147
148
149
150
  return _is_running;
}

// return true if the time is configured
bool Timer::isConfigured() {
  return _is_configured;
}

151
152
153
// return true if this is the first time the timer runs
bool Timer::isFirstRun() {
  return _first_run;
154
155
}

156
// return elapsed seconds so far
157
158
159
160
float Timer::getElapsed() {
  return _elapsed;
}

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

/******************************************
    Request
*/

Request::Request(const char* string) {
  char str[10];
  char* ptr;
  strcpy(str,string);
  // tokenize the string and split function from value
  strtok_r(str,",",&ptr);
  _function = atoi(str);
  strcpy(_value,ptr);
  #if DEBUG == 1
    Serial.print(F("REQ F="));
    Serial.print(getFunction());
    Serial.print(F(" I="));
    Serial.print(getValueInt());
    Serial.print(F(" F="));
    Serial.print(getValueFloat());
    Serial.print(F(" S="));
    Serial.println(getValueString());
  #endif
}

// return the parsed function
int Request::getFunction() {
  return _function;
}

// return the value as an int
int Request::getValueInt() {
  return atoi(_value);
  
}

// return the value as a float
float Request::getValueFloat() {
  return atof(_value);
}

// return the value as a string
char* Request::getValueString() {
  return _value;
}


DV's avatar
DV committed
208
209
210
211
212
213
214
215
/******************************************
    Sensors
*/

/*
   Sensor class
*/
// constructor
216
217
Sensor::Sensor(NodeManager* node_manager, int child_id, int pin) {
  _node_manager = node_manager;
DV's avatar
DV committed
218
219
220
  _child_id = child_id;
  _pin = pin;
  _msg = MyMessage(_child_id, _type);
221
  _msg_service = MyMessage(_child_id, V_CUSTOM);
222
223
  _report_timer = new Timer(_node_manager);
  _force_update_timer = new Timer(_node_manager);
DV's avatar
DV committed
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
}

// setter/getter
void Sensor::setPin(int value) {
  _pin = value;
}
int Sensor::getPin() {
  return _pin;
}
void Sensor::setChildId(int value) {
  _child_id = value;
}
int Sensor::getChildId() {
  return _child_id;
}
void Sensor::setPresentation(int value) {
  _presentation = value;
}
int Sensor::getPresentation() {
  return _presentation;
}
void Sensor::setType(int value) {
  _type = value;
  _msg.setType(_type);
}
int Sensor::getType() {
  return _type;
}
user2684's avatar
user2684 committed
252
253
254
void Sensor::setDescription(char* value) {
  _description = value;
}
DV's avatar
DV committed
255
256
257
258
259
260
void Sensor::setSamples(int value) {
  _samples = value;
}
void Sensor::setSamplesInterval(int value) {
  _samples_interval = value;
}
261
void Sensor::setTrackLastValue(bool value) {
DV's avatar
DV committed
262
263
  _track_last_value = value;
}
264
265
void Sensor::setForceUpdateMinutes(int value) {
  _force_update_timer->start(value,MINUTES);
DV's avatar
DV committed
266
}
267
268
269
void Sensor::setForceUpdateHours(int value) {
  _force_update_timer->start(value,HOURS);
}
DV's avatar
DV committed
270
271
272
void Sensor::setValueType(int value) {
  _value_type = value;
}
273
274
275
int Sensor::getValueType() {
  return _value_type;
}
DV's avatar
DV committed
276
277
278
279
void Sensor::setFloatPrecision(int value) {
  _float_precision = value;
}
#if POWER_MANAGER == 1
user2684's avatar
user2684 committed
280
281
    void Sensor::setPowerPins(int ground_pin, int vcc_pin, int wait_time) {
      _powerManager.setPowerPins(ground_pin, vcc_pin, wait_time);
DV's avatar
DV committed
282
    }
DV's avatar
DV committed
283
284
285
    void Sensor::setAutoPowerPins(bool value) {
      _auto_power_pins = value;
    }
DV's avatar
DV committed
286
287
288
289
290
291
292
    void Sensor::powerOn() {
      _powerManager.powerOn();
    }
    void Sensor::powerOff() {
      _powerManager.powerOff();
    }
#endif
293
294
295
int Sensor::getInterruptPin() {
  return _interrupt_pin;
}
296
297
298
299
300
301
302
303
304
int Sensor::getValueInt() {
  return _last_value_int;
}
float Sensor::getValueFloat() {
  return _last_value_float;
}
char* Sensor::getValueString() {
  return _last_value_string;
}
DV's avatar
DV committed
305

306
// After how many minutes the sensor will report back its measure 
307
308
309
310
void Sensor::setReportIntervalMinutes(int value) {
  _report_timer->start(value,MINUTES);
}

311
312
313
314
315
316
317
318
319
320
// After how many seconds the sensor will report back its measure
void Sensor::setReportIntervalSeconds(int value) {
  _report_timer->start(value,SECONDS);
}

// return true if the report interval has been already configured
bool Sensor::isReportIntervalConfigured() {
  return _report_timer->isConfigured();
}

321
322
323
324
325
326
// listen for interrupts on the given pin so interrupt() will be called when occurring
void Sensor::setInterrupt(int pin, int mode, int initial) {
  _interrupt_pin = pin;
  _node_manager->setInterrupt(pin,mode,initial);
}

DV's avatar
DV committed
327
328
329
// present the sensor to the gateway and controller
void Sensor::presentation() {
  #if DEBUG == 1
330
    Serial.print(F("PRES I="));
DV's avatar
DV committed
331
    Serial.print(_child_id);
332
    Serial.print(F(" T="));
DV's avatar
DV committed
333
334
    Serial.println(_presentation);
  #endif
335
  present(_child_id, _presentation,_description,_node_manager->getAck());
DV's avatar
DV committed
336
337
338
339
340
341
342
343
}

// call the sensor-specific implementation of before
void Sensor::before() {
  if (_pin == -1) return;
  onBefore();
}

user2684's avatar
user2684 committed
344
345
346
347
348
349
// call the sensor-specific implementation of setup
void Sensor::setup() {
  if (_pin == -1) return;
  onSetup();
}

DV's avatar
DV committed
350
351
352
// call the sensor-specific implementation of loop
void Sensor::loop(const MyMessage & message) {
  if (_pin == -1) return;
353
354
355
  // update the timers if within a loop cycle
  if (! _isReceive(message)) {
    if (_report_timer->isRunning()) {
356
357
      // store the elapsed time before updating it
      bool first_run = _report_timer->isFirstRun();
358
359
      // update the timer
      _report_timer->update();
360
361
      // if it is not the time yet to report a new measure, just return (unless the first time)
      if (! _report_timer->isOver() && ! first_run) return;
362
363
364
    }
    if (_force_update_timer->isRunning()) _force_update_timer->update();
  }
DV's avatar
DV committed
365
366
  #if POWER_MANAGER == 1
    // turn the sensor on
DV's avatar
DV committed
367
    if (_auto_power_pins) powerOn();
DV's avatar
DV committed
368
369
370
371
372
373
  #endif
  // for numeric sensor requiring multiple samples, keep track of the total
  float total = 0;
  // collect multiple samples if needed
  for (int i = 0; i < _samples; i++) {
    // call the sensor-specific implementation of the main task which will store the result in the _value variable
374
    if (_isReceive(message)) {
DV's avatar
DV committed
375
376
377
      // we've been called from receive(), pass the message along
      onReceive(message);
    }
378
379
380
381
    else {
      // we'be been called from loop()
      onLoop();
    }
DV's avatar
DV committed
382
383
384
385
    // for integers and floats, keep track of the total
    if (_value_type == TYPE_INTEGER) total += (float)_value_int;
    else if (_value_type == TYPE_FLOAT) total += _value_float;
    // wait between samples
386
    if (_samples_interval > 0) wait(_samples_interval);
DV's avatar
DV committed
387
  }
388
  // process the result and send a response back
DV's avatar
DV committed
389
390
391
392
  if (_value_type == TYPE_INTEGER && total > -1) {
    // if the value is an integer, calculate the average value of the samples
    int avg = (int) (total / _samples);
    // if track last value is disabled or if enabled and the current value is different then the old value, send it back
393
    if (_isReceive(message) || _isWorthSending(avg != _last_value_int))  {
DV's avatar
DV committed
394
395
      _last_value_int = avg;
      _send(_msg.set(avg));
396
      _value_int = -1;
DV's avatar
DV committed
397
398
399
400
401
402
    }
  }
  // process a float value
  else if (_value_type == TYPE_FLOAT && total > -1) {
    // calculate the average value of the samples
    float avg = total / _samples;
403
404
    // report the value back
    if (_isReceive(message) || _isWorthSending(avg != _last_value_float))  {
DV's avatar
DV committed
405
406
      _last_value_float = avg;
      _send(_msg.set(avg, _float_precision));
407
      _value_float = -1;
DV's avatar
DV committed
408
409
410
411
412
    }
  }
  // process a string value
  else if (_value_type == TYPE_STRING) {
    // if track last value is disabled or if enabled and the current value is different then the old value, send it back
413
    if (_isReceive(message) || _isWorthSending(strcmp(_value_string, _last_value_string) != 0))  {
DV's avatar
DV committed
414
415
      _last_value_string = _value_string;
      _send(_msg.set(_value_string));
416
      _value_string = "";
DV's avatar
DV committed
417
418
419
420
    }
  }
  // turn the sensor off
  #if POWER_MANAGER == 1
DV's avatar
DV committed
421
    if (_auto_power_pins) powerOff();
DV's avatar
DV committed
422
  #endif
423
424
  // restart the report timer if over
  if (! _isReceive(message) && _report_timer->isRunning() && _report_timer->isOver()) _report_timer->restart();
DV's avatar
DV committed
425
426
}

427
428
429
430
431
432
// receive and handle an interrupt
void Sensor::interrupt() {
  // call the implementation of onInterrupt()
  onInterrupt();
}

DV's avatar
DV committed
433
434
435
// receive a message from the radio network
void Sensor::receive(const MyMessage &message) {
  // return if not for this sensor
436
437
438
439
440
441
442
443
444
445
446
447
448
  if (message.sensor != _child_id) return;
  // check if it is a request for the API
  if (message.getCommand() == C_REQ && message.type == V_CUSTOM) {
    #if REMOTE_CONFIGURATION == 1
      // parse the request
      Request request = Request(message.getString());
      // if it is for a sensor-generic function, call process(), otherwise the sensor-specific onProcess();
      if (request.getFunction() < 100) process(request);
      else onProcess(request);
    #endif
  }
  // return if the type is not correct
  if (message.type != _type) return;
449
  // a request would make the sensor executing its main task passing along the message
DV's avatar
DV committed
450
451
452
  loop(message);
}

453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
// process a remote configuration request message
void Sensor::process(Request & request) {
  int function = request.getFunction();
  switch(function) {
    case 1: setPin(request.getValueInt()); break;
    case 2: setChildId(request.getValueInt()); break;
    case 3: setType(request.getValueInt()); break;
    case 4: setDescription(request.getValueString()); break;
    case 5: setSamples(request.getValueInt()); break;
    case 6: setSamplesInterval(request.getValueInt()); break;
    case 7: setTrackLastValue(request.getValueInt()); break;
    case 9: setForceUpdateMinutes(request.getValueInt()); break;
    case 10: setValueType(request.getValueInt()); break;
    case 11: setFloatPrecision(request.getValueInt()); break;
    #if POWER_MANAGER == 1
      case 12: setAutoPowerPins(request.getValueInt()); break;
      case 13: powerOn(); break;
      case 14: powerOff(); break;
    #endif
    case 16: setReportIntervalMinutes(request.getValueInt()); break;
473
474
    case 17: setReportIntervalSeconds(request.getValueInt()); break;
    case 18: setForceUpdateHours(request.getValueInt()); break;
475
476
477
478
479
    default: return;
  }
  _send(_msg_service.set(function));
}

DV's avatar
DV committed
480
481
482
// send a message to the network
void Sensor::_send(MyMessage & message) {
  // send the message, multiple times if requested
483
  for (int i = 0; i < _node_manager->getRetries(); i++) {
DV's avatar
DV committed
484
    // if configured, sleep beetween each send
485
    if (_node_manager->getSleepBetweenSend() > 0) sleep(_node_manager->getSleepBetweenSend());
DV's avatar
DV committed
486
    #if DEBUG == 1
487
      Serial.print(F("SEND D="));
DV's avatar
DV committed
488
      Serial.print(message.destination);
489
      Serial.print(F(" I="));
DV's avatar
DV committed
490
      Serial.print(message.sensor);
491
      Serial.print(F(" C="));
DV's avatar
DV committed
492
      Serial.print(message.getCommand());
493
      Serial.print(F(" T="));
DV's avatar
DV committed
494
      Serial.print(message.type);
495
      Serial.print(F(" S="));
DV's avatar
DV committed
496
      Serial.print(message.getString());
497
      Serial.print(F(" I="));
DV's avatar
DV committed
498
      Serial.print(message.getInt());
499
      Serial.print(F(" F="));
DV's avatar
DV committed
500
501
      Serial.println(message.getFloat());
    #endif
502
    send(message,_node_manager->getAck());
DV's avatar
DV committed
503
504
505
  }
}

506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
// return true if the message is coming from the radio network
bool Sensor::_isReceive(const MyMessage & message) {
  if (message.sender == 0 && message.sensor == 0 && message.getCommand() == 0 && message.type == 0) return false;
  return true;
}

// determine if a value is worth sending back to the controller
bool Sensor::_isWorthSending(bool comparison) {
  // track last value is disabled
  if (! _track_last_value) return true;
  // track value is enabled and the current value is different then the old value
  if (_track_last_value && comparison) return true;
  // track value is enabled and the timer is over
  if (_track_last_value && _force_update_timer->isRunning() && _force_update_timer->isOver()) {
    // restart the timer
    _force_update_timer->restart();
    return true;
  }
  return false;
}

527
#if MODULE_ANALOG_INPUT == 1
DV's avatar
DV committed
528
529
530
531
532
/*
   SensorAnalogInput
*/

// contructor
533
SensorAnalogInput::SensorAnalogInput(NodeManager* node_manager, int child_id, int pin): Sensor(node_manager, child_id, pin) {
DV's avatar
DV committed
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
}

// setter/getter
void SensorAnalogInput::setReference(int value) {
  _reference = value;
}
void SensorAnalogInput::setReverse(bool value) {
  _reverse = value;
}
void SensorAnalogInput::setOutputPercentage(bool value) {
  _output_percentage = value;
}
void SensorAnalogInput::setRangeMin(int value) {
  _range_min = value;
}
void SensorAnalogInput::setRangeMax(int value) {
  _range_max = value;
}

553
// what to do during before
DV's avatar
DV committed
554
555
556
557
558
void SensorAnalogInput::onBefore() {
  // prepare the pin for input
  pinMode(_pin, INPUT);
}

559
// what to do during setup
user2684's avatar
user2684 committed
560
561
562
void SensorAnalogInput::onSetup() {
}

563
// what to do during loop
DV's avatar
DV committed
564
565
566
567
568
569
570
void SensorAnalogInput::onLoop() {
  // read the input
  int adc = _getAnalogRead();
  // calculate the percentage
  int percentage = 0;
  if (_output_percentage) percentage = _getPercentage(adc);
  #if DEBUG == 1
571
    Serial.print(F("A-IN I="));
DV's avatar
DV committed
572
    Serial.print(_child_id);
573
    Serial.print(F(" V="));
DV's avatar
DV committed
574
    Serial.print(adc);
575
    Serial.print(F(" %="));
DV's avatar
DV committed
576
577
578
579
580
581
    Serial.println(percentage);
  #endif
  // store the result
  _value_int = _output_percentage ? percentage : adc;
}

582
// what to do during loop
DV's avatar
DV committed
583
void SensorAnalogInput::onReceive(const MyMessage & message) {
584
  if (message.getCommand() == C_REQ) onLoop();
DV's avatar
DV committed
585
586
}

587
588
589
590
591
592
593
594
595
596
597
598
599
600
// what to do when receiving a remote message
void SensorAnalogInput::onProcess(Request & request) {
  int function = request.getFunction();
  switch(function) {
    case 101: setReference(request.getValueInt()); break;
    case 102: setReverse(request.getValueInt()); break;
    case 103: setOutputPercentage(request.getValueInt()); break;
    case 104: setRangeMin(request.getValueInt()); break;
    case 105: setRangeMax(request.getValueInt()); break;
    default: return;
  }
  _send(_msg_service.set(function));
}

601
602
603
604
// what to do when receiving an interrupt
void SensorAnalogInput::onInterrupt() {
}

DV's avatar
DV committed
605
606
// read the analog input
int SensorAnalogInput::_getAnalogRead() {
607
608
609
610
611
612
613
  #ifndef MY_GATEWAY_ESP8266
    // set the reference
    if (_reference != -1) {
      analogReference(_reference);
      wait(100);
    }
  #endif
DV's avatar
DV committed
614
615
616
617
618
619
620
621
622
  // read and return the value
  int value = analogRead(_pin);
  if (_reverse) value = _range_max - value;
  return value;
}

// return a percentage from an analog value
int SensorAnalogInput::_getPercentage(int adc) {
  float value = (float)adc;
DV's avatar
DV committed
623
624
  // restore the original value
  if (_reverse) value = 1024 - value;
DV's avatar
DV committed
625
626
  // scale the percentage based on the range provided
  float percentage = ((value - _range_min) / (_range_max - _range_min)) * 100;
DV's avatar
DV committed
627
  if (_reverse) percentage = 100 - percentage;
DV's avatar
DV committed
628
629
630
631
632
633
634
635
636
637
  if (percentage > 100) percentage = 100;
  if (percentage < 0) percentage = 0;
  return (int)percentage;
}

/*
   SensorLDR
*/

// contructor
638
SensorLDR::SensorLDR(NodeManager* node_manager, int child_id, int pin): SensorAnalogInput(node_manager, child_id, pin) {
DV's avatar
DV committed
639
640
641
642
643
644
645
646
647
648
649
  // set presentation and type and reverse (0: no light, 100: max light)
  setPresentation(S_LIGHT_LEVEL);
  setType(V_LIGHT_LEVEL);
  setReverse(true);
}

/*
   SensorThermistor
*/

// contructor
650
SensorThermistor::SensorThermistor(NodeManager* node_manager, int child_id, int pin): Sensor(node_manager, child_id, pin) {
DV's avatar
DV committed
651
652
653
654
655
656
657
  // set presentation, type and value type
  setPresentation(S_TEMP);
  setType(V_TEMP);
  setValueType(TYPE_FLOAT);
}

// setter/getter
658
void SensorThermistor::setNominalResistor(long value) {
DV's avatar
DV committed
659
660
661
662
663
664
665
666
  _nominal_resistor = value;
}
void SensorThermistor::setNominalTemperature(int value) {
  _nominal_temperature = value;
}
void SensorThermistor::setBCoefficient(int value) {
  _b_coefficient = value;
}
667
void SensorThermistor::setSeriesResistor(long value) {
DV's avatar
DV committed
668
669
670
671
672
673
  _series_resistor = value;
}
void SensorThermistor::setOffset(float value) {
  _offset = value;
}

674
// what to do during before
DV's avatar
DV committed
675
676
677
678
679
void SensorThermistor::onBefore() {
  // set the pin as input
  pinMode(_pin, INPUT);
}

680
// what to do during setup
user2684's avatar
user2684 committed
681
682
683
void SensorThermistor::onSetup() {
}

684
// what to do during loop
DV's avatar
DV committed
685
686
687
688
689
690
691
692
693
694
695
696
697
void SensorThermistor::onLoop() {
  // read the voltage across the thermistor
  float adc = analogRead(_pin);
  // calculate the temperature
  float reading = (1023 / adc)  - 1;
  reading = _series_resistor / reading;
  float temperature;
  temperature = reading / _nominal_resistor;     // (R/Ro)
  temperature = log(temperature);                  // ln(R/Ro)
  temperature /= _b_coefficient;                   // 1/B * ln(R/Ro)
  temperature += 1.0 / (_nominal_temperature + 273.15); // + (1/To)
  temperature = 1.0 / temperature;                 // Invert
  temperature -= 273.15;                         // convert to C
698
  temperature = _node_manager->celsiusToFahrenheit(temperature);
DV's avatar
DV committed
699
  #if DEBUG == 1
700
    Serial.print(F("THER I="));
DV's avatar
DV committed
701
    Serial.print(_child_id);
702
    Serial.print(F(" V="));
DV's avatar
DV committed
703
    Serial.print(adc);
704
    Serial.print(F(" T="));
705
    Serial.println(temperature);
DV's avatar
DV committed
706
707
708
709
710
  #endif
  // store the value
  _value_float = temperature;
}

711
// what to do as the main task when receiving a message
DV's avatar
DV committed
712
void SensorThermistor::onReceive(const MyMessage & message) {
713
  if (message.getCommand() == C_REQ) onLoop();
DV's avatar
DV committed
714
715
}

716
717
718
719
720
721
722
723
724
725
726
727
728
// what to do when receiving a remote message
void SensorThermistor::onProcess(Request & request) {
  int function = request.getFunction();
  switch(function) {
    case 101: setNominalResistor((long)request.getValueInt()); break;
    case 102: setNominalTemperature(request.getValueInt()); break;
    case 103: setBCoefficient(request.getValueInt()); break;
    case 104: setSeriesResistor((long)request.getValueString()); break;
    case 105: setOffset(request.getValueFloat()); break;
    default: return;
  }
  _send(_msg_service.set(function));
}
729

730
731
732
733
// what to do when receiving an interrupt
void SensorThermistor::onInterrupt() {
}

734
735
736
737
738
/*
   SensorML8511
*/

// contructor
739
SensorML8511::SensorML8511(NodeManager* node_manager, int child_id, int pin): Sensor(node_manager, child_id, pin) {
740
741
742
743
744
745
  // set presentation, type and value type
  setPresentation(S_UV);
  setType(V_UV);
  setValueType(TYPE_FLOAT);
}

746
// what to do during before
747
748
749
750
751
void SensorML8511::onBefore() {
  // set the pin as input
  pinMode(_pin, INPUT);
}

752
// what to do during setup
753
754
755
void SensorML8511::onSetup() {
}

756
// what to do during loop
757
758
759
void SensorML8511::onLoop() {
  // read the voltage 
  int uvLevel = analogRead(_pin);
760
  int refLevel = _node_manager->getVcc()*1024/3.3;
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
  //Use the 3.3V power pin as a reference to get a very accurate output value from sensor
  float outputVoltage = 3.3 / refLevel * uvLevel;
  //Convert the voltage to a UV intensity level
  float uvIntensity = _mapfloat(outputVoltage, 0.99, 2.8, 0.0, 15.0); 
  #if DEBUG == 1
    Serial.print(F("UV I="));
    Serial.print(_child_id);
    Serial.print(F(" V="));
    Serial.print(outputVoltage);
    Serial.print(F(" I="));
    Serial.println(uvIntensity);
  #endif
  // store the value
  _value_float = uvIntensity;
}

777
// what to do as the main task when receiving a message
778
void SensorML8511::onReceive(const MyMessage & message) {
779
  if (message.getCommand() == C_REQ) onLoop();
780
781
}

782
783
784
785
// what to do when receiving a remote message
void SensorML8511::onProcess(Request & request) {
}

786
787
788
789
// what to do when receiving an interrupt
void SensorML8511::onInterrupt() {
}

790
791
792
793
794
// The Arduino Map function but for floats
float SensorML8511::_mapfloat(float x, float in_min, float in_max, float out_min, float out_max) {
  return (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min;
}

795
796
797
798
799
/*
   SensorACS712
*/

// contructor
800
SensorACS712::SensorACS712(NodeManager* node_manager, int child_id, int pin): Sensor(node_manager, child_id, pin) {
801
802
803
804
805
806
807
808
809
810
811
812
813
814
  // set presentation, type and value type
  setPresentation(S_MULTIMETER);
  setType(V_CURRENT);
  setValueType(TYPE_FLOAT);
}

// setter/getter
void SensorACS712::setmVPerAmp(int value) {
  _mv_per_amp = value;
}
void SensorACS712::setOffset(int value) {
  _ACS_offset = value;
}

815
// what to do during before
816
817
818
819
820
void SensorACS712::onBefore() {
  // set the pin as input
  pinMode(_pin, INPUT);
}

821
// what to do during setup
822
823
824
void SensorACS712::onSetup() {
}

825
// what to do during loop
826
827
828
829
830
831
832
833
834
835
836
837
838
839
void SensorACS712::onLoop() {
  int value = analogRead(_pin);
  // convert the analog read in mV
  double voltage = (value / 1024.0) * 5000; 
  // convert voltage in amps
  _value_float = ((voltage - _ACS_offset) / _mv_per_amp);
  #if DEBUG == 1
    Serial.print(F("ACS I="));
    Serial.print(_child_id);
    Serial.print(F(" A="));
    Serial.println(_value_float);
  #endif
}

840
// what to do as the main task when receiving a message
841
842
843
844
void SensorACS712::onReceive(const MyMessage & message) {
  if (message.getCommand() == C_REQ) onLoop();
}

845
846
847
848
849
850
851
852
853
854
855
// what to do when receiving a remote message
void SensorACS712::onProcess(Request & request) {
  int function = request.getFunction();
  switch(function) {
    case 100: setmVPerAmp(request.getValueInt()); break;
    case 102: setOffset(request.getValueInt()); break;
    default: return;
  }
  _send(_msg_service.set(function));
}

856
857
858
859
// what to do when receiving an interrupt
void SensorACS712::onInterrupt() {
}

860
861
862
863
864
/*
   SensorRainGauge
*/

// contructor
865
SensorRainGauge::SensorRainGauge(NodeManager* node_manager, int child_id, int pin): Sensor(node_manager,child_id, pin) {
866
867
868
869
870
871
872
873
874
875
  // set presentation, type and value type
  setPresentation(S_RAIN);
  setType(V_RAIN);
  setValueType(TYPE_FLOAT);
}

// setter/getter
void SensorRainGauge::setSingleTip(float value) {
  _single_tip = value;
}
876
877
878
void SensorRainGauge::setInitialValue(int value) {
  _initial_value = value;
}
879
880
881

// what to do during before
void SensorRainGauge::onBefore() {
882
883
  // configure the interrupt pin so onInterrupt() will be called on tip
  setInterrupt(_pin,FALLING,_initial_value);
884
885
886
887
888
889
890
891
}

// what to do during setup
void SensorRainGauge::onSetup() {
}

// what to do during loop
void SensorRainGauge::onLoop() {
892
893
894
895
896
897
898
899
900
901
902
903
  // do not execute loop if called by an interrupt
  if (_node_manager->getLastInterruptPin() == _interrupt_pin) return;
  // time to report the rain so far
  _value_float = _count * _single_tip;
  #if DEBUG == 1
    Serial.print(F("RAIN I="));
    Serial.print(_child_id);
    Serial.print(F(" T="));
    Serial.println(_value_float);
  #endif
  // reset the counter
  _count = 0;
904
905
906
907
908
909
}

// what to do as the main task when receiving a message
void SensorRainGauge::onReceive(const MyMessage & message) {
  if (message.getCommand() == C_REQ) {
    // report the total amount of rain for the last period
910
    _value_float = _count * _single_tip;
911
912
913
  }
}

914
915
916
917
918
919
920
921
922
923
// what to do when receiving a remote message
void SensorRainGauge::onProcess(Request & request) {
  int function = request.getFunction();
  switch(function) {
    case 102: setSingleTip(request.getValueFloat()); break;
    default: return;
  }
  _send(_msg_service.set(function));
}

924
925
926
927
928
929
930
931
932
// what to do when receiving an interrupt
void SensorRainGauge::onInterrupt() {
  // increase the counter
  _count++;
  #if DEBUG == 1
    Serial.println(F("RAIN+"));
  #endif
}

933
934
935
936
937
/*
   SensorRain
*/

// contructor
938
SensorRain::SensorRain(NodeManager* node_manager, int child_id, int pin): SensorAnalogInput(node_manager,child_id, pin) {
939
940
941
942
943
944
945
946
947
948
949
950
951
952
  // set presentation and type and reverse
  setPresentation(S_RAIN);
  setType(V_RAINRATE);
  setReference(DEFAULT);
  setOutputPercentage(true);
  setReverse(true);
  setRangeMin(100);
}

/*
   SensorSoilMoisture
*/

// contructor
953
SensorSoilMoisture::SensorSoilMoisture(NodeManager* node_manager, int child_id, int pin): SensorAnalogInput(node_manager, child_id, pin) {
954
955
956
957
958
959
960
961
962
  // set presentation and type and reverse
  setPresentation(S_MOISTURE);
  setType(V_LEVEL);
  setReference(DEFAULT);
  setOutputPercentage(true);
  setReverse(true);
  setRangeMin(100);
}

963
#endif
964

965
#if MODULE_DIGITAL_INPUT == 1
DV's avatar
DV committed
966
967
968
969
970
/*
   SensorDigitalInput
*/

// contructor
971
SensorDigitalInput::SensorDigitalInput(NodeManager* node_manager, int child_id, int pin): Sensor(node_manager,child_id, pin) {
DV's avatar
DV committed
972
973
}

974
// what to do during before
DV's avatar
DV committed
975
976
977
978
979
void SensorDigitalInput::onBefore() {
  // set the pin for input
  pinMode(_pin, INPUT);
}

980
// what to do during setup
user2684's avatar
user2684 committed
981
982
983
void SensorDigitalInput::onSetup() {
}

984
// what to do during loop
DV's avatar
DV committed
985
986
987
988
void SensorDigitalInput::onLoop() {
  // read the value
  int value = digitalRead(_pin);
  #if DEBUG == 1
989
    Serial.print(F("D-IN I="));
DV's avatar
DV committed
990
    Serial.print(_child_id);
991
    Serial.print(F(" P="));
DV's avatar
DV committed
992
    Serial.print(_pin);
993
    Serial.print(F(" V="));
DV's avatar
DV committed
994
995
996
997
998
999
    Serial.println(value);
  #endif
  // store the value
  _value_int = value;
}

1000
// what to do as the main task when receiving a message