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.

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