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.

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