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.

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