NodeManager.cpp 95.8 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) {
DV's avatar
DV committed
13
  #if DEBUG == 1
14
    Serial.print(F("PWR G="));
DV's avatar
DV committed
15
    Serial.print(ground_pin);
16
    Serial.print(F(" V="));
DV's avatar
DV committed
17
    Serial.println(vcc_pin);
DV's avatar
DV committed
18
  #endif
19
20
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
    _ground_pin = ground_pin;
    pinMode(_ground_pin, OUTPUT);
    digitalWrite(_ground_pin, LOW);
  }
  if (_vcc_pin > 0) {
    // configure the vcc pin as output and initialize to high (power on)
    _vcc_pin = vcc_pin;
    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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/******************************************
    Timer
*/

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

// start the timer
void Timer::start(long target, int unit) {
  set(target,unit);
  start();
}
void Timer::start() {
  if (_is_configured) _is_running = true;
}

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

// setup the timer
void Timer::set(long target, int unit) {
  // reset the timer
  _elapsed = 0;
  _use_millis = false;
  _last_millis = 0;
  _sleep_time = 0;
  // save the settings
  _target = target;
  _unit = unit;
  if (_unit == MINUTES) {
    if (_node_manager->isSleepingNode()) {
      // this is a sleeping node and millis() is not reliable so calculate how long a sleep/wait cycle would last
      int sleep_unit = _node_manager->getSleepUnit();
      _sleep_time = (float)_node_manager->getSleepTime();
      if (sleep_unit == SECONDS) _sleep_time = _sleep_time/60;
      else if (sleep_unit == HOURS) _sleep_time = _sleep_time*60;
      else if (sleep_unit == DAYS) _sleep_time = _sleep_time*1440;
    }
    else {
      // this is not a sleeping node, use millis() to keep track of the elapsed time
      _use_millis = true;
    }
  }
  _is_configured = true;
}

// update the timer at every cycle
void Timer::update() {
  if (! isRunning()) return;
  if (_unit == CYCLES) {
    // if not a sleeping node, counting the cycles do not make sense
    if (! _node_manager->isSleepingNode()) return;
    // just increase the cycle counter
    _elapsed++;
  }
  else if (_unit == MINUTES) {
    // if using millis(), calculate the elapsed minutes, otherwise add a sleep interval
    if (_use_millis) {
      _elapsed = (float)(millis() - _last_millis)/1000/60;
    }
    else {
      _elapsed += _sleep_time;
    }
  }
}

// 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() {
  return _is_running;
}

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

// restart the timer
void Timer::restart() {
  if (! isRunning()) return;
  // reset elapsed
  _elapsed = 0;
  // if using millis, keep track of the now timestamp
  if (_use_millis) _last_millis = millis();
}

// return elapsed minutes so far
float Timer::getElapsed() {
  return _elapsed;
}

// return the configured unit
int Timer::getUnit() {
  return _unit;
}
167

168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214

/******************************************
    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
215
216
217
218
219
220
221
222
/******************************************
    Sensors
*/

/*
   Sensor class
*/
// constructor
223
224
Sensor::Sensor(NodeManager* node_manager, int child_id, int pin) {
  _node_manager = node_manager;
DV's avatar
DV committed
225
226
227
  _child_id = child_id;
  _pin = pin;
  _msg = MyMessage(_child_id, _type);
228
  _msg_service = MyMessage(_child_id, V_CUSTOM);
229
230
  _report_timer = new Timer(_node_manager);
  _force_update_timer = new Timer(_node_manager);
DV's avatar
DV committed
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
}

// 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
259
260
261
void Sensor::setDescription(char* value) {
  _description = value;
}
DV's avatar
DV committed
262
263
264
265
266
267
void Sensor::setSamples(int value) {
  _samples = value;
}
void Sensor::setSamplesInterval(int value) {
  _samples_interval = value;
}
268
void Sensor::setTrackLastValue(bool value) {
DV's avatar
DV committed
269
270
271
  _track_last_value = value;
}
void Sensor::setForceUpdate(int value) {
272
273
274
275
276
277
278
  setForceUpdateCycles(value);
}
void Sensor::setForceUpdateCycles(int value) {
  _force_update_timer->start(value,CYCLES);
}
void Sensor::setForceUpdateMinutes(int value) {
  _force_update_timer->start(value,MINUTES);
DV's avatar
DV committed
279
280
281
282
}
void Sensor::setValueType(int value) {
  _value_type = value;
}
283
284
285
int Sensor::getValueType() {
  return _value_type;
}
DV's avatar
DV committed
286
287
288
289
void Sensor::setFloatPrecision(int value) {
  _float_precision = value;
}
#if POWER_MANAGER == 1
user2684's avatar
user2684 committed
290
291
    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
