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.

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