espurna-mirror/code/espurna/config/types.h

//------------------------------------------------------------------------------
// Type definitions
// Do not touch this definitions
//------------------------------------------------------------------------------

#pragma once

// -----------------------------------------------------------------------------
// GPIO
// -----------------------------------------------------------------------------

#define GPIO_TYPE_NONE          GpioType::None
#define GPIO_TYPE_HARDWARE      GpioType::Hardware
#define GPIO_TYPE_MCP23S08      GpioType::Mcp23s08

//------------------------------------------------------------------------------
// BUTTONS
//------------------------------------------------------------------------------

#define BUTTON_ACTION_NONE            ButtonAction::None
#define BUTTON_ACTION_TOGGLE          ButtonAction::Toggle
#define BUTTON_ACTION_ON              ButtonAction::On
#define BUTTON_ACTION_OFF             ButtonAction::Off
#define BUTTON_ACTION_AP              ButtonAction::AccessPoint
#define BUTTON_ACTION_RESET           ButtonAction::Reset
#define BUTTON_ACTION_PULSE           ButtonAction::Pulse
#define BUTTON_ACTION_FACTORY         ButtonAction::FactoryReset
#define BUTTON_ACTION_WPS             ButtonAction::Wps
#define BUTTON_ACTION_SMART_CONFIG    ButtonAction::SmartConfig
#define BUTTON_ACTION_DIM_UP          ButtonAction::BrightnessIncrease
#define BUTTON_ACTION_DIM_DOWN        ButtonAction::BrightnessDecrease
#define BUTTON_ACTION_DISPLAY_ON      ButtonAction::DisplayOn
#define BUTTON_ACTION_CUSTOM          ButtonAction::Custom
#define BUTTON_ACTION_FAN_LOW         ButtonAction::FanLow
#define BUTTON_ACTION_FAN_MEDIUM      ButtonAction::FanMedium
#define BUTTON_ACTION_FAN_HIGH        ButtonAction::FanHigh

// Deprecated: legacy mapping, changed to action from above
#define BUTTON_MODE_NONE              BUTTON_ACTION_NONE
#define BUTTON_MODE_TOGGLE            BUTTON_ACTION_TOGGLE
#define BUTTON_MODE_ON                BUTTON_ACTION_ON
#define BUTTON_MODE_OFF               BUTTON_ACTION_OFF
#define BUTTON_MODE_AP                BUTTON_ACTION_AP
#define BUTTON_MODE_RESET             BUTTON_ACTION_RESET
#define BUTTON_MODE_PULSE             BUTTON_ACTION_PULSE
#define BUTTON_MODE_FACTORY           BUTTON_ACTION_FACTORY
#define BUTTON_MODE_WPS               BUTTON_ACTION_WPS
#define BUTTON_MODE_SMART_CONFIG      BUTTON_ACTION_SMART_CONFIG
#define BUTTON_MODE_DIM_UP            BUTTON_ACTION_DIM_UP
#define BUTTON_MODE_DIM_DOWN          BUTTON_ACTION_DIM_DOWN
#define BUTTON_MODE_DISPLAY_ON        BUTTON_ACTION_DISPLAY_ON

// compat definitions for DebounceEvent
#define BUTTON_PUSHBUTTON           ButtonMask::Pushbutton
#define BUTTON_SWITCH               ButtonMask::Switch
#define BUTTON_DEFAULT_LOW          ButtonMask::DefaultLow
#define BUTTON_DEFAULT_HIGH         ButtonMask::DefaultHigh
#define BUTTON_DEFAULT_BOOT         ButtonMask::DefaultBoot
#define BUTTON_SET_PULLUP           ButtonMask::SetPullup
#define BUTTON_SET_PULLDOWN         ButtonMask::SetPulldown

// configure where do we get the button events
#define BUTTON_PROVIDER_NONE        ButtonProvider::None
#define BUTTON_PROVIDER_DUMMY       ButtonProvider::Dummy
#define BUTTON_PROVIDER_GPIO        ButtonProvider::Gpio
#define BUTTON_PROVIDER_ANALOG      ButtonProvider::Analog
#define BUTTON_PROVIDER_LIGHTFOX    ButtonProvider::Lightfox

//------------------------------------------------------------------------------
// ENCODER
//------------------------------------------------------------------------------

#define ENCODER_MODE_CHANNEL        0
#define ENCODER_MODE_RATIO          1

//------------------------------------------------------------------------------
// RELAY
//------------------------------------------------------------------------------

#define RELAY_NONE          0x99

