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.

505 lines
21 KiB

8 years ago
8 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. //------------------------------------------------------------------------------
  10. // DEBUG
  11. //------------------------------------------------------------------------------
  12. // Serial debug log
  13. #ifndef DEBUG_SERIAL_SUPPORT
  14. #define DEBUG_SERIAL_SUPPORT 1 // Enable serial debug log
  15. #endif
  16. #ifndef DEBUG_PORT
  17. #define DEBUG_PORT Serial // Default debugging port
  18. #endif
  19. //------------------------------------------------------------------------------
  20. // UDP debug log
  21. // To receive the message son the destination computer use nc:
  22. // nc -ul 8113
  23. #ifndef DEBUG_UDP_SUPPORT
  24. #define DEBUG_UDP_SUPPORT 0 // Enable UDP debug log
  25. #endif
  26. #define DEBUG_UDP_IP IPAddress(192, 168, 1, 100)
  27. #define DEBUG_UDP_PORT 8113
  28. //------------------------------------------------------------------------------
  29. // General debug options and macros
  30. #define DEBUG_MESSAGE_MAX_LENGTH 80
  31. #if (DEBUG_SERIAL_SUPPORT==1) || (DEBUG_UDP_SUPPORT==1)
  32. #define DEBUG_MSG(...) debugSend(__VA_ARGS__)
  33. #define DEBUG_MSG_P(...) debugSend_P(__VA_ARGS__)
  34. #endif
  35. #ifndef DEBUG_MSG
  36. #define DEBUG_MSG(...)
  37. #define DEBUG_MSG_P(...)
  38. #endif
  39. //------------------------------------------------------------------------------
  40. // TERMINAL
  41. //------------------------------------------------------------------------------
  42. #ifndef TERMINAL_SUPPORT
  43. #define TERMINAL_SUPPORT 1 // Enable terminal commands
  44. #endif
  45. //------------------------------------------------------------------------------
  46. // EEPROM
  47. //------------------------------------------------------------------------------
  48. #define EEPROM_SIZE 4096 // EEPROM size in bytes
  49. #define EEPROM_RELAY_STATUS 0 // Address for the relay status (1 byte)
  50. #define EEPROM_ENERGY_COUNT 1 // Address for the energy counter (4 bytes)
  51. #define EEPROM_CUSTOM_RESET 5 // Address for the reset reason (1 byte)
  52. #define EEPROM_DATA_END 6 // End of custom EEPROM data block
  53. //------------------------------------------------------------------------------
  54. // HEARTBEAT
  55. //------------------------------------------------------------------------------
  56. #define HEARTBEAT_INTERVAL 300000 // Interval between heartbeat messages (in ms)
  57. #define UPTIME_OVERFLOW 4294967295 // Uptime overflow value
  58. // Topics that will be reported in heartbeat
  59. #define HEARTBEAT_REPORT_STATUS 1
  60. #define HEARTBEAT_REPORT_IP 1
  61. #define HEARTBEAT_REPORT_MAC 1
  62. #define HEARTBEAT_REPORT_RSSI 1
  63. #define HEARTBEAT_REPORT_UPTIME 1
  64. #define HEARTBEAT_REPORT_FREEHEAP 1
  65. #define HEARTBEAT_REPORT_VCC 1
  66. #define HEARTBEAT_REPORT_RELAY 1
  67. #define HEARTBEAT_REPORT_LIGHT 1
  68. #define HEARTBEAT_REPORT_HOSTNAME 1
  69. #define HEARTBEAT_REPORT_APP 1
  70. #define HEARTBEAT_REPORT_VERSION 1
  71. #define HEARTBEAT_REPORT_INTERVAL 0
  72. //------------------------------------------------------------------------------
  73. // RESET
  74. //------------------------------------------------------------------------------
  75. #define CUSTOM_RESET_HARDWARE 1 // Reset from hardware button
  76. #define CUSTOM_RESET_WEB 2 // Reset from web interface
  77. #define CUSTOM_RESET_TERMINAL 3 // Reset from terminal
  78. #define CUSTOM_RESET_MQTT 4 // Reset via MQTT
  79. #define CUSTOM_RESET_RPC 5 // Reset via RPC (HTTP)
  80. #define CUSTOM_RESET_OTA 6 // Reset after successful OTA update
  81. #define CUSTOM_RESET_NOFUSS 8 // Reset after successful NOFUSS update
  82. #define CUSTOM_RESET_UPGRADE 9 // Reset after update from web interface
  83. #define CUSTOM_RESET_FACTORY 10 // Factory reset from terminal
  84. #define CUSTOM_RESET_MAX 10
  85. #include <pgmspace.h>
  86. PROGMEM const char custom_reset_hardware[] = "Hardware button";
  87. PROGMEM const char custom_reset_web[] = "Reset from web interface";
  88. PROGMEM const char custom_reset_terminal[] = "Reset from terminal";
  89. PROGMEM const char custom_reset_mqtt[] = "Reset from MQTT";
  90. PROGMEM const char custom_reset_rpc[] = "Reset from RPC";
  91. PROGMEM const char custom_reset_ota[] = "Reset after successful OTA update";
  92. PROGMEM const char custom_reset_nofuss[] = "Reset after successful NoFUSS update";
  93. PROGMEM const char custom_reset_upgrade[] = "Reset after successful web update";
  94. PROGMEM const char custom_reset_factory[] = "Factory reset";
  95. PROGMEM const char* const custom_reset_string[] = {
  96. custom_reset_hardware, custom_reset_web, custom_reset_terminal,
  97. custom_reset_mqtt, custom_reset_rpc, custom_reset_ota,
  98. custom_reset_nofuss, custom_reset_upgrade, custom_reset_factory
  99. };
  100. //------------------------------------------------------------------------------
  101. // BUTTON
  102. //------------------------------------------------------------------------------
  103. #define BUTTON_DEBOUNCE_DELAY 50 // Debounce delay (ms)
  104. #define BUTTON_DBLCLICK_DELAY 500 // Time in ms to wait for a second (or third...) click
  105. #define BUTTON_LNGCLICK_DELAY 1000 // Time in ms holding the button down to get a long click
  106. #define BUTTON_LNGLNGCLICK_DELAY 10000 // Time in ms holding the button down to get a long-long click
  107. #define BUTTON_EVENT_NONE 0
  108. #define BUTTON_EVENT_PRESSED 1
  109. #define BUTTON_EVENT_RELEASED 2
  110. #define BUTTON_EVENT_CLICK 2
  111. #define BUTTON_EVENT_DBLCLICK 3
  112. #define BUTTON_EVENT_LNGCLICK 4
  113. #define BUTTON_EVENT_LNGLNGCLICK 5
  114. #define BUTTON_MODE_NONE 0
  115. #define BUTTON_MODE_TOGGLE 1
  116. #define BUTTON_MODE_ON 2
  117. #define BUTTON_MODE_OFF 3
  118. #define BUTTON_MODE_AP 4
  119. #define BUTTON_MODE_RESET 5
  120. #define BUTTON_MODE_PULSE 6
  121. #define BUTTON_MODE_FACTORY 7
  122. //------------------------------------------------------------------------------
  123. // RELAY
  124. //------------------------------------------------------------------------------
  125. #define RELAY_MODE_OFF 0
  126. #define RELAY_MODE_ON 1
  127. #define RELAY_MODE_SAME 2
  128. #define RELAY_MODE_TOOGLE 3
  129. #define RELAY_TYPE_NORMAL 0
  130. #define RELAY_TYPE_INVERSE 1
  131. #define RELAY_TYPE_LATCHED 2
  132. #define RELAY_SYNC_ANY 0
  133. #define RELAY_SYNC_NONE_OR_ONE 1
  134. #define RELAY_SYNC_ONE 2
  135. #define RELAY_SYNC_SAME 3
  136. #define RELAY_PULSE_NONE 0
  137. #define RELAY_PULSE_OFF 1
  138. #define RELAY_PULSE_ON 2
  139. #define RELAY_PROVIDER_RELAY 0
  140. #define RELAY_PROVIDER_DUAL 1
  141. #define RELAY_PROVIDER_LIGHT 2
  142. #define RELAY_PROVIDER_RFBRIDGE 3
  143. // Pulse time in milliseconds
  144. #define RELAY_PULSE_TIME 1.0
  145. // 0 means OFF, 1 ON and 2 whatever was before
  146. #define RELAY_MODE RELAY_MODE_OFF
  147. // 0 means ANY, 1 zero or one and 2 one and only one
  148. #define RELAY_SYNC RELAY_SYNC_ANY
  149. // 0 means no pulses, 1 means normally off, 2 normally on
  150. #define RELAY_PULSE_MODE RELAY_PULSE_NONE
  151. // Relay requests flood protection window - in seconds
  152. #define RELAY_FLOOD_WINDOW 3
  153. // Allowed actual relay changes inside requests flood protection window
  154. #define RELAY_FLOOD_CHANGES 5
  155. // Pulse with in milliseconds for a latched relay
  156. #define RELAY_LATCHING_PULSE 10
  157. // Do not save relay state after these many milliseconds
  158. #define RELAY_SAVE_DELAY 1000
  159. //------------------------------------------------------------------------------
  160. // I18N
  161. //------------------------------------------------------------------------------
  162. #define TMP_CELSIUS 0
  163. #define TMP_FAHRENHEIT 1
  164. #define TMP_UNITS TMP_CELSIUS // Temperature units (TMP_CELSIUS | TMP_FAHRENHEIT)
  165. //------------------------------------------------------------------------------
  166. // LED
  167. //------------------------------------------------------------------------------
  168. // All defined LEDs in the board can be managed through MQTT
  169. // except the first one when LED_AUTO is set to 1.
  170. // If LED_AUTO is set to 1 the board will a defined LED to show wifi status.
  171. #define LED_AUTO 1
  172. // LED # to use as WIFI status indicator
  173. #ifndef LED_WIFI
  174. #define LED_WIFI 1
  175. #endif
  176. // -----------------------------------------------------------------------------
  177. // WIFI
  178. // -----------------------------------------------------------------------------
  179. #define WIFI_CONNECT_TIMEOUT 30000 // Connecting timeout for WIFI in ms
  180. #define WIFI_RECONNECT_INTERVAL 120000 // If could not connect to WIFI, retry after this time in ms
  181. #define WIFI_MAX_NETWORKS 5 // Max number of WIFI connection configurations
  182. #define WIFI_AP_MODE AP_MODE_ALONE
  183. #ifndef WIFI_GAIN
  184. #define WIFI_GAIN 0 // WiFi gain in dBm from 0 (normal) to 20.5 (max power and consumption)
  185. #endif
  186. // Optional hardcoded configuration (up to 2 different networks)
  187. //#define WIFI1_SSID "..."
  188. //#define WIFI1_PASS "..."
  189. //#define WIFI1_IP "192.168.1.201"
  190. //#define WIFI1_GW "192.168.1.1"
  191. //#define WIFI1_MASK "255.255.255.0"
  192. //#define WIFI1_DNS "8.8.8.8"
  193. //#define WIFI2_SSID "..."
  194. //#define WIFI2_PASS "..."
  195. // -----------------------------------------------------------------------------
  196. // WEB
  197. // -----------------------------------------------------------------------------
  198. #ifndef WEB_SUPPORT
  199. #define WEB_SUPPORT 1 // Enable web support (http, api)
  200. #endif
  201. #ifndef WEB_EMBEDDED
  202. #define WEB_EMBEDDED 1 // Build the firmware with the web interface embedded in
  203. #endif
  204. // This is not working at the moment!!
  205. // Requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core staging version.
  206. #define WEB_SSL_ENABLED 0 // Use HTTPS web interface
  207. #define WEB_MODE_NORMAL 0
  208. #define WEB_MODE_PASSWORD 1
  209. #define WEB_USERNAME "admin" // HTTP username
  210. #define WEB_FORCE_PASS_CHANGE 1 // Force the user to change the password if default one
  211. #define WEB_PORT 80 // HTTP port
  212. // -----------------------------------------------------------------------------
  213. // WEBSOCKETS
  214. // -----------------------------------------------------------------------------
  215. // This will only be enabled if WEB_SUPPORT is 1 (this is the default value)
  216. #define WS_BUFFER_SIZE 5 // Max number of secured websocket connections
  217. #define WS_TIMEOUT 1800000 // Timeout for secured websocket
  218. // -----------------------------------------------------------------------------
  219. // API
  220. // -----------------------------------------------------------------------------
  221. // This will only be enabled if WEB_SUPPORT is 1 (this is the default value)
  222. #define API_ENABLED 0 // Do not enable API by default
  223. #define API_BUFFER_SIZE 10 // Size of the buffer for HTTP GET API responses
  224. // -----------------------------------------------------------------------------
  225. // MDNS
  226. // -----------------------------------------------------------------------------
  227. #ifndef MDNS_SUPPORT
  228. #define MDNS_SUPPORT 1 // Enable MDNS by default
  229. #endif
  230. // -----------------------------------------------------------------------------
  231. // SPIFFS
  232. // -----------------------------------------------------------------------------
  233. // Do not add support for SPIFFS by default
  234. #ifndef SPIFFS_SUPPORT
  235. #define SPIFFS_SUPPORT 0
  236. #endif
  237. // -----------------------------------------------------------------------------
  238. // OTA
  239. // -----------------------------------------------------------------------------
  240. #define OTA_PORT 8266 // OTA port
  241. // -----------------------------------------------------------------------------
  242. // NOFUSS
  243. // -----------------------------------------------------------------------------
  244. #define NOFUSS_SERVER "" // Default NoFuss Server
  245. #define NOFUSS_INTERVAL 3600000 // Check for updates every hour
  246. // -----------------------------------------------------------------------------
  247. // MQTT
  248. // -----------------------------------------------------------------------------
  249. #ifndef MQTT_USE_ASYNC
  250. #define MQTT_USE_ASYNC 1 // Use AysncMQTTClient (1) or PubSubClient (0)
  251. #endif
  252. // MQTT OVER SSL
  253. // Using MQTT over SSL works pretty well but generates problems with the web interface.
  254. // It could be a good idea to use it in conjuntion with WEB_SUPPORT=0.
  255. // Requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core staging version.
  256. // Right now only available when MQTT_USE_ASYNC=1 (default value).
  257. // You will need the fingerprint for your MQTT server, example for CloudMQTT:
  258. // $ echo -n | openssl s_client -connect m11.cloudmqtt.com:24055 > cloudmqtt.pem
  259. // $ openssl x509 -noout -in cloudmqtt.pem -fingerprint -sha1
  260. #define MQTT_SSL_ENABLED 0
  261. #define MQTT_SSL_FINGERPRINT ""
  262. #define MQTT_ENABLED 0 // Do not enable MQTT connection by default
  263. #define MQTT_AUTOCONNECT 1 // If enabled and MDNS_SUPPORT=1 will perform an autodiscover and
  264. // autoconnect to the first MQTT broker found if none defined
  265. #define MQTT_SERVER "" // Default MQTT broker address
  266. #define MQTT_PORT 1883 // MQTT broker port
  267. #define MQTT_TOPIC "/test/switch/{identifier}" // Default MQTT base topic
  268. #define MQTT_RETAIN true // MQTT retain flag
  269. #define MQTT_QOS 0 // MQTT QoS value for all messages
  270. #define MQTT_KEEPALIVE 30 // MQTT keepalive value
  271. #define MQTT_RECONNECT_DELAY 10000 // Try to reconnect after 10s
  272. #define MQTT_TRY_INTERVAL 30000 // Timeframe for disconnect retries
  273. #define MQTT_MAX_TRIES 5 // After these many retries during the previous MQTT_TRY_INTERVAL the board will reset
  274. #define MQTT_SKIP_RETAINED 1 // Skip retained messages on connection
  275. #define MQTT_SKIP_TIME 1000 // Skip messages for 1 second anter connection
  276. #define MQTT_USE_JSON 0 // Group messages in a JSON body
  277. #define MQTT_USE_JSON_DELAY 100 // Wait this many ms before grouping messages
  278. // These particles will be concatenated to the MQTT_TOPIC base to form the actual topic
  279. #define MQTT_TOPIC_JSON "data"
  280. #define MQTT_TOPIC_ACTION "action"
  281. #define MQTT_TOPIC_RELAY "relay"
  282. #define MQTT_TOPIC_LED "led"
  283. #define MQTT_TOPIC_BUTTON "button"
  284. #define MQTT_TOPIC_IP "ip"
  285. #define MQTT_TOPIC_VERSION "version"
  286. #define MQTT_TOPIC_UPTIME "uptime"
  287. #define MQTT_TOPIC_FREEHEAP "freeheap"
  288. #define MQTT_TOPIC_VCC "vcc"
  289. #define MQTT_TOPIC_STATUS "status"
  290. #define MQTT_TOPIC_MAC "mac"
  291. #define MQTT_TOPIC_RSSI "rssi"
  292. #define MQTT_TOPIC_APP "app"
  293. #define MQTT_TOPIC_INTERVAL "interval"
  294. #define MQTT_TOPIC_HOSTNAME "host"
  295. #define MQTT_TOPIC_TIME "time"
  296. #define MQTT_TOPIC_ANALOG "analog"
  297. #define MQTT_TOPIC_RFOUT "rfout"
  298. #define MQTT_TOPIC_RFIN "rfin"
  299. #define MQTT_TOPIC_RFLEARN "rflearn"
  300. // Lights
  301. #define MQTT_TOPIC_CHANNEL "channel"
  302. #define MQTT_TOPIC_COLOR "color"
  303. #define MQTT_TOPIC_BRIGHTNESS "brightness"
  304. #define MQTT_TOPIC_MIRED "mired"
  305. #define MQTT_TOPIC_KELVIN "kelvin"
  306. #define MQTT_STATUS_ONLINE "1" // Value for the device ON message
  307. #define MQTT_STATUS_OFFLINE "0" // Value for the device OFF message (will)
  308. #define MQTT_ACTION_RESET "reset" // RESET MQTT topic particle
  309. // Internal MQTT events (do not change)
  310. #define MQTT_CONNECT_EVENT 0
  311. #define MQTT_DISCONNECT_EVENT 1
  312. #define MQTT_MESSAGE_EVENT 2
  313. // Custom get and set postfixes
  314. // Use something like "/status" or "/set", with leading slash
  315. // Since 1.9.0 the default value is "" for getter and "/set" for setter
  316. #define MQTT_USE_GETTER ""
  317. #define MQTT_USE_SETTER "/set"
  318. // -----------------------------------------------------------------------------
  319. // I2C
  320. // -----------------------------------------------------------------------------
  321. #ifndef I2C_SUPPORT
  322. #define I2C_SUPPORT 0 // I2C enabled
  323. #endif
  324. #define I2C_SDA_PIN 4 // SDA GPIO
  325. #define I2C_SCL_PIN 14 // SCL GPIO
  326. #define I2C_CLOCK_STRETCH_TIME 200 // BRZO clock stretch time
  327. #define I2C_SCL_FREQUENCY 1000 // BRZO SCL frequency
  328. // -----------------------------------------------------------------------------
  329. // LIGHT
  330. // -----------------------------------------------------------------------------
  331. #define LIGHT_PROVIDER_NONE 0
  332. #define LIGHT_PROVIDER_MY9192 1
  333. #define LIGHT_PROVIDER_DIMMER 2
  334. // LIGHT_PROVIDER_DIMMER can have from 1 to 5 different channels.
  335. // They have to be defined for each device in the hardware.h file.
  336. // If 3 or more channels first 3 will be considered RGB.
  337. // Usual configurations are:
  338. // 1 channels => W
  339. // 2 channels => WW
  340. // 3 channels => RGB
  341. // 4 channels => RGBW
  342. // 5 channels => RGBWW
  343. #define LIGHT_SAVE_DELAY 5 // Persist color after 5 seconds to avoid wearing out
  344. #define LIGHT_PWM_FREQUENCY 1000 // PWM frequency
  345. #define LIGHT_MAX_PWM 4095 // Maximum PWM value
  346. #define LIGHT_MAX_VALUE 255 // Maximum light value
  347. #define LIGHT_MAX_BRIGHTNESS 255 // Maximun brightness value
  348. #define LIGHT_USE_COLOR 1 // Use 3 first channels as RGB
  349. #define LIGHT_USE_WHITE 0 // Use white channel whenever RGB have the same value
  350. #define LIGHT_USE_GAMMA 0 // Use gamma correction for color channels
  351. // -----------------------------------------------------------------------------
  352. // DOMOTICZ
  353. // -----------------------------------------------------------------------------
  354. #ifndef DOMOTICZ_SUPPORT
  355. #define DOMOTICZ_SUPPORT 1 // Build with domoticz support
  356. #endif
  357. #define DOMOTICZ_ENABLED 0 // Disable domoticz by default
  358. #define DOMOTICZ_IN_TOPIC "domoticz/in" // Default subscription topic
  359. #define DOMOTICZ_OUT_TOPIC "domoticz/out" // Default publication topic
  360. // -----------------------------------------------------------------------------
  361. // HOME ASSISTANT
  362. // -----------------------------------------------------------------------------
  363. #ifndef HOMEASSISTANT_SUPPORT
  364. #define HOMEASSISTANT_SUPPORT 1 // Build with home assistant support
  365. #endif
  366. #define HOMEASSISTANT_PREFIX "homeassistant" // Default MQTT prefix
  367. // -----------------------------------------------------------------------------
  368. // INFLUXDB
  369. // -----------------------------------------------------------------------------
  370. #ifndef INFLUXDB_SUPPORT
  371. #define INFLUXDB_SUPPORT 1 // Enable InfluxDB support by default
  372. #endif
  373. #define INFLUXDB_PORT 8086 // Default InfluxDB port
  374. // -----------------------------------------------------------------------------
  375. // NTP
  376. // -----------------------------------------------------------------------------
  377. #ifndef NTP_SUPPORT
  378. #define NTP_SUPPORT 1 // Build with NTP support by default
  379. #endif
  380. #define NTP_SERVER "pool.ntp.org" // Default NTP server
  381. #define NTP_TIME_OFFSET 1 // Default timezone offset (GMT+1)
  382. #define NTP_DAY_LIGHT true // Enable daylight time saving by default
  383. #define NTP_UPDATE_INTERVAL 1800 // NTP check every 30 minutes
  384. // -----------------------------------------------------------------------------
  385. // FAUXMO
  386. // -----------------------------------------------------------------------------
  387. // This setting defines whether Alexa support should be built into the firmware
  388. #ifndef ALEXA_SUPPORT
  389. #define ALEXA_SUPPORT 1
  390. #endif
  391. // This is default value for the alexaEnabled setting that defines whether
  392. // this device should be discoberable and respond to Alexa commands.
  393. // Both ALEXA_SUPPORT and alexaEnabled should be 1 for Alexa support to work.
  394. #define ALEXA_ENABLED 1
  395. // -----------------------------------------------------------------------------
  396. // RFBRIDGE
  397. // -----------------------------------------------------------------------------
  398. #define RF_SEND_TIMES 4 // How many times to send the message
  399. #define RF_SEND_DELAY 250 // Interval between sendings in ms