Fork of the espurna firmware for `mhsw` switches
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1078 lines
36 KiB

7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
7 years ago
6 years ago
6 years ago
  1. // =============================================================================
  2. // SENSORS - General data
  3. // =============================================================================
  4. #define SENSOR_DEBUG 0 // Debug sensors
  5. #define SENSOR_READ_INTERVAL 6 // Read data from sensors every 6 seconds
  6. #define SENSOR_READ_MIN_INTERVAL 1 // Minimum read interval
  7. #define SENSOR_READ_MAX_INTERVAL 3600 // Maximum read interval
  8. #define SENSOR_INIT_INTERVAL 10000 // Try to re-init non-ready sensors every 10s
  9. #define SENSOR_REPORT_EVERY 10 // Report every this many readings
  10. #define SENSOR_REPORT_MIN_EVERY 1 // Minimum every value
  11. #define SENSOR_REPORT_MAX_EVERY 60 // Maximum
  12. #define SENSOR_USE_INDEX 0 // Use the index in topic (i.e. temperature/0)
  13. // even if just one sensor (0 for backwards compatibility)
  14. #ifndef SENSOR_POWER_CHECK_STATUS
  15. #define SENSOR_POWER_CHECK_STATUS 1 // If set to 1 the reported power/current/energy will be 0 if the relay[0] is OFF
  16. #endif
  17. #ifndef SENSOR_TEMPERATURE_CORRECTION
  18. #define SENSOR_TEMPERATURE_CORRECTION 0.0 // Offset correction
  19. #endif
  20. #ifndef TEMPERATURE_MIN_CHANGE
  21. #define TEMPERATURE_MIN_CHANGE 0.0 // Minimum temperature change to report
  22. #endif
  23. #ifndef SENSOR_HUMIDITY_CORRECTION
  24. #define SENSOR_HUMIDITY_CORRECTION 0.0 // Offset correction
  25. #endif
  26. #ifndef HUMIDITY_MIN_CHANGE
  27. #define HUMIDITY_MIN_CHANGE 0 // Minimum humidity change to report
  28. #endif
  29. #ifndef ENERGY_MAX_CHANGE
  30. #define ENERGY_MAX_CHANGE 0 // Maximum energy change to report (if >0 it will allways report when delta(E) is greater than this)
  31. #endif
  32. #ifndef SENSOR_SAVE_EVERY
  33. #define SENSOR_SAVE_EVERY 0 // Save accumulating values to EEPROM (atm only energy)
  34. // A 0 means do not save and it's the default value
  35. // A number different from 0 means it should store the value in EEPROM
  36. // after these many reports
  37. // Warning: this might wear out flash fast!
  38. #endif
  39. #define SENSOR_PUBLISH_ADDRESSES 0 // Publish sensor addresses
  40. #define SENSOR_ADDRESS_TOPIC "address" // Topic to publish sensor addresses
  41. #ifndef SENSOR_TEMPERATURE_UNITS
  42. #define SENSOR_TEMPERATURE_UNITS TMP_CELSIUS // Temperature units (TMP_CELSIUS | TMP_FAHRENHEIT)
  43. #endif
  44. #ifndef SENSOR_ENERGY_UNITS
  45. #define SENSOR_ENERGY_UNITS ENERGY_JOULES // Energy units (ENERGY_JOULES | ENERGY_KWH)
  46. #endif
  47. #ifndef SENSOR_POWER_UNITS
  48. #define SENSOR_POWER_UNITS POWER_WATTS // Power units (POWER_WATTS | POWER_KILOWATTS)
  49. #endif
  50. // =============================================================================
  51. // Specific data for each sensor
  52. // =============================================================================
  53. //------------------------------------------------------------------------------
  54. // AM2320 Humidity & Temperature sensor over I2C
  55. // Enable support by passing AM2320_SUPPORT=1 build flag
  56. //------------------------------------------------------------------------------
  57. #ifndef AM2320_SUPPORT
  58. #define AM2320_SUPPORT 0
  59. #endif
  60. #ifndef AM2320_ADDRESS
  61. #define AM2320_ADDRESS 0x00 // 0x00 means auto
  62. #endif
  63. //------------------------------------------------------------------------------
  64. // Analog sensor
  65. // Enable support by passing ANALOG_SUPPORT=1 build flag
  66. //--------------------------------------------------------------------------------
  67. #ifndef ANALOG_SUPPORT
  68. #define ANALOG_SUPPORT 0
  69. #endif
  70. #ifndef ANALOG_SAMPLES
  71. #define ANALOG_SAMPLES 10 // Number of samples
  72. #endif
  73. #ifndef ANALOG_DELAY
  74. #define ANALOG_DELAY 0 // Delay between samples in micros
  75. #endif
  76. //Use the following to perform scaling of raw analog values
  77. // scaledRead = ( factor * rawRead ) + offset
  78. //
  79. //Please take note that the offset is not affected by the scaling factor
  80. #ifndef ANALOG_FACTOR
  81. #define ANALOG_FACTOR 1.0 // Multiply raw reading by this factor
  82. #endif
  83. #ifndef ANALOG_OFFSET
  84. #define ANALOG_OFFSET 0.0 // Add this offset to *scaled* value
  85. #endif
  86. // Round to this number of decimals
  87. #ifndef ANALOG_DECIMALS
  88. #define ANALOG_DECIMALS 2
  89. #endif
  90. //------------------------------------------------------------------------------
  91. // BH1750
  92. // Enable support by passing BH1750_SUPPORT=1 build flag
  93. // http://www.elechouse.com/elechouse/images/product/Digital%20light%20Sensor/bh1750fvi-e.pdf
  94. //------------------------------------------------------------------------------
  95. #ifndef BH1750_SUPPORT
  96. #define BH1750_SUPPORT 0
  97. #endif
  98. #ifndef BH1750_ADDRESS
  99. #define BH1750_ADDRESS 0x00 // 0x00 means auto
  100. #endif
  101. #define BH1750_MODE BH1750_CONTINUOUS_HIGH_RES_MODE
  102. //------------------------------------------------------------------------------
  103. // BMP085/BMP180
  104. // Enable support by passing BMP180_SUPPORT=1 build flag
  105. //------------------------------------------------------------------------------
  106. #ifndef BMP180_SUPPORT
  107. #define BMP180_SUPPORT 0
  108. #endif
  109. #ifndef BMP180_ADDRESS
  110. #define BMP180_ADDRESS 0x00 // 0x00 means auto
  111. #endif
  112. #define BMP180_MODE 3 // 0 for ultra-low power, 1 for standard, 2 for high resolution and 3 for ultrahigh resolution
  113. //------------------------------------------------------------------------------
  114. // BME280/BMP280
  115. // Enable support by passing BMX280_SUPPORT=1 build flag
  116. //------------------------------------------------------------------------------
  117. #ifndef BMX280_SUPPORT
  118. #define BMX280_SUPPORT 0
  119. #endif
  120. #ifndef BMX280_ADDRESS
  121. #define BMX280_ADDRESS 0x00 // 0x00 means auto
  122. #endif
  123. #define BMX280_MODE 1 // 0 for sleep mode, 1 or 2 for forced mode, 3 for normal mode
  124. #define BMX280_STANDBY 0 // 0 for 0.5ms, 1 for 62.5ms, 2 for 125ms
  125. // 3 for 250ms, 4 for 500ms, 5 for 1000ms
  126. // 6 for 10ms, 7 for 20ms
  127. #define BMX280_FILTER 0 // 0 for OFF, 1 for 2 values, 2 for 4 values, 3 for 8 values and 4 for 16 values
  128. #define BMX280_TEMPERATURE 1 // Oversampling for temperature (set to 0 to disable magnitude)
  129. #define BMX280_HUMIDITY 1 // Oversampling for humidity (set to 0 to disable magnitude, only for BME280)
  130. #define BMX280_PRESSURE 1 // Oversampling for pressure (set to 0 to disable magnitude)
  131. //------------------------------------------------------------------------------
  132. // Dallas OneWire temperature sensors
  133. // Enable support by passing DALLAS_SUPPORT=1 build flag
  134. //------------------------------------------------------------------------------
  135. #ifndef DALLAS_SUPPORT
  136. #define DALLAS_SUPPORT 0
  137. #endif
  138. #ifndef DALLAS_PIN
  139. #define DALLAS_PIN 14
  140. #endif
  141. #define DALLAS_RESOLUTION 9 // Not used atm
  142. #define DALLAS_READ_INTERVAL 2000 // Force sensor read & cache every 2 seconds
  143. //------------------------------------------------------------------------------
  144. // DHTXX temperature/humidity sensor
  145. // Enable support by passing DHT_SUPPORT=1 build flag
  146. //------------------------------------------------------------------------------
  147. #ifndef DHT_SUPPORT
  148. #define DHT_SUPPORT 0
  149. #endif
  150. #ifndef DHT_PIN
  151. #define DHT_PIN 14
  152. #endif
  153. #ifndef DHT_TYPE
  154. #define DHT_TYPE DHT_CHIP_DHT22
  155. #endif
  156. //------------------------------------------------------------------------------
  157. // CSE7766 based power sensor
  158. // Enable support by passing CSE7766_SUPPORT=1 build flag
  159. //------------------------------------------------------------------------------
  160. #ifndef CSE7766_SUPPORT
  161. #define CSE7766_SUPPORT 0
  162. #endif
  163. #ifndef CSE7766_PIN
  164. #define CSE7766_PIN 1 // TX pin from the CSE7766
  165. #endif
  166. #ifndef CSE7766_PIN_INVERSE
  167. #define CSE7766_PIN_INVERSE 0 // Signal is inverted
  168. #endif
  169. #define CSE7766_SYNC_INTERVAL 300 // Safe time between transmissions (ms)
  170. #define CSE7766_BAUDRATE 4800 // UART baudrate
  171. #define CSE7766_V1R 1.0 // 1mR current resistor
  172. #define CSE7766_V2R 1.0 // 1M voltage resistor
  173. //------------------------------------------------------------------------------
  174. // Digital sensor
  175. // Enable support by passing DIGITAL_SUPPORT=1 build flag
  176. //------------------------------------------------------------------------------
  177. #ifndef DIGITAL_SUPPORT
  178. #define DIGITAL_SUPPORT 0
  179. #endif
  180. #ifndef DIGITAL_PIN
  181. #define DIGITAL_PIN 2
  182. #endif
  183. #ifndef DIGITAL_PIN_MODE
  184. #define DIGITAL_PIN_MODE INPUT_PULLUP
  185. #endif
  186. #ifndef DIGITAL_DEFAULT_STATE
  187. #define DIGITAL_DEFAULT_STATE 1
  188. #endif
  189. //------------------------------------------------------------------------------
  190. // ECH1560 based power sensor
  191. // Enable support by passing ECH1560_SUPPORT=1 build flag
  192. //------------------------------------------------------------------------------
  193. #ifndef ECH1560_SUPPORT
  194. #define ECH1560_SUPPORT 0
  195. #endif
  196. #ifndef ECH1560_CLK_PIN
  197. #define ECH1560_CLK_PIN 4 // CLK pin for the ECH1560
  198. #endif
  199. #ifndef ECH1560_MISO_PIN
  200. #define ECH1560_MISO_PIN 5 // MISO pin for the ECH1560
  201. #endif
  202. #ifndef ECH1560_INVERTED
  203. #define ECH1560_INVERTED 0 // Signal is inverted
  204. #endif
  205. //------------------------------------------------------------------------------
  206. // Energy Monitor general settings
  207. //------------------------------------------------------------------------------
  208. #define EMON_MAX_SAMPLES 1000 // Max number of samples to get
  209. #define EMON_MAX_TIME 250 // Max time in ms to sample
  210. #define EMON_FILTER_SPEED 512 // Mobile average filter speed
  211. #define EMON_REFERENCE_VOLTAGE 3.3 // Reference voltage of the ADC
  212. #ifndef EMON_MAINS_VOLTAGE
  213. #define EMON_MAINS_VOLTAGE 230 // Mains voltage
  214. #endif
  215. #ifndef EMON_CURRENT_RATIO
  216. #define EMON_CURRENT_RATIO 30 // Current ratio in the clamp (30A/1V)
  217. #endif
  218. #ifndef EMON_REPORT_CURRENT
  219. #define EMON_REPORT_CURRENT 0 // Report current
  220. #endif
  221. #ifndef EMON_REPORT_POWER
  222. #define EMON_REPORT_POWER 1 // Report power
  223. #endif
  224. #ifndef EMON_REPORT_ENERGY
  225. #define EMON_REPORT_ENERGY 1 // Report energy
  226. #endif
  227. //------------------------------------------------------------------------------
  228. // Energy Monitor based on ADC121
  229. // Enable support by passing EMON_ADC121_SUPPORT=1 build flag
  230. //------------------------------------------------------------------------------
  231. #ifndef EMON_ADC121_SUPPORT
  232. #define EMON_ADC121_SUPPORT 0 // Do not build support by default
  233. #endif
  234. #define EMON_ADC121_I2C_ADDRESS 0x00 // 0x00 means auto
  235. //------------------------------------------------------------------------------
  236. // Energy Monitor based on ADS1X15
  237. // Enable support by passing EMON_ADS1X15_SUPPORT=1 build flag
  238. //------------------------------------------------------------------------------
  239. #ifndef EMON_ADS1X15_SUPPORT
  240. #define EMON_ADS1X15_SUPPORT 0 // Do not build support by default
  241. #endif
  242. #define EMON_ADS1X15_I2C_ADDRESS 0x00 // 0x00 means auto
  243. #define EMON_ADS1X15_TYPE ADS1X15_CHIP_ADS1115
  244. #define EMON_ADS1X15_GAIN ADS1X15_REG_CONFIG_PGA_4_096V
  245. #define EMON_ADS1X15_MASK 0x0F // A0=1 A1=2 A2=4 A3=8
  246. //------------------------------------------------------------------------------
  247. // Energy Monitor based on interval analog GPIO
  248. // Enable support by passing EMON_ANALOG_SUPPORT=1 build flag
  249. //------------------------------------------------------------------------------
  250. #ifndef EMON_ANALOG_SUPPORT
  251. #define EMON_ANALOG_SUPPORT 0 // Do not build support by default
  252. #endif
  253. //------------------------------------------------------------------------------
  254. // Counter sensor
  255. // Enable support by passing EVENTS_SUPPORT=1 build flag
  256. //------------------------------------------------------------------------------
  257. #ifndef EVENTS_SUPPORT
  258. #define EVENTS_SUPPORT 0 // Do not build with counter support by default
  259. #endif
  260. #ifndef EVENTS_TRIGGER
  261. #define EVENTS_TRIGGER 1 // 1 to trigger callback on events,
  262. // 0 to only count them and report periodically
  263. #endif
  264. #ifndef EVENTS_PIN
  265. #define EVENTS_PIN 2 // GPIO to monitor
  266. #endif
  267. #ifndef EVENTS_PIN_MODE
  268. #define EVENTS_PIN_MODE INPUT // INPUT, INPUT_PULLUP
  269. #endif
  270. #ifndef EVENTS_INTERRUPT_MODE
  271. #define EVENTS_INTERRUPT_MODE RISING // RISING, FALLING, CHANGE
  272. #endif
  273. #define EVENTS_DEBOUNCE 50 // Do not register events within less than 50 millis
  274. //------------------------------------------------------------------------------
  275. // Geiger sensor
  276. // Enable support by passing GEIGER_SUPPORT=1 build flag
  277. //------------------------------------------------------------------------------
  278. #ifndef GEIGER_SUPPORT
  279. #define GEIGER_SUPPORT 0 // Do not build with geiger support by default
  280. #endif
  281. #ifndef GEIGER_PIN
  282. #define GEIGER_PIN D1 // GPIO to monitor "D1" => "GPIO5"
  283. #endif
  284. #ifndef GEIGER_PIN_MODE
  285. #define GEIGER_PIN_MODE INPUT // INPUT, INPUT_PULLUP
  286. #endif
  287. #ifndef GEIGER_INTERRUPT_MODE
  288. #define GEIGER_INTERRUPT_MODE RISING // RISING, FALLING, CHANGE
  289. #endif
  290. #define GEIGER_DEBOUNCE 25 // Do not register events within less than 25 millis.
  291. // Value derived here: Debounce time 25ms, because https://github.com/Trickx/espurna/wiki/Geiger-counter
  292. #define GEIGER_CPM2SIEVERT 240 // CPM to µSievert per hour conversion factor
  293. // Typically the literature uses the invers, but I find an integer type more convienient.
  294. #define GEIGER_REPORT_SIEVERTS 1 // Enabler for local dose rate reports in µSv/h
  295. #define GEIGER_REPORT_CPM 1 // Enabler for local dose rate reports in counts per minute
  296. //------------------------------------------------------------------------------
  297. // GUVAS12SD UV Sensor (analog)
  298. // Enable support by passing GUVAS12SD_SUPPORT=1 build flag
  299. //------------------------------------------------------------------------------
  300. #ifndef GUVAS12SD_SUPPORT
  301. #define GUVAS12SD_SUPPORT 0
  302. #endif
  303. #ifndef GUVAS12SD_PIN
  304. #define GUVAS12SD_PIN 14
  305. #endif
  306. //------------------------------------------------------------------------------
  307. // HLW8012 Energy monitor IC
  308. // Enable support by passing HLW8012_SUPPORT=1 build flag
  309. //------------------------------------------------------------------------------
  310. #ifndef HLW8012_SUPPORT
  311. #define HLW8012_SUPPORT 0
  312. #endif
  313. #ifndef HLW8012_SEL_PIN
  314. #define HLW8012_SEL_PIN 5
  315. #endif
  316. #ifndef HLW8012_CF1_PIN
  317. #define HLW8012_CF1_PIN 13
  318. #endif
  319. #ifndef HLW8012_CF_PIN
  320. #define HLW8012_CF_PIN 14
  321. #endif
  322. #ifndef HLW8012_SEL_CURRENT
  323. #define HLW8012_SEL_CURRENT HIGH // SEL pin to HIGH to measure current
  324. #endif
  325. #ifndef HLW8012_CURRENT_R
  326. #define HLW8012_CURRENT_R 0.001 // Current resistor
  327. #endif
  328. #ifndef HLW8012_VOLTAGE_R_UP
  329. #define HLW8012_VOLTAGE_R_UP ( 5 * 470000 ) // Upstream voltage resistor
  330. #endif
  331. #ifndef HLW8012_VOLTAGE_R_DOWN
  332. #define HLW8012_VOLTAGE_R_DOWN ( 1000 ) // Downstream voltage resistor
  333. #endif
  334. #ifndef HLW8012_CURRENT_RATIO
  335. #define HLW8012_CURRENT_RATIO 0 // Set to 0 to use factory defaults
  336. #endif
  337. #ifndef HLW8012_VOLTAGE_RATIO
  338. #define HLW8012_VOLTAGE_RATIO 0 // Set to 0 to use factory defaults
  339. #endif
  340. #ifndef HLW8012_POWER_RATIO
  341. #define HLW8012_POWER_RATIO 0 // Set to 0 to use factory defaults
  342. #endif
  343. #ifndef HLW8012_USE_INTERRUPTS
  344. #define HLW8012_USE_INTERRUPTS 1 // Use interrupts to trap HLW8012 signals
  345. #endif
  346. #ifndef HLW8012_WAIT_FOR_WIFI
  347. #define HLW8012_WAIT_FOR_WIFI 0 // Weather to enable interrupts only after
  348. // wifi connection has been stablished
  349. #endif
  350. #ifndef HLW8012_INTERRUPT_ON
  351. #define HLW8012_INTERRUPT_ON CHANGE // When to trigger the interrupt
  352. // Use CHANGE for HLW8012
  353. // Use FALLING for BL0937 / HJL0
  354. #endif
  355. //------------------------------------------------------------------------------
  356. // MHZ19 CO2 sensor
  357. // Enable support by passing MHZ19_SUPPORT=1 build flag
  358. //------------------------------------------------------------------------------
  359. #ifndef MHZ19_SUPPORT
  360. #define MHZ19_SUPPORT 0
  361. #endif
  362. #ifndef MHZ19_RX_PIN
  363. #define MHZ19_RX_PIN 13
  364. #endif
  365. #ifndef MHZ19_TX_PIN
  366. #define MHZ19_TX_PIN 15
  367. #endif
  368. //------------------------------------------------------------------------------
  369. // MICS-2710 (and MICS-4514) NO2 sensor
  370. // Enable support by passing MICS2710_SUPPORT=1 build flag
  371. //------------------------------------------------------------------------------
  372. #ifndef MICS2710_SUPPORT
  373. #define MICS2710_SUPPORT 0
  374. #endif
  375. #ifndef MICS2710_NOX_PIN
  376. #define MICS2710_NOX_PIN 0
  377. #endif
  378. #ifndef MICS2710_PRE_PIN
  379. #define MICS2710_PRE_PIN 4
  380. #endif
  381. #define MICS2710_PREHEAT_TIME 10000 // 10s preheat for NOX read
  382. #define MICS2710_RL 820 // RL, load resistor
  383. #define MICS2710_R0 2200 // R0 calibration value for NO2 sensor,
  384. // Typical value as per datasheet
  385. //------------------------------------------------------------------------------
  386. // MICS-5525 (and MICS-4514) CO sensor
  387. // Enable support by passing MICS5525_SUPPORT=1 build flag
  388. //------------------------------------------------------------------------------
  389. #ifndef MICS5525_SUPPORT
  390. #define MICS5525_SUPPORT 0
  391. #endif
  392. #ifndef MICS5525_RED_PIN
  393. #define MICS5525_RED_PIN 0
  394. #endif
  395. #define MICS5525_RL 820 // RL, load resistor
  396. #define MICS5525_R0 750000 // R0 calibration value for NO2 sensor,
  397. // Typical value as per datasheet
  398. //------------------------------------------------------------------------------
  399. // NTC sensor
  400. // Enable support by passing NTC_SUPPORT=1 build flag
  401. //--------------------------------------------------------------------------------
  402. #ifndef NTC_SUPPORT
  403. #define NTC_SUPPORT 0
  404. #endif
  405. #ifndef NTC_SAMPLES
  406. #define NTC_SAMPLES 10 // Number of samples
  407. #endif
  408. #ifndef NTC_DELAY
  409. #define NTC_DELAY 0 // Delay between samples in micros
  410. #endif
  411. #ifndef NTC_R_UP
  412. #define NTC_R_UP 0 // Resistor upstream, set to 0 if none
  413. #endif
  414. #ifndef NTC_R_DOWN
  415. #define NTC_R_DOWN 10000 // Resistor downstream, set to 0 if none
  416. #endif
  417. #ifndef NTC_T0
  418. #define NTC_T0 298.15 // 25 Celsius
  419. #endif
  420. #ifndef NTC_R0
  421. #define NTC_R0 10000 // Resistance at T0
  422. #endif
  423. #ifndef NTC_BETA
  424. #define NTC_BETA 3977 // Beta coeficient
  425. #endif
  426. //------------------------------------------------------------------------------
  427. // Particle Monitor based on Plantower PMS
  428. // Enable support by passing PMSX003_SUPPORT=1 build flag
  429. //------------------------------------------------------------------------------
  430. #ifndef PMSX003_SUPPORT
  431. #define PMSX003_SUPPORT 0
  432. #endif
  433. #ifndef PMS_TYPE
  434. #define PMS_TYPE PMS_TYPE_X003
  435. #endif
  436. // You can enable smart sleep (read 6-times then sleep on 24-reading-cycles) to extend PMS sensor's life.
  437. // Otherwise the default lifetime of PMS sensor is about 8000-hours/1-years.
  438. // The PMS's fan will stop working on sleeping cycle, and will wake up on reading cycle.
  439. #ifndef PMS_SMART_SLEEP
  440. #define PMS_SMART_SLEEP 0
  441. #endif
  442. #ifndef PMS_USE_SOFT
  443. #define PMS_USE_SOFT 0 // If PMS_USE_SOFT == 1, DEBUG_SERIAL_SUPPORT must be 0
  444. #endif
  445. #ifndef PMS_RX_PIN
  446. #define PMS_RX_PIN 13 // Software serial RX GPIO (if PMS_USE_SOFT == 1)
  447. #endif
  448. #ifndef PMS_TX_PIN
  449. #define PMS_TX_PIN 15 // Software serial TX GPIO (if PMS_USE_SOFT == 1)
  450. #endif
  451. #ifndef PMS_HW_PORT
  452. #define PMS_HW_PORT Serial // Hardware serial port (if PMS_USE_SOFT == 0)
  453. #endif
  454. //------------------------------------------------------------------------------
  455. // Pulse Meter Energy monitor
  456. // Enable support by passing PULSEMETER_SUPPORT=1 build flag
  457. //------------------------------------------------------------------------------
  458. #ifndef PULSEMETER_SUPPORT
  459. #define PULSEMETER_SUPPORT 0
  460. #endif
  461. #ifndef PULSEMETER_PIN
  462. #define PULSEMETER_PIN 5
  463. #endif
  464. #ifndef PULSEMETER_ENERGY_RATIO
  465. #define PULSEMETER_ENERGY_RATIO 4000 // In pulses/kWh
  466. #endif
  467. #ifndef PULSEMETER_INTERRUPT_ON
  468. #define PULSEMETER_INTERRUPT_ON FALLING
  469. #endif
  470. #ifndef PULSEMETER_DEBOUNCE
  471. #define PULSEMETER_DEBOUNCE 50 // Do not register pulses within less than 50 millis
  472. #endif
  473. //------------------------------------------------------------------------------
  474. // PZEM004T based power monitor
  475. // Enable support by passing PZEM004T_SUPPORT=1 build flag
  476. //------------------------------------------------------------------------------
  477. #ifndef PZEM004T_SUPPORT
  478. #define PZEM004T_SUPPORT 0
  479. #endif
  480. #ifndef PZEM004T_USE_SOFT
  481. #define PZEM004T_USE_SOFT 0 // Software serial is not working atm, use hardware serial
  482. #endif
  483. #ifndef PZEM004T_RX_PIN
  484. #define PZEM004T_RX_PIN 13 // Software serial RX GPIO (if PZEM004T_USE_SOFT == 1)
  485. #endif
  486. #ifndef PZEM004T_TX_PIN
  487. #define PZEM004T_TX_PIN 15 // Software serial TX GPIO (if PZEM004T_USE_SOFT == 1)
  488. #endif
  489. #ifndef PZEM004T_HW_PORT
  490. #define PZEM004T_HW_PORT Serial // Hardware serial port (if PZEM004T_USE_SOFT == 0)
  491. #endif
  492. #ifndef PZEM004T_ADDRESSES
  493. #define PZEM004T_ADDRESSES "192.168.1.1" // Device(s) address(es), separated by space, "192.168.1.1 192.168.1.2 192.168.1.3"
  494. #endif
  495. #ifndef PZEM004T_READ_INTERVAL
  496. #define PZEM004T_READ_INTERVAL 1500 // Read interval between same device
  497. #endif
  498. #ifndef PZEM004T_MAX_DEVICES
  499. #define PZEM004T_MAX_DEVICES 3
  500. #endif
  501. //------------------------------------------------------------------------------
  502. // SDS011 particulates sensor
  503. // Enable support by passing SDS011_SUPPORT=1 build flag
  504. //------------------------------------------------------------------------------
  505. #ifndef SDS011_SUPPORT
  506. #define SDS011_SUPPORT 0
  507. #endif
  508. #ifndef SDS011_RX_PIN
  509. #define SDS011_RX_PIN 14
  510. #endif
  511. #ifndef SDS011_TX_PIN
  512. #define SDS011_TX_PIN 12
  513. #endif
  514. //------------------------------------------------------------------------------
  515. // SenseAir CO2 sensor
  516. // Enable support by passing SENSEAIR_SUPPORT=1 build flag
  517. //------------------------------------------------------------------------------
  518. #ifndef SENSEAIR_SUPPORT
  519. #define SENSEAIR_SUPPORT 0
  520. #endif
  521. #ifndef SENSEAIR_RX_PIN
  522. #define SENSEAIR_RX_PIN 0
  523. #endif
  524. #ifndef SENSEAIR_TX_PIN
  525. #define SENSEAIR_TX_PIN 2
  526. #endif
  527. //------------------------------------------------------------------------------
  528. // SHT3X I2C (Wemos) temperature & humidity sensor
  529. // Enable support by passing SHT3X_I2C_SUPPORT=1 build flag
  530. //------------------------------------------------------------------------------
  531. #ifndef SHT3X_I2C_SUPPORT
  532. #define SHT3X_I2C_SUPPORT 0
  533. #endif
  534. #ifndef SHT3X_I2C_ADDRESS
  535. #define SHT3X_I2C_ADDRESS 0x00 // 0x00 means auto
  536. #endif
  537. //------------------------------------------------------------------------------
  538. // SI7021 temperature & humidity sensor
  539. // Enable support by passing SI7021_SUPPORT=1 build flag
  540. //------------------------------------------------------------------------------
  541. #ifndef SI7021_SUPPORT
  542. #define SI7021_SUPPORT 0
  543. #endif
  544. #ifndef SI7021_ADDRESS
  545. #define SI7021_ADDRESS 0x00 // 0x00 means auto
  546. #endif
  547. //------------------------------------------------------------------------------
  548. // Sonar
  549. // Enable support by passing SONAR_SUPPORT=1 build flag
  550. //------------------------------------------------------------------------------
  551. #ifndef SONAR_SUPPORT
  552. #define SONAR_SUPPORT 0
  553. #endif
  554. #ifndef SONAR_TRIGGER
  555. #define SONAR_TRIGGER 12 // GPIO for the trigger pin (output)
  556. #endif
  557. #ifndef SONAR_ECHO
  558. #define SONAR_ECHO 14 // GPIO for the echo pin (input)
  559. #endif
  560. #ifndef SONAR_MAX_DISTANCE
  561. #define SONAR_MAX_DISTANCE MAX_SENSOR_DISTANCE // Max sensor distance in cm
  562. #endif
  563. #ifndef SONAR_ITERATIONS
  564. #define SONAR_ITERATIONS 5 // Number of iterations to ping for
  565. #endif // error correction.
  566. //------------------------------------------------------------------------------
  567. // TMP3X analog temperature sensor
  568. // Enable support by passing TMP3X_SUPPORT=1 build flag
  569. //------------------------------------------------------------------------------
  570. #ifndef TMP3X_SUPPORT
  571. #define TMP3X_SUPPORT 0
  572. #endif
  573. #ifndef TMP3X_TYPE
  574. #define TMP3X_TYPE TMP3X_TMP35
  575. #endif
  576. //------------------------------------------------------------------------------
  577. // V9261F based power sensor
  578. // Enable support by passing SI7021_SUPPORT=1 build flag
  579. //------------------------------------------------------------------------------
  580. #ifndef V9261F_SUPPORT
  581. #define V9261F_SUPPORT 0
  582. #endif
  583. #ifndef V9261F_PIN
  584. #define V9261F_PIN 2 // TX pin from the V9261F
  585. #endif
  586. #ifndef V9261F_PIN_INVERSE
  587. #define V9261F_PIN_INVERSE 1 // Signal is inverted
  588. #endif
  589. #define V9261F_SYNC_INTERVAL 600 // Sync signal length (ms)
  590. #define V9261F_BAUDRATE 4800 // UART baudrate
  591. // Default ratios
  592. #define V9261F_CURRENT_FACTOR 79371434.0
  593. #define V9261F_VOLTAGE_FACTOR 4160651.0
  594. #define V9261F_POWER_FACTOR 153699.0
  595. #define V9261F_RPOWER_FACTOR V9261F_CURRENT_FACTOR
  596. //------------------------------------------------------------------------------
  597. // VEML6075 based power sensor
  598. // Enable support by passing VEML6075_SUPPORT=1 build flag
  599. //------------------------------------------------------------------------------
  600. #ifndef VEML6075_SUPPORT
  601. #define VEML6075_SUPPORT 0
  602. #endif
  603. #ifndef VEML6075_INTEGRATION_TIME
  604. #define VEML6075_INTEGRATION_TIME VEML6075::IT_100MS // The time, in milliseconds, allocated for a single
  605. #endif // measurement. A longer timing budget allows for more
  606. // accurate results at the cost of power.
  607. #ifndef VEML6075_DYNAMIC_MODE
  608. #define VEML6075_DYNAMIC_MODE VEML6075::DYNAMIC_NORMAL // The dynamic mode can either be normal or high. In high
  609. #endif // dynamic mode, the resolution increases by about two
  610. // times.
  611. //------------------------------------------------------------------------------
  612. // VL53L1X
  613. // Enable support by passing VL53L1X_SUPPORT=1 build flag
  614. //------------------------------------------------------------------------------
  615. #ifndef VL53L1X_SUPPORT
  616. #define VL53L1X_SUPPORT 0
  617. #endif
  618. #ifndef VL53L1X_I2C_ADDRESS
  619. #define VL53L1X_I2C_ADDRESS 0x00 // 0x00 means auto
  620. #endif
  621. #ifndef VL53L1X_DISTANCE_MODE
  622. #define VL53L1X_DISTANCE_MODE VL53L1X::Long // The distance mode of the sensor. Can be one of
  623. #endif // `VL53L1X::Short`, `VL53L1X::Medium`, or `VL53L1X::Long.
  624. // Shorter distance modes are less affected by ambient light
  625. // but have lower maximum ranges, especially in the dark.
  626. #ifndef VL53L1X_MEASUREMENT_TIMING_BUDGET
  627. #define VL53L1X_MEASUREMENT_TIMING_BUDGET 140000 // The time, in microseconds, allocated for a single
  628. // measurement. A longer timing budget allows for more
  629. // accurate at the cost of power. The minimum budget is
  630. // 20 ms (20000 us) in short distance mode and 33 ms for
  631. // medium and long distance modes.
  632. #endif
  633. #ifndef VL53L1X_INTER_MEASUREMENT_PERIOD
  634. #define VL53L1X_INTER_MEASUREMENT_PERIOD 50 // Period, in milliseconds, determining how
  635. #endif // often the sensor takes a measurement.
  636. //------------------------------------------------------------------------------
  637. // EZOPH pH meter
  638. // Enable support by passing EZOPH_SUPPORT=1 build flag
  639. //------------------------------------------------------------------------------
  640. #ifndef EZOPH_SUPPORT
  641. #define EZOPH_SUPPORT 0
  642. #endif
  643. #ifndef EZOPH_RX_PIN
  644. #define EZOPH_RX_PIN 13 // Software serial RX GPIO
  645. #endif
  646. #ifndef EZOPH_TX_PIN
  647. #define EZOPH_TX_PIN 15 // Software serial TX GPIO
  648. #endif
  649. #ifndef EZOPH_SYNC_INTERVAL
  650. #define EZOPH_SYNC_INTERVAL 1000 // Amount of time (in ms) sync new readings.
  651. #endif
  652. // =============================================================================
  653. // Sensor helpers configuration - can't move to dependencies.h
  654. // =============================================================================
  655. #ifndef SENSOR_SUPPORT
  656. #define SENSOR_SUPPORT ( \
  657. AM2320_SUPPORT || \
  658. ANALOG_SUPPORT || \
  659. BH1750_SUPPORT || \
  660. BMP180_SUPPORT || \
  661. BMX280_SUPPORT || \
  662. CSE7766_SUPPORT || \
  663. DALLAS_SUPPORT || \
  664. DHT_SUPPORT || \
  665. DIGITAL_SUPPORT || \
  666. ECH1560_SUPPORT || \
  667. EMON_ADC121_SUPPORT || \
  668. EMON_ADS1X15_SUPPORT || \
  669. EMON_ANALOG_SUPPORT || \
  670. EVENTS_SUPPORT || \
  671. GEIGER_SUPPORT || \
  672. GUVAS12SD_SUPPORT || \
  673. HLW8012_SUPPORT || \
  674. MICS2710_SUPPORT || \
  675. MICS5525_SUPPORT || \
  676. MHZ19_SUPPORT || \
  677. NTC_SUPPORT || \
  678. SDS011_SUPPORT || \
  679. SENSEAIR_SUPPORT || \
  680. PMSX003_SUPPORT || \
  681. PZEM004T_SUPPORT || \
  682. PULSEMETER_SUPPORT || \
  683. SHT3X_I2C_SUPPORT || \
  684. SI7021_SUPPORT || \
  685. SONAR_SUPPORT || \
  686. TMP3X_SUPPORT || \
  687. V9261F_SUPPORT || \
  688. VEML6075_SUPPORT || \
  689. VL53L1X_SUPPORT || \
  690. EZOPH_SUPPORT \
  691. )
  692. #endif
  693. // -----------------------------------------------------------------------------
  694. // ADC
  695. // -----------------------------------------------------------------------------
  696. // Default ADC mode is to monitor internal power supply
  697. #ifndef ADC_MODE_VALUE
  698. #define ADC_MODE_VALUE ADC_VCC
  699. #endif
  700. // -----------------------------------------------------------------------------
  701. // I2C
  702. // -----------------------------------------------------------------------------
  703. #ifndef I2C_SUPPORT
  704. #define I2C_SUPPORT 0 // I2C enabled (1.98Kb)
  705. #endif
  706. #define I2C_USE_BRZO 0 // Use brzo_i2c library or standard Wire
  707. #ifndef I2C_SDA_PIN
  708. #define I2C_SDA_PIN SDA // SDA GPIO (Sonoff => 4)
  709. #endif
  710. #ifndef I2C_SCL_PIN
  711. #define I2C_SCL_PIN SCL // SCL GPIO (Sonoff => 14)
  712. #endif
  713. #define I2C_CLOCK_STRETCH_TIME 200 // BRZO clock stretch time
  714. #define I2C_SCL_FREQUENCY 1000 // BRZO SCL frequency
  715. #define I2C_CLEAR_BUS 0 // Clear I2C bus on boot
  716. #define I2C_PERFORM_SCAN 1 // Perform a bus scan on boot
  717. //--------------------------------------------------------------------------------
  718. // Class loading
  719. //--------------------------------------------------------------------------------
  720. #if SENSOR_SUPPORT
  721. #if AM2320_SUPPORT
  722. #include "../sensors/AM2320Sensor.h"
  723. #endif
  724. #if ANALOG_SUPPORT
  725. #include "../sensors/AnalogSensor.h"
  726. #endif
  727. #if BH1750_SUPPORT
  728. #include "../sensors/BH1750Sensor.h"
  729. #endif
  730. #if BMP180_SUPPORT
  731. #include "../sensors/BMP180Sensor.h"
  732. #endif
  733. #if BMX280_SUPPORT
  734. #include "../sensors/BMX280Sensor.h"
  735. #endif
  736. #if CSE7766_SUPPORT
  737. #include "../sensors/CSE7766Sensor.h"
  738. #endif
  739. #if DALLAS_SUPPORT
  740. #include "../sensors/DallasSensor.h"
  741. #endif
  742. #if DHT_SUPPORT
  743. #include "../sensors/DHTSensor.h"
  744. #endif
  745. #if DIGITAL_SUPPORT
  746. #include "../sensors/DigitalSensor.h"
  747. #endif
  748. #if ECH1560_SUPPORT
  749. #include "../sensors/ECH1560Sensor.h"
  750. #endif
  751. #if EMON_ADC121_SUPPORT
  752. #include "../sensors/EmonADC121Sensor.h"
  753. #endif
  754. #if EMON_ADS1X15_SUPPORT
  755. #include "../sensors/EmonADS1X15Sensor.h"
  756. #endif
  757. #if EMON_ANALOG_SUPPORT
  758. #include "../sensors/EmonAnalogSensor.h"
  759. #endif
  760. #if EVENTS_SUPPORT
  761. #include "../sensors/EventSensor.h"
  762. #endif
  763. #if EZOPH_SUPPORT
  764. #include "../sensors/EZOPHSensor.h"
  765. #endif
  766. #if GEIGER_SUPPORT
  767. #include "../sensors/GeigerSensor.h"
  768. #endif
  769. #if GUVAS12SD_SUPPORT
  770. #include "../sensors/GUVAS12SDSensor.h"
  771. #endif
  772. #if HLW8012_SUPPORT
  773. #include "../sensors/HLW8012Sensor.h"
  774. #endif
  775. #if MAX6675_SUPPORT
  776. #include "../sensors/MAX6675.h"
  777. #endif
  778. #if MHZ19_SUPPORT
  779. #include "../sensors/MHZ19Sensor.h"
  780. #endif
  781. #if MICS2710_SUPPORT
  782. #include "../sensors/MICS2710Sensor.h"
  783. #endif
  784. #if MICS5525_SUPPORT
  785. #include "../sensors/MICS5525Sensor.h"
  786. #endif
  787. #if NTC_SUPPORT
  788. #include "../sensors/NTCSensor.h"
  789. #endif
  790. #if SDS011_SUPPORT
  791. #include "../sensors/SDS011Sensor.h"
  792. #endif
  793. #if SENSEAIR_SUPPORT
  794. #include "../sensors/SenseAirSensor.h"
  795. #endif
  796. #if PMSX003_SUPPORT
  797. #include "../sensors/PMSX003Sensor.h"
  798. #endif
  799. #if PULSEMETER_SUPPORT
  800. #include "../sensors/PulseMeterSensor.h"
  801. #endif
  802. #if PZEM004T_SUPPORT
  803. #include "../sensors/PZEM004TSensor.h"
  804. #endif
  805. #if SI7021_SUPPORT
  806. #include "../sensors/SI7021Sensor.h"
  807. #endif
  808. #if SHT3X_I2C_SUPPORT
  809. #include "../sensors/SHT3XI2CSensor.h"
  810. #endif
  811. #if SONAR_SUPPORT
  812. #include "../sensors/SonarSensor.h"
  813. #endif
  814. #if TMP3X_SUPPORT
  815. #include "../sensors/TMP3XSensor.h"
  816. #endif
  817. #if V9261F_SUPPORT
  818. #include "../sensors/V9261FSensor.h"
  819. #endif
  820. #if VEML6075_SUPPORT
  821. #include "../sensors/VEML6075Sensor.h"
  822. #endif
  823. #if VL53L1X_SUPPORT
  824. #include "../sensors/VL53L1XSensor.h"
  825. #endif
  826. #endif // SENSOR_SUPPORT