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.

971 lines
38 KiB

7 years ago
7 years ago
7 years ago
8 years ago
8 years ago
7 years ago
7 years ago
7 years ago
7 years ago
8 years ago
8 years ago
6 years ago
6 years ago
8 years ago
6 years ago
6 years ago
8 years ago
8 years ago
6 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. #define ADMIN_PASS "fibonacci" // Default password (WEB, OTA, WIFI)
  10. #define USE_PASSWORD 1 // Insecurity caution! Disabling this will disable password querying completely.
  11. #define LOOP_DELAY_TIME 10 // Delay for this millis in the main loop [0-250]
  12. #define ARRAYINIT(type, name, ...) \
  13. type name[] = {__VA_ARGS__};
  14. //------------------------------------------------------------------------------
  15. // ESPURNA CORE
  16. //------------------------------------------------------------------------------
  17. #ifdef ESPURNA_CORE
  18. #define ALEXA_SUPPORT 0
  19. #define BROKER_SUPPORT 0
  20. #define DOMOTICZ_SUPPORT 0
  21. #define HOMEASSISTANT_SUPPORT 0
  22. #define I2C_SUPPORT 0
  23. #define MQTT_SUPPORT 0
  24. #define NTP_SUPPORT 0
  25. #define SCHEDULER_SUPPORT 0
  26. #define SENSOR_SUPPORT 0
  27. #define THINGSPEAK_SUPPORT 0
  28. #define WEB_SUPPORT 0
  29. #endif
  30. //------------------------------------------------------------------------------
  31. // TELNET
  32. //------------------------------------------------------------------------------
  33. #ifndef TELNET_SUPPORT
  34. #define TELNET_SUPPORT 1 // Enable telnet support by default (3.34Kb)
  35. #endif
  36. #ifndef TELNET_STA
  37. #define TELNET_STA 0 // By default, disallow connections via STA interface
  38. #endif
  39. #define TELNET_PORT 23 // Port to listen to telnet clients
  40. #define TELNET_MAX_CLIENTS 1 // Max number of concurrent telnet clients
  41. //------------------------------------------------------------------------------
  42. // DEBUG
  43. //------------------------------------------------------------------------------
  44. // Serial debug log
  45. #ifndef DEBUG_SERIAL_SUPPORT
  46. #define DEBUG_SERIAL_SUPPORT 1 // Enable serial debug log
  47. #endif
  48. #ifndef DEBUG_PORT
  49. #define DEBUG_PORT Serial // Default debugging port
  50. #endif
  51. #ifndef SERIAL_BAUDRATE
  52. #define SERIAL_BAUDRATE 115200 // Default baudrate
  53. #endif
  54. #ifndef DEBUG_ADD_TIMESTAMP
  55. #define DEBUG_ADD_TIMESTAMP 1 // Add timestamp to debug messages
  56. // (in millis overflowing every 1000 seconds)
  57. #endif
  58. // Second serial port (used for RX)
  59. //#define SERIAL_RX_PORT Serial // This setting is usually defined
  60. // in the hardware.h file for those
  61. // boards that require it
  62. #ifndef SERIAL_RX_BAUDRATE
  63. #define SERIAL_RX_BAUDRATE 115200 // Default baudrate
  64. #endif
  65. //------------------------------------------------------------------------------
  66. // UDP debug log
  67. // To receive the message son the destination computer use nc:
  68. // nc -ul 8113
  69. #ifndef DEBUG_UDP_SUPPORT
  70. #define DEBUG_UDP_SUPPORT 0 // Enable UDP debug log
  71. #endif
  72. #define DEBUG_UDP_IP IPAddress(192, 168, 1, 100)
  73. #define DEBUG_UDP_PORT 8113
  74. //------------------------------------------------------------------------------
  75. #ifndef DEBUG_TELNET_SUPPORT
  76. #define DEBUG_TELNET_SUPPORT TELNET_SUPPORT // Enable telnet debug log if telnet is enabled too
  77. #endif
  78. #if DEBUG_TELNET_SUPPORT
  79. #undef TELNET_SUPPORT
  80. #define TELNET_SUPPORT 1
  81. #endif
  82. //------------------------------------------------------------------------------
  83. // General debug options and macros
  84. #define DEBUG_SUPPORT DEBUG_SERIAL_SUPPORT || DEBUG_UDP_SUPPORT || DEBUG_TELNET_SUPPORT
  85. #if DEBUG_SUPPORT
  86. #define DEBUG_MSG(...) debugSend(__VA_ARGS__)
  87. #define DEBUG_MSG_P(...) debugSend_P(__VA_ARGS__)
  88. #endif
  89. #ifndef DEBUG_MSG
  90. #define DEBUG_MSG(...)
  91. #define DEBUG_MSG_P(...)
  92. #endif
  93. //------------------------------------------------------------------------------
  94. // TERMINAL
  95. //------------------------------------------------------------------------------
  96. #ifndef TERMINAL_SUPPORT
  97. #define TERMINAL_SUPPORT 1 // Enable terminal commands (0.97Kb)
  98. #endif
  99. #define TERMINAL_BUFFER_SIZE 128 // Max size for commands commands
  100. //------------------------------------------------------------------------------
  101. // SYSTEM CHECK
  102. //------------------------------------------------------------------------------
  103. #ifndef SYSTEM_CHECK_ENABLED
  104. #define SYSTEM_CHECK_ENABLED 1 // Enable crash check by default
  105. #endif
  106. #define SYSTEM_CHECK_TIME 60000 // The system is considered stable after these many millis
  107. #define SYSTEM_CHECK_MAX 5 // After this many crashes on boot
  108. // the system is flagged as unstable
  109. //------------------------------------------------------------------------------
  110. // EEPROM
  111. //------------------------------------------------------------------------------
  112. #define EEPROM_SIZE 4096 // EEPROM size in bytes
  113. #define EEPROM_RELAY_STATUS 0 // Address for the relay status (1 byte)
  114. #define EEPROM_ENERGY_COUNT 1 // Address for the energy counter (4 bytes)
  115. #define EEPROM_CUSTOM_RESET 5 // Address for the reset reason (1 byte)
  116. #define EEPROM_CRASH_COUNTER 6 // Address for the crash counter (1 byte)
  117. #define EEPROM_MESSAGE_ID 7 // Address for the MQTT message id (4 bytes)
  118. #define EEPROM_DATA_END 11 // End of custom EEPROM data block
  119. //------------------------------------------------------------------------------
  120. // HEARTBEAT
  121. //------------------------------------------------------------------------------
  122. #ifndef HEARTBEAT_ENABLED
  123. #define HEARTBEAT_ENABLED 1
  124. #endif
  125. #define HEARTBEAT_INTERVAL 300000 // Interval between heartbeat messages (in ms)
  126. #define UPTIME_OVERFLOW 4294967295 // Uptime overflow value
  127. // Topics that will be reported in heartbeat
  128. #define HEARTBEAT_REPORT_STATUS 1
  129. #define HEARTBEAT_REPORT_IP 1
  130. #define HEARTBEAT_REPORT_MAC 1
  131. #define HEARTBEAT_REPORT_RSSI 1
  132. #define HEARTBEAT_REPORT_UPTIME 1
  133. #define HEARTBEAT_REPORT_DATETIME 1
  134. #define HEARTBEAT_REPORT_FREEHEAP 1
  135. #define HEARTBEAT_REPORT_VCC 1
  136. #define HEARTBEAT_REPORT_RELAY 1
  137. #define HEARTBEAT_REPORT_LIGHT 1
  138. #define HEARTBEAT_REPORT_HOSTNAME 1
  139. #define HEARTBEAT_REPORT_APP 1
  140. #define HEARTBEAT_REPORT_VERSION 1
  141. #define HEARTBEAT_REPORT_INTERVAL 0
  142. //------------------------------------------------------------------------------
  143. // RESET
  144. //------------------------------------------------------------------------------
  145. #define CUSTOM_RESET_HARDWARE 1 // Reset from hardware button
  146. #define CUSTOM_RESET_WEB 2 // Reset from web interface
  147. #define CUSTOM_RESET_TERMINAL 3 // Reset from terminal
  148. #define CUSTOM_RESET_MQTT 4 // Reset via MQTT
  149. #define CUSTOM_RESET_RPC 5 // Reset via RPC (HTTP)
  150. #define CUSTOM_RESET_OTA 6 // Reset after successful OTA update
  151. #define CUSTOM_RESET_HTTP 7 // Reset via HTTP GET
  152. #define CUSTOM_RESET_NOFUSS 8 // Reset after successful NOFUSS update
  153. #define CUSTOM_RESET_UPGRADE 9 // Reset after update from web interface
  154. #define CUSTOM_RESET_FACTORY 10 // Factory reset from terminal
  155. #define CUSTOM_RESET_MAX 10
  156. PROGMEM const char custom_reset_hardware[] = "Hardware button";
  157. PROGMEM const char custom_reset_web[] = "Reboot from web interface";
  158. PROGMEM const char custom_reset_terminal[] = "Reboot from terminal";
  159. PROGMEM const char custom_reset_mqtt[] = "Reboot from MQTT";
  160. PROGMEM const char custom_reset_rpc[] = "Reboot from RPC";
  161. PROGMEM const char custom_reset_ota[] = "Reboot after successful OTA update";
  162. PROGMEM const char custom_reset_http[] = "Reboot from HTTP";
  163. PROGMEM const char custom_reset_nofuss[] = "Reboot after successful NoFUSS update";
  164. PROGMEM const char custom_reset_upgrade[] = "Reboot after successful web update";
  165. PROGMEM const char custom_reset_factory[] = "Factory reset";
  166. PROGMEM const char* const custom_reset_string[] = {
  167. custom_reset_hardware, custom_reset_web, custom_reset_terminal,
  168. custom_reset_mqtt, custom_reset_rpc, custom_reset_ota,
  169. custom_reset_http, custom_reset_nofuss, custom_reset_upgrade,
  170. custom_reset_factory
  171. };
  172. //------------------------------------------------------------------------------
  173. // BUTTON
  174. //------------------------------------------------------------------------------
  175. #ifndef BUTTON_DEBOUNCE_DELAY
  176. #define BUTTON_DEBOUNCE_DELAY 50 // Debounce delay (ms)
  177. #endif
  178. #ifndef BUTTON_DBLCLICK_DELAY
  179. #define BUTTON_DBLCLICK_DELAY 500 // Time in ms to wait for a second (or third...) click
  180. #endif
  181. #ifndef BUTTON_LNGCLICK_DELAY
  182. #define BUTTON_LNGCLICK_DELAY 1000 // Time in ms holding the button down to get a long click
  183. #endif
  184. #ifndef BUTTON_LNGLNGCLICK_DELAY
  185. #define BUTTON_LNGLNGCLICK_DELAY 10000 // Time in ms holding the button down to get a long-long click
  186. #endif
  187. #define BUTTON_EVENT_NONE 0
  188. #define BUTTON_EVENT_PRESSED 1
  189. #define BUTTON_EVENT_RELEASED 2
  190. #define BUTTON_EVENT_CLICK 2
  191. #define BUTTON_EVENT_DBLCLICK 3
  192. #define BUTTON_EVENT_LNGCLICK 4
  193. #define BUTTON_EVENT_LNGLNGCLICK 5
  194. #define BUTTON_MODE_NONE 0
  195. #define BUTTON_MODE_TOGGLE 1
  196. #define BUTTON_MODE_ON 2
  197. #define BUTTON_MODE_OFF 3
  198. #define BUTTON_MODE_AP 4
  199. #define BUTTON_MODE_RESET 5
  200. #define BUTTON_MODE_PULSE 6
  201. #define BUTTON_MODE_FACTORY 7
  202. //------------------------------------------------------------------------------
  203. // RELAY
  204. //------------------------------------------------------------------------------
  205. #define RELAY_BOOT_OFF 0
  206. #define RELAY_BOOT_ON 1
  207. #define RELAY_BOOT_SAME 2
  208. #define RELAY_BOOT_TOGGLE 3
  209. #define RELAY_TYPE_NORMAL 0
  210. #define RELAY_TYPE_INVERSE 1
  211. #define RELAY_TYPE_LATCHED 2
  212. #define RELAY_SYNC_ANY 0
  213. #define RELAY_SYNC_NONE_OR_ONE 1
  214. #define RELAY_SYNC_ONE 2
  215. #define RELAY_SYNC_SAME 3
  216. #define RELAY_PULSE_NONE 0
  217. #define RELAY_PULSE_OFF 1
  218. #define RELAY_PULSE_ON 2
  219. #define RELAY_PROVIDER_RELAY 0
  220. #define RELAY_PROVIDER_DUAL 1
  221. #define RELAY_PROVIDER_LIGHT 2
  222. #define RELAY_PROVIDER_RFBRIDGE 3
  223. // Default boot mode: 0 means OFF, 1 ON and 2 whatever was before
  224. #define RELAY_BOOT_MODE RELAY_BOOT_OFF
  225. // 0 means ANY, 1 zero or one and 2 one and only one
  226. #define RELAY_SYNC RELAY_SYNC_ANY
  227. // Default pulse mode: 0 means no pulses, 1 means normally off, 2 normally on
  228. #define RELAY_PULSE_MODE RELAY_PULSE_NONE
  229. // Default pulse time in seconds
  230. #define RELAY_PULSE_TIME 1.0
  231. // Relay requests flood protection window - in seconds
  232. #define RELAY_FLOOD_WINDOW 3
  233. // Allowed actual relay changes inside requests flood protection window
  234. #define RELAY_FLOOD_CHANGES 5
  235. // Pulse with in milliseconds for a latched relay
  236. #define RELAY_LATCHING_PULSE 10
  237. // Do not save relay state after these many milliseconds
  238. #define RELAY_SAVE_DELAY 1000
  239. //------------------------------------------------------------------------------
  240. // I18N
  241. //------------------------------------------------------------------------------
  242. #define TMP_CELSIUS 0
  243. #define TMP_FAHRENHEIT 1
  244. //------------------------------------------------------------------------------
  245. // LED
  246. //------------------------------------------------------------------------------
  247. #define LED_MODE_MQTT 0 // LED will be managed from MQTT (OFF by default)
  248. #define LED_MODE_WIFI 1 // LED will blink according to the WIFI status
  249. #define LED_MODE_FOLLOW 2 // LED will follow state of linked relay (check RELAY#_LED)
  250. #define LED_MODE_FOLLOW_INVERSE 3 // LED will follow the opposite state of linked relay (check RELAY#_LED)
  251. #define LED_MODE_FINDME 4 // LED will be ON if all relays are OFF
  252. #define LED_MODE_MIXED 5 // A mixed between WIFI and FINDME
  253. #define LED_MODE_ON 6 // LED always ON
  254. #define LED_MODE_OFF 7 // LED always OFF
  255. #define LED_MODE_STATUS 8 // If any relay is ON, LED will be ON, otherwise OFF
  256. // -----------------------------------------------------------------------------
  257. // WIFI
  258. // -----------------------------------------------------------------------------
  259. #define WIFI_CONNECT_TIMEOUT 60000 // Connecting timeout for WIFI in ms
  260. #define WIFI_RECONNECT_INTERVAL 180000 // If could not connect to WIFI, retry after this time in ms
  261. #define WIFI_MAX_NETWORKS 5 // Max number of WIFI connection configurations
  262. #define WIFI_AP_MODE AP_MODE_ALONE
  263. #define WIFI_SLEEP_ENABLED 1 // Enable WiFi light sleep
  264. #define WIFI_SCAN_NETWORKS 1 // Perform a network scan before connecting
  265. // Optional hardcoded configuration (up to 2 different networks)
  266. //#define WIFI1_SSID "..."
  267. //#define WIFI1_PASS "..."
  268. //#define WIFI1_IP "192.168.1.201"
  269. //#define WIFI1_GW "192.168.1.1"
  270. //#define WIFI1_MASK "255.255.255.0"
  271. //#define WIFI1_DNS "8.8.8.8"
  272. //#define WIFI2_SSID "..."
  273. //#define WIFI2_PASS "..."
  274. #define WIFI_RSSI_1M -30 // Calibrate it with your router reading the RSSI at 1m
  275. #define WIFI_PROPAGATION_CONST 4 // This is typically something between 2.7 to 4.3 (free space is 2)
  276. // -----------------------------------------------------------------------------
  277. // WEB
  278. // -----------------------------------------------------------------------------
  279. #ifndef WEB_SUPPORT
  280. #define WEB_SUPPORT 1 // Enable web support (http, api, 121.65Kb)
  281. #endif
  282. #ifndef WEB_EMBEDDED
  283. #define WEB_EMBEDDED 1 // Build the firmware with the web interface embedded in
  284. #endif
  285. // This is not working at the moment!!
  286. // Requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core 2.4.0
  287. #define WEB_SSL_ENABLED 0 // Use HTTPS web interface
  288. #define WEB_MODE_NORMAL 0
  289. #define WEB_MODE_PASSWORD 1
  290. #define WEB_USERNAME "admin" // HTTP username
  291. #define WEB_FORCE_PASS_CHANGE 1 // Force the user to change the password if default one
  292. #define WEB_PORT 80 // HTTP port
  293. // -----------------------------------------------------------------------------
  294. // WEBSOCKETS
  295. // -----------------------------------------------------------------------------
  296. // This will only be enabled if WEB_SUPPORT is 1 (this is the default value)
  297. #define WS_BUFFER_SIZE 5 // Max number of secured websocket connections
  298. #define WS_TIMEOUT 1800000 // Timeout for secured websocket
  299. #define WS_UPDATE_INTERVAL 30000 // Update clients every 30 seconds
  300. // -----------------------------------------------------------------------------
  301. // API
  302. // -----------------------------------------------------------------------------
  303. // This will only be enabled if WEB_SUPPORT is 1 (this is the default value)
  304. #define API_ENABLED 0 // Do not enable API by default
  305. #define API_BUFFER_SIZE 15 // Size of the buffer for HTTP GET API responses
  306. #define API_REAL_TIME_VALUES 0 // Show filtered/median values by default (0 => median, 1 => real time)
  307. // -----------------------------------------------------------------------------
  308. // UI
  309. // -----------------------------------------------------------------------------
  310. #define UI_TAG_INPUT 0
  311. #define UI_TAG_CHECKBOX 1
  312. #define UI_TAG_SELECT 2
  313. // -----------------------------------------------------------------------------
  314. // MDNS / LLMNR / NETBIOS / SSDP
  315. // -----------------------------------------------------------------------------
  316. #ifndef MDNS_SERVER_SUPPORT
  317. #define MDNS_SERVER_SUPPORT 1 // Publish services using mDNS by default (1.48Kb)
  318. #endif
  319. #ifndef MDNS_CLIENT_SUPPORT
  320. #define MDNS_CLIENT_SUPPORT 0 // Resolve mDNS names (3.44Kb)
  321. #endif
  322. #ifndef LLMNR_SUPPORT
  323. #define LLMNR_SUPPORT 0 // Publish device using LLMNR protocol by default (1.95Kb) - requires 2.4.0
  324. #endif
  325. #ifndef NETBIOS_SUPPORT
  326. #define NETBIOS_SUPPORT 0 // Publish device using NetBIOS protocol by default (1.26Kb) - requires 2.4.0
  327. #endif
  328. #ifndef SSDP_SUPPORT
  329. #define SSDP_SUPPORT 0 // Publish device using SSDP protocol by default (4.59Kb)
  330. // Not compatible with ALEXA_SUPPORT at the moment
  331. #endif
  332. #ifndef SSDP_DEVICE_TYPE
  333. #define SSDP_DEVICE_TYPE "upnp:rootdevice"
  334. //#define SSDP_DEVICE_TYPE "urn:schemas-upnp-org:device:BinaryLight:1"
  335. #endif
  336. #if WEB_SUPPORT == 0
  337. #undef SSDP_SUPPORT
  338. #define SSDP_SUPPORT 0 // SSDP support requires web support
  339. #endif
  340. // -----------------------------------------------------------------------------
  341. // SPIFFS
  342. // -----------------------------------------------------------------------------
  343. #ifndef SPIFFS_SUPPORT
  344. #define SPIFFS_SUPPORT 0 // Do not add support for SPIFFS by default
  345. #endif
  346. // -----------------------------------------------------------------------------
  347. // OTA
  348. // -----------------------------------------------------------------------------
  349. #define OTA_PORT 8266 // OTA port
  350. #define OTA_TERMINAL 0 // Enable OTA from terminal
  351. #define OTA_GITHUB_FP "D79F076110B39293E349AC89845B0380C19E2F8B"
  352. // -----------------------------------------------------------------------------
  353. // NOFUSS
  354. // -----------------------------------------------------------------------------
  355. #ifndef NOFUSS_SUPPORT
  356. #define NOFUSS_SUPPORT 0 // Do not enable support for NoFuss by default (12.65Kb)
  357. #endif
  358. #define NOFUSS_ENABLED 0 // Do not perform NoFUSS updates by default
  359. #define NOFUSS_SERVER "" // Default NoFuss Server
  360. #define NOFUSS_INTERVAL 3600000 // Check for updates every hour
  361. // -----------------------------------------------------------------------------
  362. // MQTT
  363. // -----------------------------------------------------------------------------
  364. #ifndef MQTT_SUPPORT
  365. #define MQTT_SUPPORT 1 // MQTT support (22.38Kb async, 12.48Kb sync)
  366. #endif
  367. #ifndef MQTT_USE_ASYNC
  368. #define MQTT_USE_ASYNC 1 // Use AysncMQTTClient (1) or PubSubClient (0)
  369. #endif
  370. // MQTT OVER SSL
  371. // Using MQTT over SSL works pretty well but generates problems with the web interface.
  372. // It could be a good idea to use it in conjuntion with WEB_SUPPORT=0.
  373. // Requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core 2.4.0.
  374. //
  375. // You can use SSL with MQTT_USE_ASYNC=1 (AsyncMqttClient library)
  376. // but you might experience hiccups on the web interface, so my recommendation is:
  377. // WEB_SUPPORT=0
  378. //
  379. // If you use SSL with MQTT_USE_ASYNC=0 (PubSubClient library)
  380. // you will have to disable all the modules that use ESPAsyncTCP, that is:
  381. // ALEXA_SUPPORT=0, INFLUXDB_SUPPORT=0, TELNET_SUPPORT=0, THINGSPEAK_SUPPORT=0 and WEB_SUPPORT=0
  382. //
  383. // You will need the fingerprint for your MQTT server, example for CloudMQTT:
  384. // $ echo -n | openssl s_client -connect m11.cloudmqtt.com:24055 > cloudmqtt.pem
  385. // $ openssl x509 -noout -in cloudmqtt.pem -fingerprint -sha1
  386. #define MQTT_SSL_ENABLED 0 // By default MQTT over SSL will not be enabled
  387. #define MQTT_SSL_FINGERPRINT "" // SSL fingerprint of the server
  388. #define MQTT_ENABLED 0 // Do not enable MQTT connection by default
  389. #define MQTT_AUTOCONNECT 1 // If enabled and MDNS_SERVER_SUPPORT=1 will perform an autodiscover and
  390. // autoconnect to the first MQTT broker found if none defined
  391. #define MQTT_SERVER "" // Default MQTT broker address
  392. #define MQTT_USER "" // Default MQTT broker usename
  393. #define MQTT_PASS "" // Default MQTT broker password
  394. #define MQTT_PORT 1883 // MQTT broker port
  395. #define MQTT_TOPIC "{hostname}" // Default MQTT base topic
  396. #define MQTT_RETAIN true // MQTT retain flag
  397. #define MQTT_QOS 0 // MQTT QoS value for all messages
  398. #define MQTT_KEEPALIVE 30 // MQTT keepalive value
  399. #define MQTT_RECONNECT_DELAY_MIN 5000 // Try to reconnect in 5 seconds upon disconnection
  400. #define MQTT_RECONNECT_DELAY_STEP 5000 // Increase the reconnect delay in 5 seconds after each failed attempt
  401. #define MQTT_RECONNECT_DELAY_MAX 120000 // Set reconnect time to 2 minutes at most
  402. #define MQTT_SKIP_RETAINED 1 // Skip retained messages on connection
  403. #define MQTT_SKIP_TIME 1000 // Skip messages for 1 second anter connection
  404. #define MQTT_USE_JSON 0 // Group messages in a JSON body
  405. #define MQTT_USE_JSON_DELAY 100 // Wait this many ms before grouping messages
  406. #define MQTT_QUEUE_MAX_SIZE 10 // Size of the MQTT queue when MQTT_USE_JSON is enabled
  407. // These are the properties that will be sent when useJson is true
  408. #ifndef MQTT_ENQUEUE_IP
  409. #define MQTT_ENQUEUE_IP 1
  410. #endif
  411. #ifndef MQTT_ENQUEUE_MAC
  412. #define MQTT_ENQUEUE_MAC 1
  413. #endif
  414. #ifndef MQTT_ENQUEUE_HOSTNAME
  415. #define MQTT_ENQUEUE_HOSTNAME 1
  416. #endif
  417. #ifndef MQTT_ENQUEUE_DATETIME
  418. #define MQTT_ENQUEUE_DATETIME 1
  419. #endif
  420. #ifndef MQTT_ENQUEUE_MESSAGE_ID
  421. #define MQTT_ENQUEUE_MESSAGE_ID 1
  422. #endif
  423. // These particles will be concatenated to the MQTT_TOPIC base to form the actual topic
  424. #define MQTT_TOPIC_JSON "data"
  425. #define MQTT_TOPIC_ACTION "action"
  426. #define MQTT_TOPIC_RELAY "relay"
  427. #define MQTT_TOPIC_LED "led"
  428. #define MQTT_TOPIC_BUTTON "button"
  429. #define MQTT_TOPIC_IP "ip"
  430. #define MQTT_TOPIC_VERSION "version"
  431. #define MQTT_TOPIC_UPTIME "uptime"
  432. #define MQTT_TOPIC_DATETIME "datetime"
  433. #define MQTT_TOPIC_FREEHEAP "freeheap"
  434. #define MQTT_TOPIC_VCC "vcc"
  435. #define MQTT_TOPIC_STATUS "status"
  436. #define MQTT_TOPIC_MAC "mac"
  437. #define MQTT_TOPIC_RSSI "rssi"
  438. #define MQTT_TOPIC_MESSAGE_ID "id"
  439. #define MQTT_TOPIC_APP "app"
  440. #define MQTT_TOPIC_INTERVAL "interval"
  441. #define MQTT_TOPIC_HOSTNAME "host"
  442. #define MQTT_TOPIC_TIME "time"
  443. #define MQTT_TOPIC_RFOUT "rfout"
  444. #define MQTT_TOPIC_RFIN "rfin"
  445. #define MQTT_TOPIC_RFLEARN "rflearn"
  446. #define MQTT_TOPIC_RFRAW "rfraw"
  447. // Light module
  448. #define MQTT_TOPIC_CHANNEL "channel"
  449. #define MQTT_TOPIC_COLOR "color" // DEPRECATED, use RGB instead
  450. #define MQTT_TOPIC_COLOR_RGB "rgb"
  451. #define MQTT_TOPIC_COLOR_HSV "hsv"
  452. #define MQTT_TOPIC_ANIM_MODE "anim_mode"
  453. #define MQTT_TOPIC_ANIM_SPEED "anim_speed"
  454. #define MQTT_TOPIC_BRIGHTNESS "brightness"
  455. #define MQTT_TOPIC_MIRED "mired"
  456. #define MQTT_TOPIC_KELVIN "kelvin"
  457. #define MQTT_STATUS_ONLINE "1" // Value for the device ON message
  458. #define MQTT_STATUS_OFFLINE "0" // Value for the device OFF message (will)
  459. #define MQTT_ACTION_RESET "reboot" // RESET MQTT topic particle
  460. // Internal MQTT events (do not change)
  461. #define MQTT_CONNECT_EVENT 0
  462. #define MQTT_DISCONNECT_EVENT 1
  463. #define MQTT_MESSAGE_EVENT 2
  464. #define MQTT_MESSAGE_ID_SHIFT 1000 // Store MQTT message id into EEPROM every these many
  465. // Custom get and set postfixes
  466. // Use something like "/status" or "/set", with leading slash
  467. // Since 1.9.0 the default value is "" for getter and "/set" for setter
  468. #ifndef MQTT_GETTER
  469. #define MQTT_GETTER ""
  470. #endif
  471. #ifndef MQTT_SETTER
  472. #define MQTT_SETTER "/set"
  473. #endif
  474. // -----------------------------------------------------------------------------
  475. // BROKER
  476. // -----------------------------------------------------------------------------
  477. #ifndef BROKER_SUPPORT
  478. #define BROKER_SUPPORT 1 // The broker is a poor-man's pubsub manager
  479. #endif
  480. // -----------------------------------------------------------------------------
  481. // SETTINGS
  482. // -----------------------------------------------------------------------------
  483. #ifndef SETTINGS_AUTOSAVE
  484. #define SETTINGS_AUTOSAVE 1 // Autosave settings o force manual commit
  485. #endif
  486. #define SETTINGS_MAX_LIST_COUNT 10 // Maximum index for settings lists
  487. // -----------------------------------------------------------------------------
  488. // LIGHT
  489. // -----------------------------------------------------------------------------
  490. // Available light providers (do not change)
  491. #define LIGHT_PROVIDER_NONE 0
  492. #define LIGHT_PROVIDER_MY92XX 1 // works with MY9291 and MY9231
  493. #define LIGHT_PROVIDER_DIMMER 2
  494. // LIGHT_PROVIDER_DIMMER can have from 1 to 5 different channels.
  495. // They have to be defined for each device in the hardware.h file.
  496. // If 3 or more channels first 3 will be considered RGB.
  497. // Usual configurations are:
  498. // 1 channels => W
  499. // 2 channels => WW
  500. // 3 channels => RGB
  501. // 4 channels => RGBW
  502. // 5 channels => RGBWW
  503. #ifndef LIGHT_SAVE_ENABLED
  504. #define LIGHT_SAVE_ENABLED 1 // Light channel values saved by default after each change
  505. #endif
  506. #define LIGHT_SAVE_DELAY 5 // Persist color after 5 seconds to avoid wearing out
  507. #ifndef LIGHT_MAX_PWM
  508. #if LIGHT_PROVIDER == LIGHT_PROVIDER_MY92XX
  509. #define LIGHT_MAX_PWM 255
  510. #endif
  511. #if LIGHT_PROVIDER == LIGHT_PROVIDER_DIMMER
  512. #define LIGHT_MAX_PWM 10000 // 5000 * 200ns => 1 kHz
  513. #endif
  514. #endif // LIGHT_MAX_PWM
  515. #ifndef LIGHT_LIMIT_PWM
  516. #define LIGHT_LIMIT_PWM LIGHT_MAX_PWM // Limit PWM to this value (prevent 100% power)
  517. #endif
  518. #ifndef LIGHT_MAX_VALUE
  519. #define LIGHT_MAX_VALUE 255 // Maximum light value
  520. #endif
  521. #define LIGHT_MAX_BRIGHTNESS 255 // Maximun brightness value
  522. #define LIGHT_STEP 32 // Step size
  523. #define LIGHT_USE_COLOR 1 // Use 3 first channels as RGB
  524. #define LIGHT_USE_WHITE 0 // Use white channel whenever RGB have the same value
  525. #define LIGHT_USE_GAMMA 0 // Use gamma correction for color channels
  526. #define LIGHT_USE_CSS 1 // Use CSS style to report colors (1=> "#FF0000", 0=> "255,0,0")
  527. #define LIGHT_USE_RGB 0 // Use RGB color selector (1=> RGB, 0=> HSV)
  528. #define LIGHT_USE_TRANSITIONS 1 // Transitions between colors
  529. #define LIGHT_TRANSITION_STEP 10 // Time in millis between each transtion step
  530. #define LIGHT_TRANSITION_STEPS 50 // Number of steps to acomplish transition
  531. // -----------------------------------------------------------------------------
  532. // DOMOTICZ
  533. // -----------------------------------------------------------------------------
  534. #ifndef DOMOTICZ_SUPPORT
  535. #define DOMOTICZ_SUPPORT MQTT_SUPPORT // Build with domoticz (if MQTT) support (1.72Kb)
  536. #endif
  537. #if DOMOTICZ_SUPPORT
  538. #undef MQTT_SUPPORT
  539. #define MQTT_SUPPORT 1 // If Domoticz enabled enable MQTT
  540. #endif
  541. #define DOMOTICZ_ENABLED 0 // Disable domoticz by default
  542. #define DOMOTICZ_IN_TOPIC "domoticz/in" // Default subscription topic
  543. #define DOMOTICZ_OUT_TOPIC "domoticz/out" // Default publication topic
  544. // -----------------------------------------------------------------------------
  545. // HOME ASSISTANT
  546. // -----------------------------------------------------------------------------
  547. #ifndef HOMEASSISTANT_SUPPORT
  548. #define HOMEASSISTANT_SUPPORT MQTT_SUPPORT // Build with home assistant support (if MQTT, 1.64Kb)
  549. #endif
  550. #if HOMEASSISTANT_SUPPORT
  551. #undef MQTT_SUPPORT
  552. #define MQTT_SUPPORT 1 // If Home Assistant enabled enable MQTT
  553. #endif
  554. #define HOMEASSISTANT_ENABLED 0 // Integration not enabled by default
  555. #define HOMEASSISTANT_PREFIX "homeassistant" // Default MQTT prefix
  556. // -----------------------------------------------------------------------------
  557. // INFLUXDB
  558. // -----------------------------------------------------------------------------
  559. #ifndef INFLUXDB_SUPPORT
  560. #define INFLUXDB_SUPPORT 0 // Enable InfluxDB support by default (4.38Kb)
  561. #endif
  562. #define INFLUXDB_ENABLED 0 // InfluxDB disabled by default
  563. #define INFLUXDB_HOST "" // Default server
  564. #define INFLUXDB_PORT 8086 // Default InfluxDB port
  565. #define INFLUXDB_DATABASE "" // Default database
  566. #define INFLUXDB_USERNAME "" // Default username
  567. #define INFLUXDB_PASSWORD "" // Default password
  568. // -----------------------------------------------------------------------------
  569. // THINGSPEAK
  570. // -----------------------------------------------------------------------------
  571. #ifndef THINGSPEAK_SUPPORT
  572. #define THINGSPEAK_SUPPORT 1 // Enable Thingspeak support by default (2.56Kb)
  573. #endif
  574. #define THINGSPEAK_ENABLED 0 // Thingspeak disabled by default
  575. #define THINGSPEAK_APIKEY "" // Default API KEY
  576. #define THINGSPEAK_USE_ASYNC 1 // Use AsyncClient instead of WiFiClientSecure
  577. // THINGSPEAK OVER SSL
  578. // Using THINGSPEAK over SSL works well but generates problems with the web interface,
  579. // so you should compile it with WEB_SUPPORT to 0.
  580. // When THINGSPEAK_USE_ASYNC is 1, requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core 2.4.0.
  581. #define THINGSPEAK_USE_SSL 0 // Use secure connection
  582. #define THINGSPEAK_FINGERPRINT "78 60 18 44 81 35 BF DF 77 84 D4 0A 22 0D 9B 4E 6C DC 57 2C"
  583. #define THINGSPEAK_HOST "api.thingspeak.com"
  584. #if THINGSPEAK_USE_SSL
  585. #define THINGSPEAK_PORT 443
  586. #else
  587. #define THINGSPEAK_PORT 80
  588. #endif
  589. #define THINGSPEAK_URL "/update"
  590. #define THINGSPEAK_MIN_INTERVAL 15000 // Minimum interval between POSTs (in millis)
  591. #ifndef ASYNC_TCP_SSL_ENABLED
  592. #if THINGSPEAK_USE_SSL && THINGSPEAK_USE_ASYNC
  593. #undef THINGSPEAK_SUPPORT // Thingspeak in ASYNC mode requires ASYNC_TCP_SSL_ENABLED
  594. #endif
  595. #endif
  596. // -----------------------------------------------------------------------------
  597. // SCHEDULER
  598. // -----------------------------------------------------------------------------
  599. #ifndef SCHEDULER_SUPPORT
  600. #define SCHEDULER_SUPPORT 1 // Enable scheduler (1.77Kb)
  601. #endif
  602. #if SCHEDULER_SUPPORT
  603. #undef NTP_SUPPORT
  604. #define NTP_SUPPORT 1 // Scheduler needs NTP
  605. #endif
  606. #define SCHEDULER_MAX_SCHEDULES 10 // Max schedules alowed
  607. // -----------------------------------------------------------------------------
  608. // NTP
  609. // -----------------------------------------------------------------------------
  610. #ifndef NTP_SUPPORT
  611. #define NTP_SUPPORT 1 // Build with NTP support by default (6.78Kb)
  612. #endif
  613. #define NTP_SERVER "pool.ntp.org" // Default NTP server
  614. #define NTP_TIME_OFFSET 1 // Default timezone offset (GMT+1)
  615. #define NTP_DAY_LIGHT true // Enable daylight time saving by default
  616. #define NTP_SYNC_INTERVAL 60 // NTP initial check every minute
  617. #define NTP_UPDATE_INTERVAL 1800 // NTP check every 30 minutes
  618. #define NTP_START_DELAY 1000 // Delay NTP start 1 second
  619. // -----------------------------------------------------------------------------
  620. // ALEXA
  621. // -----------------------------------------------------------------------------
  622. // This setting defines whether Alexa support should be built into the firmware
  623. #ifndef ALEXA_SUPPORT
  624. #define ALEXA_SUPPORT 1 // Enable Alexa support by default (10.84Kb)
  625. #endif
  626. // This is default value for the alexaEnabled setting that defines whether
  627. // this device should be discoberable and respond to Alexa commands.
  628. // Both ALEXA_SUPPORT and alexaEnabled should be 1 for Alexa support to work.
  629. #define ALEXA_ENABLED 1
  630. // -----------------------------------------------------------------------------
  631. // RFBRIDGE
  632. // -----------------------------------------------------------------------------
  633. #define RF_SEND_TIMES 4 // How many times to send the message
  634. #define RF_SEND_DELAY 500 // Interval between sendings in ms
  635. #define RF_RECEIVE_DELAY 500 // Interval between recieving in ms (avoid debouncing)
  636. #define RF_RAW_SUPPORT 0 // RF raw codes require a specific firmware for the EFM8BB1
  637. // https://github.com/rhx/RF-Bridge-EFM8BB1
  638. // -----------------------------------------------------------------------------
  639. // IR
  640. // -----------------------------------------------------------------------------
  641. #ifndef IR_SUPPORT
  642. #define IR_SUPPORT 0 // Do not build with IR support by default (10.25Kb)
  643. #endif
  644. #ifndef IR_PIN
  645. #define IR_PIN 4 // IR LED
  646. #endif
  647. // 24 Buttons Set of the IR Remote
  648. #ifndef IR_BUTTON_SET
  649. #define IR_BUTTON_SET 1 // IR button set to use (see below)
  650. #endif
  651. // IR Button modes
  652. #define IR_BUTTON_MODE_NONE 0
  653. #define IR_BUTTON_MODE_RGB 1
  654. #define IR_BUTTON_MODE_HSV 2
  655. #define IR_BUTTON_MODE_BRIGHTER 3
  656. #define IR_BUTTON_MODE_STATE 4
  657. #define IR_BUTTON_MODE_EFFECT 5
  658. #define LIGHT_EFFECT_SOLID 0
  659. #define LIGHT_EFFECT_FLASH 1
  660. #define LIGHT_EFFECT_STROBE 2
  661. #define LIGHT_EFFECT_FADE 3
  662. #define LIGHT_EFFECT_SMOOTH 4
  663. //Remote Buttons SET 1 (for the original Remote shipped with the controller)
  664. #if IR_SUPPORT
  665. #if IR_BUTTON_SET == 1
  666. /*
  667. +------+------+------+------+
  668. | UP | Down | OFF | ON |
  669. +------+------+------+------+
  670. | R | G | B | W |
  671. +------+------+------+------+
  672. | 1 | 2 | 3 |FLASH |
  673. +------+------+------+------+
  674. | 4 | 5 | 6 |STROBE|
  675. +------+------+------+------+
  676. | 7 | 8 | 9 | FADE |
  677. +------+------+------+------+
  678. | 10 | 11 | 12 |SMOOTH|
  679. +------+------+------+------+
  680. */
  681. #define IR_BUTTON_COUNT 24
  682. const unsigned long IR_BUTTON[IR_BUTTON_COUNT][3] PROGMEM = {
  683. { 0xFF906F, IR_BUTTON_MODE_BRIGHTER, 1 },
  684. { 0xFFB847, IR_BUTTON_MODE_BRIGHTER, 0 },
  685. { 0xFFF807, IR_BUTTON_MODE_STATE, 0 },
  686. { 0xFFB04F, IR_BUTTON_MODE_STATE, 1 },
  687. { 0xFF9867, IR_BUTTON_MODE_RGB, 0xFF0000 },
  688. { 0xFFD827, IR_BUTTON_MODE_RGB, 0x00FF00 },
  689. { 0xFF8877, IR_BUTTON_MODE_RGB, 0x0000FF },
  690. { 0xFFA857, IR_BUTTON_MODE_RGB, 0xFFFFFF },
  691. { 0xFFE817, IR_BUTTON_MODE_RGB, 0xD13A01 },
  692. { 0xFF48B7, IR_BUTTON_MODE_RGB, 0x00E644 },
  693. { 0xFF6897, IR_BUTTON_MODE_RGB, 0x0040A7 },
  694. { 0xFFB24D, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FLASH },
  695. { 0xFF02FD, IR_BUTTON_MODE_RGB, 0xE96F2A },
  696. { 0xFF32CD, IR_BUTTON_MODE_RGB, 0x00BEBF },
  697. { 0xFF20DF, IR_BUTTON_MODE_RGB, 0x56406F },
  698. { 0xFF00FF, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_STROBE },
  699. { 0xFF50AF, IR_BUTTON_MODE_RGB, 0xEE9819 },
  700. { 0xFF7887, IR_BUTTON_MODE_RGB, 0x00799A },
  701. { 0xFF708F, IR_BUTTON_MODE_RGB, 0x944E80 },
  702. { 0xFF58A7, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FADE },
  703. { 0xFF38C7, IR_BUTTON_MODE_RGB, 0xFFFF00 },
  704. { 0xFF28D7, IR_BUTTON_MODE_RGB, 0x0060A1 },
  705. { 0xFFF00F, IR_BUTTON_MODE_RGB, 0xEF45AD },
  706. { 0xFF30CF, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_SMOOTH }
  707. };
  708. #endif
  709. //Remote Buttons SET 2 (another identical IR Remote shipped with another controller)
  710. #if IR_BUTTON_SET == 2
  711. /*
  712. +------+------+------+------+
  713. | UP | Down | OFF | ON |
  714. +------+------+------+------+
  715. | R | G | B | W |
  716. +------+------+------+------+
  717. | 1 | 2 | 3 |FLASH |
  718. +------+------+------+------+
  719. | 4 | 5 | 6 |STROBE|
  720. +------+------+------+------+
  721. | 7 | 8 | 9 | FADE |
  722. +------+------+------+------+
  723. | 10 | 11 | 12 |SMOOTH|
  724. +------+------+------+------+
  725. */
  726. #define IR_BUTTON_COUNT 24
  727. const unsigned long IR_BUTTON[IR_BUTTON_COUNT][3] PROGMEM = {
  728. { 0xFF00FF, IR_BUTTON_MODE_BRIGHTER, 1 },
  729. { 0xFF807F, IR_BUTTON_MODE_BRIGHTER, 0 },
  730. { 0xFF40BF, IR_BUTTON_MODE_STATE, 0 },
  731. { 0xFFC03F, IR_BUTTON_MODE_STATE, 1 },
  732. { 0xFF20DF, IR_BUTTON_MODE_RGB, 0xFF0000 },
  733. { 0xFFA05F, IR_BUTTON_MODE_RGB, 0x00FF00 },
  734. { 0xFF609F, IR_BUTTON_MODE_RGB, 0x0000FF },
  735. { 0xFFE01F, IR_BUTTON_MODE_RGB, 0xFFFFFF },
  736. { 0xFF10EF, IR_BUTTON_MODE_RGB, 0xD13A01 },
  737. { 0xFF906F, IR_BUTTON_MODE_RGB, 0x00E644 },
  738. { 0xFF50AF, IR_BUTTON_MODE_RGB, 0x0040A7 },
  739. { 0xFFD02F, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FLASH },
  740. { 0xFF30CF, IR_BUTTON_MODE_RGB, 0xE96F2A },
  741. { 0xFFB04F, IR_BUTTON_MODE_RGB, 0x00BEBF },
  742. { 0xFF708F, IR_BUTTON_MODE_RGB, 0x56406F },
  743. { 0xFFF00F, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_STROBE },
  744. { 0xFF08F7, IR_BUTTON_MODE_RGB, 0xEE9819 },
  745. { 0xFF8877, IR_BUTTON_MODE_RGB, 0x00799A },
  746. { 0xFF48B7, IR_BUTTON_MODE_RGB, 0x944E80 },
  747. { 0xFFC837, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FADE },
  748. { 0xFF28D7, IR_BUTTON_MODE_RGB, 0xFFFF00 },
  749. { 0xFFA857, IR_BUTTON_MODE_RGB, 0x0060A1 },
  750. { 0xFF6897, IR_BUTTON_MODE_RGB, 0xEF45AD },
  751. { 0xFFE817, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_SMOOTH }
  752. };
  753. #endif
  754. #endif // IR_SUPPORT
  755. //--------------------------------------------------------------------------------
  756. // Custom RF module
  757. // Check http://tinkerman.cat/adding-rf-to-a-non-rf-itead-sonoff/
  758. // Enable support by passing RF_SUPPORT=1 build flag
  759. //--------------------------------------------------------------------------------
  760. #ifndef RF_SUPPORT
  761. #define RF_SUPPORT 0
  762. #endif
  763. #ifndef RF_PIN
  764. #define RF_PIN 14
  765. #endif
  766. #define RF_CHANNEL 31
  767. #define RF_DEVICE 1