rTypes.h

/* 
   EN: Unified type and struct declarations
   RU: Объявления общих типов и структур для остальных модулей
   --------------------------
   (с) 2021 Разживин Александр | Razzhivin Alexander
   kotyara12@yandex.ru | https://kotyara12.ru | tg: @kotyara1971
*/

#ifndef __RTYPES_H__
#define __RTYPES_H__

#include <stdio.h>
#include <stdint.h>
#include <stdbool.h>
#include "esp_bit_defs.h"

#define TIMESPAN_NONE     0UL
#define TIMESPAN_24HOURS  2400UL
#define TIMESPAN_NIGHT    17000800UL
#define TIMESPAN_TARIFF2  22000700UL

/**
 * Type of input data stream
 * */
typedef enum { 
  IDS_NONE           = 0,
  IDS_GPIO           = 1,  
  IDS_RX433          = 2,
  IDS_MQTT           = 3
} source_type_t;

/**
 * GPIO pin and logic level details :: 32 bit
 * */
typedef struct {
  uint8_t bus;      // I2C bus +1 for expanders, 0 for internal ports
  uint8_t address;  // I2C address for expanders, 0 for internal ports
  uint8_t pin;      // Chip pin number
  uint8_t value;    // Logic level: 0 or 1
} gpio_data_t;

/**
 * External data :: 40 bit
 * */
typedef struct {
  uint32_t id;       // External data ID
  uint8_t  value;    // Logic level: 0 or 1
} ext_data_t;


/**
 * Data packet from receiver RX433 :: 40 bit
 * */
typedef struct {
  uint8_t  protocol;
  uint32_t value;
} rx433_data_t;

/**
 * Data in mixed input stream :: 40+8+16 = 64 bit
 * */
typedef struct {
  source_type_t source;
  union {
    gpio_data_t  gpio;
    rx433_data_t rx433;
    ext_data_t   ext;
  };
  uint16_t count;
} input_data_t;  

/**
 * Callback function to change the logic level on the input GPIO
 * */
typedef void (*cb_gpio_change_t) (void* source, gpio_data_t data, uint32_t duration);

/**
 * Callback function for controlling relays from various subroutines
 * */
typedef bool (*cb_relay_control_t) (bool relay_state);

/**
 * Callback function for posting data to MQTT brocker
 * */
typedef bool (*cb_mqtt_publish_t) (void* sender, char* topic, char* payload, uint8_t qos, bool retained, bool forced, bool free_topic, bool free_payload);

/**
 * Parameter kinds
 * */
typedef enum { 
  OPT_KIND_PARAMETER          = 0,   // Parameter or setting for this device
  OPT_KIND_PARAMETER_LOCATION = 1,   // Parameter or setting common to all location devices
  OPT_KIND_PARAMETER_ONLINE   = 2,   // Parameter or setting for this device without saving to NVS
  OPT_KIND_LOCDATA_ONLINE     = 3,   // External local input: online only
  OPT_KIND_LOCDATA_STORED     = 4,   // External local input: online, keeping the last value (can consume NVS pages a lot)
  OPT_KIND_EXTDATA_ONLINE     = 5,   // External data: fixed topic, online only
  OPT_KIND_EXTDATA_STORED     = 6,   // External data: fixed topic, keeping the last value (can consume NVS pages a lot)
  OPT_KIND_SIGNAL             = 7,   // External control signal
  OPT_KIND_SIGNAL_AUTOCLR     = 8,   // External control signal with automatic topic clear when received by the device
  OPT_KIND_COMMAND            = 9,   // Specialized: commands
  OPT_KIND_OTA                = 10   // Specialized: OTA command
} param_kind_t;

/**
 * Parameter types
 * */
typedef enum { 
  OPT_TYPE_UNKNOWN   = 0,
  OPT_TYPE_I8        = 1,
  OPT_TYPE_U8        = 2,
  OPT_TYPE_I16       = 3,
  OPT_TYPE_U16       = 4,
  OPT_TYPE_I32       = 5,
  OPT_TYPE_U32       = 6,
  OPT_TYPE_I64       = 7,
  OPT_TYPE_U64       = 8,
  OPT_TYPE_FLOAT     = 9,
  OPT_TYPE_DOUBLE    = 10,
  OPT_TYPE_STRING    = 11,
  OPT_TYPE_TIMEVAL   = 12,
  OPT_TYPE_TIMESPAN  = 13
} param_type_t;

