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.

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