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.

1705 lines
55 KiB

8 years ago
8 years ago
6 years ago
7 years ago
7 years ago
7 years ago
8 years ago
8 years ago
6 years ago
6 years ago
6 years ago
8 years ago
8 years ago
6 years ago
6 years ago
6 years ago
6 years ago
8 years ago
6 years ago
  1. // // //------------------------------------------------------------------------------
  2. // Do not change this file unless you know what you are doing
  3. // Configuration settings are in the settings.h file
  4. //------------------------------------------------------------------------------
  5. //------------------------------------------------------------------------------
  6. // GENERAL
  7. //------------------------------------------------------------------------------
  8. #define DEVICE_NAME MANUFACTURER "_" DEVICE // Concatenate both to get a unique device name
  9. // When defined, ADMIN_PASS must be 8..63 printable ASCII characters. See:
  10. // https://en.wikipedia.org/wiki/Wi-Fi_Protected_Access#Target_users_(authentication_key_distribution)
  11. // https://github.com/xoseperez/espurna/issues/1151
  12. #ifndef ADMIN_PASS
  13. #define ADMIN_PASS "fibonacci" // Default password (WEB, OTA, WIFI SoftAP)
  14. #endif
  15. #ifndef USE_PASSWORD
  16. #define USE_PASSWORD 1 // Insecurity caution! Disabling this will disable password querying completely.
  17. #endif
  18. #ifndef LOOP_DELAY_TIME
  19. #define LOOP_DELAY_TIME 10 // Delay for the main loop, in millis [0-250]
  20. // Recommended minimum is 10, see:
  21. // https://github.com/xoseperez/espurna/issues/1541
  22. // https://github.com/xoseperez/espurna/issues/1631
  23. // https://github.com/esp8266/Arduino/issues/5825
  24. #endif
  25. //------------------------------------------------------------------------------
  26. // DEBUG
  27. //------------------------------------------------------------------------------
  28. // Serial debug log
  29. #ifndef DEBUG_SERIAL_SUPPORT
  30. #define DEBUG_SERIAL_SUPPORT 1 // Enable serial debug log
  31. #endif
  32. #ifndef DEBUG_PORT
  33. #define DEBUG_PORT Serial // Default debugging port
  34. #endif
  35. #ifndef SERIAL_BAUDRATE
  36. #define SERIAL_BAUDRATE 115200 // Default baudrate
  37. #endif
  38. #ifndef DEBUG_ADD_TIMESTAMP
  39. #define DEBUG_ADD_TIMESTAMP 1 // Add timestamp to debug messages
  40. // (in millis overflowing every 1000 seconds)
  41. #endif
  42. // Second serial port (used for RX)
  43. #ifndef SERIAL_RX_ENABLED
  44. #define SERIAL_RX_ENABLED 0 // Secondary serial port for RX
  45. #endif
  46. #ifndef SERIAL_RX_PORT
  47. #define SERIAL_RX_PORT Serial // This setting is usually defined
  48. // in the hardware.h file for those
  49. // boards that require it
  50. #endif
  51. #ifndef SERIAL_RX_BAUDRATE
  52. #define SERIAL_RX_BAUDRATE 115200 // Default baudrate
  53. #endif
  54. //------------------------------------------------------------------------------
  55. // UDP debug log
  56. // To receive the message son the destination computer use nc:
  57. // nc -ul 8113
  58. #ifndef DEBUG_UDP_SUPPORT
  59. #define DEBUG_UDP_SUPPORT 0 // Enable UDP debug log
  60. #endif
  61. #ifndef DEBUG_UDP_IP
  62. #define DEBUG_UDP_IP IPAddress(192, 168, 1, 100)
  63. #endif
  64. #ifndef DEBUG_UDP_PORT
  65. #define DEBUG_UDP_PORT 514
  66. #endif
  67. // If DEBUG_UDP_PORT is set to 514 syslog format is assumed
  68. // (https://tools.ietf.org/html/rfc3164)
  69. // DEBUG_UDP_FAC_PRI is the facility+priority
  70. #define DEBUG_UDP_FAC_PRI (SYSLOG_LOCAL0 | SYSLOG_DEBUG)
  71. //------------------------------------------------------------------------------
  72. #ifndef DEBUG_TELNET_SUPPORT
  73. #define DEBUG_TELNET_SUPPORT 1 // Enable telnet debug log (will only work if TELNET_SUPPORT is also 1)
  74. #endif
  75. //------------------------------------------------------------------------------
  76. #ifndef DEBUG_WEB_SUPPORT
  77. #define DEBUG_WEB_SUPPORT 1 // Enable web debug log (will only work if WEB_SUPPORT is also 1)
  78. #endif
  79. //------------------------------------------------------------------------------
  80. // TELNET
  81. //------------------------------------------------------------------------------
  82. #ifndef TELNET_SUPPORT
  83. #define TELNET_SUPPORT 1 // Enable telnet support by default (3.34Kb)
  84. #endif
  85. #ifndef TELNET_STA
  86. #define TELNET_STA 0 // By default, disallow connections via STA interface
  87. #endif
  88. #ifndef TELNET_AUTHENTICATION
  89. #define TELNET_AUTHENTICATION 1 // Request password to start telnet session by default
  90. #endif
  91. #ifndef TELNET_PORT
  92. #define TELNET_PORT 23 // Port to listen to telnet clients
  93. #endif
  94. #ifndef TELNET_MAX_CLIENTS
  95. #define TELNET_MAX_CLIENTS 1 // Max number of concurrent telnet clients
  96. #endif
  97. #ifndef TELNET_SERVER
  98. #define TELNET_SERVER TELNET_SERVER_ASYNC // Can be either TELNET_SERVER_ASYNC (using ESPAsyncTCP) or TELNET_SERVER_WIFISERVER (using WiFiServer)
  99. #endif
  100. //------------------------------------------------------------------------------
  101. // TERMINAL
  102. //------------------------------------------------------------------------------
  103. #ifndef TERMINAL_SUPPORT
  104. #define TERMINAL_SUPPORT 1 // Enable terminal commands (0.97Kb)
  105. #endif
  106. #define TERMINAL_BUFFER_SIZE 128 // Max size for commands commands
  107. //------------------------------------------------------------------------------
  108. // SYSTEM CHECK
  109. //------------------------------------------------------------------------------
  110. #ifndef SYSTEM_CHECK_ENABLED
  111. #define SYSTEM_CHECK_ENABLED 1 // Enable crash check by default
  112. #endif
  113. #ifndef SYSTEM_CHECK_TIME
  114. #define SYSTEM_CHECK_TIME 60000 // The system is considered stable after these many millis
  115. #endif
  116. #ifndef SYSTEM_CHECK_MAX
  117. #define SYSTEM_CHECK_MAX 5 // After this many crashes on boot
  118. // the system is flagged as unstable
  119. #endif
  120. //------------------------------------------------------------------------------
  121. // EEPROM
  122. //------------------------------------------------------------------------------
  123. #define EEPROM_SIZE SPI_FLASH_SEC_SIZE // EEPROM size in bytes (1 sector = 4096 bytes)
  124. //#define EEPROM_RORATE_SECTORS 2 // Number of sectors to use for EEPROM rotation
  125. // If not defined the firmware will use a number based
  126. // on the number of available sectors
  127. #define EEPROM_RELAY_STATUS 0 // Address for the relay status (1 byte)
  128. #define EEPROM_ENERGY_COUNT 1 // Address for the energy counter (4 bytes)
  129. #define EEPROM_CUSTOM_RESET 5 // Address for the reset reason (1 byte)
  130. #define EEPROM_CRASH_COUNTER 6 // Address for the crash counter (1 byte)
  131. #define EEPROM_MESSAGE_ID 7 // Address for the MQTT message id (4 bytes)
  132. #define EEPROM_ROTATE_DATA 11 // Reserved for the EEPROM_ROTATE library (3 bytes)
  133. #define EEPROM_DATA_END 14 // End of custom EEPROM data block
  134. //------------------------------------------------------------------------------
  135. // THERMOSTAT
  136. //------------------------------------------------------------------------------
  137. #ifndef THERMOSTAT_SUPPORT
  138. #define THERMOSTAT_SUPPORT 0
  139. #endif
  140. #ifndef THERMOSTAT_DISPLAY_SUPPORT
  141. #define THERMOSTAT_DISPLAY_SUPPORT 0
  142. #endif
  143. #define THERMOSTAT_SERVER_LOST_INTERVAL 120000 //server means lost after 2 min from last response
  144. #define THERMOSTAT_REMOTE_TEMP_MAX_WAIT 120 // 2 min
  145. //------------------------------------------------------------------------------
  146. // HEARTBEAT
  147. //------------------------------------------------------------------------------
  148. #define HEARTBEAT_NONE 0 // Never send heartbeat
  149. #define HEARTBEAT_ONCE 1 // Send it only once upon MQTT connection
  150. #define HEARTBEAT_REPEAT 2 // Send it upon MQTT connection and every HEARTBEAT_INTERVAL
  151. #define HEARTBEAT_REPEAT_STATUS 3 // Send it upon MQTT connection and every HEARTBEAT_INTERVAL only STATUS report
  152. // Backwards compatibility check
  153. #if defined(HEARTBEAT_ENABLED) && (HEARTBEAT_ENABLED == 0)
  154. #define HEARTBEAT_MODE HEARTBEAT_NONE
  155. #endif
  156. #ifndef HEARTBEAT_MODE
  157. #define HEARTBEAT_MODE HEARTBEAT_REPEAT
  158. #endif
  159. #ifndef HEARTBEAT_INTERVAL
  160. #define HEARTBEAT_INTERVAL 300 // Interval between heartbeat messages (in sec)
  161. #endif
  162. #define UPTIME_OVERFLOW 4294967295 // Uptime overflow value
  163. // Values that will be reported in heartbeat
  164. #ifndef HEARTBEAT_REPORT_STATUS
  165. #define HEARTBEAT_REPORT_STATUS 1
  166. #endif
  167. #ifndef HEARTBEAT_REPORT_SSID
  168. #define HEARTBEAT_REPORT_SSID 1
  169. #endif
  170. #ifndef HEARTBEAT_REPORT_IP
  171. #define HEARTBEAT_REPORT_IP 1
  172. #endif
  173. #ifndef HEARTBEAT_REPORT_MAC
  174. #define HEARTBEAT_REPORT_MAC 1
  175. #endif
  176. #ifndef HEARTBEAT_REPORT_RSSI
  177. #define HEARTBEAT_REPORT_RSSI 1
  178. #endif
  179. #ifndef HEARTBEAT_REPORT_UPTIME
  180. #define HEARTBEAT_REPORT_UPTIME 1
  181. #endif
  182. #ifndef HEARTBEAT_REPORT_DATETIME
  183. #define HEARTBEAT_REPORT_DATETIME 1
  184. #endif
  185. #ifndef HEARTBEAT_REPORT_FREEHEAP
  186. #define HEARTBEAT_REPORT_FREEHEAP 1
  187. #endif
  188. #ifndef HEARTBEAT_REPORT_VCC
  189. #define HEARTBEAT_REPORT_VCC 1
  190. #endif
  191. #ifndef HEARTBEAT_REPORT_RELAY
  192. #define HEARTBEAT_REPORT_RELAY 1
  193. #endif
  194. #ifndef HEARTBEAT_REPORT_LIGHT
  195. #define HEARTBEAT_REPORT_LIGHT 1
  196. #endif
  197. #ifndef HEARTBEAT_REPORT_HOSTNAME
  198. #define HEARTBEAT_REPORT_HOSTNAME 1
  199. #endif
  200. #ifndef HEARTBEAT_REPORT_DESCRIPTION
  201. #define HEARTBEAT_REPORT_DESCRIPTION 1
  202. #endif
  203. #ifndef HEARTBEAT_REPORT_APP
  204. #define HEARTBEAT_REPORT_APP 1
  205. #endif
  206. #ifndef HEARTBEAT_REPORT_VERSION
  207. #define HEARTBEAT_REPORT_VERSION 1
  208. #endif
  209. #ifndef HEARTBEAT_REPORT_BOARD
  210. #define HEARTBEAT_REPORT_BOARD 1
  211. #endif
  212. #ifndef HEARTBEAT_REPORT_LOADAVG
  213. #define HEARTBEAT_REPORT_LOADAVG 1
  214. #endif
  215. #ifndef HEARTBEAT_REPORT_INTERVAL
  216. #define HEARTBEAT_REPORT_INTERVAL 0
  217. #endif
  218. #if THERMOSTAT_SUPPORT && ! defined HEARTBEAT_REPORT_RANGE
  219. #define HEARTBEAT_REPORT_RANGE 1
  220. #else
  221. #define HEARTBEAT_REPORT_RANGE 0
  222. #endif
  223. #if THERMOSTAT_SUPPORT && ! defined HEARTBEAT_REPORT_REMOTE_TEMP
  224. #define HEARTBEAT_REPORT_REMOTE_TEMP 1
  225. #else
  226. #define HEARTBEAT_REPORT_REMOTE_TEMP 0
  227. #endif
  228. //------------------------------------------------------------------------------
  229. // Load average
  230. //------------------------------------------------------------------------------
  231. #ifndef LOADAVG_INTERVAL
  232. #define LOADAVG_INTERVAL 30000 // Interval between calculating load average (in ms)
  233. #endif
  234. //------------------------------------------------------------------------------
  235. // BUTTON
  236. //------------------------------------------------------------------------------
  237. #ifndef BUTTON_SUPPORT
  238. #define BUTTON_SUPPORT 1
  239. #endif
  240. #ifndef BUTTON_DEBOUNCE_DELAY
  241. #define BUTTON_DEBOUNCE_DELAY 50 // Debounce delay (ms)
  242. #endif
  243. #ifndef BUTTON_DBLCLICK_DELAY
  244. #define BUTTON_DBLCLICK_DELAY 500 // Time in ms to wait for a second (or third...) click
  245. #endif
  246. #ifndef BUTTON_LNGCLICK_DELAY
  247. #define BUTTON_LNGCLICK_DELAY 1000 // Time in ms holding the button down to get a long click
  248. #endif
  249. #ifndef BUTTON_LNGLNGCLICK_DELAY
  250. #define BUTTON_LNGLNGCLICK_DELAY 10000 // Time in ms holding the button down to get a long-long click
  251. #endif
  252. #ifndef BUTTON_MQTT_SEND_ALL_EVENTS
  253. #define BUTTON_MQTT_SEND_ALL_EVENTS 0 // 0 - to send only events the are bound to actions
  254. // 1 - to send all button events to MQTT
  255. #endif
  256. //------------------------------------------------------------------------------
  257. // ENCODER
  258. //------------------------------------------------------------------------------
  259. #ifndef ENCODER_SUPPORT
  260. #define ENCODER_SUPPORT 0
  261. #endif
  262. #ifndef ENCODER_MINIMUM_DELTA
  263. #define ENCODER_MINIMUM_DELTA 1
  264. #endif
  265. //------------------------------------------------------------------------------
  266. // LED
  267. //------------------------------------------------------------------------------
  268. #ifndef LED_SUPPORT
  269. #define LED_SUPPORT 1
  270. #endif
  271. //------------------------------------------------------------------------------
  272. // RELAY
  273. //------------------------------------------------------------------------------
  274. // Default boot mode: 0 means OFF, 1 ON and 2 whatever was before
  275. #ifndef RELAY_BOOT_MODE
  276. #define RELAY_BOOT_MODE RELAY_BOOT_OFF
  277. #endif
  278. // 0 means ANY, 1 zero or one and 2 one and only one
  279. #ifndef RELAY_SYNC
  280. #define RELAY_SYNC RELAY_SYNC_ANY
  281. #endif
  282. // Default pulse mode: 0 means no pulses, 1 means normally off, 2 normally on
  283. #ifndef RELAY_PULSE_MODE
  284. #define RELAY_PULSE_MODE RELAY_PULSE_NONE
  285. #endif
  286. // Default pulse time in seconds
  287. #ifndef RELAY_PULSE_TIME
  288. #define RELAY_PULSE_TIME 1.0
  289. #endif
  290. // Relay requests flood protection window - in seconds
  291. #ifndef RELAY_FLOOD_WINDOW
  292. #define RELAY_FLOOD_WINDOW 3
  293. #endif
  294. // Allowed actual relay changes inside requests flood protection window
  295. #ifndef RELAY_FLOOD_CHANGES
  296. #define RELAY_FLOOD_CHANGES 5
  297. #endif
  298. // Pulse with in milliseconds for a latched relay
  299. #ifndef RELAY_LATCHING_PULSE
  300. #define RELAY_LATCHING_PULSE 10
  301. #endif
  302. // Do not save relay state after these many milliseconds
  303. #ifndef RELAY_SAVE_DELAY
  304. #define RELAY_SAVE_DELAY 1000
  305. #endif
  306. #ifndef RELAY_REPORT_STATUS
  307. #define RELAY_REPORT_STATUS 1
  308. #endif
  309. // Configure the MQTT payload for ON/OFF
  310. #ifndef RELAY_MQTT_ON
  311. #define RELAY_MQTT_ON "1"
  312. #endif
  313. #ifndef RELAY_MQTT_OFF
  314. #define RELAY_MQTT_OFF "0"
  315. #endif
  316. // TODO Only single EEPROM address is used to store state, which is 1 byte
  317. // Relay status is stored using bitfield.
  318. // This means that, atm, we are only storing the status of the first 8 relays.
  319. #define RELAY_SAVE_MASK_MAX 8
  320. // -----------------------------------------------------------------------------
  321. // WIFI
  322. // -----------------------------------------------------------------------------
  323. #ifndef WIFI_CONNECT_TIMEOUT
  324. #define WIFI_CONNECT_TIMEOUT 60000 // Connecting timeout for WIFI in ms
  325. #endif
  326. #ifndef WIFI_RECONNECT_INTERVAL
  327. #define WIFI_RECONNECT_INTERVAL 180000 // If could not connect to WIFI, retry after this time in ms
  328. #endif
  329. #ifndef WIFI_MAX_NETWORKS
  330. #define WIFI_MAX_NETWORKS 5 // Max number of WIFI connection configurations
  331. #endif
  332. #ifndef WIFI_AP_CAPTIVE
  333. #define WIFI_AP_CAPTIVE 1 // Captive portal enabled when in AP mode
  334. #endif
  335. #ifndef WIFI_FALLBACK_APMODE
  336. #define WIFI_FALLBACK_APMODE 1 // Fallback to AP mode if no STA connection
  337. #endif
  338. #ifndef WIFI_SLEEP_MODE
  339. #define WIFI_SLEEP_MODE WIFI_NONE_SLEEP // WIFI_NONE_SLEEP, WIFI_LIGHT_SLEEP or WIFI_MODEM_SLEEP
  340. #endif
  341. #ifndef WIFI_SCAN_NETWORKS
  342. #define WIFI_SCAN_NETWORKS 1 // Perform a network scan before connecting
  343. #endif
  344. // Optional hardcoded configuration (up to 2 networks)
  345. #ifndef WIFI1_SSID
  346. #define WIFI1_SSID ""
  347. #endif
  348. #ifndef WIFI1_PASS
  349. #define WIFI1_PASS ""
  350. #endif
  351. #ifndef WIFI1_IP
  352. #define WIFI1_IP ""
  353. #endif
  354. #ifndef WIFI1_GW
  355. #define WIFI1_GW ""
  356. #endif
  357. #ifndef WIFI1_MASK
  358. #define WIFI1_MASK ""
  359. #endif
  360. #ifndef WIFI1_DNS
  361. #define WIFI1_DNS ""
  362. #endif
  363. #ifndef WIFI2_SSID
  364. #define WIFI2_SSID ""
  365. #endif
  366. #ifndef WIFI2_PASS
  367. #define WIFI2_PASS ""
  368. #endif
  369. #ifndef WIFI2_IP
  370. #define WIFI2_IP ""
  371. #endif
  372. #ifndef WIFI2_GW
  373. #define WIFI2_GW ""
  374. #endif
  375. #ifndef WIFI2_MASK
  376. #define WIFI2_MASK ""
  377. #endif
  378. #ifndef WIFI2_DNS
  379. #define WIFI2_DNS ""
  380. #endif
  381. #ifndef WIFI3_SSID
  382. #define WIFI3_SSID ""
  383. #endif
  384. #ifndef WIFI3_PASS
  385. #define WIFI3_PASS ""
  386. #endif
  387. #ifndef WIFI3_IP
  388. #define WIFI3_IP ""
  389. #endif
  390. #ifndef WIFI3_GW
  391. #define WIFI3_GW ""
  392. #endif
  393. #ifndef WIFI3_MASK
  394. #define WIFI3_MASK ""
  395. #endif
  396. #ifndef WIFI3_DNS
  397. #define WIFI3_DNS ""
  398. #endif
  399. #ifndef WIFI4_SSID
  400. #define WIFI4_SSID ""
  401. #endif
  402. #ifndef WIFI4_PASS
  403. #define WIFI4_PASS ""
  404. #endif
  405. #ifndef WIFI4_IP
  406. #define WIFI4_IP ""
  407. #endif
  408. #ifndef WIFI4_GW
  409. #define WIFI4_GW ""
  410. #endif
  411. #ifndef WIFI4_MASK
  412. #define WIFI4_MASK ""
  413. #endif
  414. #ifndef WIFI4_DNS
  415. #define WIFI4_DNS ""
  416. #endif
  417. #ifndef WIFI_RSSI_1M
  418. #define WIFI_RSSI_1M -30 // Calibrate it with your router reading the RSSI at 1m
  419. #endif
  420. #ifndef WIFI_PROPAGATION_CONST
  421. #define WIFI_PROPAGATION_CONST 4 // This is typically something between 2.7 to 4.3 (free space is 2)
  422. #endif
  423. // -----------------------------------------------------------------------------
  424. // WEB
  425. // -----------------------------------------------------------------------------
  426. #ifndef WEB_SUPPORT
  427. #define WEB_SUPPORT 1 // Enable web support (http, api, 121.65Kb)
  428. #endif
  429. #ifndef WEB_EMBEDDED
  430. #define WEB_EMBEDDED 1 // Build the firmware with the web interface embedded in
  431. #endif
  432. // This is not working at the moment!!
  433. // Requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core 2.4.0
  434. #ifndef WEB_SSL_ENABLED
  435. #define WEB_SSL_ENABLED 0 // Use HTTPS web interface
  436. #endif
  437. #ifndef WEB_USERNAME
  438. #define WEB_USERNAME "admin" // HTTP username
  439. #endif
  440. #ifndef WEB_FORCE_PASS_CHANGE
  441. #define WEB_FORCE_PASS_CHANGE 1 // Force the user to change the password if default one
  442. #endif
  443. #ifndef WEB_PORT
  444. #define WEB_PORT 80 // HTTP port
  445. #endif
  446. // Defining a WEB_REMOTE_DOMAIN will enable Cross-Origin Resource Sharing (CORS)
  447. // so you will be able to login to this device from another domain. This will allow
  448. // you to manage all ESPurna devices in your local network from a unique installation
  449. // of the web UI. This installation could be in a local server (a Raspberry Pi, for instance)
  450. // or in the Internet. Since the WebUI is just one compressed file with HTML, CSS and JS
  451. // there are no special requirements. Any static web server will do (NGinx, Apache, Lighttpd,...).
  452. // The only requirement is that the resource must be available under this domain.
  453. #ifndef WEB_REMOTE_DOMAIN
  454. #define WEB_REMOTE_DOMAIN "http://espurna.io"
  455. #endif
  456. // -----------------------------------------------------------------------------
  457. // WEBSOCKETS
  458. // -----------------------------------------------------------------------------
  459. // This will only be enabled if WEB_SUPPORT is 1 (this is the default value)
  460. #ifndef WS_AUTHENTICATION
  461. #define WS_AUTHENTICATION 1 // WS authentication ON by default (see #507)
  462. #endif
  463. #ifndef WS_BUFFER_SIZE
  464. #define WS_BUFFER_SIZE 5 // Max number of secured websocket connections
  465. #endif
  466. #ifndef WS_TIMEOUT
  467. #define WS_TIMEOUT 1800000 // Timeout for secured websocket
  468. #endif
  469. #ifndef WS_UPDATE_INTERVAL
  470. #define WS_UPDATE_INTERVAL 30000 // Update clients every 30 seconds
  471. #endif
  472. // -----------------------------------------------------------------------------
  473. // API
  474. // -----------------------------------------------------------------------------
  475. #ifndef API_SUPPORT
  476. #define API_SUPPORT 1 // API (REST & RPC) support built in
  477. #endif
  478. // This will only be enabled if WEB_SUPPORT is 1 (this is the default value)
  479. #ifndef API_ENABLED
  480. #define API_ENABLED 0 // Do not enable API by default
  481. #endif
  482. #ifndef API_RESTFUL
  483. #define API_RESTFUL 1 // A restful API requires changes to be issued as PUT requests
  484. // Setting this to 0 will allow using GET to change relays, for instance
  485. #endif
  486. #ifndef API_BUFFER_SIZE
  487. #define API_BUFFER_SIZE 64 // Size of the buffer for HTTP GET API responses
  488. #endif
  489. #ifndef API_REAL_TIME_VALUES
  490. #define API_REAL_TIME_VALUES 0 // Show filtered/median values by default (0 => median, 1 => real time)
  491. #endif
  492. // -----------------------------------------------------------------------------
  493. // MDNS / LLMNR / NETBIOS / SSDP
  494. // -----------------------------------------------------------------------------
  495. #ifndef MDNS_SERVER_SUPPORT
  496. #define MDNS_SERVER_SUPPORT 1 // Publish services using mDNS by default (1.48Kb)
  497. #endif
  498. #ifndef MDNS_CLIENT_SUPPORT
  499. #define MDNS_CLIENT_SUPPORT 0 // Resolve mDNS names (3.44Kb)
  500. #endif
  501. #ifndef LLMNR_SUPPORT
  502. #define LLMNR_SUPPORT 0 // Publish device using LLMNR protocol by default (1.95Kb) - requires 2.4.0
  503. #endif
  504. #ifndef NETBIOS_SUPPORT
  505. #define NETBIOS_SUPPORT 0 // Publish device using NetBIOS protocol by default (1.26Kb) - requires 2.4.0
  506. #endif
  507. #ifndef SSDP_SUPPORT
  508. #define SSDP_SUPPORT 0 // Publish device using SSDP protocol by default (4.59Kb)
  509. // Not compatible with ALEXA_SUPPORT at the moment
  510. #endif
  511. #ifndef SSDP_DEVICE_TYPE
  512. #define SSDP_DEVICE_TYPE "upnp:rootdevice"
  513. //#define SSDP_DEVICE_TYPE "urn:schemas-upnp-org:device:BinaryLight:1"
  514. #endif
  515. // -----------------------------------------------------------------------------
  516. // SPIFFS
  517. // -----------------------------------------------------------------------------
  518. #ifndef SPIFFS_SUPPORT
  519. #define SPIFFS_SUPPORT 0 // Do not add support for SPIFFS by default
  520. #endif
  521. // -----------------------------------------------------------------------------
  522. // SSL Client ** EXPERIMENTAL **
  523. // -----------------------------------------------------------------------------
  524. #ifndef SECURE_CLIENT
  525. #define SECURE_CLIENT SECURE_CLIENT_NONE // What variant of WiFiClient to use
  526. // SECURE_CLIENT_NONE - No secure client support (default)
  527. // SECURE_CLIENT_AXTLS - axTLS client secure support (All Core versions, ONLY TLS 1.1)
  528. // SECURE_CLIENT_BEARSSL - BearSSL client secure support (starting with 2.5.0, TLS 1.2)
  529. //
  530. // axTLS marked for derecation since Arduino Core 2.4.2 and **will** be removed in the future
  531. #endif
  532. // Security check that is performed when the connection is established:
  533. // SECURE_CLIENT_CHECK_CA - Use Trust Anchor / Root Certificate
  534. // Supported only by the SECURE_CLIENT_BEARSSL
  535. // (See respective ..._SECURE_CLIENT_INCLUDE_CA options per-module)
  536. // SECURE_CLIENT_CHECK_FINGERPRINT - Check certificate fingerprint
  537. // SECURE_CLIENT_CHECK_NONE - Allow insecure connections
  538. #ifndef SECURE_CLIENT_CHECK
  539. #if SECURE_CLIENT == SECURE_CLIENT_BEARSSL
  540. #define SECURE_CLIENT_CHECK SECURE_CLIENT_CHECK_CA
  541. #else
  542. #define SECURE_CLIENT_CHECK SECURE_CLIENT_CHECK_FINGERPRINT
  543. #endif
  544. #endif // SECURE_CLIENT_CHECK
  545. // Support Maximum Fragment Length Negotiation TLS extension
  546. // "...negotiate a smaller maximum fragment length due to memory limitations or bandwidth limitations."
  547. // - https://arduino-esp8266.readthedocs.io/en/latest/esp8266wifi/bearssl-client-secure-class.html#mfln-or-maximum-fragment-length-negotiation-saving-ram
  548. // - https://tools.ietf.org/html/rfc6066#section-4
  549. #ifndef SECURE_CLIENT_MFLN
  550. #define SECURE_CLIENT_MFLN 0 // The only possible values are: 512, 1024, 2048 and 4096
  551. // Set to 0 to disable (default)
  552. #endif
  553. // -----------------------------------------------------------------------------
  554. // OTA
  555. // -----------------------------------------------------------------------------
  556. #ifndef OTA_PORT
  557. #define OTA_PORT 8266 // Port for ArduinoOTA
  558. #endif
  559. #ifndef OTA_MQTT_SUPPORT
  560. #define OTA_MQTT_SUPPORT 0 // Listen for HTTP(s) URLs at '<root topic>/ota'. Depends on OTA_CLIENT
  561. #endif
  562. #ifndef OTA_ARDUINOOTA_SUPPORT
  563. #define OTA_ARDUINOOTA_SUPPORT 1 // Support ArduinoOTA by default (4.2Kb)
  564. // Implicitly depends on ESP8266mDNS library, thus increasing firmware size
  565. #endif
  566. #ifndef OTA_CLIENT
  567. #define OTA_CLIENT OTA_CLIENT_ASYNCTCP // Terminal / MQTT OTA support
  568. // OTA_CLIENT_ASYNCTCP (ESPAsyncTCP library)
  569. // OTA_CLIENT_HTTPUPDATE (Arduino Core library)
  570. #endif
  571. #ifndef OTA_CLIENT_HTTPUPDATE_2_3_0_COMPATIBLE
  572. #define OTA_CLIENT_HTTPUPDATE_2_3_0_COMPATIBLE 1 // Use old HTTPUpdate API by default
  573. #endif
  574. #define OTA_GITHUB_FP "CA:06:F5:6B:25:8B:7A:0D:4F:2B:05:47:09:39:47:86:51:15:19:84"
  575. #ifndef OTA_FINGERPRINT
  576. #define OTA_FINGERPRINT OTA_GITHUB_FP
  577. #endif
  578. #ifndef OTA_SECURE_CLIENT_CHECK
  579. #define OTA_SECURE_CLIENT_CHECK SECURE_CLIENT_CHECK
  580. #endif
  581. #ifndef OTA_SECURE_CLIENT_MFLN
  582. #define OTA_SECURE_CLIENT_MFLN SECURE_CLIENT_MFLN
  583. #endif
  584. #ifndef OTA_SECURE_CLIENT_INCLUDE_CA
  585. #define OTA_SECURE_CLIENT_INCLUDE_CA 0 // Use user-provided CA. Only PROGMEM PEM option is supported.
  586. // TODO: eventually should be replaced with pre-parsed structs, read directly from flash
  587. // (ref: https://github.com/earlephilhower/bearssl-esp8266/pull/14)
  588. //
  589. // When enabled, current implementation includes "static/ota_secure_client_ca.h" with
  590. // const char _ota_client_http_update_ca[] PROGMEM = "...PEM data...";
  591. // By default, using DigiCert root in "static/digicert_evroot_pem.h" (for https://github.com)
  592. #endif
  593. // -----------------------------------------------------------------------------
  594. // NOFUSS
  595. // -----------------------------------------------------------------------------
  596. #ifndef NOFUSS_SUPPORT
  597. #define NOFUSS_SUPPORT 0 // Do not enable support for NoFuss by default (12.65Kb)
  598. #endif
  599. #ifndef NOFUSS_ENABLED
  600. #define NOFUSS_ENABLED 0 // Do not perform NoFUSS updates by default
  601. #endif
  602. #ifndef NOFUSS_SERVER
  603. #define NOFUSS_SERVER "" // Default NoFuss Server
  604. #endif
  605. #ifndef NOFUSS_INTERVAL
  606. #define NOFUSS_INTERVAL 3600000 // Check for updates every hour
  607. #endif
  608. // -----------------------------------------------------------------------------
  609. // UART <-> MQTT
  610. // -----------------------------------------------------------------------------
  611. #ifndef UART_MQTT_SUPPORT
  612. #define UART_MQTT_SUPPORT 0 // No support by default
  613. #endif
  614. #ifndef UART_MQTT_USE_SOFT
  615. #define UART_MQTT_USE_SOFT 0 // Use SoftwareSerial
  616. #endif
  617. #ifndef UART_MQTT_HW_PORT
  618. #define UART_MQTT_HW_PORT Serial // Hardware serial port (if UART_MQTT_USE_SOFT == 0)
  619. #endif
  620. #ifndef UART_MQTT_RX_PIN
  621. #define UART_MQTT_RX_PIN 4 // RX PIN (if UART_MQTT_USE_SOFT == 1)
  622. #endif
  623. #ifndef UART_MQTT_TX_PIN
  624. #define UART_MQTT_TX_PIN 5 // TX PIN (if UART_MQTT_USE_SOFT == 1)
  625. #endif
  626. #ifndef UART_MQTT_BAUDRATE
  627. #define UART_MQTT_BAUDRATE 115200 // Serial speed
  628. #endif
  629. #ifndef UART_MQTT_TERMINATION
  630. #define UART_MQTT_TERMINATION '\n' // Termination character
  631. #endif
  632. #define UART_MQTT_BUFFER_SIZE 100 // UART buffer size
  633. // -----------------------------------------------------------------------------
  634. // MQTT
  635. // -----------------------------------------------------------------------------
  636. #ifndef MQTT_SUPPORT
  637. #define MQTT_SUPPORT 1 // MQTT support (22.38Kb async, 12.48Kb sync)
  638. #endif
  639. #ifndef MQTT_USE_ASYNC
  640. #define MQTT_USE_ASYNC 1 // Use AysncMQTTClient (1) or PubSubClient (0)
  641. #endif
  642. // MQTT OVER SSL
  643. // Using MQTT over SSL works pretty well but generates problems with the web interface.
  644. // It could be a good idea to use it in conjuntion with WEB_SUPPORT=0.
  645. // Requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core 2.4.0.
  646. //
  647. // You can use SSL with MQTT_USE_ASYNC=1 (AsyncMqttClient library)
  648. // but you might experience hiccups on the web interface, so my recommendation is:
  649. // WEB_SUPPORT=0
  650. //
  651. // If you use SSL with MQTT_USE_ASYNC=0 (PubSubClient library)
  652. // you will have to disable all the modules that use ESPAsyncTCP, that is:
  653. // ALEXA_SUPPORT=0, INFLUXDB_SUPPORT=0, TELNET_SUPPORT=0, THINGSPEAK_SUPPORT=0 and WEB_SUPPORT=0
  654. //
  655. // You will need the fingerprint for your MQTT server, example for CloudMQTT:
  656. // $ echo -n | openssl s_client -connect m11.cloudmqtt.com:24055 > cloudmqtt.pem
  657. // $ openssl x509 -noout -in cloudmqtt.pem -fingerprint -sha1
  658. #ifndef MQTT_SSL_ENABLED
  659. #define MQTT_SSL_ENABLED 0 // By default MQTT over SSL will not be enabled
  660. #endif
  661. #ifndef MQTT_SSL_FINGERPRINT
  662. #define MQTT_SSL_FINGERPRINT "" // SSL fingerprint of the server
  663. #endif
  664. #ifndef MQTT_ENABLED
  665. #define MQTT_ENABLED 0 // Do not enable MQTT connection by default
  666. #endif
  667. #ifndef MQTT_AUTOCONNECT
  668. #define MQTT_AUTOCONNECT 1 // If enabled and MDNS_SERVER_SUPPORT=1 will perform an autodiscover and
  669. // autoconnect to the first MQTT broker found if none defined
  670. #endif
  671. #ifndef MQTT_SERVER
  672. #define MQTT_SERVER "" // Default MQTT broker address
  673. #endif
  674. #ifndef MQTT_USER
  675. #define MQTT_USER "" // Default MQTT broker usename
  676. #endif
  677. #ifndef MQTT_PASS
  678. #define MQTT_PASS "" // Default MQTT broker password
  679. #endif
  680. #ifndef MQTT_PORT
  681. #define MQTT_PORT 1883 // MQTT broker port
  682. #endif
  683. #ifndef MQTT_TOPIC
  684. #define MQTT_TOPIC "{hostname}" // Default MQTT base topic
  685. #endif
  686. #ifndef MQTT_RETAIN
  687. #define MQTT_RETAIN true // MQTT retain flag
  688. #endif
  689. #ifndef MQTT_QOS
  690. #define MQTT_QOS 0 // MQTT QoS value for all messages
  691. #endif
  692. #ifndef MQTT_KEEPALIVE
  693. #define MQTT_KEEPALIVE 300 // MQTT keepalive value
  694. #endif
  695. #ifndef MQTT_RECONNECT_DELAY_MIN
  696. #define MQTT_RECONNECT_DELAY_MIN 5000 // Try to reconnect in 5 seconds upon disconnection
  697. #endif
  698. #ifndef MQTT_RECONNECT_DELAY_STEP
  699. #define MQTT_RECONNECT_DELAY_STEP 5000 // Increase the reconnect delay in 5 seconds after each failed attempt
  700. #endif
  701. #ifndef MQTT_RECONNECT_DELAY_MAX
  702. #define MQTT_RECONNECT_DELAY_MAX 120000 // Set reconnect time to 2 minutes at most
  703. #endif
  704. #ifndef MQTT_SKIP_RETAINED
  705. #define MQTT_SKIP_RETAINED 1 // Skip retained messages on connection
  706. #endif
  707. #ifndef MQTT_SKIP_TIME
  708. #define MQTT_SKIP_TIME 1000 // Skip messages for 1 second anter connection
  709. #endif
  710. #if THERMOSTAT_SUPPORT == 1
  711. #ifndef MQTT_USE_JSON
  712. #define MQTT_USE_JSON 1 // Group messages in a JSON body
  713. #endif
  714. #else
  715. #ifndef MQTT_USE_JSON
  716. #define MQTT_USE_JSON 0 // Don't group messages in a JSON body (default)
  717. #endif
  718. #endif
  719. #ifndef MQTT_USE_JSON_DELAY
  720. #define MQTT_USE_JSON_DELAY 100 // Wait this many ms before grouping messages
  721. #endif
  722. #ifndef MQTT_QUEUE_MAX_SIZE
  723. #define MQTT_QUEUE_MAX_SIZE 20 // Size of the MQTT queue when MQTT_USE_JSON is enabled
  724. #endif
  725. // These are the properties that will be sent when useJson is true
  726. #ifndef MQTT_ENQUEUE_IP
  727. #define MQTT_ENQUEUE_IP 1
  728. #endif
  729. #ifndef MQTT_ENQUEUE_MAC
  730. #define MQTT_ENQUEUE_MAC 1
  731. #endif
  732. #ifndef MQTT_ENQUEUE_HOSTNAME
  733. #define MQTT_ENQUEUE_HOSTNAME 1
  734. #endif
  735. #ifndef MQTT_ENQUEUE_DATETIME
  736. #define MQTT_ENQUEUE_DATETIME 1
  737. #endif
  738. #ifndef MQTT_ENQUEUE_MESSAGE_ID
  739. #define MQTT_ENQUEUE_MESSAGE_ID 1
  740. #endif
  741. // These particles will be concatenated to the MQTT_TOPIC base to form the actual topic
  742. #define MQTT_TOPIC_JSON "data"
  743. #define MQTT_TOPIC_ACTION "action"
  744. #define MQTT_TOPIC_RELAY "relay"
  745. #define MQTT_TOPIC_LED "led"
  746. #define MQTT_TOPIC_BUTTON "button"
  747. #define MQTT_TOPIC_IP "ip"
  748. #define MQTT_TOPIC_SSID "ssid"
  749. #define MQTT_TOPIC_VERSION "version"
  750. #define MQTT_TOPIC_UPTIME "uptime"
  751. #define MQTT_TOPIC_DATETIME "datetime"
  752. #define MQTT_TOPIC_FREEHEAP "freeheap"
  753. #define MQTT_TOPIC_VCC "vcc"
  754. #define MQTT_TOPIC_STATUS "status"
  755. #define MQTT_TOPIC_MAC "mac"
  756. #define MQTT_TOPIC_RSSI "rssi"
  757. #define MQTT_TOPIC_MESSAGE_ID "id"
  758. #define MQTT_TOPIC_APP "app"
  759. #define MQTT_TOPIC_INTERVAL "interval"
  760. #define MQTT_TOPIC_HOSTNAME "host"
  761. #define MQTT_TOPIC_DESCRIPTION "desc"
  762. #define MQTT_TOPIC_TIME "time"
  763. #define MQTT_TOPIC_RFOUT "rfout"
  764. #define MQTT_TOPIC_RFIN "rfin"
  765. #define MQTT_TOPIC_RFLEARN "rflearn"
  766. #define MQTT_TOPIC_RFRAW "rfraw"
  767. #define MQTT_TOPIC_UARTIN "uartin"
  768. #define MQTT_TOPIC_UARTOUT "uartout"
  769. #define MQTT_TOPIC_LOADAVG "loadavg"
  770. #define MQTT_TOPIC_BOARD "board"
  771. #define MQTT_TOPIC_PULSE "pulse"
  772. #define MQTT_TOPIC_SPEED "speed"
  773. #define MQTT_TOPIC_IRIN "irin"
  774. #define MQTT_TOPIC_IROUT "irout"
  775. #define MQTT_TOPIC_OTA "ota"
  776. // Light module
  777. #define MQTT_TOPIC_CHANNEL "channel"
  778. #define MQTT_TOPIC_COLOR_RGB "rgb"
  779. #define MQTT_TOPIC_COLOR_HSV "hsv"
  780. #define MQTT_TOPIC_ANIM_MODE "anim_mode"
  781. #define MQTT_TOPIC_ANIM_SPEED "anim_speed"
  782. #define MQTT_TOPIC_BRIGHTNESS "brightness"
  783. #define MQTT_TOPIC_MIRED "mired"
  784. #define MQTT_TOPIC_KELVIN "kelvin"
  785. #define MQTT_TOPIC_TRANSITION "transition"
  786. // Thermostat module
  787. #define MQTT_TOPIC_HOLD_TEMP "hold_temp"
  788. #define MQTT_TOPIC_HOLD_TEMP_MIN "min"
  789. #define MQTT_TOPIC_HOLD_TEMP_MAX "max"
  790. #define MQTT_TOPIC_REMOTE_TEMP "remote_temp"
  791. #define MQTT_TOPIC_ASK_TEMP_RANGE "ask_temp_range"
  792. #define MQTT_TOPIC_NOTIFY_TEMP_RANGE_MIN "notify_temp_range_min"
  793. #define MQTT_TOPIC_NOTIFY_TEMP_RANGE_MAX "notify_temp_range_max"
  794. #define MQTT_STATUS_ONLINE "1" // Value for the device ON message
  795. #define MQTT_STATUS_OFFLINE "0" // Value for the device OFF message (will)
  796. #define MQTT_ACTION_RESET "reboot" // RESET MQTT topic particle
  797. #define MQTT_MESSAGE_ID_SHIFT 1000 // Store MQTT message id into EEPROM every these many
  798. // Custom get and set postfixes
  799. // Use something like "/status" or "/set", with leading slash
  800. // Since 1.9.0 the default value is "" for getter and "/set" for setter
  801. #ifndef MQTT_GETTER
  802. #define MQTT_GETTER ""
  803. #endif
  804. #ifndef MQTT_SETTER
  805. #define MQTT_SETTER "/set"
  806. #endif
  807. // -----------------------------------------------------------------------------
  808. // BROKER
  809. // -----------------------------------------------------------------------------
  810. #ifndef BROKER_SUPPORT
  811. #define BROKER_SUPPORT 1 // The broker is a poor-man's pubsub manager
  812. #endif
  813. // -----------------------------------------------------------------------------
  814. // SETTINGS
  815. // -----------------------------------------------------------------------------
  816. #ifndef SETTINGS_AUTOSAVE
  817. #define SETTINGS_AUTOSAVE 1 // Autosave settings or force manual commit
  818. #endif
  819. #define SETTINGS_MAX_LIST_COUNT 10 // Maximum index for settings lists
  820. // -----------------------------------------------------------------------------
  821. // LIGHT
  822. // -----------------------------------------------------------------------------
  823. // LIGHT_PROVIDER_DIMMER can have from 1 to 5 different channels.
  824. // They have to be defined for each device in the hardware.h file.
  825. // If 3 or more channels first 3 will be considered RGB.
  826. // Usual configurations are:
  827. // 1 channels => W
  828. // 2 channels => WW
  829. // 3 channels => RGB
  830. // 4 channels => RGBW
  831. // 5 channels => RGBWW
  832. #ifndef LIGHT_SAVE_ENABLED
  833. #define LIGHT_SAVE_ENABLED 1 // Light channel values saved by default after each change
  834. #endif
  835. #ifndef LIGHT_COMMS_DELAY
  836. #define LIGHT_COMMS_DELAY 100 // Delay communication after light update (in ms)
  837. #endif
  838. #ifndef LIGHT_SAVE_DELAY
  839. #define LIGHT_SAVE_DELAY 5 // Persist color after 5 seconds to avoid wearing out
  840. #endif
  841. #ifndef LIGHT_MAX_PWM
  842. #if LIGHT_PROVIDER == LIGHT_PROVIDER_MY92XX
  843. #define LIGHT_MAX_PWM 255
  844. #endif
  845. #if LIGHT_PROVIDER == LIGHT_PROVIDER_DIMMER
  846. #define LIGHT_MAX_PWM 10000 // 10000 * 200ns => 2 kHz
  847. #endif
  848. #endif // LIGHT_MAX_PWM
  849. #ifndef LIGHT_LIMIT_PWM
  850. #define LIGHT_LIMIT_PWM LIGHT_MAX_PWM // Limit PWM to this value (prevent 100% power)
  851. #endif
  852. #ifndef LIGHT_MAX_VALUE
  853. #define LIGHT_MAX_VALUE 255 // Maximum light value
  854. #endif
  855. #ifndef LIGHT_MAX_BRIGHTNESS
  856. #define LIGHT_MAX_BRIGHTNESS 255 // Maximun brightness value
  857. #endif
  858. #define LIGHT_MIN_MIREDS 153 // Default to the Philips Hue value that HA also use.
  859. #define LIGHT_MAX_MIREDS 500 // https://developers.meethue.com/documentation/core-concepts
  860. #ifndef LIGHT_STEP
  861. #define LIGHT_STEP 32 // Step size
  862. #endif
  863. #ifndef LIGHT_USE_COLOR
  864. #define LIGHT_USE_COLOR 1 // Use 3 first channels as RGB
  865. #endif
  866. #ifndef LIGHT_USE_WHITE
  867. #define LIGHT_USE_WHITE 0 // Use the 4th channel as (Warm-)White LEDs
  868. #endif
  869. #ifndef LIGHT_USE_CCT
  870. #define LIGHT_USE_CCT 0 // Use the 5th channel as Coldwhite LEDs, LIGHT_USE_WHITE must be 1.
  871. #endif
  872. // Used when LIGHT_USE_WHITE AND LIGHT_USE_CCT is 1 - (1000000/Kelvin = MiReds)
  873. // Warning! Don't change this yet, NOT FULLY IMPLEMENTED!
  874. #define LIGHT_COLDWHITE_MIRED 153 // Coldwhite Strip, Value must be __BELOW__ W2!! (Default: 6535 Kelvin/153 MiRed)
  875. #define LIGHT_WARMWHITE_MIRED 500 // Warmwhite Strip, Value must be __ABOVE__ W1!! (Default: 2000 Kelvin/500 MiRed)
  876. #ifndef LIGHT_USE_GAMMA
  877. #define LIGHT_USE_GAMMA 0 // Use gamma correction for color channels
  878. #endif
  879. #ifndef LIGHT_USE_CSS
  880. #define LIGHT_USE_CSS 1 // Use CSS style to report colors (1=> "#FF0000", 0=> "255,0,0")
  881. #endif
  882. #ifndef LIGHT_USE_RGB
  883. #define LIGHT_USE_RGB 0 // Use RGB color selector (1=> RGB, 0=> HSV)
  884. #endif
  885. #ifndef LIGHT_WHITE_FACTOR
  886. #define LIGHT_WHITE_FACTOR 1 // When using LIGHT_USE_WHITE with uneven brightness LEDs,
  887. // this factor is used to scale the white channel to match brightness
  888. #endif
  889. #ifndef LIGHT_USE_TRANSITIONS
  890. #define LIGHT_USE_TRANSITIONS 1 // Transitions between colors
  891. #endif
  892. #ifndef LIGHT_TRANSITION_STEP
  893. #define LIGHT_TRANSITION_STEP 10 // Time in millis between each transtion step
  894. #endif
  895. #ifndef LIGHT_TRANSITION_TIME
  896. #define LIGHT_TRANSITION_TIME 500 // Time in millis from color to color
  897. #endif
  898. // -----------------------------------------------------------------------------
  899. // DOMOTICZ
  900. // -----------------------------------------------------------------------------
  901. #ifndef DOMOTICZ_SUPPORT
  902. #define DOMOTICZ_SUPPORT MQTT_SUPPORT // Build with domoticz (if MQTT) support (1.72Kb)
  903. #endif
  904. #ifndef DOMOTICZ_ENABLED
  905. #define DOMOTICZ_ENABLED 0 // Disable domoticz by default
  906. #endif
  907. #ifndef DOMOTICZ_IN_TOPIC
  908. #define DOMOTICZ_IN_TOPIC "domoticz/in" // Default subscription topic
  909. #endif
  910. #ifndef DOMOTICZ_OUT_TOPIC
  911. #define DOMOTICZ_OUT_TOPIC "domoticz/out" // Default publication topic
  912. #endif
  913. // -----------------------------------------------------------------------------
  914. // HOME ASSISTANT
  915. // -----------------------------------------------------------------------------
  916. #ifndef HOMEASSISTANT_SUPPORT
  917. #define HOMEASSISTANT_SUPPORT MQTT_SUPPORT // Build with home assistant support (if MQTT, 1.64Kb)
  918. #endif
  919. #ifndef HOMEASSISTANT_ENABLED
  920. #define HOMEASSISTANT_ENABLED 0 // Integration not enabled by default
  921. #endif
  922. #ifndef HOMEASSISTANT_PREFIX
  923. #define HOMEASSISTANT_PREFIX "homeassistant" // Default MQTT prefix
  924. #endif
  925. #ifndef HOMEASSISTANT_PAYLOAD_ON
  926. #define HOMEASSISTANT_PAYLOAD_ON "1" // Payload for ON and available messages
  927. #endif
  928. #ifndef HOMEASSISTANT_PAYLOAD_OFF
  929. #define HOMEASSISTANT_PAYLOAD_OFF "0" // Payload for OFF and unavailable messages
  930. #endif
  931. #ifndef HOMEASSISTANT_PAYLOAD_AVAILABLE
  932. #define HOMEASSISTANT_PAYLOAD_AVAILABLE "1" // Payload for available messages
  933. #endif
  934. #ifndef HOMEASSISTANT_PAYLOAD_NOT_AVAILABLE
  935. #define HOMEASSISTANT_PAYLOAD_NOT_AVAILABLE "0" // Payload for available messages
  936. #endif
  937. // -----------------------------------------------------------------------------
  938. // INFLUXDB
  939. // -----------------------------------------------------------------------------
  940. #ifndef INFLUXDB_SUPPORT
  941. #define INFLUXDB_SUPPORT 0 // Disable InfluxDB support by default (4.38Kb)
  942. #endif
  943. #ifndef INFLUXDB_ENABLED
  944. #define INFLUXDB_ENABLED 0 // InfluxDB disabled by default
  945. #endif
  946. #ifndef INFLUXDB_HOST
  947. #define INFLUXDB_HOST "" // Default server
  948. #endif
  949. #ifndef INFLUXDB_PORT
  950. #define INFLUXDB_PORT 8086 // Default InfluxDB port
  951. #endif
  952. #ifndef INFLUXDB_DATABASE
  953. #define INFLUXDB_DATABASE "" // Default database
  954. #endif
  955. #ifndef INFLUXDB_USERNAME
  956. #define INFLUXDB_USERNAME "" // Default username
  957. #endif
  958. #ifndef INFLUXDB_PASSWORD
  959. #define INFLUXDB_PASSWORD "" // Default password
  960. #endif
  961. // -----------------------------------------------------------------------------
  962. // THINGSPEAK
  963. // -----------------------------------------------------------------------------
  964. #ifndef THINGSPEAK_SUPPORT
  965. #define THINGSPEAK_SUPPORT 1 // Enable Thingspeak support by default (2.56Kb)
  966. #endif
  967. #ifndef THINGSPEAK_ENABLED
  968. #define THINGSPEAK_ENABLED 0 // Thingspeak disabled by default
  969. #endif
  970. #ifndef THINGSPEAK_APIKEY
  971. #define THINGSPEAK_APIKEY "" // Default API KEY
  972. #endif
  973. #ifndef THINGSPEAK_CLEAR_CACHE
  974. #define THINGSPEAK_CLEAR_CACHE 1 // Clear cache after sending values
  975. // Not clearing it will result in latest values for each field being sent every time
  976. #endif
  977. #define THINGSPEAK_USE_ASYNC 1 // Use AsyncClient instead of WiFiClientSecure
  978. // THINGSPEAK OVER SSL
  979. // Using THINGSPEAK over SSL works well but generates problems with the web interface,
  980. // so you should compile it with WEB_SUPPORT to 0.
  981. // When THINGSPEAK_USE_ASYNC is 1, requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core 2.4.0.
  982. #define THINGSPEAK_USE_SSL 0 // Use secure connection
  983. #define THINGSPEAK_FINGERPRINT "78 60 18 44 81 35 BF DF 77 84 D4 0A 22 0D 9B 4E 6C DC 57 2C"
  984. #define THINGSPEAK_HOST "api.thingspeak.com"
  985. #if THINGSPEAK_USE_SSL
  986. #define THINGSPEAK_PORT 443
  987. #else
  988. #define THINGSPEAK_PORT 80
  989. #endif
  990. #define THINGSPEAK_URL "/update"
  991. #define THINGSPEAK_MIN_INTERVAL 15000 // Minimum interval between POSTs (in millis)
  992. #define THINGSPEAK_FIELDS 8 // Number of fields
  993. #ifndef THINGSPEAK_TRIES
  994. #define THINGSPEAK_TRIES 3 // Number of tries when sending data (minimum 1)
  995. #endif
  996. // -----------------------------------------------------------------------------
  997. // SCHEDULER
  998. // -----------------------------------------------------------------------------
  999. #ifndef SCHEDULER_SUPPORT
  1000. #define SCHEDULER_SUPPORT 1 // Enable scheduler (1.77Kb)
  1001. #endif
  1002. #ifndef SCHEDULER_MAX_SCHEDULES
  1003. #define SCHEDULER_MAX_SCHEDULES 10 // Max schedules alowed
  1004. #endif
  1005. // -----------------------------------------------------------------------------
  1006. // NTP
  1007. // -----------------------------------------------------------------------------
  1008. #ifndef NTP_SUPPORT
  1009. #define NTP_SUPPORT 1 // Build with NTP support by default (6.78Kb)
  1010. #endif
  1011. #ifndef NTP_SERVER
  1012. #define NTP_SERVER "pool.ntp.org" // Default NTP server
  1013. #endif
  1014. #ifndef NTP_TIMEOUT
  1015. #define NTP_TIMEOUT 1000 // Set NTP request timeout to 2 seconds (issue #452)
  1016. #endif
  1017. #ifndef NTP_TIME_OFFSET
  1018. #define NTP_TIME_OFFSET 60 // Default timezone offset (GMT+1)
  1019. #endif
  1020. #ifndef NTP_DAY_LIGHT
  1021. #define NTP_DAY_LIGHT 1 // Enable daylight time saving by default
  1022. #endif
  1023. #ifndef NTP_SYNC_INTERVAL
  1024. #define NTP_SYNC_INTERVAL 60 // NTP initial check every minute
  1025. #endif
  1026. #ifndef NTP_UPDATE_INTERVAL
  1027. #define NTP_UPDATE_INTERVAL 1800 // NTP check every 30 minutes
  1028. #endif
  1029. #ifndef NTP_START_DELAY
  1030. #define NTP_START_DELAY 1000 // Delay NTP start 1 second
  1031. #endif
  1032. #ifndef NTP_DST_REGION
  1033. #define NTP_DST_REGION 0 // 0 for Europe, 1 for USA (defined in NtpClientLib)
  1034. #endif
  1035. #ifndef NTP_WAIT_FOR_SYNC
  1036. #define NTP_WAIT_FOR_SYNC 1 // Do not report any datetime until NTP sync'ed
  1037. #endif
  1038. // -----------------------------------------------------------------------------
  1039. // ALEXA
  1040. // -----------------------------------------------------------------------------
  1041. // This setting defines whether Alexa support should be built into the firmware
  1042. #ifndef ALEXA_SUPPORT
  1043. #define ALEXA_SUPPORT 1 // Enable Alexa support by default (10.84Kb)
  1044. #endif
  1045. // This is default value for the alexaEnabled setting that defines whether
  1046. // this device should be discoberable and respond to Alexa commands.
  1047. // Both ALEXA_SUPPORT and alexaEnabled should be 1 for Alexa support to work.
  1048. #ifndef ALEXA_ENABLED
  1049. #define ALEXA_ENABLED 1
  1050. #endif
  1051. #ifndef ALEXA_HOSTNAME
  1052. #define ALEXA_HOSTNAME ""
  1053. #endif
  1054. // -----------------------------------------------------------------------------
  1055. // MQTT RF BRIDGE
  1056. // -----------------------------------------------------------------------------
  1057. #ifndef RF_SUPPORT
  1058. #define RF_SUPPORT 0
  1059. #endif
  1060. #ifndef RF_DEBOUNCE
  1061. #define RF_DEBOUNCE 500
  1062. #endif
  1063. #ifndef RF_LEARN_TIMEOUT
  1064. #define RF_LEARN_TIMEOUT 60000
  1065. #endif
  1066. #ifndef RF_SEND_TIMES
  1067. #define RF_SEND_TIMES 4 // How many times to send the message
  1068. #endif
  1069. #ifndef RF_SEND_DELAY
  1070. #define RF_SEND_DELAY 500 // Interval between sendings in ms
  1071. #endif
  1072. #ifndef RF_RECEIVE_DELAY
  1073. #define RF_RECEIVE_DELAY 500 // Interval between recieving in ms (avoid debouncing)
  1074. #endif
  1075. // Enable RCSwitch support
  1076. // Originally implemented for SONOFF BASIC
  1077. // https://tinkerman.cat/adding-rf-to-a-non-rf-itead-sonoff/
  1078. // Also possible to use with SONOFF RF BRIDGE, thanks to @wildwiz
  1079. // https://github.com/xoseperez/espurna/wiki/Hardware-Itead-Sonoff-RF-Bridge---Direct-Hack
  1080. #ifndef RFB_DIRECT
  1081. #define RFB_DIRECT 0
  1082. #endif
  1083. #ifndef RFB_RX_PIN
  1084. #define RFB_RX_PIN GPIO_NONE
  1085. #endif
  1086. #ifndef RFB_TX_PIN
  1087. #define RFB_TX_PIN GPIO_NONE
  1088. #endif
  1089. // -----------------------------------------------------------------------------
  1090. // IR Bridge
  1091. // -----------------------------------------------------------------------------
  1092. #ifndef IR_SUPPORT
  1093. #define IR_SUPPORT 0 // Do not build with IR support by default (10.25Kb)
  1094. #endif
  1095. //#define IR_RX_PIN 5 // GPIO the receiver is connected to
  1096. //#define IR_TX_PIN 4 // GPIO the transmitter is connected to
  1097. #ifndef IR_USE_RAW
  1098. #define IR_USE_RAW 0 // Use raw codes
  1099. #endif
  1100. #ifndef IR_BUFFER_SIZE
  1101. #define IR_BUFFER_SIZE 1024
  1102. #endif
  1103. #ifndef IR_TIMEOUT
  1104. #define IR_TIMEOUT 15U
  1105. #endif
  1106. #ifndef IR_REPEAT
  1107. #define IR_REPEAT 1
  1108. #endif
  1109. #ifndef IR_DELAY
  1110. #define IR_DELAY 100
  1111. #endif
  1112. #ifndef IR_DEBOUNCE
  1113. #define IR_DEBOUNCE 500 // IR debounce time in milliseconds
  1114. #endif
  1115. #ifndef IR_BUTTON_SET
  1116. #define IR_BUTTON_SET 0 // IR button set to use (see below)
  1117. #endif
  1118. // -----------------------------------------------------------------------------
  1119. // Remote Buttons SET 1 (for the original Remote shipped with the controller)
  1120. #if IR_BUTTON_SET == 1
  1121. /*
  1122. +------+------+------+------+
  1123. | UP | Down | OFF | ON |
  1124. +------+------+------+------+
  1125. | R | G | B | W |
  1126. +------+------+------+------+
  1127. | 1 | 2 | 3 |FLASH |
  1128. +------+------+------+------+
  1129. | 4 | 5 | 6 |STROBE|
  1130. +------+------+------+------+
  1131. | 7 | 8 | 9 | FADE |
  1132. +------+------+------+------+
  1133. | 10 | 11 | 12 |SMOOTH|
  1134. +------+------+------+------+
  1135. */
  1136. #define IR_BUTTON_COUNT 24
  1137. const uint32_t IR_BUTTON[IR_BUTTON_COUNT][3] PROGMEM = {
  1138. { 0xFF906F, IR_BUTTON_MODE_BRIGHTER, 1 },
  1139. { 0xFFB847, IR_BUTTON_MODE_BRIGHTER, 0 },
  1140. { 0xFFF807, IR_BUTTON_MODE_STATE, 0 },
  1141. { 0xFFB04F, IR_BUTTON_MODE_STATE, 1 },
  1142. { 0xFF9867, IR_BUTTON_MODE_RGB, 0xFF0000 },
  1143. { 0xFFD827, IR_BUTTON_MODE_RGB, 0x00FF00 },
  1144. { 0xFF8877, IR_BUTTON_MODE_RGB, 0x0000FF },
  1145. { 0xFFA857, IR_BUTTON_MODE_RGB, 0xFFFFFF },
  1146. { 0xFFE817, IR_BUTTON_MODE_RGB, 0xD13A01 },
  1147. { 0xFF48B7, IR_BUTTON_MODE_RGB, 0x00E644 },
  1148. { 0xFF6897, IR_BUTTON_MODE_RGB, 0x0040A7 },
  1149. { 0xFFB24D, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FLASH },
  1150. { 0xFF02FD, IR_BUTTON_MODE_RGB, 0xE96F2A },
  1151. { 0xFF32CD, IR_BUTTON_MODE_RGB, 0x00BEBF },
  1152. { 0xFF20DF, IR_BUTTON_MODE_RGB, 0x56406F },
  1153. { 0xFF00FF, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_STROBE },
  1154. { 0xFF50AF, IR_BUTTON_MODE_RGB, 0xEE9819 },
  1155. { 0xFF7887, IR_BUTTON_MODE_RGB, 0x00799A },
  1156. { 0xFF708F, IR_BUTTON_MODE_RGB, 0x944E80 },
  1157. { 0xFF58A7, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FADE },
  1158. { 0xFF38C7, IR_BUTTON_MODE_RGB, 0xFFFF00 },
  1159. { 0xFF28D7, IR_BUTTON_MODE_RGB, 0x0060A1 },
  1160. { 0xFFF00F, IR_BUTTON_MODE_RGB, 0xEF45AD },
  1161. { 0xFF30CF, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_SMOOTH }
  1162. };
  1163. #endif
  1164. //Remote Buttons SET 2 (another identical IR Remote shipped with another controller)
  1165. #if IR_BUTTON_SET == 2
  1166. /*
  1167. +------+------+------+------+
  1168. | UP | Down | OFF | ON |
  1169. +------+------+------+------+
  1170. | R | G | B | W |
  1171. +------+------+------+------+
  1172. | 1 | 2 | 3 |FLASH |
  1173. +------+------+------+------+
  1174. | 4 | 5 | 6 |STROBE|
  1175. +------+------+------+------+
  1176. | 7 | 8 | 9 | FADE |
  1177. +------+------+------+------+
  1178. | 10 | 11 | 12 |SMOOTH|
  1179. +------+------+------+------+
  1180. */
  1181. #define IR_BUTTON_COUNT 24
  1182. const unsigned long IR_BUTTON[IR_BUTTON_COUNT][3] PROGMEM = {
  1183. { 0xFF00FF, IR_BUTTON_MODE_BRIGHTER, 1 },
  1184. { 0xFF807F, IR_BUTTON_MODE_BRIGHTER, 0 },
  1185. { 0xFF40BF, IR_BUTTON_MODE_STATE, 0 },
  1186. { 0xFFC03F, IR_BUTTON_MODE_STATE, 1 },
  1187. { 0xFF20DF, IR_BUTTON_MODE_RGB, 0xFF0000 },
  1188. { 0xFFA05F, IR_BUTTON_MODE_RGB, 0x00FF00 },
  1189. { 0xFF609F, IR_BUTTON_MODE_RGB, 0x0000FF },
  1190. { 0xFFE01F, IR_BUTTON_MODE_RGB, 0xFFFFFF },
  1191. { 0xFF10EF, IR_BUTTON_MODE_RGB, 0xD13A01 },
  1192. { 0xFF906F, IR_BUTTON_MODE_RGB, 0x00E644 },
  1193. { 0xFF50AF, IR_BUTTON_MODE_RGB, 0x0040A7 },
  1194. { 0xFFD02F, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FLASH },
  1195. { 0xFF30CF, IR_BUTTON_MODE_RGB, 0xE96F2A },
  1196. { 0xFFB04F, IR_BUTTON_MODE_RGB, 0x00BEBF },
  1197. { 0xFF708F, IR_BUTTON_MODE_RGB, 0x56406F },
  1198. { 0xFFF00F, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_STROBE },
  1199. { 0xFF08F7, IR_BUTTON_MODE_RGB, 0xEE9819 },
  1200. { 0xFF8877, IR_BUTTON_MODE_RGB, 0x00799A },
  1201. { 0xFF48B7, IR_BUTTON_MODE_RGB, 0x944E80 },
  1202. { 0xFFC837, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FADE },
  1203. { 0xFF28D7, IR_BUTTON_MODE_RGB, 0xFFFF00 },
  1204. { 0xFFA857, IR_BUTTON_MODE_RGB, 0x0060A1 },
  1205. { 0xFF6897, IR_BUTTON_MODE_RGB, 0xEF45AD },
  1206. { 0xFFE817, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_SMOOTH }
  1207. };
  1208. #endif
  1209. //Remote Buttons SET 3 (samsung AA59-00608A 8 Toggle Buttons for generic 8CH module)
  1210. #if IR_BUTTON_SET == 3
  1211. /*
  1212. +------+------+------+
  1213. | 1 | 2 | 3 |
  1214. +------+------+------+
  1215. | 4 | 5 | 6 |
  1216. +------+------+------+
  1217. | 7 | 8 | 9 |
  1218. +------+------+------+
  1219. | | 0 | |
  1220. +------+------+------+
  1221. */
  1222. #define IR_BUTTON_COUNT 10
  1223. const unsigned long IR_BUTTON[IR_BUTTON_COUNT][3] PROGMEM = {
  1224. { 0xE0E020DF, IR_BUTTON_MODE_TOGGLE, 0 }, // Toggle Relay #0
  1225. { 0xE0E0A05F, IR_BUTTON_MODE_TOGGLE, 1 }, // Toggle Relay #1
  1226. { 0xE0E0609F, IR_BUTTON_MODE_TOGGLE, 2 }, // Toggle Relay #2
  1227. { 0xE0E010EF, IR_BUTTON_MODE_TOGGLE, 3 }, // Toggle Relay #3
  1228. { 0xE0E0906F, IR_BUTTON_MODE_TOGGLE, 4 }, // Toggle Relay #4
  1229. { 0xE0E050AF, IR_BUTTON_MODE_TOGGLE, 5 }, // Toggle Relay #5
  1230. { 0xE0E030CF, IR_BUTTON_MODE_TOGGLE, 6 }, // Toggle Relay #6
  1231. { 0xE0E0B04F, IR_BUTTON_MODE_TOGGLE, 7 } // Toggle Relay #7
  1232. //{ 0xE0E0708F, IR_BUTTON_MODE_TOGGLE, 8 } //Extra Button
  1233. //{ 0xE0E08877, IR_BUTTON_MODE_TOGGLE, 9 } //Extra Button
  1234. };
  1235. #endif
  1236. //Remote Buttons SET 4
  1237. #if IR_BUTTON_SET == 4
  1238. /*
  1239. +------+------+------+
  1240. | OFF | SRC | MUTE |
  1241. +------+------+------+
  1242. ...
  1243. +------+------+------+
  1244. */
  1245. #define IR_BUTTON_COUNT 1
  1246. const unsigned long IR_BUTTON[IR_BUTTON_COUNT][3] PROGMEM = {
  1247. { 0xFFB24D, IR_BUTTON_MODE_TOGGLE, 0 } // Toggle Relay #0
  1248. };
  1249. #endif
  1250. #ifndef IR_BUTTON_COUNT
  1251. #define IR_BUTTON_COUNT 0
  1252. #endif
  1253. //--------------------------------------------------------------------------------
  1254. // Custom RFM69 to MQTT bridge
  1255. // Check http://tinkerman.cat/rfm69-wifi-gateway/
  1256. // Enable support by passing RFM69_SUPPORT=1 build flag
  1257. //--------------------------------------------------------------------------------
  1258. #ifndef RFM69_SUPPORT
  1259. #define RFM69_SUPPORT 0
  1260. #endif
  1261. #ifndef RFM69_MAX_TOPICS
  1262. #define RFM69_MAX_TOPICS 50
  1263. #endif
  1264. #ifndef RFM69_MAX_NODES
  1265. #define RFM69_MAX_NODES 255
  1266. #endif
  1267. #ifndef RFM69_DEFAULT_TOPIC
  1268. #define RFM69_DEFAULT_TOPIC "/rfm69gw/{node}/{key}"
  1269. #endif
  1270. #ifndef RFM69_NODE_ID
  1271. #define RFM69_NODE_ID 1
  1272. #endif
  1273. #ifndef RFM69_GATEWAY_ID
  1274. #define RFM69_GATEWAY_ID 1
  1275. #endif
  1276. #ifndef RFM69_NETWORK_ID
  1277. #define RFM69_NETWORK_ID 164
  1278. #endif
  1279. #ifndef RFM69_PROMISCUOUS
  1280. #define RFM69_PROMISCUOUS 0
  1281. #endif
  1282. #ifndef RFM69_PROMISCUOUS_SENDS
  1283. #define RFM69_PROMISCUOUS_SENDS 0
  1284. #endif
  1285. #ifndef RFM69_FREQUENCY
  1286. #define RFM69_FREQUENCY RF69_868MHZ
  1287. #endif
  1288. #ifndef RFM69_ENCRYPTKEY
  1289. #define RFM69_ENCRYPTKEY "fibonacci0123456"
  1290. #endif
  1291. #ifndef RFM69_CS_PIN
  1292. #define RFM69_CS_PIN SS
  1293. #endif
  1294. #ifndef RFM69_IRQ_PIN
  1295. #define RFM69_IRQ_PIN 5
  1296. #endif
  1297. #ifndef RFM69_RESET_PIN
  1298. #define RFM69_RESET_PIN 7
  1299. #endif
  1300. #ifndef RFM69_IS_RFM69HW
  1301. #define RFM69_IS_RFM69HW 0
  1302. #endif