#define RELAY_BOOT_OFF              RelayBoot::Off
#define RELAY_BOOT_ON               RelayBoot::On
#define RELAY_BOOT_SAME             RelayBoot::Same
#define RELAY_BOOT_TOGGLE           RelayBoot::Toggle
#define RELAY_BOOT_LOCKED_OFF       RelayBoot::LockedOff
#define RELAY_BOOT_LOCKED_ON        RelayBoot::LockedOn

#define RELAY_TYPE_NORMAL           RelayType::Normal
#define RELAY_TYPE_INVERSE          RelayType::Inverse
#define RELAY_TYPE_LATCHED          RelayType::Latched
#define RELAY_TYPE_LATCHED_INVERSE  RelayType::LatchedInverse

#define RELAY_SYNC_ANY              RelaySync::None
#define RELAY_SYNC_NONE_OR_ONE      RelaySync::ZeroOrOne
#define RELAY_SYNC_ONE              RelaySync::JustOne
#define RELAY_SYNC_SAME             RelaySync::All
#define RELAY_SYNC_FIRST            RelaySync::First

#define RELAY_PULSE_NONE            Mode::None
#define RELAY_PULSE_OFF             Mode::Off
#define RELAY_PULSE_ON              Mode::On

#define RELAY_PROVIDER_NONE         RelayProvider::None
#define RELAY_PROVIDER_DUMMY        RelayProvider::Dummy
#define RELAY_PROVIDER_GPIO         RelayProvider::Gpio
#define RELAY_PROVIDER_DUAL         RelayProvider::Dual
#define RELAY_PROVIDER_STM          RelayProvider::Stm
#define RELAY_PROVIDER_LIGHT_STATE  RelayProvider::LightState
#define RELAY_PROVIDER_FAN          RelayProvider::Fan
#define RELAY_PROVIDER_LIGHTFOX     RelayProvider::Lightfox
#define RELAY_PROVIDER_TUYA         RelayProvider::Tuya

#define RFB_PROVIDER_RCSWITCH       0
#define RFB_PROVIDER_EFM8BB1        1

#define RELAY_MQTT_TOPIC_NORMAL       RelayMqttTopicMode::Normal
#define RELAY_MQTT_TOPIC_INVERSE      RelayMqttTopicMode::Inverse
#define RELAY_MQTT_TOPIC_RECEIVE_ONLY RelayMqttTopicMode::ReceiveOnly

#define RELAY_MQTT_DISCONNECT_NONE    PayloadStatus::Unknown
#define RELAY_MQTT_DISCONNECT_ON      PayloadStatus::On
#define RELAY_MQTT_DISCONNECT_OFF     PayloadStatus::Off
#define RELAY_MQTT_DISCONNECT_TOGGLE  PayloadStatus::Toggle

#define RELAY_LOCK_DISABLED          RelayLock::None
#define RELAY_LOCK_NONE              RelayLock::None
#define RELAY_LOCK_OFF               RelayLock::Off
#define RELAY_LOCK_ON                RelayLock::On

//------------------------------------------------------------------------------
// UDP SYSLOG
//------------------------------------------------------------------------------

// Priority codes:
#define SYSLOG_EMERG       0 /* system is unusable */
#define SYSLOG_ALERT       1 /* action must be taken immediately */
#define SYSLOG_CRIT        2 /* critical conditions */
#define SYSLOG_ERR         3 /* error conditions */
#define SYSLOG_WARNING     4 /* warning conditions */
#define SYSLOG_NOTICE      5 /* normal but significant condition */
#define SYSLOG_INFO        6 /* informational */
#define SYSLOG_DEBUG       7 /* debug-level messages */

// Facility codes:
#define SYSLOG_KERN        (0<<3)  /* kernel messages */
#define SYSLOG_USER        (1<<3)  /* random user-level messages */
#define SYSLOG_MAIL        (2<<3)  /* mail system */
#define SYSLOG_DAEMON      (3<<3)  /* system daemons */
#define SYSLOG_AUTH        (4<<3)  /* security/authorization messages */
#define SYSLOG_SYSLOG      (5<<3)  /* messages generated internally by syslogd */
#define SYSLOG_LPR         (6<<3)  /* line printer subsystem */
#define SYSLOG_NEWS        (7<<3)  /* network news subsystem */
#define SYSLOG_UUCP        (8<<3)  /* UUCP subsystem */
#define SYSLOG_CRON        (9<<3)  /* clock daemon */
#define SYSLOG_AUTHPRIV    (10<<3) /* security/authorization messages (private) */
#define SYSLOG_FTP         (11<<3) /* ftp daemon */
#define SYSLOG_LOCAL0      (16<<3) /* reserved for local use */
#define SYSLOG_LOCAL1      (17<<3) /* reserved for local use */
#define SYSLOG_LOCAL2      (18<<3) /* reserved for local use */
#define SYSLOG_LOCAL3      (19<<3) /* reserved for local use */
#define SYSLOG_LOCAL4      (20<<3) /* reserved for local use */
#define SYSLOG_LOCAL5      (21<<3) /* reserved for local use */
#define SYSLOG_LOCAL6      (22<<3) /* reserved for local use */
#define SYSLOG_LOCAL7      (23<<3) /* reserved for local use */

