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.

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