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.

837 lines
34 KiB

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