/**
 * Boundary checking
*/
typedef enum { 
  HYSTERESIS_NONE             = 0,
  HYSTERESIS_SWITCH_ON        = 1,
  HYSTERESIS_SWITCH_OFF       = 2,
  HYSTERESIS_SYMMETRIC        = 3
} hysteresis_type_t;

#define HYSTERESIS_TYPE_MIN HYSTERESIS_NONE
#define HYSTERESIS_TYPE_MAX HYSTERESIS_SYMMETRIC

typedef enum { 
  THRESHOLD_MORE_OR_EQUAL     = 0,
  THRESHOLD_MORE              = 1,
  THRESHOLD_LESS_OR_EQUAL     = 2,
  THRESHOLD_LESS              = 3
} threshold_type_t;

#define THRESHOLD_TYPE_MIN THRESHOLD_MORE_OR_EQUAL
#define THRESHOLD_TYPE_MAX THRESHOLD_LESS

typedef struct {
  threshold_type_t threshold_type;
  float threshold;
  hysteresis_type_t hysteresis_type;
  float hysteresis;
} threshold_float_t;

bool checkThresholdFloat(float value, threshold_float_t* threshold, bool current_state);

/**
 * Notification kinds
 * */
typedef enum {
  MK_MAIN = 0,
  MK_SERVICE,
  MK_PARAMS,
  MK_SECURITY
} msg_kind_t;  

/**
 * Notification priorities
 * Messages with a lower priority may be discarded if there is no Internet access
 * */
typedef enum {
  MP_LOW = 0,    
  MP_REDUCED,    
  MP_ORDINARY,   
  MP_INCREASED,  
  MP_HIGH,       
  MP_CRITICAL    
} msg_priority_t;

/**
 * Notification options
 * bits: xKKKPPPA
 *    7: x   - reserved
 *  5-6: KKK - msg_kind_t
 *  1-4: PPP - message_priority_t
 *    0: A   - alert / sound notification
 * */
typedef uint8_t msg_options_t;
msg_options_t encMsgOptions(msg_kind_t kind, bool notify, msg_priority_t priority);
bool decMsgOptionsNotify(msg_options_t options);
msg_kind_t decMsgOptionsKind(msg_options_t options);
msg_priority_t decMsgOptionsPriority(msg_options_t options);

/**
 * Automatic shift of the range limits
 * */
typedef enum { 
  LIM_AUTOSHIFT_OFF  = 0,
  LIM_AUTOSHIFT_ALL  = 1,
  LIM_AUTOSHIFT_LOW  = 2,
  LIM_AUTOSHIFT_HIGH = 3
} limits_autoshift_t;

typedef uint32_t timespan_t;
typedef enum {
  WEEK_EMPTY         = 0,
  WEEK_SUNDAY        = 1,
  WEEK_MONDAY        = 2,
  WEEK_TUESDAY       = 3,
  WEEK_WEDNESDAY     = 4,
  WEEK_THURSDAY      = 5,
  WEEK_FRIDAY        = 6,
  WEEK_SATURDAY      = 7,
  WEEK_WEEKDAYS      = 8,
  WEEK_WEEKEND       = 9,
  WEEK_ANY           = 10
} weekdays_t;

/**
 * Dimensions of time intervals
 * */
typedef enum {
  TI_MILLISECONDS    = 0,
  TI_SECONDS         = 1,
  TI_MINUTES         = 2,
  TI_HOURS           = 3,
  TI_DAYS            = 4
} timeintv_t;

typedef struct {
  weekdays_t weekdays;
  timespan_t timespan;
} schedule_t;

#ifdef __cplusplus
extern "C" {
#endif

bool checkTimespan(struct tm* timeinfo, timespan_t timespan);
bool checkTimespanTime(time_t time, timespan_t timespan);
bool checkTimespanTimeEx(time_t time, timespan_t timespan, bool in_range);
bool checkTimespanNow(timespan_t timespan);
bool checkTimespanNowEx(timespan_t timespan, bool in_range);
bool checkWeekday(struct tm* timeinfo, weekdays_t day);
bool checkSchedule(struct tm* timeinfo, schedule_t* schedule);
bool checkTimeInterval(time_t timestamp, uint32_t interval, timeintv_t dimension, bool expired);

#ifdef __cplusplus
}
#endif

#endif // __RTYPES_H__