292
    }
DV's avatar
DV committed
293
294
295
    void Sensor::setAutoPowerPins(bool value) {
      _auto_power_pins = value;
    }
DV's avatar
DV committed
296
297
298
299
300
301
302
    void Sensor::powerOn() {
      _powerManager.powerOn();
    }
    void Sensor::powerOff() {
      _powerManager.powerOff();
    }
#endif
303
304
305
int Sensor::getInterruptPin() {
  return _interrupt_pin;
}
306
307
308
309
310
311
312
313
314
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
315

316
317
318
319
320
321
322
323
324
325
// After how many cycles the sensor will report back its measure (default: 1 cycle)
void Sensor::setReportIntervalCycles(int value) {
  _report_timer->start(value,CYCLES);
}

// After how many minutes the sensor will report back its measure (default: 1 cycle)
void Sensor::setReportIntervalMinutes(int value) {
  _report_timer->start(value,MINUTES);
}

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

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

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

DV's avatar
DV committed
349
350
351
// call the sensor-specific implementation of loop
void Sensor::loop(const MyMessage & message) {
  if (_pin == -1) return;
352
353
354
355
356
357
358
359
360
361
  // update the timers if within a loop cycle
  if (! _isReceive(message)) {
    if (_report_timer->isRunning()) {
      // update the timer
      _report_timer->update();
      // if it is not the time yet to report a new measure, just return
      if (! _report_timer->isOver()) return;
    }
    if (_force_update_timer->isRunning()) _force_update_timer->update();
  }
DV's avatar
DV committed
362
363
  #if POWER_MANAGER == 1
    // turn the sensor on
DV's avatar
DV committed
364
    if (_auto_power_pins) powerOn();
DV's avatar
DV committed
365
366
367
368
369
370
371
  #endif
  // for numeric sensor requiring multiple samples, keep track of the total
  float total = 0;
  // keep track of the number of cycles since the last update
  // 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
372
    if (_isReceive(message)) {
DV's avatar
DV committed
373
374
375
      // we've been called from receive(), pass the message along
      onReceive(message);
    }
376
377
378
379
    else {
      // we'be been called from loop()
      onLoop();
    }
DV's avatar
DV committed
380
381
382
383
    // 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
384
    if (_samples_interval > 0) wait(_samples_interval);
DV's avatar
DV committed
385
  }
386
  // process the result and send a response back
DV's avatar
DV committed
387
388
389
390
  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
391
    if (_isReceive(message) || _isWorthSending(avg != _last_value_int))  {
DV's avatar
DV committed
392
393
394
395
396
397
398
399
      _last_value_int = avg;
      _send(_msg.set(avg));
    }
  }
  // process a float value
  else if (_value_type == TYPE_FLOAT && total > -1) {
    // calculate the average value of the samples
    float avg = total / _samples;
400
401
    // report the value back
    if (_isReceive(message) || _isWorthSending(avg != _last_value_float))  {
DV's avatar
DV committed
402
403
404
405
406
407
408
      _last_value_float = avg;
      _send(_msg.set(avg, _float_precision));
    }
  }
  // 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
409
    if (_isReceive(message) || _isWorthSending(strcmp(_value_string, _last_value_string) != 0))  {
DV's avatar
DV committed
410
411
412
413
414
415
      _last_value_string = _value_string;
      _send(_msg.set(_value_string));
    }
  }
  // turn the sensor off
  #if POWER_MANAGER == 1
DV's avatar
DV committed
416
    if (_auto_power_pins) powerOff();
DV's avatar
DV committed
417
  #endif
418
419
  // restart the report timer if over
  if (! _isReceive(message) && _report_timer->isRunning() && _report_timer->isOver()) _report_timer->restart();
DV's avatar
DV committed
420
421
422
423
424
}

// receive a message from the radio network
void Sensor::receive(const MyMessage &message) {
  // return if not for this sensor
425
426
427
428
429
430
431
432
433
434
435
436
437
  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;
438
  // a request would make the sensor executing its main task passing along the message
DV's avatar
DV committed
439
440
441
  loop(message);
}

442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
// 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 8: setForceUpdateCycles(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 15: setReportIntervalCycles(request.getValueInt()); break;
    case 16: setReportIntervalMinutes(request.getValueInt()); break;
    default: return;
  }
  _send(_msg_service.set(function));
}

