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.

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