Headers for Sensor and Filter classes

code/espurna/filters/BaseFilter.h

@@ -1,5 +1,6 @@
 // -----------------------------------------------------------------------------
-// Aggregator base class
+// Base Filter (other filters inherit from this)
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/filters/MaxFilter.h

@@ -1,5 +1,6 @@
 // -----------------------------------------------------------------------------
-// Aggregator base class
+// Max Filter
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/filters/MedianFilter.h

@@ -1,5 +1,6 @@
 // -----------------------------------------------------------------------------
 // Median Filter
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/filters/MovingAverageFilter.h

@@ -1,5 +1,6 @@
 // -----------------------------------------------------------------------------
-// Aggregator Moving Average
+// Moving Average Filter
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/sensors/AnalogSensor.h

@@ -1,5 +1,6 @@
 // -----------------------------------------------------------------------------
-// DHT Sensor
+// Analog Sensor (maps to an analogRead)
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/sensors/BMX280Sensor.h

@@ -1,5 +1,7 @@
 // -----------------------------------------------------------------------------
-// BMX280 Sensor
+// BME280/BMP280 Sensor over I2C
+// Uses SparkFun BME280 library
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/sensors/BaseSensor.h

@@ -1,5 +1,6 @@
 // -----------------------------------------------------------------------------
-// Median Filter
+// Abstract sensor class (other sensor classes extend this class)
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/sensors/DHTSensor.h

@@ -1,5 +1,6 @@
 // -----------------------------------------------------------------------------
-// DHT Sensor
+// DHTXX Sensor
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/sensors/DallasSensor.h

@@ -1,5 +1,7 @@
 // -----------------------------------------------------------------------------
-// DHT Sensor
+// Dallas OneWire Sensor
+// Uses OneWire library
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/sensors/DigitalSensor.h

@@ -1,5 +1,6 @@
 // -----------------------------------------------------------------------------
-// DHT Sensor
+// Digital Sensor (maps to a digitalRead)
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/sensors/EmonADC121Sensor.h

@@ -1,5 +1,6 @@
 // -----------------------------------------------------------------------------
-// Energy monitor sensor
+// ADS121-based Energy Monitor Sensor over I2C
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/sensors/EmonADS1X15Sensor.h

@@ -1,5 +1,6 @@
 // -----------------------------------------------------------------------------
-// Energy monitor sensor
+// ADS1X15-based Energy Monitor Sensor over I2C
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/sensors/EmonAnalogSensor.h

@@ -1,5 +1,6 @@
 // -----------------------------------------------------------------------------
-// Eergy monitor sensor
+// Energy Monitor Sensor using builtin ADC
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/sensors/EmonSensor.h

@@ -1,5 +1,6 @@
 // -----------------------------------------------------------------------------
-// Eergy monitor sensor
+// Abstract Energy Monitor Sensor (other EMON sensors extend this class)
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/sensors/EventSensor.h

@@ -1,5 +1,6 @@
 // -----------------------------------------------------------------------------
-// DHT Sensor
+// Event Counter Sensor
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/sensors/MHZ19Sensor.h

@@ -2,6 +2,8 @@
 // MHZ19 CO2 sensor
 // Based on: https://github.com/nara256/mhz19_uart
 // http://www.winsen-sensor.com/d/files/infrared-gas-sensor/mh-z19b-co2-ver1_0.pdf
+// Uses SoftwareSerial library
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once

code/espurna/sensors/PMSX003Sensor.h

@@ -1,5 +1,7 @@
 // -----------------------------------------------------------------------------
-// PMSX003 Dust sensor
+// PMSX003 Dust Sensor
+// Uses SoftwareSerial library
+// Contribution by Òscar Rovira López
 // -----------------------------------------------------------------------------
 
 #pragma once
@@ -86,7 +88,7 @@ class PMSX003Sensor : public BaseSensor {
             _error = SENSOR_ERROR_OUT_OF_RANGE;
             return 0;
         }
-    
+
     protected:
         unsigned int _pm1dot0;
         unsigned int _pm2dot5;

code/espurna/sensors/SI7021Sensor.h

@@ -1,5 +1,6 @@
 // -----------------------------------------------------------------------------
-// DHT Sensor
+// SI7021 / HTU21D Sensor over I2C
+// Copyright (C) 2017 by Xose Pérez <xose dot perez at gmail dot com>
 // -----------------------------------------------------------------------------
 
 #pragma once