DV's avatar
DV committed
469
470
471
// send a message to the network
void Sensor::_send(MyMessage & message) {
  // send the message, multiple times if requested
472
  for (int i = 0; i < _node_manager->getRetries(); i++) {
DV's avatar
DV committed
473
    // if configured, sleep beetween each send
474
    if (_node_manager->getSleepBetweenSend() > 0) sleep(_node_manager->getSleepBetweenSend());
DV's avatar
DV committed
475
    #if DEBUG == 1
476
      Serial.print(F("SEND D="));
DV's avatar
DV committed
477
      Serial.print(message.destination);
478
      Serial.print(F(" I="));
DV's avatar
DV committed
479
      Serial.print(message.sensor);
480
      Serial.print(F(" C="));
DV's avatar
DV committed
481
      Serial.print(message.getCommand());
482
      Serial.print(F(" T="));
DV's avatar
DV committed
483
      Serial.print(message.type);
484
      Serial.print(F(" S="));
DV's avatar
DV committed
485
      Serial.print(message.getString());
486
      Serial.print(F(" I="));
DV's avatar
DV committed
487
      Serial.print(message.getInt());
488
      Serial.print(F(" F="));
DV's avatar
DV committed
489
490
      Serial.println(message.getFloat());
    #endif
491
    send(message,_node_manager->getAck());
DV's avatar
DV committed
492
493
494
  }
}

495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
// 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;
}

516
#if MODULE_ANALOG_INPUT == 1
DV's avatar
DV committed
517
518
519
520
521
/*
   SensorAnalogInput
*/

// contructor
522
SensorAnalogInput::SensorAnalogInput(NodeManager* node_manager, int child_id, int pin): Sensor(node_manager, child_id, pin) {
DV's avatar
DV committed
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
}

// 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;
}

542
// what to do during before
DV's avatar
DV committed
543
544
545
546
547
void SensorAnalogInput::onBefore() {
  // prepare the pin for input
  pinMode(_pin, INPUT);
}

548
// what to do during setup
user2684's avatar
user2684 committed
549
550
551
void SensorAnalogInput::onSetup() {
}

552
// what to do during loop
DV's avatar
DV committed
553
554
555
556
557
558
559
void SensorAnalogInput::onLoop() {
  // read the input
  int adc = _getAnalogRead();
  // calculate the percentage
  int percentage = 0;
  if (_output_percentage) percentage = _getPercentage(adc);
  #if DEBUG == 1
560
    Serial.print(F("A-IN I="));
DV's avatar
DV committed
561
    Serial.print(_child_id);
562
    Serial.print(F(" V="));
DV's avatar
DV committed
563
    Serial.print(adc);
564
    Serial.print(F(" %="));
DV's avatar
DV committed
565
566
567
568
569
570
    Serial.println(percentage);
  #endif
  // store the result
  _value_int = _output_percentage ? percentage : adc;
}

571
// what to do during loop
DV's avatar
DV committed
572
void SensorAnalogInput::onReceive(const MyMessage & message) {
573
  if (message.getCommand() == C_REQ) onLoop();
DV's avatar
DV committed
574
575
}

576
577
578
579
580
581
582
583
584
585
586
587
588
589
// 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));
}

DV's avatar
DV committed
590
591
// read the analog input
int SensorAnalogInput::_getAnalogRead() {
592
593
594
595
596
597
598
  #ifndef MY_GATEWAY_ESP8266
    // set the reference
    if (_reference != -1) {
      analogReference(_reference);
      wait(100);
    }
  #endif
DV's avatar
DV committed
599
600
601
602
603
604
605
606
607
  // 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
608
609
  // restore the original value
  if (_reverse) value = 1024 - value;
DV's avatar
DV committed
610
611
  // scale the percentage based on the range provided
  float percentage = ((value - _range_min) / (_range_max - _range_min)) * 100;
DV's avatar
DV committed
612
  if (_reverse) percentage = 100 - percentage;
DV's avatar
DV committed
613
614
615
616
617
618
619
620
621
622
  if (percentage > 100) percentage = 100;
  if (percentage < 0) percentage = 0;
  return (int)percentage;
}

/*
   SensorLDR
*/

// contructor
623
SensorLDR::SensorLDR(NodeManager* node_manager, int child_id, int pin): SensorAnalogInput(node_manager, child_id, pin) {
DV's avatar
DV committed
624
625
626
627
628
629
630
631
632
633
634
  // set presentation and type and reverse (0: no light, 100: max light)
  setPresentation(S_LIGHT_LEVEL);
  setType(V_LIGHT_LEVEL);
  setReverse(true);
}

