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.

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