//------------------------------------------------------------------------------ // Do not change this file unless you know what you are doing // Configuration settings are in the settings.h file //------------------------------------------------------------------------------ //------------------------------------------------------------------------------ // GENERAL //------------------------------------------------------------------------------ #define DEVICE_NAME MANUFACTURER "_" DEVICE // Concatenate both to get a unique device name #define ADMIN_PASS "fibonacci" // Default password (WEB, OTA, WIFI) #define USE_PASSWORD 1 // Insecurity caution! Disabling this will disable password querying completely. #define LOOP_DELAY_TIME 10 // Delay for this millis in the main loop [0-250] #define ARRAYINIT(type, name, ...) \ type name[] = {__VA_ARGS__}; //------------------------------------------------------------------------------ // ESPURNA CORE //------------------------------------------------------------------------------ #ifdef ESPURNA_CORE #define ALEXA_SUPPORT 0 #define BROKER_SUPPORT 0 #define DOMOTICZ_SUPPORT 0 #define HOMEASSISTANT_SUPPORT 0 #define I2C_SUPPORT 0 #define MQTT_SUPPORT 0 #define NTP_SUPPORT 0 #define SCHEDULER_SUPPORT 0 #define SENSOR_SUPPORT 0 #define THINGSPEAK_SUPPORT 0 #define WEB_SUPPORT 0 #endif //------------------------------------------------------------------------------ // TELNET //------------------------------------------------------------------------------ #ifndef TELNET_SUPPORT #define TELNET_SUPPORT 1 // Enable telnet support by default (3.34Kb) #endif #ifndef TELNET_STA #define TELNET_STA 0 // By default, disallow connections via STA interface #endif #define TELNET_PORT 23 // Port to listen to telnet clients #define TELNET_MAX_CLIENTS 1 // Max number of concurrent telnet clients //------------------------------------------------------------------------------ // DEBUG //------------------------------------------------------------------------------ // Serial debug log #ifndef DEBUG_SERIAL_SUPPORT #define DEBUG_SERIAL_SUPPORT 1 // Enable serial debug log #endif #ifndef DEBUG_PORT #define DEBUG_PORT Serial // Default debugging port #endif #ifndef SERIAL_BAUDRATE #define SERIAL_BAUDRATE 115200 // Default baudrate #endif #ifndef DEBUG_ADD_TIMESTAMP #define DEBUG_ADD_TIMESTAMP 1 // Add timestamp to debug messages // (in millis overflowing every 1000 seconds) #endif // Second serial port (used for RX) #ifndef SERIAL_RX_ENABLED #define SERIAL_RX_ENABLED 0 // Secondary serial port for RX #endif #ifndef SERIAL_RX_PORT #define SERIAL_RX_PORT Serial // This setting is usually defined // in the hardware.h file for those // boards that require it #endif #ifndef SERIAL_RX_BAUDRATE #define SERIAL_RX_BAUDRATE 115200 // Default baudrate #endif //------------------------------------------------------------------------------ // UDP debug log // To receive the message son the destination computer use nc: // nc -ul 8113 #ifndef DEBUG_UDP_SUPPORT #define DEBUG_UDP_SUPPORT 0 // Enable UDP debug log #endif #define DEBUG_UDP_IP IPAddress(192, 168, 1, 100) #define DEBUG_UDP_PORT 8113 //------------------------------------------------------------------------------ #ifndef DEBUG_TELNET_SUPPORT #define DEBUG_TELNET_SUPPORT TELNET_SUPPORT // Enable telnet debug log if telnet is enabled too #endif #if DEBUG_TELNET_SUPPORT #undef TELNET_SUPPORT #define TELNET_SUPPORT 1 #endif //------------------------------------------------------------------------------ // General debug options and macros #define DEBUG_SUPPORT DEBUG_SERIAL_SUPPORT || DEBUG_UDP_SUPPORT || DEBUG_TELNET_SUPPORT #if DEBUG_SUPPORT #define DEBUG_MSG(...) debugSend(__VA_ARGS__) #define DEBUG_MSG_P(...) debugSend_P(__VA_ARGS__) #endif #ifndef DEBUG_MSG #define DEBUG_MSG(...) #define DEBUG_MSG_P(...) #endif //------------------------------------------------------------------------------ // TERMINAL //------------------------------------------------------------------------------ #ifndef TERMINAL_SUPPORT #define TERMINAL_SUPPORT 1 // Enable terminal commands (0.97Kb) #endif #define TERMINAL_BUFFER_SIZE 128 // Max size for commands commands //------------------------------------------------------------------------------ // SYSTEM CHECK //------------------------------------------------------------------------------ #ifndef SYSTEM_CHECK_ENABLED #define SYSTEM_CHECK_ENABLED 1 // Enable crash check by default #endif #define SYSTEM_CHECK_TIME 60000 // The system is considered stable after these many millis #define SYSTEM_CHECK_MAX 5 // After this many crashes on boot // the system is flagged as unstable //------------------------------------------------------------------------------ // EEPROM //------------------------------------------------------------------------------ #define EEPROM_SIZE 4096 // EEPROM size in bytes #define EEPROM_RELAY_STATUS 0 // Address for the relay status (1 byte) #define EEPROM_ENERGY_COUNT 1 // Address for the energy counter (4 bytes) #define EEPROM_CUSTOM_RESET 5 // Address for the reset reason (1 byte) #define EEPROM_CRASH_COUNTER 6 // Address for the crash counter (1 byte) #define EEPROM_MESSAGE_ID 7 // Address for the MQTT message id (4 bytes) #define EEPROM_DATA_END 11 // End of custom EEPROM data block //------------------------------------------------------------------------------ // HEARTBEAT //------------------------------------------------------------------------------ #ifndef HEARTBEAT_ENABLED #define HEARTBEAT_ENABLED 1 #endif #define HEARTBEAT_INTERVAL 300000 // Interval between heartbeat messages (in ms) #define UPTIME_OVERFLOW 4294967295 // Uptime overflow value // Topics that will be reported in heartbeat #define HEARTBEAT_REPORT_STATUS 1 #define HEARTBEAT_REPORT_IP 1 #define HEARTBEAT_REPORT_MAC 1 #define HEARTBEAT_REPORT_RSSI 1 #define HEARTBEAT_REPORT_UPTIME 1 #define HEARTBEAT_REPORT_DATETIME 1 #define HEARTBEAT_REPORT_FREEHEAP 1 #define HEARTBEAT_REPORT_VCC 1 #define HEARTBEAT_REPORT_RELAY 1 #define HEARTBEAT_REPORT_LIGHT 1 #define HEARTBEAT_REPORT_HOSTNAME 1 #define HEARTBEAT_REPORT_APP 1 #define HEARTBEAT_REPORT_VERSION 1 #define HEARTBEAT_REPORT_INTERVAL 0 //------------------------------------------------------------------------------ // RESET //------------------------------------------------------------------------------ #define CUSTOM_RESET_HARDWARE 1 // Reset from hardware button #define CUSTOM_RESET_WEB 2 // Reset from web interface #define CUSTOM_RESET_TERMINAL 3 // Reset from terminal #define CUSTOM_RESET_MQTT 4 // Reset via MQTT #define CUSTOM_RESET_RPC 5 // Reset via RPC (HTTP) #define CUSTOM_RESET_OTA 6 // Reset after successful OTA update #define CUSTOM_RESET_HTTP 7 // Reset via HTTP GET #define CUSTOM_RESET_NOFUSS 8 // Reset after successful NOFUSS update #define CUSTOM_RESET_UPGRADE 9 // Reset after update from web interface #define CUSTOM_RESET_FACTORY 10 // Factory reset from terminal #define CUSTOM_RESET_MAX 10 PROGMEM const char custom_reset_hardware[] = "Hardware button"; PROGMEM const char custom_reset_web[] = "Reboot from web interface"; PROGMEM const char custom_reset_terminal[] = "Reboot from terminal"; PROGMEM const char custom_reset_mqtt[] = "Reboot from MQTT"; PROGMEM const char custom_reset_rpc[] = "Reboot from RPC"; PROGMEM const char custom_reset_ota[] = "Reboot after successful OTA update"; PROGMEM const char custom_reset_http[] = "Reboot from HTTP"; PROGMEM const char custom_reset_nofuss[] = "Reboot after successful NoFUSS update"; PROGMEM const char custom_reset_upgrade[] = "Reboot after successful web update"; PROGMEM const char custom_reset_factory[] = "Factory reset"; PROGMEM const char* const custom_reset_string[] = { custom_reset_hardware, custom_reset_web, custom_reset_terminal, custom_reset_mqtt, custom_reset_rpc, custom_reset_ota, custom_reset_http, custom_reset_nofuss, custom_reset_upgrade, custom_reset_factory }; //------------------------------------------------------------------------------ // BUTTON //------------------------------------------------------------------------------ #ifndef BUTTON_DEBOUNCE_DELAY #define BUTTON_DEBOUNCE_DELAY 50 // Debounce delay (ms) #endif #ifndef BUTTON_DBLCLICK_DELAY #define BUTTON_DBLCLICK_DELAY 500 // Time in ms to wait for a second (or third...) click #endif #ifndef BUTTON_LNGCLICK_DELAY #define BUTTON_LNGCLICK_DELAY 1000 // Time in ms holding the button down to get a long click #endif #ifndef BUTTON_LNGLNGCLICK_DELAY #define BUTTON_LNGLNGCLICK_DELAY 10000 // Time in ms holding the button down to get a long-long click #endif #define BUTTON_EVENT_NONE 0 #define BUTTON_EVENT_PRESSED 1 #define BUTTON_EVENT_RELEASED 2 #define BUTTON_EVENT_CLICK 2 #define BUTTON_EVENT_DBLCLICK 3 #define BUTTON_EVENT_LNGCLICK 4 #define BUTTON_EVENT_LNGLNGCLICK 5 #define BUTTON_MODE_NONE 0 #define BUTTON_MODE_TOGGLE 1 #define BUTTON_MODE_ON 2 #define BUTTON_MODE_OFF 3 #define BUTTON_MODE_AP 4 #define BUTTON_MODE_RESET 5 #define BUTTON_MODE_PULSE 6 #define BUTTON_MODE_FACTORY 7 //------------------------------------------------------------------------------ // RELAY //------------------------------------------------------------------------------ #define RELAY_BOOT_OFF 0 #define RELAY_BOOT_ON 1 #define RELAY_BOOT_SAME 2 #define RELAY_BOOT_TOGGLE 3 #define RELAY_TYPE_NORMAL 0 #define RELAY_TYPE_INVERSE 1 #define RELAY_TYPE_LATCHED 2 #define RELAY_SYNC_ANY 0 #define RELAY_SYNC_NONE_OR_ONE 1 #define RELAY_SYNC_ONE 2 #define RELAY_SYNC_SAME 3 #define RELAY_PULSE_NONE 0 #define RELAY_PULSE_OFF 1 #define RELAY_PULSE_ON 2 #define RELAY_PROVIDER_RELAY 0 #define RELAY_PROVIDER_DUAL 1 #define RELAY_PROVIDER_LIGHT 2 #define RELAY_PROVIDER_RFBRIDGE 3 #define RELAY_PROVIDER_STM 4 // Default boot mode: 0 means OFF, 1 ON and 2 whatever was before #define RELAY_BOOT_MODE RELAY_BOOT_OFF // 0 means ANY, 1 zero or one and 2 one and only one #define RELAY_SYNC RELAY_SYNC_ANY // Default pulse mode: 0 means no pulses, 1 means normally off, 2 normally on #define RELAY_PULSE_MODE RELAY_PULSE_NONE // Default pulse time in seconds #define RELAY_PULSE_TIME 1.0 // Relay requests flood protection window - in seconds #define RELAY_FLOOD_WINDOW 3 // Allowed actual relay changes inside requests flood protection window #define RELAY_FLOOD_CHANGES 5 // Pulse with in milliseconds for a latched relay #define RELAY_LATCHING_PULSE 10 // Do not save relay state after these many milliseconds #define RELAY_SAVE_DELAY 1000 //------------------------------------------------------------------------------ // LED //------------------------------------------------------------------------------ #define LED_MODE_MQTT 0 // LED will be managed from MQTT (OFF by default) #define LED_MODE_WIFI 1 // LED will blink according to the WIFI status #define LED_MODE_FOLLOW 2 // LED will follow state of linked relay (check RELAY#_LED) #define LED_MODE_FOLLOW_INVERSE 3 // LED will follow the opposite state of linked relay (check RELAY#_LED) #define LED_MODE_FINDME 4 // LED will be ON if all relays are OFF #define LED_MODE_FINDME_WIFI 5 // A mixture between WIFI and FINDME #define LED_MODE_ON 6 // LED always ON #define LED_MODE_OFF 7 // LED always OFF #define LED_MODE_RELAY 8 // If any relay is ON, LED will be ON, otherwise OFF #define LED_MODE_RELAY_WIFI 9 // A mixture between WIFI and RELAY, the reverse of MIXED // ----------------------------------------------------------------------------- // WIFI // ----------------------------------------------------------------------------- #define WIFI_CONNECT_TIMEOUT 60000 // Connecting timeout for WIFI in ms #define WIFI_RECONNECT_INTERVAL 180000 // If could not connect to WIFI, retry after this time in ms #define WIFI_MAX_NETWORKS 5 // Max number of WIFI connection configurations #define WIFI_AP_MODE AP_MODE_ALONE #define WIFI_SLEEP_ENABLED 1 // Enable WiFi light sleep #define WIFI_SCAN_NETWORKS 1 // Perform a network scan before connecting // Optional hardcoded configuration (up to 2 networks) #ifndef WIFI1_SSID #define WIFI1_SSID "" #endif #ifndef WIFI1_PASS #define WIFI1_PASS "" #endif #ifndef WIFI1_IP #define WIFI1_IP "" #endif #ifndef WIFI1_GW #define WIFI1_GW "" #endif #ifndef WIFI1_MASK #define WIFI1_MASK "" #endif #ifndef WIFI1_DNS #define WIFI1_DNS "" #endif #ifndef WIFI2_SSID #define WIFI2_SSID "" #endif #ifndef WIFI2_PASS #define WIFI2_PASS "" #endif #ifndef WIFI2_IP #define WIFI2_IP "" #endif #ifndef WIFI2_GW #define WIFI2_GW "" #endif #ifndef WIFI2_MASK #define WIFI2_MASK "" #endif #ifndef WIFI2_DNS #define WIFI2_DNS "" #endif #define WIFI_RSSI_1M -30 // Calibrate it with your router reading the RSSI at 1m #define WIFI_PROPAGATION_CONST 4 // This is typically something between 2.7 to 4.3 (free space is 2) // ----------------------------------------------------------------------------- // WEB // ----------------------------------------------------------------------------- #ifndef WEB_SUPPORT #define WEB_SUPPORT 1 // Enable web support (http, api, 121.65Kb) #endif #ifndef WEB_EMBEDDED #define WEB_EMBEDDED 1 // Build the firmware with the web interface embedded in #endif // This is not working at the moment!! // Requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core 2.4.0 #define WEB_SSL_ENABLED 0 // Use HTTPS web interface #define WEB_MODE_NORMAL 0 #define WEB_MODE_PASSWORD 1 #define WEB_USERNAME "admin" // HTTP username #define WEB_FORCE_PASS_CHANGE 1 // Force the user to change the password if default one #define WEB_PORT 80 // HTTP port // ----------------------------------------------------------------------------- // WEBSOCKETS // ----------------------------------------------------------------------------- // This will only be enabled if WEB_SUPPORT is 1 (this is the default value) #define WS_BUFFER_SIZE 5 // Max number of secured websocket connections #define WS_TIMEOUT 1800000 // Timeout for secured websocket #define WS_UPDATE_INTERVAL 30000 // Update clients every 30 seconds // ----------------------------------------------------------------------------- // API // ----------------------------------------------------------------------------- // This will only be enabled if WEB_SUPPORT is 1 (this is the default value) #define API_ENABLED 0 // Do not enable API by default #define API_BUFFER_SIZE 15 // Size of the buffer for HTTP GET API responses #define API_REAL_TIME_VALUES 0 // Show filtered/median values by default (0 => median, 1 => real time) // ----------------------------------------------------------------------------- // UI // ----------------------------------------------------------------------------- #define UI_TAG_INPUT 0 #define UI_TAG_CHECKBOX 1 #define UI_TAG_SELECT 2 // ----------------------------------------------------------------------------- // MDNS / LLMNR / NETBIOS / SSDP // ----------------------------------------------------------------------------- #ifndef MDNS_SERVER_SUPPORT #define MDNS_SERVER_SUPPORT 1 // Publish services using mDNS by default (1.48Kb) #endif #ifndef MDNS_CLIENT_SUPPORT #define MDNS_CLIENT_SUPPORT 0 // Resolve mDNS names (3.44Kb) #endif #ifndef LLMNR_SUPPORT #define LLMNR_SUPPORT 0 // Publish device using LLMNR protocol by default (1.95Kb) - requires 2.4.0 #endif #ifndef NETBIOS_SUPPORT #define NETBIOS_SUPPORT 0 // Publish device using NetBIOS protocol by default (1.26Kb) - requires 2.4.0 #endif #ifndef SSDP_SUPPORT #define SSDP_SUPPORT 0 // Publish device using SSDP protocol by default (4.59Kb) // Not compatible with ALEXA_SUPPORT at the moment #endif #ifndef SSDP_DEVICE_TYPE #define SSDP_DEVICE_TYPE "upnp:rootdevice" //#define SSDP_DEVICE_TYPE "urn:schemas-upnp-org:device:BinaryLight:1" #endif #if WEB_SUPPORT == 0 #undef SSDP_SUPPORT #define SSDP_SUPPORT 0 // SSDP support requires web support #endif // ----------------------------------------------------------------------------- // SPIFFS // ----------------------------------------------------------------------------- #ifndef SPIFFS_SUPPORT #define SPIFFS_SUPPORT 0 // Do not add support for SPIFFS by default #endif // ----------------------------------------------------------------------------- // OTA // ----------------------------------------------------------------------------- #define OTA_PORT 8266 // OTA port #define OTA_GITHUB_FP "D7:9F:07:61:10:B3:92:93:E3:49:AC:89:84:5B:03:80:C1:9E:2F:8B" // ----------------------------------------------------------------------------- // NOFUSS // ----------------------------------------------------------------------------- #ifndef NOFUSS_SUPPORT #define NOFUSS_SUPPORT 0 // Do not enable support for NoFuss by default (12.65Kb) #endif #define NOFUSS_ENABLED 0 // Do not perform NoFUSS updates by default #define NOFUSS_SERVER "" // Default NoFuss Server #define NOFUSS_INTERVAL 3600000 // Check for updates every hour // ----------------------------------------------------------------------------- // UART <-> MQTT // ----------------------------------------------------------------------------- #ifndef UART_MQTT_SUPPORT #define UART_MQTT_SUPPORT 0 // No support by default #endif #define UART_MQTT_USE_SOFT 0 // Use SoftwareSerial #define UART_MQTT_HW_PORT Serial // Hardware serial port (if UART_MQTT_USE_SOFT == 0) #define UART_MQTT_RX_PIN 4 // RX PIN (if UART_MQTT_USE_SOFT == 1) #define UART_MQTT_TX_PIN 5 // TX PIN (if UART_MQTT_USE_SOFT == 1) #define UART_MQTT_BAUDRATE 115200 // Serial speed #define UART_MQTT_BUFFER_SIZE 100 // UART buffer size #if UART_MQTT_SUPPORT #define MQTT_SUPPORT 1 #undef TERMINAL_SUPPORT #define TERMINAL_SUPPORT 0 #undef DEBUG_SERIAL_SUPPORT #define DEBUG_SERIAL_SUPPORT 0 #endif // ----------------------------------------------------------------------------- // MQTT // ----------------------------------------------------------------------------- #ifndef MQTT_SUPPORT #define MQTT_SUPPORT 1 // MQTT support (22.38Kb async, 12.48Kb sync) #endif #ifndef MQTT_USE_ASYNC #define MQTT_USE_ASYNC 1 // Use AysncMQTTClient (1) or PubSubClient (0) #endif // MQTT OVER SSL // Using MQTT over SSL works pretty well but generates problems with the web interface. // It could be a good idea to use it in conjuntion with WEB_SUPPORT=0. // Requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core 2.4.0. // // You can use SSL with MQTT_USE_ASYNC=1 (AsyncMqttClient library) // but you might experience hiccups on the web interface, so my recommendation is: // WEB_SUPPORT=0 // // If you use SSL with MQTT_USE_ASYNC=0 (PubSubClient library) // you will have to disable all the modules that use ESPAsyncTCP, that is: // ALEXA_SUPPORT=0, INFLUXDB_SUPPORT=0, TELNET_SUPPORT=0, THINGSPEAK_SUPPORT=0 and WEB_SUPPORT=0 // // You will need the fingerprint for your MQTT server, example for CloudMQTT: // $ echo -n | openssl s_client -connect m11.cloudmqtt.com:24055 > cloudmqtt.pem // $ openssl x509 -noout -in cloudmqtt.pem -fingerprint -sha1 #define MQTT_SSL_ENABLED 0 // By default MQTT over SSL will not be enabled #define MQTT_SSL_FINGERPRINT "" // SSL fingerprint of the server #define MQTT_ENABLED 0 // Do not enable MQTT connection by default #define MQTT_AUTOCONNECT 1 // If enabled and MDNS_SERVER_SUPPORT=1 will perform an autodiscover and // autoconnect to the first MQTT broker found if none defined #define MQTT_SERVER "" // Default MQTT broker address #define MQTT_USER "" // Default MQTT broker usename #define MQTT_PASS "" // Default MQTT broker password #define MQTT_PORT 1883 // MQTT broker port #define MQTT_TOPIC "{hostname}" // Default MQTT base topic #define MQTT_RETAIN true // MQTT retain flag #define MQTT_QOS 0 // MQTT QoS value for all messages #define MQTT_KEEPALIVE 30 // MQTT keepalive value #define MQTT_RECONNECT_DELAY_MIN 5000 // Try to reconnect in 5 seconds upon disconnection #define MQTT_RECONNECT_DELAY_STEP 5000 // Increase the reconnect delay in 5 seconds after each failed attempt #define MQTT_RECONNECT_DELAY_MAX 120000 // Set reconnect time to 2 minutes at most #define MQTT_SKIP_RETAINED 1 // Skip retained messages on connection #define MQTT_SKIP_TIME 1000 // Skip messages for 1 second anter connection #define MQTT_USE_JSON 0 // Group messages in a JSON body #define MQTT_USE_JSON_DELAY 100 // Wait this many ms before grouping messages #define MQTT_QUEUE_MAX_SIZE 20 // Size of the MQTT queue when MQTT_USE_JSON is enabled // These are the properties that will be sent when useJson is true #ifndef MQTT_ENQUEUE_IP #define MQTT_ENQUEUE_IP 1 #endif #ifndef MQTT_ENQUEUE_MAC #define MQTT_ENQUEUE_MAC 1 #endif #ifndef MQTT_ENQUEUE_HOSTNAME #define MQTT_ENQUEUE_HOSTNAME 1 #endif #ifndef MQTT_ENQUEUE_DATETIME #define MQTT_ENQUEUE_DATETIME 1 #endif #ifndef MQTT_ENQUEUE_MESSAGE_ID #define MQTT_ENQUEUE_MESSAGE_ID 1 #endif // These particles will be concatenated to the MQTT_TOPIC base to form the actual topic #define MQTT_TOPIC_JSON "data" #define MQTT_TOPIC_ACTION "action" #define MQTT_TOPIC_RELAY "relay" #define MQTT_TOPIC_LED "led" #define MQTT_TOPIC_BUTTON "button" #define MQTT_TOPIC_IP "ip" #define MQTT_TOPIC_VERSION "version" #define MQTT_TOPIC_UPTIME "uptime" #define MQTT_TOPIC_DATETIME "datetime" #define MQTT_TOPIC_FREEHEAP "freeheap" #define MQTT_TOPIC_VCC "vcc" #define MQTT_TOPIC_STATUS "status" #define MQTT_TOPIC_MAC "mac" #define MQTT_TOPIC_RSSI "rssi" #define MQTT_TOPIC_MESSAGE_ID "id" #define MQTT_TOPIC_APP "app" #define MQTT_TOPIC_INTERVAL "interval" #define MQTT_TOPIC_HOSTNAME "host" #define MQTT_TOPIC_TIME "time" #define MQTT_TOPIC_RFOUT "rfout" #define MQTT_TOPIC_RFIN "rfin" #define MQTT_TOPIC_RFLEARN "rflearn" #define MQTT_TOPIC_RFRAW "rfraw" #define MQTT_TOPIC_UARTIN "uartin" #define MQTT_TOPIC_UARTOUT "uartout" // Light module #define MQTT_TOPIC_CHANNEL "channel" #define MQTT_TOPIC_COLOR "color" // DEPRECATED, use RGB instead #define MQTT_TOPIC_COLOR_RGB "rgb" #define MQTT_TOPIC_COLOR_HSV "hsv" #define MQTT_TOPIC_ANIM_MODE "anim_mode" #define MQTT_TOPIC_ANIM_SPEED "anim_speed" #define MQTT_TOPIC_BRIGHTNESS "brightness" #define MQTT_TOPIC_MIRED "mired" #define MQTT_TOPIC_KELVIN "kelvin" #define MQTT_STATUS_ONLINE "1" // Value for the device ON message #define MQTT_STATUS_OFFLINE "0" // Value for the device OFF message (will) #define MQTT_ACTION_RESET "reboot" // RESET MQTT topic particle // Internal MQTT events (do not change) #define MQTT_CONNECT_EVENT 0 #define MQTT_DISCONNECT_EVENT 1 #define MQTT_MESSAGE_EVENT 2 #define MQTT_MESSAGE_ID_SHIFT 1000 // Store MQTT message id into EEPROM every these many // Custom get and set postfixes // Use something like "/status" or "/set", with leading slash // Since 1.9.0 the default value is "" for getter and "/set" for setter #ifndef MQTT_GETTER #define MQTT_GETTER "" #endif #ifndef MQTT_SETTER #define MQTT_SETTER "/set" #endif // ----------------------------------------------------------------------------- // BROKER // ----------------------------------------------------------------------------- #ifndef BROKER_SUPPORT #define BROKER_SUPPORT 1 // The broker is a poor-man's pubsub manager #endif // ----------------------------------------------------------------------------- // SETTINGS // ----------------------------------------------------------------------------- #ifndef SETTINGS_AUTOSAVE #define SETTINGS_AUTOSAVE 1 // Autosave settings o force manual commit #endif #define SETTINGS_MAX_LIST_COUNT 10 // Maximum index for settings lists // ----------------------------------------------------------------------------- // LIGHT // ----------------------------------------------------------------------------- // Available light providers (do not change) #define LIGHT_PROVIDER_NONE 0 #define LIGHT_PROVIDER_MY92XX 1 // works with MY9291 and MY9231 #define LIGHT_PROVIDER_DIMMER 2 // LIGHT_PROVIDER_DIMMER can have from 1 to 5 different channels. // They have to be defined for each device in the hardware.h file. // If 3 or more channels first 3 will be considered RGB. // Usual configurations are: // 1 channels => W // 2 channels => WW // 3 channels => RGB // 4 channels => RGBW // 5 channels => RGBWW #ifndef LIGHT_SAVE_ENABLED #define LIGHT_SAVE_ENABLED 1 // Light channel values saved by default after each change #endif #define LIGHT_SAVE_DELAY 5 // Persist color after 5 seconds to avoid wearing out #ifndef LIGHT_MAX_PWM #if LIGHT_PROVIDER == LIGHT_PROVIDER_MY92XX #define LIGHT_MAX_PWM 255 #endif #if LIGHT_PROVIDER == LIGHT_PROVIDER_DIMMER #define LIGHT_MAX_PWM 10000 // 5000 * 200ns => 1 kHz #endif #endif // LIGHT_MAX_PWM #ifndef LIGHT_LIMIT_PWM #define LIGHT_LIMIT_PWM LIGHT_MAX_PWM // Limit PWM to this value (prevent 100% power) #endif #ifndef LIGHT_MAX_VALUE #define LIGHT_MAX_VALUE 255 // Maximum light value #endif #define LIGHT_MAX_BRIGHTNESS 255 // Maximun brightness value #define LIGHT_STEP 32 // Step size #define LIGHT_USE_COLOR 1 // Use 3 first channels as RGB #define LIGHT_USE_WHITE 0 // Use white channel whenever RGB have the same value #define LIGHT_USE_GAMMA 0 // Use gamma correction for color channels #define LIGHT_USE_CSS 1 // Use CSS style to report colors (1=> "#FF0000", 0=> "255,0,0") #define LIGHT_USE_RGB 0 // Use RGB color selector (1=> RGB, 0=> HSV) #define LIGHT_USE_TRANSITIONS 1 // Transitions between colors #define LIGHT_TRANSITION_STEP 10 // Time in millis between each transtion step #define LIGHT_TRANSITION_STEPS 50 // Number of steps to acomplish transition // ----------------------------------------------------------------------------- // DOMOTICZ // ----------------------------------------------------------------------------- #ifndef DOMOTICZ_SUPPORT #define DOMOTICZ_SUPPORT MQTT_SUPPORT // Build with domoticz (if MQTT) support (1.72Kb) #endif #if DOMOTICZ_SUPPORT #undef MQTT_SUPPORT #define MQTT_SUPPORT 1 // If Domoticz enabled enable MQTT #endif #define DOMOTICZ_ENABLED 0 // Disable domoticz by default #define DOMOTICZ_IN_TOPIC "domoticz/in" // Default subscription topic #define DOMOTICZ_OUT_TOPIC "domoticz/out" // Default publication topic // ----------------------------------------------------------------------------- // HOME ASSISTANT // ----------------------------------------------------------------------------- #ifndef HOMEASSISTANT_SUPPORT #define HOMEASSISTANT_SUPPORT MQTT_SUPPORT // Build with home assistant support (if MQTT, 1.64Kb) #endif #if HOMEASSISTANT_SUPPORT #undef MQTT_SUPPORT #define MQTT_SUPPORT 1 // If Home Assistant enabled enable MQTT #endif #define HOMEASSISTANT_ENABLED 0 // Integration not enabled by default #define HOMEASSISTANT_PREFIX "homeassistant" // Default MQTT prefix // ----------------------------------------------------------------------------- // INFLUXDB // ----------------------------------------------------------------------------- #ifndef INFLUXDB_SUPPORT #define INFLUXDB_SUPPORT 0 // Enable InfluxDB support by default (4.38Kb) #endif #define INFLUXDB_ENABLED 0 // InfluxDB disabled by default #define INFLUXDB_HOST "" // Default server #define INFLUXDB_PORT 8086 // Default InfluxDB port #define INFLUXDB_DATABASE "" // Default database #define INFLUXDB_USERNAME "" // Default username #define INFLUXDB_PASSWORD "" // Default password // ----------------------------------------------------------------------------- // THINGSPEAK // ----------------------------------------------------------------------------- #ifndef THINGSPEAK_SUPPORT #define THINGSPEAK_SUPPORT 1 // Enable Thingspeak support by default (2.56Kb) #endif #define THINGSPEAK_ENABLED 0 // Thingspeak disabled by default #define THINGSPEAK_APIKEY "" // Default API KEY #define THINGSPEAK_USE_ASYNC 1 // Use AsyncClient instead of WiFiClientSecure // THINGSPEAK OVER SSL // Using THINGSPEAK over SSL works well but generates problems with the web interface, // so you should compile it with WEB_SUPPORT to 0. // When THINGSPEAK_USE_ASYNC is 1, requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core 2.4.0. #define THINGSPEAK_USE_SSL 0 // Use secure connection #define THINGSPEAK_FINGERPRINT "78 60 18 44 81 35 BF DF 77 84 D4 0A 22 0D 9B 4E 6C DC 57 2C" #define THINGSPEAK_HOST "api.thingspeak.com" #if THINGSPEAK_USE_SSL #define THINGSPEAK_PORT 443 #else #define THINGSPEAK_PORT 80 #endif #define THINGSPEAK_URL "/update" #define THINGSPEAK_MIN_INTERVAL 15000 // Minimum interval between POSTs (in millis) #ifndef ASYNC_TCP_SSL_ENABLED #if THINGSPEAK_USE_SSL && THINGSPEAK_USE_ASYNC #undef THINGSPEAK_SUPPORT // Thingspeak in ASYNC mode requires ASYNC_TCP_SSL_ENABLED #endif #endif // ----------------------------------------------------------------------------- // SCHEDULER // ----------------------------------------------------------------------------- #ifndef SCHEDULER_SUPPORT #define SCHEDULER_SUPPORT 1 // Enable scheduler (1.77Kb) #endif #if SCHEDULER_SUPPORT #undef NTP_SUPPORT #define NTP_SUPPORT 1 // Scheduler needs NTP #endif #define SCHEDULER_MAX_SCHEDULES 10 // Max schedules alowed // ----------------------------------------------------------------------------- // NTP // ----------------------------------------------------------------------------- #ifndef NTP_SUPPORT #define NTP_SUPPORT 1 // Build with NTP support by default (6.78Kb) #endif #define NTP_SERVER "pool.ntp.org" // Default NTP server #define NTP_TIME_OFFSET 1 // Default timezone offset (GMT+1) #define NTP_DAY_LIGHT true // Enable daylight time saving by default #define NTP_SYNC_INTERVAL 60 // NTP initial check every minute #define NTP_UPDATE_INTERVAL 1800 // NTP check every 30 minutes #define NTP_START_DELAY 1000 // Delay NTP start 1 second // ----------------------------------------------------------------------------- // ALEXA // ----------------------------------------------------------------------------- // This setting defines whether Alexa support should be built into the firmware #ifndef ALEXA_SUPPORT #define ALEXA_SUPPORT 1 // Enable Alexa support by default (10.84Kb) #endif // This is default value for the alexaEnabled setting that defines whether // this device should be discoberable and respond to Alexa commands. // Both ALEXA_SUPPORT and alexaEnabled should be 1 for Alexa support to work. #define ALEXA_ENABLED 1 // ----------------------------------------------------------------------------- // RFBRIDGE // This module is not compatible with RF_SUPPORT=1 // ----------------------------------------------------------------------------- #define RF_SEND_TIMES 4 // How many times to send the message #define RF_SEND_DELAY 500 // Interval between sendings in ms #define RF_RECEIVE_DELAY 500 // Interval between recieving in ms (avoid debouncing) #define RF_RAW_SUPPORT 0 // RF raw codes require a specific firmware for the EFM8BB1 // https://github.com/rhx/RF-Bridge-EFM8BB1 // ----------------------------------------------------------------------------- // IR // ----------------------------------------------------------------------------- #ifndef IR_SUPPORT #define IR_SUPPORT 0 // Do not build with IR support by default (10.25Kb) #endif #ifndef IR_PIN #define IR_PIN 4 // IR LED #endif // 24 Buttons Set of the IR Remote #ifndef IR_BUTTON_SET #define IR_BUTTON_SET 1 // IR button set to use (see below) #endif // IR Button modes #define IR_BUTTON_MODE_NONE 0 #define IR_BUTTON_MODE_RGB 1 #define IR_BUTTON_MODE_HSV 2 #define IR_BUTTON_MODE_BRIGHTER 3 #define IR_BUTTON_MODE_STATE 4 #define IR_BUTTON_MODE_EFFECT 5 #define LIGHT_EFFECT_SOLID 0 #define LIGHT_EFFECT_FLASH 1 #define LIGHT_EFFECT_STROBE 2 #define LIGHT_EFFECT_FADE 3 #define LIGHT_EFFECT_SMOOTH 4 //Remote Buttons SET 1 (for the original Remote shipped with the controller) #if IR_SUPPORT #if IR_BUTTON_SET == 1 /* +------+------+------+------+ | UP | Down | OFF | ON | +------+------+------+------+ | R | G | B | W | +------+------+------+------+ | 1 | 2 | 3 |FLASH | +------+------+------+------+ | 4 | 5 | 6 |STROBE| +------+------+------+------+ | 7 | 8 | 9 | FADE | +------+------+------+------+ | 10 | 11 | 12 |SMOOTH| +------+------+------+------+ */ #define IR_BUTTON_COUNT 24 const unsigned long IR_BUTTON[IR_BUTTON_COUNT][3] PROGMEM = { { 0xFF906F, IR_BUTTON_MODE_BRIGHTER, 1 }, { 0xFFB847, IR_BUTTON_MODE_BRIGHTER, 0 }, { 0xFFF807, IR_BUTTON_MODE_STATE, 0 }, { 0xFFB04F, IR_BUTTON_MODE_STATE, 1 }, { 0xFF9867, IR_BUTTON_MODE_RGB, 0xFF0000 }, { 0xFFD827, IR_BUTTON_MODE_RGB, 0x00FF00 }, { 0xFF8877, IR_BUTTON_MODE_RGB, 0x0000FF }, { 0xFFA857, IR_BUTTON_MODE_RGB, 0xFFFFFF }, { 0xFFE817, IR_BUTTON_MODE_RGB, 0xD13A01 }, { 0xFF48B7, IR_BUTTON_MODE_RGB, 0x00E644 }, { 0xFF6897, IR_BUTTON_MODE_RGB, 0x0040A7 }, { 0xFFB24D, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FLASH }, { 0xFF02FD, IR_BUTTON_MODE_RGB, 0xE96F2A }, { 0xFF32CD, IR_BUTTON_MODE_RGB, 0x00BEBF }, { 0xFF20DF, IR_BUTTON_MODE_RGB, 0x56406F }, { 0xFF00FF, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_STROBE }, { 0xFF50AF, IR_BUTTON_MODE_RGB, 0xEE9819 }, { 0xFF7887, IR_BUTTON_MODE_RGB, 0x00799A }, { 0xFF708F, IR_BUTTON_MODE_RGB, 0x944E80 }, { 0xFF58A7, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FADE }, { 0xFF38C7, IR_BUTTON_MODE_RGB, 0xFFFF00 }, { 0xFF28D7, IR_BUTTON_MODE_RGB, 0x0060A1 }, { 0xFFF00F, IR_BUTTON_MODE_RGB, 0xEF45AD }, { 0xFF30CF, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_SMOOTH } }; #endif //Remote Buttons SET 2 (another identical IR Remote shipped with another controller) #if IR_BUTTON_SET == 2 /* +------+------+------+------+ | UP | Down | OFF | ON | +------+------+------+------+ | R | G | B | W | +------+------+------+------+ | 1 | 2 | 3 |FLASH | +------+------+------+------+ | 4 | 5 | 6 |STROBE| +------+------+------+------+ | 7 | 8 | 9 | FADE | +------+------+------+------+ | 10 | 11 | 12 |SMOOTH| +------+------+------+------+ */ #define IR_BUTTON_COUNT 24 const unsigned long IR_BUTTON[IR_BUTTON_COUNT][3] PROGMEM = { { 0xFF00FF, IR_BUTTON_MODE_BRIGHTER, 1 }, { 0xFF807F, IR_BUTTON_MODE_BRIGHTER, 0 }, { 0xFF40BF, IR_BUTTON_MODE_STATE, 0 }, { 0xFFC03F, IR_BUTTON_MODE_STATE, 1 }, { 0xFF20DF, IR_BUTTON_MODE_RGB, 0xFF0000 }, { 0xFFA05F, IR_BUTTON_MODE_RGB, 0x00FF00 }, { 0xFF609F, IR_BUTTON_MODE_RGB, 0x0000FF }, { 0xFFE01F, IR_BUTTON_MODE_RGB, 0xFFFFFF }, { 0xFF10EF, IR_BUTTON_MODE_RGB, 0xD13A01 }, { 0xFF906F, IR_BUTTON_MODE_RGB, 0x00E644 }, { 0xFF50AF, IR_BUTTON_MODE_RGB, 0x0040A7 }, { 0xFFD02F, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FLASH }, { 0xFF30CF, IR_BUTTON_MODE_RGB, 0xE96F2A }, { 0xFFB04F, IR_BUTTON_MODE_RGB, 0x00BEBF }, { 0xFF708F, IR_BUTTON_MODE_RGB, 0x56406F }, { 0xFFF00F, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_STROBE }, { 0xFF08F7, IR_BUTTON_MODE_RGB, 0xEE9819 }, { 0xFF8877, IR_BUTTON_MODE_RGB, 0x00799A }, { 0xFF48B7, IR_BUTTON_MODE_RGB, 0x944E80 }, { 0xFFC837, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_FADE }, { 0xFF28D7, IR_BUTTON_MODE_RGB, 0xFFFF00 }, { 0xFFA857, IR_BUTTON_MODE_RGB, 0x0060A1 }, { 0xFF6897, IR_BUTTON_MODE_RGB, 0xEF45AD }, { 0xFFE817, IR_BUTTON_MODE_EFFECT, LIGHT_EFFECT_SMOOTH } }; #endif #endif // IR_SUPPORT //-------------------------------------------------------------------------------- // Custom RF module // Check http://tinkerman.cat/adding-rf-to-a-non-rf-itead-sonoff/ // Enable support by passing RF_SUPPORT=1 build flag // This module is not compatible with RFBRIDGE //-------------------------------------------------------------------------------- #ifndef RF_SUPPORT #define RF_SUPPORT 0 #endif #ifndef RF_PIN #define RF_PIN 14 #endif #define RF_DEBOUNCE 500 #define RF_LEARN_TIMEOUT 60000