//------------------------------------------------------------------------------
// Heartbeat
//------------------------------------------------------------------------------

#define HEARTBEAT_NONE      espurna::heartbeat::Mode::None
#define HEARTBEAT_ONCE      espurna::heartbeat::Mode::Once
#define HEARTBEAT_REPEAT    espurna::heartbeat::Mode::Repeat

//------------------------------------------------------------------------------
// MQTT
//------------------------------------------------------------------------------

// Internal MQTT events
#define MQTT_CONNECT_EVENT          0
#define MQTT_DISCONNECT_EVENT       1
#define MQTT_MESSAGE_EVENT          2

// MQTT_LIBRARY
#define MQTT_LIBRARY_ASYNCMQTTCLIENT        0
#define MQTT_LIBRARY_ARDUINOMQTT            1
#define MQTT_LIBRARY_PUBSUBCLIENT           2


//------------------------------------------------------------------------------
// LED
//------------------------------------------------------------------------------

#define LED_MODE_MANUAL             LedMode::Manual         // LED will be managed manually (OFF by default)
#define LED_MODE_WIFI               LedMode::WiFi           // LED will blink according to the WIFI status
#define LED_MODE_FOLLOW             LedMode::Relay          // LED will follow state of linked LED#_RELAY relay ID
#define LED_MODE_FOLLOW_INVERSE     LedMode::RelayInverse   // LED will follow the opposite state of linked LED#_RELAY relay ID
#define LED_MODE_FINDME             LedMode::FindMe         // LED will be ON if all relays are OFF
#define LED_MODE_FINDME_WIFI        LedMode::FindMeWiFi     // A mixture between WIFI and FINDME
#define LED_MODE_ON                 LedMode::On             // LED always ON
#define LED_MODE_OFF                LedMode::Off            // LED always OFF
#define LED_MODE_RELAY              LedMode::Relays         // If any relay is ON, LED will be ON, otherwise OFF
#define LED_MODE_RELAY_WIFI         LedMode::RelaysWiFi     // A mixture between WIFI and RELAY, the reverse of MIXED

// -----------------------------------------------------------------------------
// UI
// -----------------------------------------------------------------------------

#define UI_TAG_INPUT                0
#define UI_TAG_CHECKBOX             1
#define UI_TAG_SELECT               2

#define WEB_MODE_NORMAL             0
#define WEB_MODE_PASSWORD           1

// -----------------------------------------------------------------------------
// LIGHT
// -----------------------------------------------------------------------------

// Available light providers
#define LIGHT_PROVIDER_NONE         0
#define LIGHT_PROVIDER_MY92XX       1       // works with MY9291 and MY9231
#define LIGHT_PROVIDER_DIMMER       2
#define LIGHT_PROVIDER_CUSTOM       3

// -----------------------------------------------------------------------------
// SCHEDULER
// -----------------------------------------------------------------------------

#define SCHEDULER_TYPE_NONE         scheduler::Type::None
#define SCHEDULER_TYPE_RELAY        scheduler::Type::Relay
#define SCHEDULER_TYPE_CHANNEL      scheduler::Type::Channel
#define SCHEDULER_TYPE_CURTAIN      scheduler::Type::Curtain

// -----------------------------------------------------------------------------
// IR
// -----------------------------------------------------------------------------

#define IR_BUTTON_ACTION_NONE         0
#define IR_BUTTON_ACTION_RGB          1
#define IR_BUTTON_ACTION_HSV          2
#define IR_BUTTON_ACTION_BRIGHTER     3
#define IR_BUTTON_ACTION_STATE        4
#define IR_BUTTON_ACTION_EFFECT       5
#define IR_BUTTON_ACTION_TOGGLE       6

