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.

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