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.

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