#define IR_BUTTON_MODE_NONE         IR_BUTTON_ACTION_NONE
#define IR_BUTTON_MODE_RGB          IR_BUTTON_ACTION_RGB
#define IR_BUTTON_MODE_HSV          IR_BUTTON_ACTION_HSV
#define IR_BUTTON_MODE_BRIGHTER     IR_BUTTON_ACTION_BRIGHTER
#define IR_BUTTON_MODE_STATE        IR_BUTTON_ACTION_STATE
#define IR_BUTTON_MODE_EFFECT       IR_BUTTON_ACTION_EFFECT
#define IR_BUTTON_MODE_TOGGLE       IR_BUTTON_ACTION_TOGGLE

#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

//------------------------------------------------------------------------------
// PWM
//------------------------------------------------------------------------------
#define PWM_PROVIDER_NONE           0
#define PWM_PROVIDER_GENERIC        1
#define PWM_PROVIDER_ARDUINO        2

//------------------------------------------------------------------------------
// ENVIRONMENTAL
//------------------------------------------------------------------------------

// American Society of Heating, Refrigerating and Air-Conditioning Engineers suggests a range of 45% - 55% humidity to manage health effects and illnesses.
// Comfortable: 30% - 60%
// Recommended: 45% - 55%
// High       : 55% - 80%

#define HUMIDITY_NORMAL             0       // > %30
#define HUMIDITY_COMFORTABLE        1       // > %45
#define HUMIDITY_DRY                2       // < %30
#define HUMIDITY_WET                3       // > %70

// United States Environmental Protection Agency - UV Index Scale
// One UV Index unit is equivalent to 25 milliWatts per square meter.
#define UV_INDEX_LOW                0       // 0 to 2 means low danger from the sun's UV rays for the average person.
#define UV_INDEX_MODERATE           1       // 3 to 5 means moderate risk of harm from unprotected sun exposure.
#define UV_INDEX_HIGH               2       // 6 to 7 means high risk of harm from unprotected sun exposure. Protection against skin and eye damage is needed.
#define UV_INDEX_VERY_HIGH          3       // 8 to 10 means very high risk of harm from unprotected sun exposure.
                                            // Take extra precautions because unprotected skin and eyes will be damaged and can burn quickly.
#define UV_INDEX_EXTREME            4       // 11 or more means extreme risk of harm from unprotected sun exposure.
                                            // Take all precautions because unprotected skin and eyes can burn in minutes.

//--------------------------------------------------------------------------------
// Sensor ID
// These should remain over time, do not modify them, only add new ones at the end
//--------------------------------------------------------------------------------

#define SENSOR_DHTXX_ID             1
#define SENSOR_DALLAS_ID            2
#define SENSOR_EMON_ANALOG_ID       3
#define SENSOR_EMON_ADC121_ID       4
#define SENSOR_EMON_ADS1X15_ID      5
#define SENSOR_HLW8012_ID           6
#define SENSOR_V9261F_ID            7
#define SENSOR_ECH1560_ID           8
#define SENSOR_ANALOG_ID            9
#define SENSOR_DIGITAL_ID           10
#define SENSOR_EVENTS_ID            11
#define SENSOR_PMSX003_ID           12
#define SENSOR_BMX280_ID            13
#define SENSOR_MHZ19_ID             14
#define SENSOR_SI7021_ID            15
#define SENSOR_SHT3X_I2C_ID         16
#define SENSOR_BH1750_ID            17
#define SENSOR_PZEM004T_ID          18
#define SENSOR_AM2320_ID            19
#define SENSOR_GUVAS12SD_ID         20
#define SENSOR_CSE7766_ID           21
#define SENSOR_TMP3X_ID             22
#define SENSOR_SONAR_ID             23
#define SENSOR_SENSEAIR_ID          24
#define SENSOR_GEIGER_ID            25
#define SENSOR_NTC_ID               26
#define SENSOR_SDS011_ID            27
#define SENSOR_MICS2710_ID          28
#define SENSOR_MICS5525_ID          29
#define SENSOR_PULSEMETER_ID        30
#define SENSOR_VEML6075_ID          31
#define SENSOR_VL53L1X_ID           32
#define SENSOR_EZOPH_ID             33
#define SENSOR_BMP180_ID            34
#define SENSOR_MAX6675_ID           35
#define SENSOR_LDR_ID               36
#define SENSOR_ADE7953_ID           37
#define SENSOR_T6613_ID             38
#define SENSOR_SI1145_ID            39
#define SENSOR_HDC1080_ID           40
#define SENSOR_PZEM004TV30_ID       41
#define SENSOR_BME680_ID            42
#define SENSOR_SM300D2_ID           43
#define SENSOR_PM1006_ID            44
#define SENSOR_INA219_ID            45

