2017-10-10 14:40:02 +01:00
/*
2019-10-27 11:04:08 +00:00
tasmota . h - Master header file for Tasmota
2017-10-10 14:40:02 +01:00
2021-01-01 12:44:04 +00:00
Copyright ( C ) 2021 Theo Arends
2017-10-10 14:40:02 +01:00
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/>.
*/
2019-10-27 11:04:08 +00:00
# ifndef _TASMOTA_H_
# define _TASMOTA_H_
2017-10-18 17:22:34 +01:00
2018-11-07 10:57:28 +00:00
/*********************************************************************************************\
* Performance ROM ( PROGMEM ) vs RAM ( RODATA )
\ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2019-08-16 15:12:33 +01:00
# define XFUNC_PTR_IN_ROM // Enable for keeping tables in ROM (PROGMEM) which seem to have access issues on some flash types
2018-11-07 10:57:28 +00:00
/*********************************************************************************************\
* Default sensor states
\ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2020-01-22 21:49:28 +00:00
# define CODE_IMAGE_STR "tasmota"
2018-11-07 14:03:41 +00:00
2019-06-16 15:43:23 +01:00
# define USE_LIGHT // Enable light control
2018-10-02 16:07:30 +01:00
# define USE_ENERGY_SENSOR // Use energy sensors (+14k code)
# define USE_HLW8012 // Use energy sensor for Sonoff Pow and WolfBlitz
# define USE_CSE7766 // Use energy sensor for Sonoff S31 and Pow R2
2017-10-10 14:40:02 +01:00
/*********************************************************************************************\
* Power Type
\ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
typedef unsigned long power_t ; // Power (Relay) type
2019-03-30 15:29:27 +00:00
const uint32_t POWER_MASK = 0xffffffffUL ; // Power (Relay) full mask
2017-10-10 14:40:02 +01:00
/*********************************************************************************************\
2019-03-30 15:29:27 +00:00
* Constants
2017-10-10 14:40:02 +01:00
\ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2021-02-04 16:06:45 +00:00
# ifdef ESP8266
2021-02-05 14:21:06 +00:00
const uint8_t MAX_RELAYS = 8 ; // Max number of relays (up to 28)
2021-02-05 15:36:25 +00:00
const uint8_t MAX_INTERLOCKS = 4 ; // Max number of interlock groups (up to MAX_INTERLOCKS_SET)
const uint8_t MAX_SWITCHES = 8 ; // Max number of switches (up to MAX_SWITCHES_SET)
2021-02-04 16:06:45 +00:00
# endif // ESP8266
# ifdef ESP32
2021-02-05 14:21:06 +00:00
const uint8_t MAX_RELAYS = 28 ; // Max number of relays (up to 28)
2021-02-05 15:36:25 +00:00
const uint8_t MAX_INTERLOCKS = 14 ; // Max number of interlock groups (up to MAX_INTERLOCKS_SET)
const uint8_t MAX_SWITCHES = 28 ; // Max number of switches (up to MAX_SWITCHES_SET)
2021-02-04 16:06:45 +00:00
# endif // ESP32
2021-02-05 14:21:06 +00:00
const uint8_t MAX_KEYS = 8 ; // Max number of keys or buttons (up to 28)
2021-02-04 16:06:45 +00:00
2017-10-12 10:29:40 +01:00
// Changes to the following MAX_ defines will impact settings layout
2021-02-05 15:36:25 +00:00
const uint8_t MAX_INTERLOCKS_SET = 14 ; // Max number of interlock groups (MAX_RELAYS / 2)
const uint8_t MAX_SWITCHES_SET = 28 ; // Max number of switches
2019-03-30 15:29:27 +00:00
const uint8_t MAX_LEDS = 4 ; // Max number of leds
const uint8_t MAX_PWMS = 5 ; // Max number of PWM channels
const uint8_t MAX_COUNTERS = 4 ; // Max number of counter sensors
const uint8_t MAX_TIMERS = 16 ; // Max number of Timers
const uint8_t MAX_PULSETIMERS = 8 ; // Max number of supported pulse timers
const uint8_t MAX_DOMOTICZ_IDX = 4 ; // Max number of Domoticz device, key and switch indices
const uint8_t MAX_DOMOTICZ_SNS_IDX = 12 ; // Max number of Domoticz sensors indices
const uint8_t MAX_KNX_GA = 10 ; // Max number of KNX Group Addresses to read that can be set
const uint8_t MAX_KNX_CB = 10 ; // Max number of KNX Group Addresses to write that can be set
const uint8_t MAX_XNRG_DRIVERS = 32 ; // Max number of allowed energy drivers
const uint8_t MAX_XDSP_DRIVERS = 32 ; // Max number of allowed display drivers
const uint8_t MAX_XDRV_DRIVERS = 96 ; // Max number of allowed driver drivers
const uint8_t MAX_XSNS_DRIVERS = 96 ; // Max number of allowed sensor drivers
2019-11-03 17:52:49 +00:00
const uint8_t MAX_I2C_DRIVERS = 96 ; // Max number of allowed i2c drivers
2019-09-29 17:00:01 +01:00
const uint8_t MAX_SHUTTERS = 4 ; // Max number of shutters
2021-02-05 11:27:59 +00:00
const uint8_t MAX_SHUTTER_RELAYS = 8 ; // Max number of shutter relays
const uint8_t MAX_SHUTTER_KEYS = 4 ; // Max number of shutter keys or buttons
2020-05-06 16:44:44 +01:00
const uint8_t MAX_PCF8574 = 4 ; // Max number of PCF8574 devices
2019-03-30 15:29:27 +00:00
const uint8_t MAX_RULE_SETS = 3 ; // Max number of rule sets of size 512 characters
const uint16_t MAX_RULE_SIZE = 512 ; // Max number of characters in rules
2019-12-24 14:06:19 +00:00
// Changes to the following MAX_ defines need to be in line with enum SettingsTextIndex
2020-01-12 12:10:21 +00:00
const uint8_t MAX_MQTT_PREFIXES = 3 ; // Max number of MQTT prefixes (cmnd, stat, tele)
const uint8_t MAX_SSIDS = 2 ; // Max number of SSIDs
const uint8_t MAX_STATE_TEXT = 4 ; // Max number of State names (OFF, ON, TOGGLE, HOLD)
const uint8_t MAX_NTP_SERVERS = 3 ; // Max number of NTP servers
2019-12-22 14:36:20 +00:00
const uint8_t MAX_RULE_MEMS = 16 ; // Max number of saved vars
2019-12-24 16:10:50 +00:00
const uint8_t MAX_FRIENDLYNAMES = 8 ; // Max number of Friendly names
const uint8_t MAX_BUTTON_TEXT = 16 ; // Max number of GUI button labels
2020-03-28 15:48:36 +00:00
const uint8_t MAX_GROUP_TOPICS = 4 ; // Max number of Group Topics
2020-04-06 18:29:50 +01:00
const uint8_t MAX_DEV_GROUP_NAMES = 4 ; // Max number of Device Group names
2020-09-25 17:15:31 +01:00
# ifdef ESP8266
2020-09-29 17:10:21 +01:00
const uint8_t MAX_ADCS = 1 ; // Max number of ESP8266 ADC pins
2021-02-05 15:36:25 +00:00
const uint8_t MAX_SWITCHES_TXT = 8 ; // Max number of switches user text
2020-11-28 15:39:15 +00:00
# endif // ESP8266
# ifdef ESP32
2020-08-09 14:31:37 +01:00
const uint8_t MAX_ADCS = 8 ; // Max number of ESP32 ADC pins (ADC2 pins are unusable with Wifi enabled)
2021-02-05 15:36:25 +00:00
const uint8_t MAX_SWITCHES_TXT = 28 ; // Max number of switches user text
2020-11-28 15:39:15 +00:00
# endif // ESP32
2019-12-24 14:06:19 +00:00
2019-08-07 11:08:13 +01:00
const uint8_t MAX_HUE_DEVICES = 15 ; // Max number of Philips Hue device per emulation
2020-07-13 14:10:23 +01:00
const uint8_t MAX_ROTARIES = 2 ; // Max number of Rotary Encoders
2019-08-07 11:08:13 +01:00
2019-03-30 15:29:27 +00:00
const char MQTT_TOKEN_PREFIX [ ] PROGMEM = " %prefix% " ; // To be substituted by mqtt_prefix[x]
const char MQTT_TOKEN_TOPIC [ ] PROGMEM = " %topic% " ; // To be substituted by mqtt_topic, mqtt_grptopic, mqtt_buttontopic, mqtt_switchtopic
const char WIFI_HOSTNAME [ ] = " %s-%04d " ; // Expands to <MQTT_TOPIC>-<last 4 decimal chars of MAC address>
const uint8_t CONFIG_FILE_SIGN = 0xA5 ; // Configuration file signature
const uint8_t CONFIG_FILE_XOR = 0x5A ; // Configuration file xor (0 = No Xor)
const uint32_t HLW_PREF_PULSE = 12530 ; // was 4975us = 201Hz = 1000W
const uint32_t HLW_UREF_PULSE = 1950 ; // was 1666us = 600Hz = 220V
const uint32_t HLW_IREF_PULSE = 3500 ; // was 1666us = 600Hz = 4.545A
const uint8_t MQTT_RETRY_SECS = 10 ; // Minimum seconds to retry MQTT connection
const uint32_t GLOBAL_VALUES_VALID = 300 ; // Max number of seconds to keep last received values
const power_t APP_POWER = 0 ; // Default saved power state Off
const uint16_t WS2812_MAX_LEDS = 512 ; // Max number of LEDs
const uint32_t PWM_RANGE = 1023 ; // 255..1023 needs to be devisible by 256
//const uint16_t PWM_FREQ = 1000; // 100..1000 Hz led refresh
//const uint16_t PWM_FREQ = 910; // 100..1000 Hz led refresh (iTead value)
2020-05-08 15:06:02 +01:00
const uint16_t PWM_FREQ = 977 ; // 100..4000 Hz led refresh
2021-02-08 17:52:03 +00:00
# ifdef ESP32
const uint16_t PWM_MAX = 50000 ; // [PWM_MAX] Maximum frequency for ESP32 - Default: 4000
# else
2019-03-30 15:29:27 +00:00
const uint16_t PWM_MAX = 4000 ; // [PWM_MAX] Maximum frequency - Default: 4000
2021-02-08 17:52:03 +00:00
# endif
2020-05-08 14:42:44 +01:00
const uint16_t PWM_MIN = 40 ; // [PWM_MIN] Minimum frequency - Default: 40
2018-10-07 18:24:52 +01:00
// For Dimmers use double of your mains AC frequecy (100 for 50Hz and 120 for 60Hz)
// For Controlling Servos use 50 and also set PWM_FREQ as 50 (DO NOT USE THESE VALUES FOR DIMMERS)
2017-10-10 14:40:02 +01:00
2019-03-30 15:29:27 +00:00
const uint16_t MAX_POWER_HOLD = 10 ; // Time in SECONDS to allow max agreed power
const uint16_t MAX_POWER_WINDOW = 30 ; // Time in SECONDS to disable allow max agreed power
const uint16_t SAFE_POWER_HOLD = 10 ; // Time in SECONDS to allow max unit safe power
const uint16_t SAFE_POWER_WINDOW = 30 ; // Time in MINUTES to disable allow max unit safe power
const uint8_t MAX_POWER_RETRY = 5 ; // Retry count allowing agreed power limit overflow
2017-10-10 14:40:02 +01:00
2019-03-30 15:29:27 +00:00
const uint8_t STATES = 20 ; // Number of states per second using 50 mSec interval
const uint8_t IMMINENT_RESET_FACTOR = 10 ; // Factor to extent button hold time for imminent Reset to default 40 seconds using KEY_HOLD_TIME of 40
const uint32_t BOOT_LOOP_TIME = 10 ; // Number of seconds to stop detecting boot loops
2019-10-17 09:30:43 +01:00
const uint32_t POWER_CYCLE_TIME = 8 ; // Number of seconds to reset power cycle boot loops
2019-03-30 15:29:27 +00:00
const uint16_t SYSLOG_TIMER = 600 ; // Seconds to restore syslog_level
const uint16_t SERIALLOG_TIMER = 600 ; // Seconds to disable SerialLog
2021-02-12 12:19:50 +00:00
# ifdef ESP8266
const uint8_t OTA_ATTEMPTS = 10 ; // Number of times to try fetching the new firmware
# else
2019-03-30 15:29:27 +00:00
const uint8_t OTA_ATTEMPTS = 5 ; // Number of times to try fetching the new firmware
2021-02-12 12:19:50 +00:00
# endif // ESP8266
2017-10-10 14:40:02 +01:00
2020-05-26 11:15:20 +01:00
const uint16_t INPUT_BUFFER_SIZE = 520 ; // Max number of characters in serial command buffer
2019-09-22 13:00:34 +01:00
const uint16_t FLOATSZ = 16 ; // Max number of characters in float result from dtostrfd (max 32)
2019-03-30 15:29:27 +00:00
const uint16_t CMDSZ = 24 ; // Max number of characters in command
2019-12-22 14:23:52 +00:00
const uint16_t TOPSZ = 151 ; // Max number of characters in topic string
2021-01-02 15:20:15 +00:00
const uint16_t LOGSZ = 128 ; // Max number of characters in AddLog_P log
const uint16_t MAX_LOGSZ = 700 ; // Max number of characters in log
2020-05-24 16:23:26 +01:00
const uint16_t MIN_MESSZ = 1040 ; // Min number of characters in MQTT message (1200 - TOPSZ - 9 header bytes)
2018-01-30 13:14:55 +00:00
2019-03-30 15:29:27 +00:00
const uint8_t SENSOR_MAX_MISS = 5 ; // Max number of missed sensor reads before deciding it's offline
2018-07-10 21:12:16 +01:00
2019-03-30 15:29:27 +00:00
const uint8_t MAX_BACKLOG = 30 ; // Max number of commands in backlog
2019-10-09 16:52:52 +01:00
const uint32_t MIN_BACKLOG_DELAY = 200 ; // Minimal backlog delay in mSeconds
2019-03-30 15:29:27 +00:00
const uint32_t SOFT_BAUDRATE = 9600 ; // Default software serial baudrate
const uint32_t APP_BAUDRATE = 115200 ; // Default serial baudrate
const uint32_t SERIAL_POLLING = 100 ; // Serial receive polling in ms
2019-08-09 21:52:33 +01:00
const uint32_t ZIGBEE_POLLING = 100 ; // Serial receive polling in ms
2020-08-20 15:04:15 +01:00
const uint8_t MAX_STATUS = 13 ; // Max number of status lines
2017-10-10 14:40:02 +01:00
2019-09-05 16:45:43 +01:00
const uint32_t START_VALID_TIME = 1451602800 ; // Time is synced and after 2016-01-01
2019-03-30 15:29:27 +00:00
const uint32_t DRIVER_BOOT_DELAY = 1 ; // Number of milliseconds to retard driver cycles during boot-up time to reduce overall CPU load whilst Wifi is connecting
const uint32_t LOOP_SLEEP_DELAY = 50 ; // Lowest number of milliseconds to go through the main loop using delay when needed
/*********************************************************************************************\
* Defines
\ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2017-10-10 14:40:02 +01:00
2019-03-30 15:29:27 +00:00
# define MAX_RULE_TIMERS 8 // Max number of rule timers (4 bytes / timer)
2019-12-22 16:15:47 +00:00
# define MAX_RULE_VARS 16 // Max number of rule variables (33 bytes / variable)
2018-11-20 13:10:32 +00:00
2018-03-17 14:22:29 +00:00
//enum ws2812NeopixelbusFeature { NEO_RGB, NEO_GRB, NEO_BRG, NEO_RBG, NEO_3LED, NEO_RGBW, NEO_GRBW }; // Doesn't work
# define NEO_RGB 0 // Neopixel RGB leds
# define NEO_GRB 1 // Neopixel GRB leds
# define NEO_BRG 2 // Neopixel BRG leds
# define NEO_RBG 3 // Neopixel RBG leds
# define NEO_3LED 4 // Placeholder to test for 4 led types
# define NEO_RGBW 5 // Neopixel RGBW leds
# define NEO_GRBW 6 // Neopixel GRBW leds
2019-02-24 23:48:03 +00:00
# define RGB_REMAP_RGBW 0
# define RGB_REMAP_RBGW 6
# define RGB_REMAP_GRBW 24
# define RGB_REMAP_GBRW 30
# define RGB_REMAP_BRGW 48
# define RGB_REMAP_BGRW 54
2019-08-30 13:35:08 +01:00
# define NEO_HW_WS2812 0 // NeoPixelBus hardware WS2812
# define NEO_HW_WS2812X 1 // NeoPixelBus hardware WS2812x like WS2812b
# define NEO_HW_WS2813 1 // NeoPixelBus hardware WS2813
# define NEO_HW_SK6812 2 // NeoPixelBus hardware SK6812
# define NEO_HW_LC8812 2 // NeoPixelBus hardware LC8812
# define NEO_HW_APA106 3 // NeoPixelBus hardware APA106
2020-12-17 15:33:26 +00:00
# define NEO_HW_P9813 4 // NeoPixelBus hardware P9813
2019-08-29 17:03:30 +01:00
2018-03-17 14:22:29 +00:00
# define MQTT_PUBSUBCLIENT 1 // Mqtt PubSubClient library
2018-10-08 09:30:24 +01:00
# define MQTT_TASMOTAMQTT 2 // Mqtt TasmotaMqtt library based on esp-mqtt-arduino - soon obsolete
2018-10-08 13:39:36 +01:00
# define MQTT_ESPMQTTARDUINO 3 // Mqtt esp-mqtt-arduino library by Ingo Randolf - obsolete but define is present for debugging purposes
2018-10-08 09:30:24 +01:00
# define MQTT_ARDUINOMQTT 4 // Mqtt arduino-mqtt library by Joel Gaehwiler (https://github.com/256dpi/arduino-mqtt)
2018-03-17 14:22:29 +00:00
2018-04-23 10:37:46 +01:00
// Sunrise and Sunset DawnType
# define DAWN_NORMAL -0.8333
# define DAWN_CIVIL -6.0
# define DAWN_NAUTIC -12.0
# define DAWN_ASTRONOMIC -18.0
2018-05-31 06:46:09 +01:00
// Sensor and Commands definition for KNX Driver
2018-05-17 10:55:40 +01:00
# define KNX_TEMPERATURE 17
# define KNX_HUMIDITY 18
# define KNX_ENERGY_VOLTAGE 19
# define KNX_ENERGY_CURRENT 20
# define KNX_ENERGY_POWER 21
2018-05-17 05:42:51 +01:00
# define KNX_ENERGY_POWERFACTOR 22
2018-05-17 10:55:40 +01:00
# define KNX_ENERGY_DAILY 23
# define KNX_ENERGY_START 24
# define KNX_ENERGY_TOTAL 25
2018-05-30 19:19:17 +01:00
# define KNX_SLOT1 26
# define KNX_SLOT2 27
# define KNX_SLOT3 28
# define KNX_SLOT4 29
# define KNX_SLOT5 30
2020-06-18 19:23:58 +01:00
# define KNX_SCENE 31
# define KNX_MAX_device_param 31
2018-05-31 06:46:09 +01:00
# define MAX_KNXTX_CMNDS 5
2018-05-17 05:42:51 +01:00
2021-02-28 09:49:49 +00:00
// XPT2046 resistive touch driver min/max raw values
# define XPT2046_MINX 192
# define XPT2046_MAXX 3895
# define XPT2046_MINY 346
# define XPT2046_MAXY 3870
2017-10-10 14:40:02 +01:00
/*********************************************************************************************\
* Enumeration
\ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2017-10-18 17:22:34 +01:00
enum WeekInMonthOptions { Last , First , Second , Third , Fourth } ;
enum DayOfTheWeekOptions { Sun = 1 , Mon , Tue , Wed , Thu , Fri , Sat } ;
enum MonthNamesOptions { Jan = 1 , Feb , Mar , Apr , May , Jun , Jul , Aug , Sep , Oct , Nov , Dec } ;
enum HemisphereOptions { North , South } ;
2020-06-11 18:14:39 +01:00
enum GetDateAndTimeOptions { DT_LOCAL , DT_UTC , DT_LOCALNOTZ , DT_DST , DT_STD , DT_RESTART , DT_ENERGY , DT_BOOTCOUNT , DT_LOCAL_MILLIS } ;
2017-11-08 10:57:16 +00:00
2019-10-24 07:55:00 +01:00
enum LoggingLevels { LOG_LEVEL_NONE , LOG_LEVEL_ERROR , LOG_LEVEL_INFO , LOG_LEVEL_DEBUG , LOG_LEVEL_DEBUG_MORE } ;
2017-11-08 10:57:16 +00:00
2019-10-22 15:34:25 +01:00
enum WifiConfigOptions { WIFI_RESTART , EX_WIFI_SMARTCONFIG , WIFI_MANAGER , EX_WIFI_WPSCONFIG , WIFI_RETRY , WIFI_WAIT , WIFI_SERIAL , WIFI_MANAGER_RESET_ONLY , MAX_WIFI_OPTION } ;
2017-11-08 10:57:16 +00:00
2020-02-06 13:53:35 +00:00
enum SwitchModeOptions { TOGGLE , FOLLOW , FOLLOW_INV , PUSHBUTTON , PUSHBUTTON_INV , PUSHBUTTONHOLD , PUSHBUTTONHOLD_INV , PUSHBUTTON_TOGGLE , TOGGLEMULTI ,
2020-10-18 11:17:31 +01:00
FOLLOWMULTI , FOLLOWMULTI_INV , PUSHHOLDMULTI , PUSHHOLDMULTI_INV , PUSHON , PUSHON_INV , PUSH_IGNORE , MAX_SWITCH_OPTION } ;
2017-11-08 10:57:16 +00:00
2017-10-18 17:22:34 +01:00
enum LedStateOptions { LED_OFF , LED_POWER , LED_MQTTSUB , LED_POWER_MQTTSUB , LED_MQTTPUB , LED_POWER_MQTTPUB , LED_MQTT , LED_POWER_MQTT , MAX_LED_OPTION } ;
2017-11-08 10:57:16 +00:00
2017-10-18 17:22:34 +01:00
enum EmulationOptions { EMUL_NONE , EMUL_WEMO , EMUL_HUE , EMUL_MAX } ;
2017-11-08 10:57:16 +00:00
2018-01-18 15:19:28 +00:00
enum TopicOptions { CMND , STAT , TELE , nu1 , RESULT_OR_CMND , RESULT_OR_STAT , RESULT_OR_TELE } ;
2019-09-04 11:20:04 +01:00
enum ExecuteCommandPowerOptions { POWER_OFF , POWER_ON , POWER_TOGGLE , POWER_BLINK , POWER_BLINK_STOP ,
POWER_OFF_NO_STATE = 8 , POWER_ON_NO_STATE , POWER_TOGGLE_NO_STATE ,
POWER_SHOW_STATE = 16 } ;
2020-08-04 21:53:44 +01:00
enum SendKeyPowerOptions { POWER_HOLD = 3 , POWER_INCREMENT = 4 , POWER_INV = 5 , POWER_CLEAR = 6 , POWER_RELEASE = 7 , POWER_100 = 8 , CLEAR_RETAIN = 9 } ;
2019-09-04 11:20:04 +01:00
enum SendKeyOptions { KEY_BUTTON , KEY_SWITCH } ;
2020-04-14 14:47:01 +01:00
enum SendKeyMultiClick { SINGLE = 10 , DOUBLE = 11 , TRIPLE = 12 , QUAD = 13 , PENTA = 14 } ;
2018-01-24 16:31:20 +00:00
enum PowerOnStateOptions { POWER_ALL_OFF , POWER_ALL_ON , POWER_ALL_SAVED_TOGGLE , POWER_ALL_SAVED , POWER_ALL_ALWAYS_ON , POWER_ALL_OFF_PULSETIME_ON } ;
2018-08-27 13:53:09 +01:00
enum ButtonStates { PRESSED , NOT_PRESSED } ;
enum Shortcuts { SC_CLEAR , SC_DEFAULT , SC_USER } ;
2017-11-08 10:57:16 +00:00
2019-10-09 16:52:52 +01:00
enum SettingsParamIndex { P_HOLD_TIME , P_MAX_POWER_RETRY , P_BACKLOG_DELAY , P_MDNS_DELAYED_START , P_BOOT_LOOP_OFFSET , P_RGB_REMAP , P_IR_UNKNOW_THRESHOLD , // SetOption32 .. SetOption38
2020-04-07 13:07:00 +01:00
P_CSE7766_INVALID_POWER , P_HOLD_IGNORE , P_ARP_GRATUITOUS , P_OVER_TEMP , // SetOption39 .. SetOption42
2021-01-07 16:53:48 +00:00
P_ROTARY_MAX_STEP , P_ex_TUYA_VOLTAGE_ID , P_ex_TUYA_CURRENT_ID , P_ex_TUYA_POWER_ID , // SetOption43 .. SetOption46
2019-09-10 15:18:23 +01:00
P_ex_ENERGY_TARIFF1 , P_ex_ENERGY_TARIFF2 , // SetOption47 .. SetOption48
P_MAX_PARAM8 } ; // Max is PARAM8_SIZE (18) - SetOption32 until SetOption49
2019-09-29 17:00:01 +01:00
enum DomoticzSensors { DZ_TEMP , DZ_TEMP_HUM , DZ_TEMP_HUM_BARO , DZ_POWER_ENERGY , DZ_ILLUMINANCE , DZ_COUNT , DZ_VOLTAGE , DZ_CURRENT ,
DZ_AIRQUALITY , DZ_P1_SMART_METER , DZ_SHUTTER , DZ_MAX_SENSORS } ;
2018-01-05 11:26:19 +00:00
2018-03-10 16:58:54 +00:00
enum Ws2812ClockIndex { WS_SECOND , WS_MINUTE , WS_HOUR , WS_MARKER } ;
enum Ws2812Color { WS_RED , WS_GREEN , WS_BLUE } ;
2018-11-16 11:22:15 +00:00
2020-01-04 10:01:44 +00:00
enum LightSubtypes { LST_NONE , LST_SINGLE , LST_COLDWARM , LST_RGB , LST_RGBW , LST_RGBCW , LST_MAX = 5 } ; // Do not insert new fields
2018-11-16 11:22:15 +00:00
enum LightTypes { LT_BASIC , LT_PWM1 , LT_PWM2 , LT_PWM3 , LT_PWM4 , LT_PWM5 , LT_PWM6 , LT_PWM7 ,
2019-10-08 16:46:03 +01:00
LT_NU8 , LT_SERIAL1 , LT_SERIAL2 , LT_RGB , LT_RGBW , LT_RGBWC , LT_NU14 , LT_NU15 } ; // Do not insert new fields
2017-11-08 10:57:16 +00:00
2019-08-12 16:18:08 +01:00
enum XsnsFunctions { FUNC_SETTINGS_OVERRIDE , FUNC_PIN_STATE , FUNC_MODULE_INIT , FUNC_PRE_INIT , FUNC_INIT ,
2019-11-13 10:32:12 +00:00
FUNC_LOOP , FUNC_EVERY_50_MSECOND , FUNC_EVERY_100_MSECOND , FUNC_EVERY_200_MSECOND , FUNC_EVERY_250_MSECOND , FUNC_EVERY_SECOND ,
2021-02-01 15:51:41 +00:00
FUNC_SAVE_SETTINGS , FUNC_SAVE_AT_MIDNIGHT , FUNC_SAVE_BEFORE_RESTART ,
2019-11-07 16:08:58 +00:00
FUNC_AFTER_TELEPERIOD , FUNC_JSON_APPEND , FUNC_WEB_SENSOR , FUNC_COMMAND , FUNC_COMMAND_SENSOR , FUNC_COMMAND_DRIVER ,
2018-10-23 14:51:51 +01:00
FUNC_MQTT_SUBSCRIBE , FUNC_MQTT_INIT , FUNC_MQTT_DATA ,
2019-10-24 08:47:28 +01:00
FUNC_SET_POWER , FUNC_SET_DEVICE_POWER , FUNC_SHOW_SENSOR , FUNC_ANY_KEY ,
2019-09-01 16:51:25 +01:00
FUNC_ENERGY_EVERY_SECOND , FUNC_ENERGY_RESET ,
2018-10-23 14:51:51 +01:00
FUNC_RULES_PROCESS , FUNC_SERIAL , FUNC_FREE_MEM , FUNC_BUTTON_PRESSED ,
2021-01-06 16:54:03 +00:00
FUNC_WEB_ADD_BUTTON , FUNC_WEB_ADD_MANAGEMENT_BUTTON , FUNC_WEB_ADD_MAIN_BUTTON ,
FUNC_WEB_ADD_HANDLER , FUNC_SET_CHANNELS , FUNC_SET_SCHEME , FUNC_HOTPLUG_SCAN ,
2020-03-12 17:51:54 +00:00
FUNC_DEVICE_GROUP_ITEM } ;
2017-10-18 17:22:34 +01:00
2019-09-16 15:56:16 +01:00
enum AddressConfigSteps { ADDR_IDLE , ADDR_RECEIVE , ADDR_SEND } ;
2019-12-14 12:16:55 +00:00
enum SettingsTextIndex { SET_OTAURL ,
2020-08-09 14:31:37 +01:00
SET_MQTTPREFIX1 , SET_MQTTPREFIX2 , SET_MQTTPREFIX3 , // MAX_MQTT_PREFIXES
SET_STASSID1 , SET_STASSID2 , // MAX_SSIDS
SET_STAPWD1 , SET_STAPWD2 , // MAX_SSIDS
2019-12-14 12:16:55 +00:00
SET_HOSTNAME , SET_SYSLOG_HOST ,
2019-12-18 13:29:05 +00:00
SET_WEBPWD , SET_CORS ,
2019-12-14 12:16:55 +00:00
SET_MQTT_HOST , SET_MQTT_CLIENT ,
SET_MQTT_USER , SET_MQTT_PWD ,
SET_MQTT_FULLTOPIC , SET_MQTT_TOPIC ,
SET_MQTT_BUTTON_TOPIC , SET_MQTT_SWITCH_TOPIC , SET_MQTT_GRP_TOPIC ,
2020-08-09 14:31:37 +01:00
SET_STATE_TXT1 , SET_STATE_TXT2 , SET_STATE_TXT3 , SET_STATE_TXT4 , // MAX_STATE_TEXT
SET_NTPSERVER1 , SET_NTPSERVER2 , SET_NTPSERVER3 , // MAX_NTP_SERVERS
2019-12-18 13:29:05 +00:00
SET_MEM1 , SET_MEM2 , SET_MEM3 , SET_MEM4 , SET_MEM5 , SET_MEM6 , SET_MEM7 , SET_MEM8 ,
2020-08-09 14:31:37 +01:00
SET_MEM9 , SET_MEM10 , SET_MEM11 , SET_MEM12 , SET_MEM13 , SET_MEM14 , SET_MEM15 , SET_MEM16 , // MAX_RULE_MEMS
2019-12-14 12:16:55 +00:00
SET_FRIENDLYNAME1 , SET_FRIENDLYNAME2 , SET_FRIENDLYNAME3 , SET_FRIENDLYNAME4 ,
2020-08-09 14:31:37 +01:00
SET_FRIENDLYNAME5 , SET_FRIENDLYNAME6 , SET_FRIENDLYNAME7 , SET_FRIENDLYNAME8 , // MAX_FRIENDLYNAMES
2019-12-24 16:10:50 +00:00
SET_BUTTON1 , SET_BUTTON2 , SET_BUTTON3 , SET_BUTTON4 , SET_BUTTON5 , SET_BUTTON6 , SET_BUTTON7 , SET_BUTTON8 ,
2020-08-09 14:31:37 +01:00
SET_BUTTON9 , SET_BUTTON10 , SET_BUTTON11 , SET_BUTTON12 , SET_BUTTON13 , SET_BUTTON14 , SET_BUTTON15 , SET_BUTTON16 , // MAX_BUTTON_TEXT
SET_MQTT_GRP_TOPIC2 , SET_MQTT_GRP_TOPIC3 , SET_MQTT_GRP_TOPIC4 , // MAX_GROUP_TOPICS
2020-04-09 14:32:23 +01:00
SET_TEMPLATE_NAME ,
2020-08-09 14:31:37 +01:00
SET_DEV_GROUP_NAME1 , SET_DEV_GROUP_NAME2 , SET_DEV_GROUP_NAME3 , SET_DEV_GROUP_NAME4 , // MAX_DEV_GROUP_NAMES
2020-05-17 16:10:17 +01:00
SET_DEVICENAME ,
2020-06-11 16:30:33 +01:00
SET_TELEGRAM_TOKEN , SET_TELEGRAM_CHATID ,
2020-09-25 17:15:31 +01:00
# ifdef ESP8266
SET_ADC_PARAM1 ,
2021-02-05 15:36:25 +00:00
SET_SWITCH_TXT1 , SET_SWITCH_TXT2 , SET_SWITCH_TXT3 , SET_SWITCH_TXT4 , SET_SWITCH_TXT5 , SET_SWITCH_TXT6 , SET_SWITCH_TXT7 , SET_SWITCH_TXT8 , // MAX_SWITCHES_TXT
2020-11-28 15:39:15 +00:00
# endif // ESP8266
# ifdef ESP32
2020-08-09 14:31:37 +01:00
SET_ADC_PARAM1 , SET_ADC_PARAM2 , SET_ADC_PARAM3 , SET_ADC_PARAM4 , SET_ADC_PARAM5 , SET_ADC_PARAM6 , SET_ADC_PARAM7 , SET_ADC_PARAM8 , // MAX_ADCS
2021-02-05 10:58:24 +00:00
SET_SWITCH_TXT1 , SET_SWITCH_TXT2 , SET_SWITCH_TXT3 , SET_SWITCH_TXT4 , SET_SWITCH_TXT5 , SET_SWITCH_TXT6 , SET_SWITCH_TXT7 , SET_SWITCH_TXT8 , // MAX_SWITCHES_TXT
2021-02-05 15:36:25 +00:00
SET_SWITCH_TXT9 , SET_SWITCH_TXT10 , SET_SWITCH_TXT11 , SET_SWITCH_TXT12 , SET_SWITCH_TXT13 , SET_SWITCH_TXT14 , SET_SWITCH_TXT15 , SET_SWITCH_TXT16 , // MAX_SWITCHES_TXT
SET_SWITCH_TXT17 , SET_SWITCH_TXT18 , SET_SWITCH_TXT19 , SET_SWITCH_TXT20 , SET_SWITCH_TXT21 , SET_SWITCH_TXT22 , SET_SWITCH_TXT23 , SET_SWITCH_TXT24 , // MAX_SWITCHES_TXT
SET_SWITCH_TXT25 , SET_SWITCH_TXT26 , SET_SWITCH_TXT27 , SET_SWITCH_TXT28 , // MAX_SWITCHES_TXT
# endif // ESP32
2020-11-14 15:43:32 +00:00
SET_SHD_PARAM ,
2019-12-14 12:16:55 +00:00
SET_MAX } ;
2020-12-31 15:17:30 +00:00
enum SpiInterfaces { SPI_NONE , SPI_MOSI , SPI_MISO , SPI_MOSI_MISO } ;
2020-10-05 21:15:32 +01:00
enum DevGroupMessageType { DGR_MSGTYP_FULL_STATUS , DGR_MSGTYP_PARTIAL_UPDATE , DGR_MSGTYP_UPDATE , DGR_MSGTYP_UPDATE_MORE_TO_COME , DGR_MSGTYP_UPDATE_DIRECT , DGR_MSGTYPE_UPDATE_COMMAND , DGR_MSGTYPFLAG_WITH_LOCAL = 128 } ;
2020-04-06 18:29:50 +01:00
2020-10-20 02:12:41 +01:00
enum DevGroupMessageFlag { DGR_FLAG_RESET = 1 , DGR_FLAG_STATUS_REQUEST = 2 , DGR_FLAG_FULL_STATUS = 4 , DGR_FLAG_ACK = 8 , DGR_FLAG_MORE_TO_COME = 16 , DGR_FLAG_DIRECT = 32 , DGR_FLAG_ANNOUNCEMENT = 64 , DGR_FLAG_LOCAL = 128 } ;
2020-04-06 18:29:50 +01:00
2020-04-24 15:12:43 +01:00
enum DevGroupItem { DGR_ITEM_EOL , DGR_ITEM_STATUS , DGR_ITEM_FLAGS ,
2020-04-06 18:29:50 +01:00
DGR_ITEM_LIGHT_FADE , DGR_ITEM_LIGHT_SPEED , DGR_ITEM_LIGHT_BRI , DGR_ITEM_LIGHT_SCHEME , DGR_ITEM_LIGHT_FIXED_COLOR ,
DGR_ITEM_BRI_PRESET_LOW , DGR_ITEM_BRI_PRESET_HIGH , DGR_ITEM_BRI_POWER_ON ,
// Add new 8-bit items before this line
DGR_ITEM_LAST_8BIT , DGR_ITEM_MAX_8BIT = 63 ,
2020-04-07 19:25:58 +01:00
//DGR_ITEM_ANALOG1, DGR_ITEM_ANALOG2, DGR_ITEM_ANALOG3, DGR_ITEM_ANALOG4, DGR_ITEM_ANALOG5,
2020-04-06 18:29:50 +01:00
// Add new 16-bit items before this line
DGR_ITEM_LAST_16BIT , DGR_ITEM_MAX_16BIT = 127 ,
2021-02-09 03:28:59 +00:00
DGR_ITEM_POWER , DGR_ITEM_NO_STATUS_SHARE ,
2020-04-06 18:29:50 +01:00
// Add new 32-bit items before this line
DGR_ITEM_LAST_32BIT , DGR_ITEM_MAX_32BIT = 191 ,
2020-04-21 22:33:07 +01:00
DGR_ITEM_EVENT , DGR_ITEM_COMMAND ,
2020-04-06 18:29:50 +01:00
// Add new string items before this line
DGR_ITEM_LAST_STRING , DGR_ITEM_MAX_STRING = 223 ,
DGR_ITEM_LIGHT_CHANNELS } ;
2021-02-09 03:28:59 +00:00
enum DevGroupItemFlag { DGR_ITEM_FLAG_NO_SHARE = 1 } ;
2020-04-06 18:29:50 +01:00
enum DevGroupShareItem { DGR_SHARE_POWER = 1 , DGR_SHARE_LIGHT_BRI = 2 , DGR_SHARE_LIGHT_FADE = 4 , DGR_SHARE_LIGHT_SCHEME = 8 ,
2020-04-19 04:37:05 +01:00
DGR_SHARE_LIGHT_COLOR = 16 , DGR_SHARE_DIMMER_SETTINGS = 32 , DGR_SHARE_EVENT = 64 } ;
2020-02-21 15:09:21 +00:00
2018-05-28 14:52:42 +01:00
enum CommandSource { SRC_IGNORE , SRC_MQTT , SRC_RESTART , SRC_BUTTON , SRC_SWITCH , SRC_BACKLOG , SRC_SERIAL , SRC_WEBGUI , SRC_WEBCOMMAND , SRC_WEBCONSOLE , SRC_PULSETIMER ,
2019-09-29 17:00:01 +01:00
SRC_TIMER , SRC_RULE , SRC_MAXPOWER , SRC_MAXENERGY , SRC_OVERTEMP , SRC_LIGHT , SRC_KNX , SRC_DISPLAY , SRC_WEMO , SRC_HUE , SRC_RETRY , SRC_REMOTE , SRC_SHUTTER ,
2021-02-16 11:19:40 +00:00
SRC_THERMOSTAT , SRC_CHAT , SRC_TCL , SRC_BERRY , SRC_FILE , SRC_MAX } ;
2019-09-29 17:00:01 +01:00
const char kCommandSource [ ] PROGMEM = " I|MQTT|Restart|Button|Switch|Backlog|Serial|WebGui|WebCommand|WebConsole|PulseTimer| "
2020-06-11 16:30:33 +01:00
" Timer|Rule|MaxPower|MaxEnergy|Overtemp|Light|Knx|Display|Wemo|Hue|Retry|Remote|Shutter| "
2021-02-16 11:19:40 +00:00
" Thermostat|Chat|TCL|Berry|File " ;
2018-05-28 14:52:42 +01:00
2018-12-06 09:49:49 +00:00
const uint8_t kDefaultRfCode [ 9 ] PROGMEM = { 0x21 , 0x16 , 0x01 , 0x0E , 0x03 , 0x48 , 0x2E , 0x1A , 0x00 } ;
2020-04-09 14:32:23 +01:00
enum TasmotaSerialConfig {
TS_SERIAL_5N1 , TS_SERIAL_6N1 , TS_SERIAL_7N1 , TS_SERIAL_8N1 ,
TS_SERIAL_5N2 , TS_SERIAL_6N2 , TS_SERIAL_7N2 , TS_SERIAL_8N2 ,
TS_SERIAL_5E1 , TS_SERIAL_6E1 , TS_SERIAL_7E1 , TS_SERIAL_8E1 ,
TS_SERIAL_5E2 , TS_SERIAL_6E2 , TS_SERIAL_7E2 , TS_SERIAL_8E2 ,
TS_SERIAL_5O1 , TS_SERIAL_6O1 , TS_SERIAL_7O1 , TS_SERIAL_8O1 ,
TS_SERIAL_5O2 , TS_SERIAL_6O2 , TS_SERIAL_7O2 , TS_SERIAL_8O2 } ;
2020-10-30 17:27:34 +00:00
# ifdef ESP8266
2020-04-10 17:24:08 +01:00
const SerConfu8 kTasmotaSerialConfig [ ] PROGMEM = {
2020-04-09 14:32:23 +01:00
SERIAL_5N1 , SERIAL_6N1 , SERIAL_7N1 , SERIAL_8N1 ,
SERIAL_5N2 , SERIAL_6N2 , SERIAL_7N2 , SERIAL_8N2 ,
SERIAL_5E1 , SERIAL_6E1 , SERIAL_7E1 , SERIAL_8E1 ,
SERIAL_5E2 , SERIAL_6E2 , SERIAL_7E2 , SERIAL_8E2 ,
SERIAL_5O1 , SERIAL_6O1 , SERIAL_7O1 , SERIAL_8O1 ,
SERIAL_5O2 , SERIAL_6O2 , SERIAL_7O2 , SERIAL_8O2
} ;
2020-11-28 15:39:15 +00:00
# endif // ESP8266
# ifdef ESP32
2020-10-30 17:27:34 +00:00
const uint32_t kTasmotaSerialConfig [ ] PROGMEM = {
SERIAL_5N1 , SERIAL_6N1 , SERIAL_7N1 , SERIAL_8N1 ,
SERIAL_5N2 , SERIAL_6N2 , SERIAL_7N2 , SERIAL_8N2 ,
SERIAL_5E1 , SERIAL_6E1 , SERIAL_7E1 , SERIAL_8E1 ,
SERIAL_5E2 , SERIAL_6E2 , SERIAL_7E2 , SERIAL_8E2 ,
SERIAL_5O1 , SERIAL_6O1 , SERIAL_7O1 , SERIAL_8O1 ,
SERIAL_5O2 , SERIAL_6O2 , SERIAL_7O2 , SERIAL_8O2
} ;
2020-11-28 15:39:15 +00:00
# endif // ESP32
2020-04-09 14:32:23 +01:00
2020-10-17 11:48:45 +01:00
enum TuyaSupportedFunctions { TUYA_MCU_FUNC_NONE ,
TUYA_MCU_FUNC_SWT1 = 1 , TUYA_MCU_FUNC_SWT2 , TUYA_MCU_FUNC_SWT3 , TUYA_MCU_FUNC_SWT4 ,
2020-06-11 16:30:33 +01:00
TUYA_MCU_FUNC_REL1 = 11 , TUYA_MCU_FUNC_REL2 , TUYA_MCU_FUNC_REL3 , TUYA_MCU_FUNC_REL4 , TUYA_MCU_FUNC_REL5 ,
2020-10-17 11:48:45 +01:00
TUYA_MCU_FUNC_REL6 , TUYA_MCU_FUNC_REL7 , TUYA_MCU_FUNC_REL8 ,
TUYA_MCU_FUNC_DIMMER = 21 , TUYA_MCU_FUNC_DIMMER2 , TUYA_MCU_FUNC_CT , TUYA_MCU_FUNC_RGB , TUYA_MCU_FUNC_WHITE ,
TUYA_MCU_FUNC_MODESET , TUYA_MCU_FUNC_REPORT1 , TUYA_MCU_FUNC_REPORT2 ,
2020-09-16 19:45:56 +01:00
TUYA_MCU_FUNC_POWER = 31 , TUYA_MCU_FUNC_CURRENT , TUYA_MCU_FUNC_VOLTAGE , TUYA_MCU_FUNC_BATTERY_STATE , TUYA_MCU_FUNC_BATTERY_PERCENTAGE ,
2020-06-09 18:08:57 +01:00
TUYA_MCU_FUNC_REL1_INV = 41 , TUYA_MCU_FUNC_REL2_INV , TUYA_MCU_FUNC_REL3_INV , TUYA_MCU_FUNC_REL4_INV , TUYA_MCU_FUNC_REL5_INV ,
2020-10-17 11:48:45 +01:00
TUYA_MCU_FUNC_REL6_INV , TUYA_MCU_FUNC_REL7_INV , TUYA_MCU_FUNC_REL8_INV ,
TUYA_MCU_FUNC_LOWPOWER_MODE = 51 ,
2020-11-07 21:08:07 +00:00
TUYA_MCU_FUNC_ENUM1 = 61 , TUYA_MCU_FUNC_ENUM2 , TUYA_MCU_FUNC_ENUM3 , TUYA_MCU_FUNC_ENUM4 ,
2020-11-28 14:49:04 +00:00
TUYA_MCU_FUNC_TEMP = 71 , TUYA_MCU_FUNC_TEMPSET , TUYA_MCU_FUNC_HUM , TUYA_MCU_FUNC_HUMSET ,
TUYA_MCU_FUNC_LX = 75 , TUYA_MCU_FUNC_TVOC , TUYA_MCU_FUNC_CO2 , TUYA_MCU_FUNC_ECO2 ,
TUYA_MCU_FUNC_TIMER1 = 81 , TUYA_MCU_FUNC_TIMER2 , TUYA_MCU_FUNC_TIMER3 , TUYA_MCU_FUNC_TIMER4 ,
2020-10-17 11:48:45 +01:00
TUYA_MCU_FUNC_MOTOR_DIR = 97 ,
TUYA_MCU_FUNC_ERROR = 98 ,
TUYA_MCU_FUNC_DUMMY = 99 ,
TUYA_MCU_FUNC_LAST = 255
2020-11-07 21:08:07 +00:00
// IDs from 230 to 234 are reserved for internal use
2020-06-09 18:08:57 +01:00
} ;
2019-10-27 11:04:08 +00:00
# endif // _TASMOTA_H_