// ============================================================================= // SENSORS - General data // ============================================================================= #define SENSOR_DEBUG 0 // Debug sensors #define SENSOR_READ_INTERVAL 6 // Read data from sensors every 6 seconds #define SENSOR_READ_MIN_INTERVAL 6 // Minimum read interval #define SENSOR_READ_MAX_INTERVAL 3600 // Maximum read interval #define SENSOR_INIT_INTERVAL 10000 // Try to re-init non-ready sensors every 10s #define SENSOR_REPORT_EVERY 10 // Report every this many readings #define SENSOR_REPORT_MIN_EVERY 1 // Minimum every value #define SENSOR_REPORT_MAX_EVERY 12 // Maximum #define SENSOR_USE_INDEX 0 // Use the index in topic (i.e. temperature/0) // even if just one sensor (0 for backwards compatibility) #ifndef SENSOR_POWER_CHECK_STATUS #define SENSOR_POWER_CHECK_STATUS 1 // If set to 1 the reported power/current/energy will be 0 if the relay[0] is OFF #endif #ifndef SENSOR_TEMPERATURE_CORRECTION #define SENSOR_TEMPERATURE_CORRECTION 0.0 // Offset correction #endif #ifndef TEMPERATURE_MIN_CHANGE #define TEMPERATURE_MIN_CHANGE 0.0 // Minimum temperature change to report #endif #ifndef SENSOR_HUMIDITY_CORRECTION #define SENSOR_HUMIDITY_CORRECTION 0.0 // Offset correction #endif #ifndef HUMIDITY_MIN_CHANGE #define HUMIDITY_MIN_CHANGE 0 // Minimum humidity change to report #endif #define SENSOR_PUBLISH_ADDRESSES 0 // Publish sensor addresses #define SENSOR_ADDRESS_TOPIC "address" // Topic to publish sensor addresses #ifndef SENSOR_TEMPERATURE_UNITS #define SENSOR_TEMPERATURE_UNITS TMP_CELSIUS // Temperature units (TMP_CELSIUS | TMP_FAHRENHEIT) #endif #ifndef SENSOR_ENERGY_UNITS #define SENSOR_ENERGY_UNITS ENERGY_JOULES // Energy units (ENERGY_JOULES | ENERGY_KWH) #endif #ifndef SENSOR_POWER_UNITS #define SENSOR_POWER_UNITS POWER_WATTS // Power units (POWER_WATTS | POWER_KILOWATTS) #endif // ============================================================================= // Specific data for each sensor // ============================================================================= //------------------------------------------------------------------------------ // AM2320 Humidity & Temperature sensor over I2C // Enable support by passing AM2320_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef AM2320_SUPPORT #define AM2320_SUPPORT 0 #endif #ifndef AM2320_ADDRESS #define AM2320_ADDRESS 0x00 // 0x00 means auto #endif //------------------------------------------------------------------------------ // Analog sensor // Enable support by passing ANALOG_SUPPORT=1 build flag //-------------------------------------------------------------------------------- #ifndef ANALOG_SUPPORT #define ANALOG_SUPPORT 0 #endif #ifndef ANALOG_SAMPLES #define ANALOG_SAMPLES 10 // Number of samples #endif #ifndef ANALOG_DELAY #define ANALOG_DELAY 0 // Delay between samples in micros #endif //------------------------------------------------------------------------------ // BH1750 // Enable support by passing BH1750_SUPPORT=1 build flag // http://www.elechouse.com/elechouse/images/product/Digital%20light%20Sensor/bh1750fvi-e.pdf //------------------------------------------------------------------------------ #ifndef BH1750_SUPPORT #define BH1750_SUPPORT 0 #endif #ifndef BH1750_ADDRESS #define BH1750_ADDRESS 0x00 // 0x00 means auto #endif #define BH1750_MODE BH1750_CONTINUOUS_HIGH_RES_MODE //------------------------------------------------------------------------------ // BME280/BMP280 // Enable support by passing BMX280_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef BMX280_SUPPORT #define BMX280_SUPPORT 0 #endif #ifndef BMX280_ADDRESS #define BMX280_ADDRESS 0x00 // 0x00 means auto #endif #define BMX280_MODE 1 // 0 for sleep mode, 1 or 2 for forced mode, 3 for normal mode #define BMX280_STANDBY 0 // 0 for 0.5ms, 1 for 62.5ms, 2 for 125ms // 3 for 250ms, 4 for 500ms, 5 for 1000ms // 6 for 10ms, 7 for 20ms #define BMX280_FILTER 0 // 0 for OFF, 1 for 2 values, 2 for 4 values, 3 for 8 values and 4 for 16 values #define BMX280_TEMPERATURE 1 // Oversampling for temperature (set to 0 to disable magnitude) #define BMX280_HUMIDITY 1 // Oversampling for humidity (set to 0 to disable magnitude, only for BME280) #define BMX280_PRESSURE 1 // Oversampling for pressure (set to 0 to disable magnitude) //------------------------------------------------------------------------------ // Dallas OneWire temperature sensors // Enable support by passing DALLAS_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef DALLAS_SUPPORT #define DALLAS_SUPPORT 0 #endif #ifndef DALLAS_PIN #define DALLAS_PIN 14 #endif #define DALLAS_RESOLUTION 9 // Not used atm #define DALLAS_READ_INTERVAL 2000 // Force sensor read & cache every 2 seconds //------------------------------------------------------------------------------ // DHTXX temperature/humidity sensor // Enable support by passing DHT_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef DHT_SUPPORT #define DHT_SUPPORT 0 #endif #ifndef DHT_PIN #define DHT_PIN 14 #endif #ifndef DHT_TYPE #define DHT_TYPE DHT_CHIP_DHT22 #endif //------------------------------------------------------------------------------ // CSE7766 based power sensor // Enable support by passing CSE7766_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef CSE7766_SUPPORT #define CSE7766_SUPPORT 0 #endif #ifndef CSE7766_PIN #define CSE7766_PIN 1 // TX pin from the CSE7766 #endif #ifndef CSE7766_PIN_INVERSE #define CSE7766_PIN_INVERSE 0 // Signal is inverted #endif #define CSE7766_SYNC_INTERVAL 300 // Safe time between transmissions (ms) #define CSE7766_BAUDRATE 4800 // UART baudrate #define CSE7766_V1R 1.0 // 1mR current resistor #define CSE7766_V2R 1.0 // 1M voltage resistor //------------------------------------------------------------------------------ // Digital sensor // Enable support by passing DIGITAL_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef DIGITAL_SUPPORT #define DIGITAL_SUPPORT 0 #endif #ifndef DIGITAL_PIN #define DIGITAL_PIN 2 #endif #ifndef DIGITAL_PIN_MODE #define DIGITAL_PIN_MODE INPUT_PULLUP #endif #ifndef DIGITAL_DEFAULT_STATE #define DIGITAL_DEFAULT_STATE 1 #endif //------------------------------------------------------------------------------ // ECH1560 based power sensor // Enable support by passing ECH1560_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef ECH1560_SUPPORT #define ECH1560_SUPPORT 0 #endif #ifndef ECH1560_CLK_PIN #define ECH1560_CLK_PIN 4 // CLK pin for the ECH1560 #endif #ifndef ECH1560_MISO_PIN #define ECH1560_MISO_PIN 5 // MISO pin for the ECH1560 #endif #ifndef ECH1560_INVERTED #define ECH1560_INVERTED 0 // Signal is inverted #endif //------------------------------------------------------------------------------ // Energy Monitor general settings //------------------------------------------------------------------------------ #define EMON_MAX_SAMPLES 1000 // Max number of samples to get #define EMON_MAX_TIME 250 // Max time in ms to sample #define EMON_FILTER_SPEED 512 // Mobile average filter speed #define EMON_MAINS_VOLTAGE 230 // Mains voltage #define EMON_REFERENCE_VOLTAGE 3.3 // Reference voltage of the ADC #define EMON_CURRENT_RATIO 30 // Current ratio in the clamp (30V/1A) #define EMON_REPORT_CURRENT 0 // Report current #define EMON_REPORT_POWER 1 // Report power #define EMON_REPORT_ENERGY 1 // Report energy //------------------------------------------------------------------------------ // Energy Monitor based on ADC121 // Enable support by passing EMON_ADC121_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef EMON_ADC121_SUPPORT #define EMON_ADC121_SUPPORT 0 // Do not build support by default #endif #define EMON_ADC121_I2C_ADDRESS 0x00 // 0x00 means auto //------------------------------------------------------------------------------ // Energy Monitor based on ADS1X15 // Enable support by passing EMON_ADS1X15_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef EMON_ADS1X15_SUPPORT #define EMON_ADS1X15_SUPPORT 0 // Do not build support by default #endif #define EMON_ADS1X15_I2C_ADDRESS 0x00 // 0x00 means auto #define EMON_ADS1X15_TYPE ADS1X15_CHIP_ADS1115 #define EMON_ADS1X15_GAIN ADS1X15_REG_CONFIG_PGA_4_096V #define EMON_ADS1X15_MASK 0x0F // A0=1 A1=2 A2=4 A3=8 //------------------------------------------------------------------------------ // Energy Monitor based on interval analog GPIO // Enable support by passing EMON_ANALOG_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef EMON_ANALOG_SUPPORT #define EMON_ANALOG_SUPPORT 0 // Do not build support by default #endif //------------------------------------------------------------------------------ // Counter sensor // Enable support by passing EVENTS_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef EVENTS_SUPPORT #define EVENTS_SUPPORT 0 // Do not build with counter support by default #endif #ifndef EVENTS_PIN #define EVENTS_PIN 2 // GPIO to monitor #endif #ifndef EVENTS_PIN_MODE #define EVENTS_PIN_MODE INPUT // INPUT, INPUT_PULLUP #endif #ifndef EVENTS_INTERRUPT_MODE #define EVENTS_INTERRUPT_MODE RISING // RISING, FALLING, BOTH #endif #define EVENTS_DEBOUNCE 50 // Do not register events within less than 50 millis //------------------------------------------------------------------------------ // Geiger sensor // Enable support by passing GEIGER_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef GEIGER_SUPPORT #define GEIGER_SUPPORT 0 // Do not build with geiger support by default #endif #ifndef GEIGER_PIN #define GEIGER_PIN D1 // GPIO to monitor "D1" => "GPIO5" #endif #ifndef GEIGER_PIN_MODE #define GEIGER_PIN_MODE INPUT // INPUT, INPUT_PULLUP #endif #ifndef GEIGER_INTERRUPT_MODE #define GEIGER_INTERRUPT_MODE RISING // RISING, FALLING, BOTH #endif #define GEIGER_DEBOUNCE 25 // Do not register events within less than 25 millis. // Value derived here: Debounce time 25ms, because https://github.com/Trickx/espurna/wiki/Geiger-counter #define GEIGER_CPM2SIEVERT 240 // CPM to µSievert per hour conversion factor // Typically the literature uses the invers, but I find an integer type more convienient. #define GEIGER_REPORT_SIEVERTS 1 // Enabler for local dose rate reports in µSv/h #define GEIGER_REPORT_CPM 1 // Enabler for local dose rate reports in counts per minute //------------------------------------------------------------------------------ // GUVAS12SD UV Sensor (analog) // Enable support by passing GUVAS12SD_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef GUVAS12SD_SUPPORT #define GUVAS12SD_SUPPORT 0 #endif #ifndef GUVAS12SD_PIN #define GUVAS12SD_PIN 14 #endif //------------------------------------------------------------------------------ // HC-SR04 // Enable support by passing HCSR04_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef HCSR04_SUPPORT #define HCSR04_SUPPORT 0 #endif #ifndef HCSR04_TRIGGER #define HCSR04_TRIGGER 12 // GPIO for the trigger pin (output) #endif #ifndef HCSR04_ECHO #define HCSR04_ECHO 14 // GPIO for the echo pin (input) #endif //------------------------------------------------------------------------------ // HLW8012 Energy monitor IC // Enable support by passing HLW8012_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef HLW8012_SUPPORT #define HLW8012_SUPPORT 0 #endif #ifndef HLW8012_SEL_PIN #define HLW8012_SEL_PIN 5 #endif #ifndef HLW8012_CF1_PIN #define HLW8012_CF1_PIN 13 #endif #ifndef HLW8012_CF_PIN #define HLW8012_CF_PIN 14 #endif #ifndef HLW8012_SEL_CURRENT #define HLW8012_SEL_CURRENT HIGH // SEL pin to HIGH to measure current #endif #ifndef HLW8012_CURRENT_R #define HLW8012_CURRENT_R 0.001 // Current resistor #endif #ifndef HLW8012_VOLTAGE_R_UP #define HLW8012_VOLTAGE_R_UP ( 5 * 470000 ) // Upstream voltage resistor #endif #ifndef HLW8012_VOLTAGE_R_DOWN #define HLW8012_VOLTAGE_R_DOWN ( 1000 ) // Downstream voltage resistor #endif #ifndef HLW8012_CURRENT_RATIO #define HLW8012_CURRENT_RATIO 0 // Set to 0 to use factory defaults #endif #ifndef HLW8012_VOLTAGE_RATIO #define HLW8012_VOLTAGE_RATIO 0 // Set to 0 to use factory defaults #endif #ifndef HLW8012_POWER_RATIO #define HLW8012_POWER_RATIO 0 // Set to 0 to use factory defaults #endif #ifndef HLW8012_USE_INTERRUPTS #define HLW8012_USE_INTERRUPTS 1 // Use interrupts to trap HLW8012 signals #endif #ifndef HLW8012_INTERRUPT_ON #define HLW8012_INTERRUPT_ON CHANGE // When to trigger the interrupt // Use CHANGE for HLW8012 // Use FALLING for BL0937 / HJL0 #endif //------------------------------------------------------------------------------ // MHZ19 CO2 sensor // Enable support by passing MHZ19_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef MHZ19_SUPPORT #define MHZ19_SUPPORT 0 #endif #ifndef MHZ19_RX_PIN #define MHZ19_RX_PIN 13 #endif #ifndef MHZ19_TX_PIN #define MHZ19_TX_PIN 15 #endif //------------------------------------------------------------------------------ // SenseAir CO2 sensor // Enable support by passing SENSEAIR_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef SENSEAIR_SUPPORT #define SENSEAIR_SUPPORT 0 #endif #ifndef SENSEAIR_RX_PIN #define SENSEAIR_RX_PIN 0 #endif #ifndef SENSEAIR_TX_PIN #define SENSEAIR_TX_PIN 2 #endif //------------------------------------------------------------------------------ // Particle Monitor based on Plantower PMS // Enable support by passing PMSX003_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef PMSX003_SUPPORT #define PMSX003_SUPPORT 0 #endif #ifndef PMS_TYPE #define PMS_TYPE PMS_TYPE_X003 #endif // You can enable smart sleep (read 6-times then sleep on 24-reading-cycles) to extend PMS sensor's life. // Otherwise the default lifetime of PMS sensor is about 8000-hours/1-years. // The PMS's fan will stop working on sleeping cycle, and will wake up on reading cycle. #ifndef PMS_SMART_SLEEP #define PMS_SMART_SLEEP 0 #endif #ifndef PMS_RX_PIN #define PMS_RX_PIN 13 #endif #ifndef PMS_TX_PIN #define PMS_TX_PIN 15 #endif //------------------------------------------------------------------------------ // PZEM004T based power monitor // Enable support by passing PZEM004T_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef PZEM004T_SUPPORT #define PZEM004T_SUPPORT 0 #endif #ifndef PZEM004T_USE_SOFT #define PZEM004T_USE_SOFT 0 // Software serial is not working atm, use hardware serial #endif #ifndef PZEM004T_RX_PIN #define PZEM004T_RX_PIN 13 // Software serial RX GPIO (if PZEM004T_USE_SOFT == 1) #endif #ifndef PZEM004T_TX_PIN #define PZEM004T_TX_PIN 15 // Software serial TX GPIO (if PZEM004T_USE_SOFT == 1) #endif #ifndef PZEM004T_HW_PORT #define PZEM004T_HW_PORT Serial // Hardware serial port (if PZEM004T_USE_SOFT == 0) #endif //------------------------------------------------------------------------------ // SHT3X I2C (Wemos) temperature & humidity sensor // Enable support by passing SHT3X_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef SHT3X_I2C_SUPPORT #define SHT3X_I2C_SUPPORT 0 #endif #ifndef SHT3X_I2C_ADDRESS #define SHT3X_I2C_ADDRESS 0x00 // 0x00 means auto #endif //------------------------------------------------------------------------------ // SI7021 temperature & humidity sensor // Enable support by passing SI7021_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef SI7021_SUPPORT #define SI7021_SUPPORT 0 #endif #ifndef SI7021_ADDRESS #define SI7021_ADDRESS 0x00 // 0x00 means auto #endif //------------------------------------------------------------------------------ // TMP3X analog temperature sensor // Enable support by passing TMP3X_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef TMP3X_SUPPORT #define TMP3X_SUPPORT 0 #endif #ifndef TMP3X_TYPE #define TMP3X_TYPE TMP3X_TMP35 #endif //------------------------------------------------------------------------------ // V9261F based power sensor // Enable support by passing SI7021_SUPPORT=1 build flag //------------------------------------------------------------------------------ #ifndef V9261F_SUPPORT #define V9261F_SUPPORT 0 #endif #ifndef V9261F_PIN #define V9261F_PIN 2 // TX pin from the V9261F #endif #ifndef V9261F_PIN_INVERSE #define V9261F_PIN_INVERSE 1 // Signal is inverted #endif #define V9261F_SYNC_INTERVAL 600 // Sync signal length (ms) #define V9261F_BAUDRATE 4800 // UART baudrate // Default ratios #define V9261F_CURRENT_FACTOR 79371434.0 #define V9261F_VOLTAGE_FACTOR 4160651.0 #define V9261F_POWER_FACTOR 153699.0 #define V9261F_RPOWER_FACTOR V9261F_CURRENT_FACTOR // ============================================================================= // Sensor helpers configuration - can't move to dependencies.h // ============================================================================= #ifndef SENSOR_SUPPORT #define SENSOR_SUPPORT ( \ AM2320_SUPPORT || \ ANALOG_SUPPORT || \ BH1750_SUPPORT || \ BMX280_SUPPORT || \ CSE7766_SUPPORT || \ DALLAS_SUPPORT || \ DHT_SUPPORT || \ DIGITAL_SUPPORT || \ ECH1560_SUPPORT || \ EMON_ADC121_SUPPORT || \ EMON_ADS1X15_SUPPORT || \ EMON_ANALOG_SUPPORT || \ EVENTS_SUPPORT || \ GEIGER_SUPPORT || \ GUVAS12SD_SUPPORT || \ HCSR04_SUPPORT || \ HLW8012_SUPPORT || \ MHZ19_SUPPORT || \ SENSEAIR_SUPPORT || \ PMSX003_SUPPORT || \ PZEM004T_SUPPORT || \ SHT3X_I2C_SUPPORT || \ SI7021_SUPPORT || \ TMP3X_SUPPORT || \ V9261F_SUPPORT \ ) #endif // ----------------------------------------------------------------------------- // ADC // ----------------------------------------------------------------------------- // Default ADC mode is to monitor internal power supply #ifndef ADC_MODE_VALUE #define ADC_MODE_VALUE ADC_VCC #endif // ----------------------------------------------------------------------------- // I2C // ----------------------------------------------------------------------------- #ifndef I2C_SUPPORT #define I2C_SUPPORT 0 // I2C enabled (1.98Kb) #endif #define I2C_USE_BRZO 0 // Use brzo_i2c library or standard Wire #ifndef I2C_SDA_PIN #define I2C_SDA_PIN SDA // SDA GPIO (Sonoff => 4) #endif #ifndef I2C_SCL_PIN #define I2C_SCL_PIN SCL // SCL GPIO (Sonoff => 14) #endif #define I2C_CLOCK_STRETCH_TIME 200 // BRZO clock stretch time #define I2C_SCL_FREQUENCY 1000 // BRZO SCL frequency #define I2C_CLEAR_BUS 0 // Clear I2C bus on boot #define I2C_PERFORM_SCAN 1 // Perform a bus scan on boot //-------------------------------------------------------------------------------- // Class loading //-------------------------------------------------------------------------------- #if SENSOR_SUPPORT #if SENSOR_DEBUG #include "../config/debug.h" #endif #include "../sensors/BaseSensor.h" #if AM2320_SUPPORT #include "../sensors/AM2320Sensor.h" #endif #if ANALOG_SUPPORT #include "../sensors/AnalogSensor.h" #endif #if BH1750_SUPPORT #include "../sensors/BH1750Sensor.h" #endif #if BMX280_SUPPORT #include "../sensors/BMX280Sensor.h" #endif #if CSE7766_SUPPORT #include #include "../sensors/CSE7766Sensor.h" #endif #if DALLAS_SUPPORT #include #include "../sensors/DallasSensor.h" #endif #if DHT_SUPPORT #include "../sensors/DHTSensor.h" #endif #if DIGITAL_SUPPORT #include "../sensors/DigitalSensor.h" #endif #if ECH1560_SUPPORT #include "../sensors/ECH1560Sensor.h" #endif #if EMON_ADC121_SUPPORT #include "../sensors/EmonADC121Sensor.h" #endif #if EMON_ADS1X15_SUPPORT #include "../sensors/EmonADS1X15Sensor.h" #endif #if EMON_ANALOG_SUPPORT #include "../sensors/EmonAnalogSensor.h" #endif #if EVENTS_SUPPORT #include "../sensors/EventSensor.h" #endif #if GEIGER_SUPPORT #include "../sensors/GeigerSensor.h" // The main file for geiger counting module #endif #if GUVAS12SD_SUPPORT #include "../sensors/GUVAS12SDSensor.h" #endif #if HCSR04_SUPPORT #include "../sensors/HCSR04Sensor.h" #endif #if HLW8012_SUPPORT #include #include "../sensors/HLW8012Sensor.h" #endif #if MHZ19_SUPPORT #include #include "../sensors/MHZ19Sensor.h" #endif #if SENSEAIR_SUPPORT #include #include "../sensors/SenseAirSensor.h" #endif #if PMSX003_SUPPORT #include #include "../sensors/PMSX003Sensor.h" #endif #if PZEM004T_SUPPORT #include #include "../sensors/PZEM004TSensor.h" #endif #if SI7021_SUPPORT #include "../sensors/SI7021Sensor.h" #endif #if SHT3X_I2C_SUPPORT #include "../sensors/SHT3XI2CSensor.h" #endif #if TMP3X_SUPPORT #include "../sensors/TMP3XSensor.h" #endif #if V9261F_SUPPORT #include #include "../sensors/V9261FSensor.h" #endif #endif // SENSOR_SUPPORT