e08d96acc2
5.9.0 20171030 * Rewrite code (partly) using Google C++ Style Guide (https://google.github.io/styleguide/cppguide.html) * Rewrite code by using command lookup tables and javascript (client side) web page expansions * Change HTML/CSS to enable nicer form field entry * Change default PWM assignments for H801 RGB(CW) led controller to support optional Color/Dimmer control * GPIO04 (W2) from GPIO_PWM2 to GPIO_USER to be user configurable for GPIO_PWM5 (second White - Warm if W1 is Cold) * GPIO12 (Blue) GPIO_PWM3 no change * GPIO13 (Green) from GPIO_PWM4 to GPIO_PWM2 * GPIO14 (W1) from GPIO_PWM1 to GPIO_USER to be user configurable for GPIO_PWM4 (first White - Cold or Warm) * GPIO15 (Red) from GPIO_PWM5 to GPIO_PWM1 * Change default PWM assignments for MagicHome RGB(W) led controller to support optional Color/Dimmer control * GPIO05 (Green) from GPIO_PWM4 to GPIO_PWM2 * GPIO12 (Blue) from GPIO_PWM5 to GPIO_PWM3 * GPIO13 (White) GPIO_USER to be user configurable for GPIO_PWM4 (White - Cold or Warm) * GPIO14 (Red) from GPIO_PWM3 to GPIO_PWM1 * Change default PWM assignment for Witty Cloud to support optional Color/Dimmer control (#976) * GPIO12 (Green) from GPIO_PWM4 to GPIO_PWM2 * GPIO13 (Blue) from GPIO_PWM5 to GPIO_PWM3 * GPIO15 (Red) from GPIO_PWM3 to GPIO_PWM1 * Change when another module is selected now all GPIO user configuration is removed * Change command name IRRemote to IRSend (#956) * Remove Arduino IDE version too low warning as it interferes with platformio.ini platform = espressif8266_stage * Fix command FullTopic entry when using serial or console interface * Fix possible UDP syslog blocking * Fix minimum TelePeriod of 10 seconds set by web page * Fix command GPIOx JSON response (#897) * Fix inverted relay power on state (#909) * Fix compile error when DOMOTICZ_UPDATE_TIMER is not defined (#930) * Fix alignment of web page items in some browsers (#935) * Fix setting all saved power settings to Off when SetOption0 (SaveState) = 0 (#955) * Fix timezone range from -12/12 to -13/13 (#968) * Fix Southern Hemisphere TIME_STD/TIME_DST (#968) * Fix TLS MQTT SSL fingerprint test (#970, #808) * Fix virtual relay status message used with Color/Dimmer control (#989) * Fix command IRSend and IRHvac case sensitive parameter regression introduced with version 5.8.0 (#993) * Fix pressure calculation for some BMP versions regression introduced with version 5.8.0i (#974) * Fix Domoticz Dimmer set to same level not powering on (#945) * Fix Blocked Loop when erasing large flash using command reset 2 (#1002) * Fix relay power control when light power control is also configured as regression from 5.8.0 (#1016) * Fix Mqtt server mDNS lookup only when MqttHost name is empty (#1026) * Add debug information to MQTT subscribe * Add translations to I2Cscan * Add translation to BH1750 unit lx * Add light scheme options (Color cycle Up, Down, Random) and moving WS2812 schemes up by 3 * Add Domoticz counter sensor to IrReceive representing Received IR Protocol and Data * Add option 0 to MqttHost to allow empty Mqtt host name * Add support for Arilux AL-LC01 RGB Led controller (#370) * Add esp8266 de-blocking to PubSubClient library (#790) * Add Domoticz sensors for Voltage and Current (#903) * Add platformio OTA upload support (#928, #934) * Add warning to webpage when USE_MINIMAL is selected (#929) * Add smoother movement of hour hand in WS2812 led clock (#936) * Add support for Magic Home RGBW and some Arilux Led controllers (#940) * Add command SetOption15 0 (default) for command PWM control or SetOption15 1 for commands Color/Dimmer control to PWM RGB(CW) leds (#941) * Add Domoticz counter sensor to Sonoff Bridge representing Received RF code (#943) * Add support for Luani HVIO board (https://luani.de/projekte/esp8266-hvio/) (#953) * Add PWM initialization after restart (#955) * Add IR Receiver support. Disable in user_config.h (#956) * Add support for inverted PWM (#960) * Add Sea level pressure calculation and Provide command Altitude (#974) * Add support for up to 8 relays (#995) * Add commands RfSync, RfLow, RfHigh, RfHost and RfCode to allow sending custom RF codes (#1001) * Add retain to ENERGY messages controlled by command SensorRetain (#1013) * Add commands Color2, Color3, Color4, Width2, Width3, Width4 and SetOption16 to set Ws2812 Clock parameters (#1019) * Add German language file (#1022) * Add support for connecting to MQTT brokers without userid and/or password (#1023) * Add support for esp8266 core v2.4.0-rc2 (#1024) * Add commands PwmRange 1,255..1023 and PwmFrequency 1,100..4000 (#1025) * Add Polish language file (#1044, #1047) * Add support for KMC 70011 Power Monitoring Smart Plug (#1045) * Add support for VEML6070 I2C Ultra Violet level sensor (#1053) * Add light turn Off Fade (#925) * Add IrSend command option Panasonic as IrSend {"Protocol":"Panasonic", "Bits":16388, "Data":<Panasonic data>} * where 16388 is 0x4004 hexadecimal (#1014) * Add retry counter to DHT11/21/22 sensors (#1082)
201 lines
15 KiB
C
201 lines
15 KiB
C
/*
|
|
user_config.h - user specific configuration for Sonoff-Tasmota
|
|
|
|
Copyright (C) 2017 Theo Arends
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef _USER_CONFIG_H_
|
|
#define _USER_CONFIG_H_
|
|
|
|
/*********************************************************************************************\
|
|
* ATTENTION: Changes to most PARAMETER defines will only override flash settings if you change
|
|
* define CFG_HOLDER.
|
|
* Most parameters can be changed online using commands via MQTT, WebConsole or serial
|
|
*
|
|
* Corresponding MQTT/Serial/Console commands in [brackets]
|
|
\*********************************************************************************************/
|
|
|
|
// -- Localization --------------------------------
|
|
//#define MY_LANGUAGE en-GB // English in Great Britain. Enabled by Default
|
|
//#define MY_LANGUAGE nl-NL // Dutch in the Netherlands
|
|
//#define MY_LANGUAGE de-DE // German in Germany
|
|
//#define MY_LANGUAGE pl-PL // Polish in Poland
|
|
|
|
// -- Project -------------------------------------
|
|
#define PROJECT "sonoff" // PROJECT is used as the default topic delimiter and OTA file name
|
|
// As an IDE restriction it needs to be the same as the main .ino file
|
|
|
|
#define CFG_HOLDER 0x20161209 // [Reset 1] Change this value to load following default configuration parameters
|
|
#define SAVE_DATA 1 // [SaveData] Save changed parameters to Flash (0 = disable, 1 - 3600 seconds)
|
|
#define SAVE_STATE 1 // [SetOption0] Save changed power state to Flash (0 = disable, 1 = enable)
|
|
|
|
// -- Wifi ----------------------------------------
|
|
#define WIFI_IP_ADDRESS "0.0.0.0" // [IpAddress1] Set to 0.0.0.0 for using DHCP or IP address
|
|
#define WIFI_GATEWAY "192.168.2.254" // [IpAddress2] If not using DHCP set Gateway IP address
|
|
#define WIFI_SUBNETMASK "255.255.255.0" // [IpAddress3] If not using DHCP set Network mask
|
|
#define WIFI_DNS "192.168.2.27" // [IpAddress4] If not using DHCP set DNS IP address (might be equal to WIFI_GATEWAY)
|
|
|
|
#define STA_SSID1 "indebuurt1" // [Ssid1] Wifi SSID
|
|
#define STA_PASS1 "VnsqrtnrsddbrN" // [Password1] Wifi password
|
|
#define STA_SSID2 "indebuurt2" // [Ssid2] Optional alternate AP Wifi SSID
|
|
#define STA_PASS2 "VnsqrtnrsddbrN" // [Password2] Optional alternate AP Wifi password
|
|
#define WIFI_CONFIG_TOOL WIFI_WPSCONFIG // [WifiConfig] Default tool if wifi fails to connect
|
|
// (WIFI_RESTART, WIFI_SMARTCONFIG, WIFI_MANAGER, WIFI_WPSCONFIG, WIFI_RETRY, WIFI_WAIT)
|
|
|
|
// -- Syslog --------------------------------------
|
|
#define SYS_LOG_HOST "domus1" // [LogHost] (Linux) syslog host
|
|
#define SYS_LOG_PORT 514 // [LogPort] default syslog UDP port
|
|
#define SYS_LOG_LEVEL LOG_LEVEL_NONE // [SysLog]
|
|
#define SERIAL_LOG_LEVEL LOG_LEVEL_INFO // [SerialLog]
|
|
#define WEB_LOG_LEVEL LOG_LEVEL_INFO // [WebLog]
|
|
|
|
// -- Ota -----------------------------------------
|
|
#define OTA_URL "http://domus1:80/api/arduino/" PROJECT ".ino.bin" // [OtaUrl]
|
|
|
|
// -- MQTT ----------------------------------------
|
|
#define MQTT_USE 1 // [SetOption3] Select default MQTT use (0 = Off, 1 = On)
|
|
// !!! TLS uses a LOT OF MEMORY (20k) so be careful to enable other options at the same time !!!
|
|
//#define USE_MQTT_TLS // EXPERIMENTAL Use TLS for MQTT connection (+53k code, +20k mem) - Disable by //
|
|
// Needs Fingerprint, TLS Port, UserId and Password
|
|
#ifdef USE_MQTT_TLS
|
|
#define MQTT_HOST "m20.cloudmqtt.com" // [MqttHost]
|
|
#define MQTT_FINGERPRINT "A5 02 FF 13 99 9F 8B 39 8E F1 83 4F 11 23 65 0B 32 36 FC 07" // [MqttFingerprint]
|
|
#define MQTT_PORT 20123 // [MqttPort] MQTT TLS port
|
|
#define MQTT_USER "cloudmqttuser" // [MqttUser] Mandatory user
|
|
#define MQTT_PASS "cloudmqttpassword" // [MqttPassword] Mandatory password
|
|
#else
|
|
#define MQTT_HOST "domus1" // [MqttHost]
|
|
#define MQTT_PORT 1883 // [MqttPort] MQTT port (10123 on CloudMQTT)
|
|
#define MQTT_USER "DVES_USER" // [MqttUser] Optional user
|
|
#define MQTT_PASS "DVES_PASS" // [MqttPassword] Optional password
|
|
#endif
|
|
|
|
#define MQTT_BUTTON_RETAIN 0 // [ButtonRetain] Button may send retain flag (0 = off, 1 = on)
|
|
#define MQTT_POWER_RETAIN 0 // [PowerRetain] Power status message may send retain flag (0 = off, 1 = on)
|
|
#define MQTT_SWITCH_RETAIN 0 // [SwitchRetain] Switch may send retain flag (0 = off, 1 = on)
|
|
|
|
#define MQTT_STATUS_OFF "OFF" // [StateText1] Command or Status result when turned off (needs to be a string like "0" or "Off")
|
|
#define MQTT_STATUS_ON "ON" // [StateText2] Command or Status result when turned on (needs to be a string like "1" or "On")
|
|
#define MQTT_CMND_TOGGLE "TOGGLE" // [StateText3] Command to send when toggling (needs to be a string like "2" or "Toggle")
|
|
#define MQTT_CMND_HOLD "HOLD" // [StateText4] Command to send when button is kept down for over KEY_HOLD_TIME * 0.1 seconds (needs to be a string like "HOLD")
|
|
|
|
// -- MQTT topics ---------------------------------
|
|
//#define MQTT_FULLTOPIC "tasmota/bedroom/%topic%/%prefix%/" // Up to max 80 characers
|
|
#define MQTT_FULLTOPIC "%prefix%/%topic%/" // [FullTopic] Subscribe and Publish full topic name - Legacy topic
|
|
|
|
// %prefix% token options
|
|
#define SUB_PREFIX "cmnd" // [Prefix1] Sonoff devices subscribe to %prefix%/%topic% being SUB_PREFIX/MQTT_TOPIC and SUB_PREFIX/MQTT_GRPTOPIC
|
|
#define PUB_PREFIX "stat" // [Prefix2] Sonoff devices publish to %prefix%/%topic% being PUB_PREFIX/MQTT_TOPIC
|
|
#define PUB_PREFIX2 "tele" // [Prefix3] Sonoff devices publish telemetry data to %prefix%/%topic% being PUB_PREFIX2/MQTT_TOPIC/UPTIME, POWER and TIME
|
|
// May be named the same as PUB_PREFIX
|
|
// %topic% token options (also ButtonTopic and SwitchTopic)
|
|
#define MQTT_TOPIC PROJECT // [Topic] (unique) MQTT device topic
|
|
#define MQTT_GRPTOPIC "sonoffs" // [GroupTopic] MQTT Group topic
|
|
#define MQTT_CLIENT_ID "DVES_%06X" // [MqttClient] Also fall back topic using Chip Id = last 6 characters of MAC address
|
|
|
|
// -- MQTT - Telemetry ----------------------------
|
|
#define TELE_PERIOD 300 // [TelePeriod] Telemetry (0 = disable, 10 - 3600 seconds)
|
|
|
|
// -- MQTT - Domoticz -----------------------------
|
|
#define USE_DOMOTICZ // Enable Domoticz (+6k code, +0.3k mem) - Disable by //
|
|
#define DOMOTICZ_IN_TOPIC "domoticz/in" // Domoticz Input Topic
|
|
#define DOMOTICZ_OUT_TOPIC "domoticz/out" // Domoticz Output Topic
|
|
#define DOMOTICZ_UPDATE_TIMER 0 // [DomoticzUpdateTimer] Send relay status (0 = disable, 1 - 3600 seconds) (Optional)
|
|
|
|
// -- HTTP ----------------------------------------
|
|
#define USE_WEBSERVER // Enable web server and wifi manager (+66k code, +8k mem) - Disable by //
|
|
#define WEB_SERVER 2 // [WebServer] Web server (0 = Off, 1 = Start as User, 2 = Start as Admin)
|
|
#define WEB_PORT 80 // Web server Port for User and Admin mode
|
|
#define WEB_USERNAME "admin" // Web server Admin mode user name
|
|
#define WEB_PASSWORD "" // [WebPassword] Web server Admin mode Password for WEB_USERNAME (empty string = Disable)
|
|
#define FRIENDLY_NAME "Sonoff" // [FriendlyName] Friendlyname up to 32 characters used by webpages and Alexa
|
|
#define USE_EMULATION // Enable Belkin WeMo and Hue Bridge emulation for Alexa (+11k code, +2k mem)
|
|
#define EMULATION EMUL_NONE // [Emulation] Select Belkin WeMo (single relay/light) or Hue Bridge emulation (multi relay/light) (EMUL_NONE, EMUL_WEMO or EMUL_HUE)
|
|
|
|
// -- mDNS ----------------------------------------
|
|
#define USE_DISCOVERY // Enable mDNS for the following services (+8k code, +0.3k mem) - Disable by //
|
|
#define WEBSERVER_ADVERTISE // Provide access to webserver by name <Hostname>.local/
|
|
#define MQTT_HOST_DISCOVERY // Find MQTT host server (overrides MQTT_HOST if found)
|
|
|
|
// -- Time - Up to three NTP servers in your region
|
|
#define NTP_SERVER1 "pool.ntp.org" // [NtpServer1] Select first NTP server by name or IP address (129.250.35.250)
|
|
#define NTP_SERVER2 "nl.pool.ntp.org" // [NtpServer2] Select second NTP server by name or IP address (5.39.184.5)
|
|
#define NTP_SERVER3 "0.nl.pool.ntp.org" // [NtpServer3] Select third NTP server by name or IP address (93.94.224.67)
|
|
|
|
// -- Time - Start Daylight Saving Time and timezone offset from UTC in minutes
|
|
#define TIME_DST North, Last, Sun, Mar, 2, +120 // Northern Hemisphere, Last sunday in march at 02:00 +120 minutes
|
|
|
|
// -- Time - Start Standard Time and timezone offset from UTC in minutes
|
|
#define TIME_STD North, Last, Sun, Oct, 3, +60 // Northern Hemisphere, Last sunday in october 02:00 +60 minutes
|
|
|
|
// -- Application ---------------------------------
|
|
#define APP_TIMEZONE 1 // [Timezone] +1 hour (Amsterdam) (-12 .. 12 = hours from UTC, 99 = use TIME_DST/TIME_STD)
|
|
#define APP_LEDSTATE LED_POWER // [LedState] Function of led (LED_OFF, LED_POWER, LED_MQTTSUB, LED_POWER_MQTTSUB, LED_MQTTPUB, LED_POWER_MQTTPUB, LED_MQTT, LED_POWER_MQTT)
|
|
#define APP_PULSETIME 0 // [PulseTime] Time in 0.1 Sec to turn off power for relay 1 (0 = disabled)
|
|
#define APP_POWERON_STATE 3 // [PowerOnState] Power On Relay state (0 = Off, 1 = On, 2 = Toggle Saved state, 3 = Saved state)
|
|
#define APP_BLINKTIME 10 // [BlinkTime] Time in 0.1 Sec to blink/toggle power for relay 1
|
|
#define APP_BLINKCOUNT 10 // [BlinkCount] Number of blinks (0 = 32000)
|
|
#define APP_SLEEP 0 // [Sleep] Sleep time to lower energy consumption (0 = Off, 1 - 250 mSec)
|
|
|
|
#define KEY_HOLD_TIME 40 // [SetOption32] Number of 0.1 seconds to hold Button or external Pushbutton before sending HOLD message
|
|
#define SWITCH_MODE TOGGLE // [SwitchMode] TOGGLE, FOLLOW, FOLLOW_INV, PUSHBUTTON, PUSHBUTTON_INV, PUSHBUTTONHOLD or PUSHBUTTONHOLD_INV (the wall switch state)
|
|
#define WS2812_LEDS 30 // [Pixels] Number of WS2812 LEDs to start with
|
|
|
|
#define TEMP_CONVERSION 0 // [SetOption8] Return temperature in (0 = Celsius or 1 = Fahrenheit)
|
|
#define TEMP_RESOLUTION 1 // [TempRes] Maximum number of decimals (0 - 3) showing sensor Temperature
|
|
#define HUMIDITY_RESOLUTION 1 // [HumRes] Maximum number of decimals (0 - 3) showing sensor Humidity
|
|
#define PRESSURE_RESOLUTION 1 // [PressRes] Maximum number of decimals (0 - 3) showing sensor Pressure
|
|
#define ENERGY_RESOLUTION 3 // [EnergyRes] Maximum number of decimals (0 - 5) showing energy usage in kWh
|
|
|
|
// -- Sensor code selection -----------------------
|
|
#define USE_ADC_VCC // Display Vcc in Power status. Disable for use as Analog input on selected devices
|
|
|
|
//#define USE_DS18x20 // Optional using OneWire library for multiple DS18B20 and/or DS18S20 (+2k code)
|
|
|
|
#define USE_I2C // I2C using library wire (+10k code, 0.2k mem) - Disable by //
|
|
#define USE_BH1750 // Add I2C code for BH1750 sensor
|
|
// #define USE_VEML6070 // Add I2C code for VEML6070 sensor (+0.5k code)
|
|
#define USE_BMP // Add I2C code for BMP/BME280 sensor
|
|
#define USE_HTU // Add I2C code for HTU21/SI7013/SI7020/SI7021 sensor
|
|
#define USE_SHT // Add I2C emulating code for SHT1X sensor
|
|
|
|
#define USE_IR_REMOTE // Send IR remote commands using library IRremoteESP8266 and ArduinoJson (+3k code, 0.3k mem)
|
|
// #define USE_IR_HVAC // Support for HVAC system using IR (+2k code)
|
|
#define USE_IR_RECEIVE // Support for IR receiver (+4k code)
|
|
|
|
#define USE_WS2812 // WS2812 Led string using library NeoPixelBus (+5k code, +1k mem) - Disable by //
|
|
#define USE_WS2812_CTYPE 1 // WS2812 Color type (0 - RGB, 1 - GRB)
|
|
// #define USE_WS2812_DMA // DMA supports only GPIO03 (= Serial RXD) (+1k mem). When USE_WS2812_DMA is enabled expect Exceptions on Pow
|
|
|
|
/*********************************************************************************************\
|
|
* Compile a minimal version if upgrade memory gets tight ONLY TO BE USED FOR UPGRADE STEP 1!
|
|
* To be used as step 1 during upgrade.
|
|
* Step 2 is re-compile with option BE_MINIMAL commented out.
|
|
* !!! Needed for next release of Arduino/ESP8266 (+22k code, +2k mem) !!!
|
|
\*********************************************************************************************/
|
|
|
|
//#define BE_MINIMAL // Minimal version if upgrade memory gets tight (-45k code, -2k mem)
|
|
|
|
/*********************************************************************************************\
|
|
* No user configurable items below
|
|
\*********************************************************************************************/
|
|
|
|
#if defined(USE_MQTT_TLS) && defined(USE_WEBSERVER)
|
|
#error "Select either USE_MQTT_TLS or USE_WEBSERVER as there is just not enough memory to play with"
|
|
#endif
|
|
|
|
#endif // _USER_CONFIG_H_
|