/*
   SensorThermistor
*/

// contructor
635
SensorThermistor::SensorThermistor(NodeManager* node_manager, int child_id, int pin): Sensor(node_manager, child_id, pin) {
DV's avatar
DV committed
636
637
638
639
640
641
642
  // set presentation, type and value type
  setPresentation(S_TEMP);
  setType(V_TEMP);
  setValueType(TYPE_FLOAT);
}

// setter/getter
643
void SensorThermistor::setNominalResistor(long value) {
DV's avatar
DV committed
644
645
646
647
648
649
650
651
  _nominal_resistor = value;
}
void SensorThermistor::setNominalTemperature(int value) {
  _nominal_temperature = value;
}
void SensorThermistor::setBCoefficient(int value) {
  _b_coefficient = value;
}
652
void SensorThermistor::setSeriesResistor(long value) {
DV's avatar
DV committed
653
654
655
656
657
658
  _series_resistor = value;
}
void SensorThermistor::setOffset(float value) {
  _offset = value;
}

659
// what to do during before
DV's avatar
DV committed
660
661
662
663
664
void SensorThermistor::onBefore() {
  // set the pin as input
  pinMode(_pin, INPUT);
}

665
// what to do during setup
user2684's avatar
user2684 committed
666
667
668
void SensorThermistor::onSetup() {
}

669
// what to do during loop
DV's avatar
DV committed
670
671
672
673
674
675
676
677
678
679
680
681
682
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
683
  temperature = _node_manager->celsiusToFahrenheit(temperature);
DV's avatar
DV committed
684
  #if DEBUG == 1
685
    Serial.print(F("THER I="));
DV's avatar
DV committed
686
    Serial.print(_child_id);
687
    Serial.print(F(" V="));
DV's avatar
DV committed
688
    Serial.print(adc);
689
    Serial.print(F(" T="));
690
    Serial.print(temperature);
DV's avatar
DV committed
691
692
693
694
695
  #endif
  // store the value
  _value_float = temperature;
}

696
// what to do as the main task when receiving a message
DV's avatar
DV committed
697
void SensorThermistor::onReceive(const MyMessage & message) {
698
  if (message.getCommand() == C_REQ) onLoop();
DV's avatar
DV committed
699
700
}

701
702
703
704
705
706
707
708
709
710
711
712
713
// 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));
}
714
715
716
717
718
719

/*
   SensorML8511
*/

// contructor
720
SensorML8511::SensorML8511(NodeManager* node_manager, int child_id, int pin): Sensor(node_manager, child_id, pin) {
721
722
723
724
725
726
  // set presentation, type and value type
  setPresentation(S_UV);
  setType(V_UV);
  setValueType(TYPE_FLOAT);
}

727
// what to do during before
728
729
730
731
732
void SensorML8511::onBefore() {
  // set the pin as input
  pinMode(_pin, INPUT);
}

733
// what to do during setup
734
735
736
void SensorML8511::onSetup() {
}

737
// what to do during loop
738
739
740
void SensorML8511::onLoop() {
  // read the voltage 
  int uvLevel = analogRead(_pin);
741
  int refLevel = _node_manager->getVcc()*1024/3.3;
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
  //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;
}

758
// what to do as the main task when receiving a message
759
void SensorML8511::onReceive(const MyMessage & message) {
760
  if (message.getCommand() == C_REQ) onLoop();
761
762
}

763
764
765
766
// what to do when receiving a remote message
void SensorML8511::onProcess(Request & request) {
}

767
768
769
770
771
// 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;
}

772
773
774
775
776
/*
   SensorACS712
*/

// contructor
777
SensorACS712::SensorACS712(NodeManager* node_manager, int child_id, int pin): Sensor(node_manager, child_id, pin) {
778
779
780
781
782
783
784
785
786
787
788
789
790
791
  // 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;
}

792
// what to do during before
793
794
795
796
797
void SensorACS712::onBefore() {
  // set the pin as input
  pinMode(_pin, INPUT);
}

798
// what to do during setup
799
800
801
void SensorACS712::onSetup() {
}

802
// what to do during loop
803
804
805
806
807
808
809
810
811
812
813
814
815
816
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
}

817
// what to do as the main task when receiving a message
818
819
820
821
void SensorACS712::onReceive(const MyMessage & message) {
  if (message.getCommand() == C_REQ) onLoop();
}

822
823
824
825
826
827
828
829
830
831
832
// 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));
}

