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.

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