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.

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