833
834
835
836
837
/*
   SensorRainGauge
*/

// contructor
838
SensorRainGauge::SensorRainGauge(NodeManager* node_manager, int child_id, int pin): Sensor(node_manager,child_id, pin) {
839
840
841
842
  // set presentation, type and value type
  setPresentation(S_RAIN);
  setType(V_RAIN);
  setValueType(TYPE_FLOAT);
843
844
  // create the timer
  _timer = new Timer(node_manager);
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
}

// initialize static variables
long SensorRainGauge::_last_tip = 0;
long SensorRainGauge::_count = 0;

// setter/getter
void SensorRainGauge::setReportInterval(int value) {
  _report_interval = value;
}
void SensorRainGauge::setSingleTip(float value) {
  _single_tip = value;
}

// what to do during before
void SensorRainGauge::onBefore() {
  // set the pin as input and enabled pull up
  pinMode(_pin, INPUT_PULLUP);
  // attach to the pin's interrupt and execute the routine on falling
  attachInterrupt(digitalPinToInterrupt(_pin), _onTipped, FALLING);
865
866
  // start the timer
  _timer->start(_report_interval,MINUTES);
867
868
869
870
871
872
873
874
}

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

// what to do when when receiving an interrupt
void SensorRainGauge::_onTipped() {
875
  long now = millis();
876
  // on tipping, two consecutive interrupts are received, ignore the second one
877
  if ( (now - _last_tip > 100) || (now < _last_tip) ){
878
879
880
881
882
883
    // increase the counter
    _count++;
    #if DEBUG == 1
      Serial.println(F("RAIN+"));
    #endif
  }
884
  _last_tip = now;
885
886
887
888
889
890
}

// what to do during loop
void SensorRainGauge::onLoop() {
  // avoid reporting the same value multiple times
  _value_float = -1;
891
892
893
  _timer->update();
  // time to report 
  if (_timer->isOver()) {
894
    // report the total amount of rain for the last period
895
    _value_float = _count * _single_tip;
896
897
898
899
900
901
    #if DEBUG == 1
      Serial.print(F("RAIN I="));
      Serial.print(_child_id);
      Serial.print(F(" T="));
      Serial.println(_value_float);
    #endif
902
903
    // reset the timer
    _timer->restart();
904
905
906
907
908
909
910
  }
}

// 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
911
    _value_float = _count * _single_tip;    
912
913
914
  }
}

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

926
927
928
929
930
/*
   SensorRain
*/

// contructor
931
SensorRain::SensorRain(NodeManager* node_manager, int child_id, int pin): SensorAnalogInput(node_manager,child_id, pin) {
932
933
934
935
936
937
938
939
940
941
942
943
944
945
  // set presentation and type and reverse
  setPresentation(S_RAIN);
  setType(V_RAINRATE);
  setReference(DEFAULT);
  setOutputPercentage(true);
  setReverse(true);
  setRangeMin(100);
}

/*
   SensorSoilMoisture
*/

// contructor
946
SensorSoilMoisture::SensorSoilMoisture(NodeManager* node_manager, int child_id, int pin): SensorAnalogInput(node_manager, child_id, pin) {
947
948
949
950
951
952
953
954
955
  // set presentation and type and reverse
  setPresentation(S_MOISTURE);
  setType(V_LEVEL);
  setReference(DEFAULT);
  setOutputPercentage(true);
  setReverse(true);
  setRangeMin(100);
}

956
#endif
957

958
#if MODULE_DIGITAL_INPUT == 1
DV's avatar
DV committed
959
960
961
962
963
/*
   SensorDigitalInput
*/

// contructor
964
SensorDigitalInput::SensorDigitalInput(NodeManager* node_manager, int child_id, int pin): Sensor(node_manager,child_id, pin) {
DV's avatar
DV committed
965
966
}

967
// what to do during before
DV's avatar
DV committed
968
969
970
971
972
void SensorDigitalInput::onBefore() {
  // set the pin for input
  pinMode(_pin, INPUT);
}

973
// what to do during setup
user2684's avatar
user2684 committed
974
975
976
void SensorDigitalInput::onSetup() {
}

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

993
// what to do as the main task when receiving a message
DV's avatar
DV committed
994
void SensorDigitalInput::onReceive(const MyMessage & message) {
995
  if (message.getCommand() == C_REQ) onLoop();
DV's avatar
DV committed
996
997
}

998
999
1000
// what to do when receiving a remote message
void SensorDigitalInput::onProcess(Request & request) {
}
For faster browsing, not all history is shown. View entire blame