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.

858 lines
35 KiB

7 years ago
7 years ago
7 years ago
8 years ago
8 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_FREEHEAP 1
  95. #define HEARTBEAT_REPORT_VCC 1
  96. #define HEARTBEAT_REPORT_RELAY 1
  97. #define HEARTBEAT_REPORT_LIGHT 1
  98. #define HEARTBEAT_REPORT_HOSTNAME 1
  99. #define HEARTBEAT_REPORT_APP 1
  100. #define HEARTBEAT_REPORT_VERSION 1
  101. #define HEARTBEAT_REPORT_INTERVAL 0
  102. //------------------------------------------------------------------------------
  103. // RESET
  104. //------------------------------------------------------------------------------
  105. #define CUSTOM_RESET_HARDWARE 1 // Reset from hardware button
  106. #define CUSTOM_RESET_WEB 2 // Reset from web interface
  107. #define CUSTOM_RESET_TERMINAL 3 // Reset from terminal
  108. #define CUSTOM_RESET_MQTT 4 // Reset via MQTT
  109. #define CUSTOM_RESET_RPC 5 // Reset via RPC (HTTP)
  110. #define CUSTOM_RESET_OTA 6 // Reset after successful OTA update
  111. #define CUSTOM_RESET_NOFUSS 8 // Reset after successful NOFUSS update
  112. #define CUSTOM_RESET_UPGRADE 9 // Reset after update from web interface
  113. #define CUSTOM_RESET_FACTORY 10 // Factory reset from terminal
  114. #define CUSTOM_RESET_MAX 10
  115. #include <pgmspace.h>
  116. PROGMEM const char custom_reset_hardware[] = "Hardware button";
  117. PROGMEM const char custom_reset_web[] = "Reset from web interface";
  118. PROGMEM const char custom_reset_terminal[] = "Reset from terminal";
  119. PROGMEM const char custom_reset_mqtt[] = "Reset from MQTT";
  120. PROGMEM const char custom_reset_rpc[] = "Reset from RPC";
  121. PROGMEM const char custom_reset_ota[] = "Reset after successful OTA update";
  122. PROGMEM const char custom_reset_nofuss[] = "Reset after successful NoFUSS update";
  123. PROGMEM const char custom_reset_upgrade[] = "Reset after successful web update";
  124. PROGMEM const char custom_reset_factory[] = "Factory reset";
  125. PROGMEM const char* const custom_reset_string[] = {
  126. custom_reset_hardware, custom_reset_web, custom_reset_terminal,
  127. custom_reset_mqtt, custom_reset_rpc, custom_reset_ota,
  128. custom_reset_nofuss, custom_reset_upgrade, custom_reset_factory
  129. };
  130. //------------------------------------------------------------------------------
  131. // BUTTON
  132. //------------------------------------------------------------------------------
  133. #define BUTTON_DEBOUNCE_DELAY 50 // Debounce delay (ms)
  134. #define BUTTON_DBLCLICK_DELAY 500 // Time in ms to wait for a second (or third...) click
  135. #define BUTTON_LNGCLICK_DELAY 1000 // Time in ms holding the button down to get a long click
  136. #define BUTTON_LNGLNGCLICK_DELAY 10000 // Time in ms holding the button down to get a long-long click
  137. #define BUTTON_EVENT_NONE 0
  138. #define BUTTON_EVENT_PRESSED 1
  139. #define BUTTON_EVENT_RELEASED 2
  140. #define BUTTON_EVENT_CLICK 2
  141. #define BUTTON_EVENT_DBLCLICK 3
  142. #define BUTTON_EVENT_LNGCLICK 4
  143. #define BUTTON_EVENT_LNGLNGCLICK 5
  144. #define BUTTON_MODE_NONE 0
  145. #define BUTTON_MODE_TOGGLE 1
  146. #define BUTTON_MODE_ON 2
  147. #define BUTTON_MODE_OFF 3
  148. #define BUTTON_MODE_AP 4
  149. #define BUTTON_MODE_RESET 5
  150. #define BUTTON_MODE_PULSE 6
  151. #define BUTTON_MODE_FACTORY 7
  152. //------------------------------------------------------------------------------
  153. // RELAY
  154. //------------------------------------------------------------------------------
  155. #define RELAY_MODE_OFF 0
  156. #define RELAY_MODE_ON 1
  157. #define RELAY_MODE_SAME 2
  158. #define RELAY_MODE_TOOGLE 3
  159. #define RELAY_TYPE_NORMAL 0
  160. #define RELAY_TYPE_INVERSE 1
  161. #define RELAY_TYPE_LATCHED 2
  162. #define RELAY_SYNC_ANY 0
  163. #define RELAY_SYNC_NONE_OR_ONE 1
  164. #define RELAY_SYNC_ONE 2
  165. #define RELAY_SYNC_SAME 3
  166. #define RELAY_PULSE_NONE 0
  167. #define RELAY_PULSE_OFF 1
  168. #define RELAY_PULSE_ON 2
  169. #define RELAY_PROVIDER_RELAY 0
  170. #define RELAY_PROVIDER_DUAL 1
  171. #define RELAY_PROVIDER_LIGHT 2
  172. #define RELAY_PROVIDER_RFBRIDGE 3
  173. // Pulse time in milliseconds
  174. #define RELAY_PULSE_TIME 1.0
  175. // 0 means OFF, 1 ON and 2 whatever was before
  176. #define RELAY_MODE RELAY_MODE_OFF
  177. // 0 means ANY, 1 zero or one and 2 one and only one
  178. #define RELAY_SYNC RELAY_SYNC_ANY
  179. // 0 means no pulses, 1 means normally off, 2 normally on
  180. #define RELAY_PULSE_MODE RELAY_PULSE_NONE
  181. // Relay requests flood protection window - in seconds
  182. #define RELAY_FLOOD_WINDOW 3
  183. // Allowed actual relay changes inside requests flood protection window
  184. #define RELAY_FLOOD_CHANGES 5
  185. // Pulse with in milliseconds for a latched relay
  186. #define RELAY_LATCHING_PULSE 10
  187. // Do not save relay state after these many milliseconds
  188. #define RELAY_SAVE_DELAY 1000
  189. //------------------------------------------------------------------------------
  190. // I18N
  191. //------------------------------------------------------------------------------
  192. #define TMP_CELSIUS 0
  193. #define TMP_FAHRENHEIT 1
  194. #define TMP_UNITS TMP_CELSIUS // Temperature units (TMP_CELSIUS | TMP_FAHRENHEIT)
  195. //------------------------------------------------------------------------------
  196. // LED
  197. //------------------------------------------------------------------------------
  198. // All defined LEDs in the board can be managed through MQTT
  199. // except the first one when LED_AUTO is set to 1.
  200. // If LED_AUTO is set to 1 the board will use a defined LED to show wifi status.
  201. #define LED_AUTO 1
  202. // LED # to use as WIFI status indicator
  203. #ifndef LED_WIFI
  204. #define LED_WIFI 1
  205. #endif
  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. // MDNS & LLMNR
  255. // -----------------------------------------------------------------------------
  256. #ifndef MDNS_SUPPORT
  257. #define MDNS_SUPPORT 1 // Publish services using mDNS by default (1.84Kb)
  258. #endif
  259. #ifndef LLMNR_SUPPORT
  260. #define LLMNR_SUPPORT 0 // Publish device using LLMNR protocol by default (1.95Kb) - requires 2.4.0
  261. #endif
  262. #ifndef NETBIOS_SUPPORT
  263. #define NETBIOS_SUPPORT 0 // Publish device using NetBIOS protocol by default (1.26Kb) - requires 2.4.0
  264. #endif
  265. // -----------------------------------------------------------------------------
  266. // SPIFFS
  267. // -----------------------------------------------------------------------------
  268. #ifndef SPIFFS_SUPPORT
  269. #define SPIFFS_SUPPORT 0 // Do not add support for SPIFFS by default
  270. #endif
  271. // -----------------------------------------------------------------------------
  272. // OTA
  273. // -----------------------------------------------------------------------------
  274. #define OTA_PORT 8266 // OTA port
  275. // -----------------------------------------------------------------------------
  276. // NOFUSS
  277. // -----------------------------------------------------------------------------
  278. #ifndef NOFUSS_SUPPORT
  279. #define NOFUSS_SUPPORT 0 // Do not enable support for NoFuss by default (12.65Kb)
  280. #endif
  281. #define NOFUSS_ENABLED 0 // Do not perform NoFUSS updates by default
  282. #define NOFUSS_SERVER "" // Default NoFuss Server
  283. #define NOFUSS_INTERVAL 3600000 // Check for updates every hour
  284. // -----------------------------------------------------------------------------
  285. // MQTT
  286. // -----------------------------------------------------------------------------
  287. #ifndef MQTT_SUPPORT
  288. #define MQTT_SUPPORT 1 // MQTT support (22.38Kb async, 12.48Kb sync)
  289. #endif
  290. #ifndef MQTT_USE_ASYNC
  291. #define MQTT_USE_ASYNC 1 // Use AysncMQTTClient (1) or PubSubClient
  292. #endif
  293. // MQTT OVER SSL
  294. // Using MQTT over SSL works pretty well but generates problems with the web interface.
  295. // It could be a good idea to use it in conjuntion with WEB_SUPPORT=0.
  296. // Requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core staging version.
  297. //
  298. // You can use it with MQTT_USE_ASYNC=1 (AsyncMqttClient library)
  299. // but you might experience hiccups on the web interface, so my recommendation is:
  300. // WEB_SUPPORT=0
  301. //
  302. // If you use it with MQTT_USE_ASYNC=0 (PubSubClient library)
  303. // you will have to disable all the modules that use ESPAsyncTCP, that is:
  304. // ALEXA_SUPPORT=0, INFLUXDB_SUPPORT=0, TELNET_SUPPORT=0 and WEB_SUPPORT=0
  305. //
  306. // You will need the fingerprint for your MQTT server, example for CloudMQTT:
  307. // $ echo -n | openssl s_client -connect m11.cloudmqtt.com:24055 > cloudmqtt.pem
  308. // $ openssl x509 -noout -in cloudmqtt.pem -fingerprint -sha1
  309. #define MQTT_SSL_ENABLED 0 // By default MQTT over SSL will not be enabled
  310. #define MQTT_SSL_FINGERPRINT "" // SSL fingerprint of the server
  311. #define MQTT_ENABLED 0 // Do not enable MQTT connection by default
  312. #define MQTT_AUTOCONNECT 1 // If enabled and MDNS_SUPPORT=1 will perform an autodiscover and
  313. // autoconnect to the first MQTT broker found if none defined
  314. #define MQTT_SERVER "" // Default MQTT broker address
  315. #define MQTT_USER "" // Default MQTT broker usename
  316. #define MQTT_PASS "" // Default MQTT broker password
  317. #define MQTT_PORT 1883 // MQTT broker port
  318. #define MQTT_TOPIC "{identifier}" // Default MQTT base topic
  319. #define MQTT_RETAIN true // MQTT retain flag
  320. #define MQTT_QOS 0 // MQTT QoS value for all messages
  321. #define MQTT_KEEPALIVE 30 // MQTT keepalive value
  322. #define MQTT_RECONNECT_DELAY_MIN 5000 // Try to reconnect in 5 seconds upon disconnection
  323. #define MQTT_RECONNECT_DELAY_STEP 5000 // Increase the reconnect delay in 5 seconds after each failed attempt
  324. #define MQTT_RECONNECT_DELAY_MAX 120000 // Set reconnect time to 2 minutes at most
  325. #define MQTT_SKIP_RETAINED 1 // Skip retained messages on connection
  326. #define MQTT_SKIP_TIME 1000 // Skip messages for 1 second anter connection
  327. #define MQTT_USE_JSON 0 // Group messages in a JSON body
  328. #define MQTT_USE_JSON_DELAY 100 // Wait this many ms before grouping messages
  329. // These particles will be concatenated to the MQTT_TOPIC base to form the actual topic
  330. #define MQTT_TOPIC_JSON "data"
  331. #define MQTT_TOPIC_ACTION "action"
  332. #define MQTT_TOPIC_RELAY "relay"
  333. #define MQTT_TOPIC_LED "led"
  334. #define MQTT_TOPIC_BUTTON "button"
  335. #define MQTT_TOPIC_IP "ip"
  336. #define MQTT_TOPIC_VERSION "version"
  337. #define MQTT_TOPIC_UPTIME "uptime"
  338. #define MQTT_TOPIC_FREEHEAP "freeheap"
  339. #define MQTT_TOPIC_VCC "vcc"
  340. #define MQTT_TOPIC_STATUS "status"
  341. #define MQTT_TOPIC_MAC "mac"
  342. #define MQTT_TOPIC_RSSI "rssi"
  343. #define MQTT_TOPIC_APP "app"
  344. #define MQTT_TOPIC_INTERVAL "interval"
  345. #define MQTT_TOPIC_HOSTNAME "host"
  346. #define MQTT_TOPIC_TIME "time"
  347. #define MQTT_TOPIC_ANALOG "analog"
  348. #define MQTT_TOPIC_COUNTER "counter"
  349. #define MQTT_TOPIC_RFOUT "rfout"
  350. #define MQTT_TOPIC_RFIN "rfin"
  351. #define MQTT_TOPIC_RFLEARN "rflearn"
  352. // Power module
  353. #define MQTT_TOPIC_POWER_ACTIVE "power"
  354. #define MQTT_TOPIC_CURRENT "current"
  355. #define MQTT_TOPIC_VOLTAGE "voltage"
  356. #define MQTT_TOPIC_POWER_APPARENT "apparent"
  357. #define MQTT_TOPIC_POWER_REACTIVE "reactive"
  358. #define MQTT_TOPIC_POWER_FACTOR "factor"
  359. #define MQTT_TOPIC_ENERGY_DELTA "energy_delta"
  360. #define MQTT_TOPIC_ENERGY_TOTAL "energy_total"
  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 "reset" // 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. // -----------------------------------------------------------------------------
  390. // LIGHT
  391. // -----------------------------------------------------------------------------
  392. // Available light providers (do not change)
  393. #define LIGHT_PROVIDER_NONE 0
  394. #define LIGHT_PROVIDER_MY92XX 1 // works with MY9291 and MY9231
  395. #define LIGHT_PROVIDER_DIMMER 2
  396. // LIGHT_PROVIDER_DIMMER can have from 1 to 5 different channels.
  397. // They have to be defined for each device in the hardware.h file.
  398. // If 3 or more channels first 3 will be considered RGB.
  399. // Usual configurations are:
  400. // 1 channels => W
  401. // 2 channels => WW
  402. // 3 channels => RGB
  403. // 4 channels => RGBW
  404. // 5 channels => RGBWW
  405. #ifndef LIGHT_SAVE_ENABLED
  406. #define LIGHT_SAVE_ENABLED 1 // Light channel values saved by default after each change
  407. #endif
  408. #define LIGHT_SAVE_DELAY 5 // Persist color after 5 seconds to avoid wearing out
  409. #ifndef LIGHT_MAX_PWM
  410. #if LIGHT_PROVIDER == LIGHT_PROVIDER_MY92XX
  411. #define LIGHT_MAX_PWM 255
  412. #endif
  413. #if LIGHT_PROVIDER == LIGHT_PROVIDER_DIMMER
  414. #define LIGHT_MAX_PWM 5000 // 5000 * 200ns => 1 kHz
  415. #endif
  416. #endif // LIGHT_MAX_PWM
  417. #ifndef LIGHT_LIMIT_PWM
  418. #define LIGHT_LIMIT_PWM LIGHT_MAX_PWM // Limit PWM to this value (prevent 100% power)
  419. #endif
  420. #ifndef LIGHT_MAX_VALUE
  421. #define LIGHT_MAX_VALUE 255 // Maximum light value
  422. #endif
  423. #define LIGHT_MAX_BRIGHTNESS 255 // Maximun brightness value
  424. #define LIGHT_STEP 32 // Step size
  425. #define LIGHT_USE_COLOR 1 // Use 3 first channels as RGB
  426. #define LIGHT_USE_WHITE 0 // Use white channel whenever RGB have the same value
  427. #define LIGHT_USE_GAMMA 0 // Use gamma correction for color channels
  428. #define LIGHT_USE_CSS 1 // Use CSS style to report colors (1=> "#FF0000", 0=> "255,0,0")
  429. #define LIGHT_USE_RGB 0 // Use RGB color selector (1=> RGB, 0=> HSV)
  430. #define LIGHT_USE_TRANSITIONS 1 // Transitions between colors
  431. #define LIGHT_TRANSITION_STEP 10 // Time in millis between each transtion step
  432. #define LIGHT_TRANSITION_STEPS 50 // Number of steps to acomplish transition
  433. // -----------------------------------------------------------------------------
  434. // POWER METERING
  435. // -----------------------------------------------------------------------------
  436. // Available power-metering providers (do not change this)
  437. #define POWER_PROVIDER_NONE 0x00
  438. #define POWER_PROVIDER_EMON_ANALOG 0x10
  439. #define POWER_PROVIDER_EMON_ADC121 0x11
  440. #define POWER_PROVIDER_HLW8012 0x20
  441. #define POWER_PROVIDER_V9261F 0x30
  442. #define POWER_PROVIDER_ECH1560 0x40
  443. // Available magnitudes (do not change this)
  444. #define POWER_MAGNITUDE_CURRENT 1
  445. #define POWER_MAGNITUDE_VOLTAGE 2
  446. #define POWER_MAGNITUDE_ACTIVE 4
  447. #define POWER_MAGNITUDE_APPARENT 8
  448. #define POWER_MAGNITUDE_REACTIVE 16
  449. #define POWER_MAGNITUDE_POWER_FACTOR 32
  450. #define POWER_MAGNITUDE_ALL 63
  451. // No power provider defined (do not change this)
  452. #ifndef POWER_PROVIDER
  453. #define POWER_PROVIDER POWER_PROVIDER_NONE
  454. #endif
  455. // Identify available magnitudes (do not change this)
  456. #if (POWER_PROVIDER == POWER_PROVIDER_HLW8012) || (POWER_PROVIDER == POWER_PROVIDER_V9261F)
  457. #define POWER_HAS_ACTIVE 1
  458. #else
  459. #define POWER_HAS_ACTIVE 0
  460. #endif
  461. #if (POWER_PROVIDER == POWER_PROVIDER_HLW8012)
  462. #define POWER_HAS_ENERGY 1
  463. #else
  464. #define POWER_HAS_ENERGY 0
  465. #endif
  466. #define POWER_VOLTAGE 230 // Default voltage
  467. #define POWER_MIN_READ_INTERVAL 2000 // Minimum read interval
  468. #define POWER_READ_INTERVAL 6000 // Default reading interval (6 seconds)
  469. #define POWER_REPORT_INTERVAL 60000 // Default report interval (1 minute)
  470. #define POWER_CURRENT_DECIMALS 2 // Decimals for current values
  471. #define POWER_VOLTAGE_DECIMALS 0 // Decimals for voltage values
  472. #define POWER_POWER_DECIMALS 0 // Decimals for power values
  473. #define POWER_ENERGY_DECIMALS 3 // Decimals for energy values
  474. #define POWER_ENERGY_DECIMALS_KWH 6 // Decimals for energy values
  475. #define POWER_ENERGY_FACTOR 1 // Watt * seconds == Joule (Ws == J)
  476. #define POWER_ENERGY_FACTOR_KWH (1. / 1000. / 3600.) // kWh
  477. #if POWER_PROVIDER == POWER_PROVIDER_EMON_ANALOG
  478. #define EMON_CURRENT_RATIO 30 // Current ratio in the clamp (30V/1A)
  479. #define EMON_SAMPLES 1000 // Number of samples to get for each reading
  480. #define EMON_ADC_BITS 10 // ADC depth
  481. #define EMON_REFERENCE_VOLTAGE 1.0 // Reference voltage of the ADC
  482. #define EMON_CURRENT_OFFSET 0.25 // Current offset (error)
  483. #undef ADC_VCC_ENABLED
  484. #define ADC_VCC_ENABLED 0 // Disable internal battery measurement
  485. #endif
  486. #if POWER_PROVIDER == POWER_PROVIDER_EMON_ADC121
  487. #define EMON_CURRENT_RATIO 30 // Current ratio in the clamp (30V/1A)
  488. #define EMON_SAMPLES 1000 // Number of samples to get for each reading
  489. #define EMON_ADC_BITS 12 // ADC depth
  490. #define EMON_REFERENCE_VOLTAGE 3.3 // Reference voltage of the ADC
  491. #define EMON_CURRENT_OFFSET 0.10 // Current offset (error)
  492. #define ADC121_I2C_ADDRESS 0x50 // I2C address of the ADC121
  493. #undef I2C_SUPPORT
  494. #define I2C_SUPPORT 1 // Enabled I2C support
  495. #endif
  496. #if POWER_PROVIDER == POWER_PROVIDER_HLW8012
  497. #define HLW8012_USE_INTERRUPTS 1 // Use interrupts to trap HLW8012 signals
  498. #define HLW8012_SEL_CURRENT HIGH // SEL pin to HIGH to measure current
  499. #define HLW8012_CURRENT_R 0.001 // Current resistor
  500. #define HLW8012_VOLTAGE_R_UP ( 5 * 470000 ) // Upstream voltage resistor
  501. #define HLW8012_VOLTAGE_R_DOWN ( 1000 ) // Downstream voltage resistor
  502. #endif
  503. #if POWER_PROVIDER == POWER_PROVIDER_V9261F
  504. #ifndef V9261F_PIN
  505. #define V9261F_PIN 2 // TX pin from the V9261F
  506. #endif
  507. #ifndef V9261F_PIN_INVERSE
  508. #define V9261F_PIN_INVERSE 1 // Signal is inverted
  509. #endif
  510. #define V9261F_SYNC_INTERVAL 600 // Sync signal length (ms)
  511. #define V9261F_BAUDRATE 4800 // UART baudrate
  512. // Default ratios
  513. #define V9261F_CURRENT_FACTOR 79371434.0
  514. #define V9261F_VOLTAGE_FACTOR 4160651.0
  515. #define V9261F_POWER_FACTOR 153699.0
  516. #define V9261F_RPOWER_FACTOR V9261F_CURRENT_FACTOR
  517. #endif
  518. #if POWER_PROVIDER == POWER_PROVIDER_ECH1560
  519. #ifndef ECH1560_CLK_PIN
  520. #define ECH1560_CLK_PIN 4 // Default CLK pin
  521. #endif
  522. #ifndef ECH1560_MISO_PIN
  523. #define ECH1560_MISO_PIN 5 // Default MISO pin
  524. #endif
  525. #ifndef ECH1560_INVERTED
  526. #define ECH1560_INVERTED 0 // Power signal is inverted
  527. #endif
  528. #endif
  529. // -----------------------------------------------------------------------------
  530. // I2C
  531. // -----------------------------------------------------------------------------
  532. #ifndef I2C_SUPPORT
  533. #define I2C_SUPPORT 0 // I2C enabled (1.98Kb)
  534. #endif
  535. #define I2C_SDA_PIN 4 // SDA GPIO
  536. #define I2C_SCL_PIN 14 // SCL GPIO
  537. #define I2C_CLOCK_STRETCH_TIME 200 // BRZO clock stretch time
  538. #define I2C_SCL_FREQUENCY 1000 // BRZO SCL frequency
  539. // -----------------------------------------------------------------------------
  540. // DOMOTICZ
  541. // -----------------------------------------------------------------------------
  542. #ifndef DOMOTICZ_SUPPORT
  543. #define DOMOTICZ_SUPPORT MQTT_SUPPORT // Build with domoticz (if MQTT) support (1.72Kb)
  544. #endif
  545. #define DOMOTICZ_ENABLED 0 // Disable domoticz by default
  546. #define DOMOTICZ_IN_TOPIC "domoticz/in" // Default subscription topic
  547. #define DOMOTICZ_OUT_TOPIC "domoticz/out" // Default publication topic
  548. #define DOMOTICZ_SKIP_TIME 2 // Avoid recursion skipping messages to same IDX within 2 seconds
  549. // -----------------------------------------------------------------------------
  550. // HOME ASSISTANT
  551. // -----------------------------------------------------------------------------
  552. #ifndef HOMEASSISTANT_SUPPORT
  553. #define HOMEASSISTANT_SUPPORT MQTT_SUPPORT // Build with home assistant support (if MQTT, 1.64Kb)
  554. #endif
  555. #define HOMEASSISTANT_ENABLED 0 // Integration not enabled by default
  556. #define HOMEASSISTANT_PREFIX "homeassistant" // Default MQTT prefix
  557. // -----------------------------------------------------------------------------
  558. // INFLUXDB
  559. // -----------------------------------------------------------------------------
  560. #ifndef INFLUXDB_SUPPORT
  561. #define INFLUXDB_SUPPORT 0 // Enable InfluxDB support by default (4.38Kb)
  562. #endif
  563. #define INFLUXDB_PORT 8086 // Default InfluxDB port
  564. // -----------------------------------------------------------------------------
  565. // NTP
  566. // -----------------------------------------------------------------------------
  567. #ifndef NTP_SUPPORT
  568. #define NTP_SUPPORT 1 // Build with NTP support by default (6.78Kb)
  569. #endif
  570. #define NTP_SERVER "pool.ntp.org" // Default NTP server
  571. #define NTP_TIME_OFFSET 1 // Default timezone offset (GMT+1)
  572. #define NTP_DAY_LIGHT true // Enable daylight time saving by default
  573. #define NTP_UPDATE_INTERVAL 1800 // NTP check every 30 minutes
  574. // -----------------------------------------------------------------------------
  575. // FAUXMO
  576. // -----------------------------------------------------------------------------
  577. // This setting defines whether Alexa support should be built into the firmware
  578. #ifndef ALEXA_SUPPORT
  579. #define ALEXA_SUPPORT 1 // Enable Alexa support by default (9.5Kb)
  580. #endif
  581. // This is default value for the alexaEnabled setting that defines whether
  582. // this device should be discoberable and respond to Alexa commands.
  583. // Both ALEXA_SUPPORT and alexaEnabled should be 1 for Alexa support to work.
  584. #define ALEXA_ENABLED 1
  585. // -----------------------------------------------------------------------------
  586. // RFBRIDGE
  587. // -----------------------------------------------------------------------------
  588. #define RF_SEND_TIMES 4 // How many times to send the message
  589. #define RF_SEND_DELAY 250 // Interval between sendings in ms
  590. #define RF_RECEIVE_DELAY 500 // Interval between recieving in ms (avoid debouncing)
  591. // -----------------------------------------------------------------------------
  592. // IR
  593. // -----------------------------------------------------------------------------
  594. #ifndef IR_SUPPORT
  595. #define IR_SUPPORT 0 // Do not build with IR support by default (10.25Kb)
  596. #endif
  597. #ifndef IR_PIN
  598. #define IR_PIN 4 // IR LED
  599. #endif
  600. // 24 Buttons Set of the IR Remote
  601. #ifndef IR_BUTTON_SET
  602. #define IR_BUTTON_SET 1 // IR button set to use (see below)
  603. #endif
  604. // IR Button modes
  605. #define IR_BUTTON_MODE_NONE 0
  606. #define IR_BUTTON_MODE_RGB 1
  607. #define IR_BUTTON_MODE_HSV 2
  608. #define IR_BUTTON_MODE_BRIGHTER 3
  609. #define IR_BUTTON_MODE_STATE 4
  610. #define IR_BUTTON_MODE_EFFECT 5
  611. #define LIGHT_EFFECT_SOLID 0
  612. #define LIGHT_EFFECT_FLASH 1
  613. #define LIGHT_EFFECT_STROBE 2
  614. #define LIGHT_EFFECT_FADE 3
  615. #define LIGHT_EFFECT_SMOOTH 4
  616. //Remote Buttons SET 1 (for the original Remote shipped with the controller)
  617. #if IR_SUPPORT
  618. #if IR_BUTTON_SET == 1
  619. #define IR_BUTTON_COUNT 24
  620. const unsigned long IR_BUTTON[IR_BUTTON_COUNT][3] PROGMEM = {
  621. { 0xFF906F, IR_BUTTON_MODE_BRIGHTER, 1 },
  622. { 0xFFB847, IR_BUTTON_MODE_BRIGHTER, 0 },
  623. { 0xFFF807, IR_BUTTON_MODE_STATE, 0 },
  624. { 0xFFB04F, IR_BUTTON_MODE_STATE, 1 },
  625. { 0xFF9867, IR_BUTTON_MODE_RGB, 0xFF0000 },
  626. { 0xFFD827, IR_BUTTON_MODE_RGB, 0x00FF00 },
  627. { 0xFF8877, IR_BUTTON_MODE_RGB, 0x0000FF },
  628. { 0xFFA857, IR_BUTTON_MODE_RGB, 0xFFFFFF },
  629. { 0xFFE817, IR_BUTTON_MODE_RGB, 0xD13A01 },
  630. { 0xFF48B7, IR_BUTTON_MODE_RGB, 0x00E644 },
  631. { 0xFF6897, IR_BUTTON_MODE_RGB, 0x0040A7 },
  632. { 0xFFB24D, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FLASH },
  633. { 0xFF02FD, IR_BUTTON_MODE_RGB, 0xE96F2A },
  634. { 0xFF32CD, IR_BUTTON_MODE_RGB, 0x00BEBF },
  635. { 0xFF20DF, IR_BUTTON_MODE_RGB, 0x56406F },
  636. { 0xFF00FF, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_STROBE },
  637. { 0xFF50AF, IR_BUTTON_MODE_RGB, 0xEE9819 },
  638. { 0xFF7887, IR_BUTTON_MODE_RGB, 0x00799A },
  639. { 0xFF708F, IR_BUTTON_MODE_RGB, 0x944E80 },
  640. { 0xFF58A7, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FADE },
  641. { 0xFF38C7, IR_BUTTON_MODE_RGB, 0xFFFF00 },
  642. { 0xFF28D7, IR_BUTTON_MODE_RGB, 0x0060A1 },
  643. { 0xFFF00F, IR_BUTTON_MODE_RGB, 0xEF45AD },
  644. { 0xFF30CF, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_SMOOTH }
  645. };
  646. #endif
  647. //Remote Buttons SET 2 (another identical IR Remote shipped with another controller)
  648. #if IR_BUTTON_SET == 2
  649. #define IR_BUTTON_COUNT 24
  650. const unsigned long IR_BUTTON[IR_BUTTON_COUNT][3] PROGMEM = {
  651. { 0xFF00FF, IR_BUTTON_MODE_BRIGHTER, 1 },
  652. { 0xFF807F, IR_BUTTON_MODE_BRIGHTER, 0 },
  653. { 0xFF40BF, IR_BUTTON_MODE_STATE, 0 },
  654. { 0xFFC03F, IR_BUTTON_MODE_STATE, 1 },
  655. { 0xFF20DF, IR_BUTTON_MODE_RGB, 0xFF0000 },
  656. { 0xFFA05F, IR_BUTTON_MODE_RGB, 0x00FF00 },
  657. { 0xFF609F, IR_BUTTON_MODE_RGB, 0x0000FF },
  658. { 0xFFE01F, IR_BUTTON_MODE_RGB, 0xFFFFFF },
  659. { 0xFF10EF, IR_BUTTON_MODE_RGB, 0xD13A01 },
  660. { 0xFF906F, IR_BUTTON_MODE_RGB, 0x00E644 },
  661. { 0xFF50AF, IR_BUTTON_MODE_RGB, 0x0040A7 },
  662. { 0xFFD02F, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FLASH },
  663. { 0xFF30CF, IR_BUTTON_MODE_RGB, 0xE96F2A },
  664. { 0xFFB04F, IR_BUTTON_MODE_RGB, 0x00BEBF },
  665. { 0xFF708F, IR_BUTTON_MODE_RGB, 0x56406F },
  666. { 0xFFF00F, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_STROBE },
  667. { 0xFF08F7, IR_BUTTON_MODE_RGB, 0xEE9819 },
  668. { 0xFF8877, IR_BUTTON_MODE_RGB, 0x00799A },
  669. { 0xFF48B7, IR_BUTTON_MODE_RGB, 0x944E80 },
  670. { 0xFFC837, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FADE },
  671. { 0xFF28D7, IR_BUTTON_MODE_RGB, 0xFFFF00 },
  672. { 0xFFA857, IR_BUTTON_MODE_RGB, 0x0060A1 },
  673. { 0xFF6897, IR_BUTTON_MODE_RGB, 0xEF45AD },
  674. { 0xFFE817, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_SMOOTH }
  675. };
  676. #endif
  677. #endif // IR_SUPPORT