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.

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