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.

1813 lines
62 KiB

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