//--------------------------------------------------------------------------------
// Magnitudes
// These should remain over time, do not modify their values, only add new ones at the end
//--------------------------------------------------------------------------------

#define MAGNITUDE_NONE              0
#define MAGNITUDE_TEMPERATURE       1
#define MAGNITUDE_HUMIDITY          2
#define MAGNITUDE_PRESSURE          3
#define MAGNITUDE_CURRENT           4
#define MAGNITUDE_VOLTAGE           5
#define MAGNITUDE_POWER_ACTIVE      6
#define MAGNITUDE_POWER_APPARENT    7
#define MAGNITUDE_POWER_REACTIVE    8
#define MAGNITUDE_POWER_FACTOR      9
#define MAGNITUDE_ENERGY            10
#define MAGNITUDE_ENERGY_DELTA      11
#define MAGNITUDE_ANALOG            12
#define MAGNITUDE_DIGITAL           13
#define MAGNITUDE_EVENT             14
#define MAGNITUDE_PM1DOT0           15
#define MAGNITUDE_PM2DOT5           16
#define MAGNITUDE_PM10              17
#define MAGNITUDE_CO2               18
#define MAGNITUDE_LUX               19
#define MAGNITUDE_UVA               20
#define MAGNITUDE_UVB               21
#define MAGNITUDE_UVI               22
#define MAGNITUDE_DISTANCE          23
#define MAGNITUDE_HCHO              24
#define MAGNITUDE_GEIGER_CPM        25
#define MAGNITUDE_GEIGER_SIEVERT    26
#define MAGNITUDE_COUNT             27
#define MAGNITUDE_NO2               28
#define MAGNITUDE_CO                29
#define MAGNITUDE_RESISTANCE        30
#define MAGNITUDE_PH                31
#define MAGNITUDE_FREQUENCY         32
#define MAGNITUDE_IAQ               33
#define MAGNITUDE_IAQ_ACCURACY      34
#define MAGNITUDE_IAQ_STATIC        35
#define MAGNITUDE_VOC               36
#define MAGNITUDE_TVOC              37
#define MAGNITUDE_CH2O              38

#define MAGNITUDE_MAX               39

// TODO: backwards compatible sensor integer values. should probably allow custom messsages
// (even with the increased flash arequirements)

#define SENSOR_ERROR_OK             0       // No error
#define SENSOR_ERROR_OUT_OF_RANGE   1       // Result out of sensor range
#define SENSOR_ERROR_WARM_UP        2       // Sensor is warming-up
#define SENSOR_ERROR_TIMEOUT        3       // Response from sensor timed out
#define SENSOR_ERROR_UNKNOWN_ID     4       // Sensor did not report a known ID
#define SENSOR_ERROR_CRC            5       // Sensor data corrupted
#define SENSOR_ERROR_I2C            6       // Wrong or locked I2C address
#define SENSOR_ERROR_GPIO_USED      7       // The GPIO is already in use
#define SENSOR_ERROR_CALIBRATION    8       // Calibration error or Not calibrated
#define SENSOR_ERROR_OVERFLOW       9       // Value overflow
#define SENSOR_ERROR_NOT_READY      10      // Device is not ready / available / disconnected
#define SENSOR_ERROR_CONFIG         11      // Configuration values were invalid
#define SENSOR_ERROR_SUPPORT        12      // Not supported
#define SENSOR_ERROR_OTHER          99      // Any other error

#define SENSOR_ERROR_MAX            13

//------------------------------------------------------------------------------
// OTA Client (not related to the Web OTA support)
//------------------------------------------------------------------------------

#define OTA_CLIENT_NONE             0
#define OTA_CLIENT_ASYNCTCP         1
#define OTA_CLIENT_HTTPUPDATE       2

//------------------------------------------------------------------------------
// Secure Client
//------------------------------------------------------------------------------

#define SECURE_CLIENT_NONE                0
#define SECURE_CLIENT_AXTLS               1
#define SECURE_CLIENT_BEARSSL             2

#define SECURE_CLIENT_CHECK_NONE          0 // !!! INSECURE CONNECTION !!!
#define SECURE_CLIENT_CHECK_FINGERPRINT   1 // legacy fingerprint validation
#define SECURE_CLIENT_CHECK_CA            2 // set trust anchor from PROGMEM CA certificate

//------------------------------------------------------------------------------
// WiFi
//------------------------------------------------------------------------------

#define WIFI_SLEEP_MODE_NONE        NONE_SLEEP_T
#define WIFI_SLEEP_MODE_MODEM       MODEM_SLEEP_T
#define WIFI_SLEEP_MODE_LIGHT       LIGHT_SLEEP_T