diff --git a/code/espurna/filters/BaseFilter.h b/code/espurna/filters/BaseFilter.h index d11e99d8..bef36c65 100644 --- a/code/espurna/filters/BaseFilter.h +++ b/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 // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/filters/MaxFilter.h b/code/espurna/filters/MaxFilter.h index 006b163f..58f6ec69 100644 --- a/code/espurna/filters/MaxFilter.h +++ b/code/espurna/filters/MaxFilter.h @@ -1,5 +1,6 @@ // ----------------------------------------------------------------------------- -// Aggregator base class +// Max Filter +// Copyright (C) 2017 by Xose Pérez // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/filters/MedianFilter.h b/code/espurna/filters/MedianFilter.h index e85e3793..005788fd 100644 --- a/code/espurna/filters/MedianFilter.h +++ b/code/espurna/filters/MedianFilter.h @@ -1,5 +1,6 @@ // ----------------------------------------------------------------------------- // Median Filter +// Copyright (C) 2017 by Xose Pérez // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/filters/MovingAverageFilter.h b/code/espurna/filters/MovingAverageFilter.h index f6eb40d3..7855ff22 100644 --- a/code/espurna/filters/MovingAverageFilter.h +++ b/code/espurna/filters/MovingAverageFilter.h @@ -1,5 +1,6 @@ // ----------------------------------------------------------------------------- -// Aggregator Moving Average +// Moving Average Filter +// Copyright (C) 2017 by Xose Pérez // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/sensors/AnalogSensor.h b/code/espurna/sensors/AnalogSensor.h index 345b609f..3d641ce8 100644 --- a/code/espurna/sensors/AnalogSensor.h +++ b/code/espurna/sensors/AnalogSensor.h @@ -1,5 +1,6 @@ // ----------------------------------------------------------------------------- -// DHT Sensor +// Analog Sensor (maps to an analogRead) +// Copyright (C) 2017 by Xose Pérez // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/sensors/BMX280Sensor.h b/code/espurna/sensors/BMX280Sensor.h index 9965729b..4e2683af 100644 --- a/code/espurna/sensors/BMX280Sensor.h +++ b/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 // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/sensors/BaseSensor.h b/code/espurna/sensors/BaseSensor.h index c116a8df..5c96f17b 100644 --- a/code/espurna/sensors/BaseSensor.h +++ b/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 // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/sensors/DHTSensor.h b/code/espurna/sensors/DHTSensor.h index 2892c930..a72c6e57 100644 --- a/code/espurna/sensors/DHTSensor.h +++ b/code/espurna/sensors/DHTSensor.h @@ -1,5 +1,6 @@ // ----------------------------------------------------------------------------- -// DHT Sensor +// DHTXX Sensor +// Copyright (C) 2017 by Xose Pérez // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/sensors/DallasSensor.h b/code/espurna/sensors/DallasSensor.h index 857b9892..8f46bdc2 100644 --- a/code/espurna/sensors/DallasSensor.h +++ b/code/espurna/sensors/DallasSensor.h @@ -1,5 +1,7 @@ // ----------------------------------------------------------------------------- -// DHT Sensor +// Dallas OneWire Sensor +// Uses OneWire library +// Copyright (C) 2017 by Xose Pérez // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/sensors/DigitalSensor.h b/code/espurna/sensors/DigitalSensor.h index e01ea8ea..95e7e35e 100644 --- a/code/espurna/sensors/DigitalSensor.h +++ b/code/espurna/sensors/DigitalSensor.h @@ -1,5 +1,6 @@ // ----------------------------------------------------------------------------- -// DHT Sensor +// Digital Sensor (maps to a digitalRead) +// Copyright (C) 2017 by Xose Pérez // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/sensors/EmonADC121Sensor.h b/code/espurna/sensors/EmonADC121Sensor.h index ae44d91e..2ee410dd 100644 --- a/code/espurna/sensors/EmonADC121Sensor.h +++ b/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 // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/sensors/EmonADS1X15Sensor.h b/code/espurna/sensors/EmonADS1X15Sensor.h index 65ac4e55..3a1153f6 100644 --- a/code/espurna/sensors/EmonADS1X15Sensor.h +++ b/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 // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/sensors/EmonAnalogSensor.h b/code/espurna/sensors/EmonAnalogSensor.h index 8e83dee4..4da34426 100644 --- a/code/espurna/sensors/EmonAnalogSensor.h +++ b/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 // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/sensors/EmonSensor.h b/code/espurna/sensors/EmonSensor.h index 07b5fd48..2a84f939 100644 --- a/code/espurna/sensors/EmonSensor.h +++ b/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 // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/sensors/EventSensor.h b/code/espurna/sensors/EventSensor.h index f3581ffc..9defb28c 100644 --- a/code/espurna/sensors/EventSensor.h +++ b/code/espurna/sensors/EventSensor.h @@ -1,5 +1,6 @@ // ----------------------------------------------------------------------------- -// DHT Sensor +// Event Counter Sensor +// Copyright (C) 2017 by Xose Pérez // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/sensors/MHZ19Sensor.h b/code/espurna/sensors/MHZ19Sensor.h index 3e950c42..a4fa6cc4 100644 --- a/code/espurna/sensors/MHZ19Sensor.h +++ b/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 // ----------------------------------------------------------------------------- #pragma once diff --git a/code/espurna/sensors/PMSX003Sensor.h b/code/espurna/sensors/PMSX003Sensor.h index f0a5a118..ca5a9707 100644 --- a/code/espurna/sensors/PMSX003Sensor.h +++ b/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; diff --git a/code/espurna/sensors/SI7021Sensor.h b/code/espurna/sensors/SI7021Sensor.h index d995cf78..050d1e03 100644 --- a/code/espurna/sensors/SI7021Sensor.h +++ b/code/espurna/sensors/SI7021Sensor.h @@ -1,5 +1,6 @@ // ----------------------------------------------------------------------------- -// DHT Sensor +// SI7021 / HTU21D Sensor over I2C +// Copyright (C) 2017 by Xose Pérez // ----------------------------------------------------------------------------- #pragma once