gw_intf.h

浏览该文件的文档.

 
#ifndef _GW_INTF_H
#define _GW_INTF_H
 
#include "tuya_cloud_types.h"
#include "tuya_cloud_com_defs.h"
#include "tuya_os_adapter.h"
#include "tuya_base_utilities.h"
#include "tuya_iot_internal_api.h"
#include "tuya_error_code.h"
 
#if defined(WIFI_GW) && (WIFI_GW==1)
#include "tuya_cloud_wifi_defs.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SERIAL_NO_STR_LEN 32    // max string length of sn
#define GET_ACCESS_TOKEN_INTERVAL  (300 * 1000) //5min
 
typedef struct {
    CHAR_T uuid[GW_UUID_LEN + 1];
    CHAR_T psk_key[PSK_KEY_LEN + 1];
    CHAR_T auth_key[AUTH_KEY_LEN + 1];
 
#if defined(WIFI_GW) && (WIFI_GW==1)
    CHAR_T ap_ssid[WIFI_SSID_LEN + 1];
    CHAR_T ap_passwd[WIFI_PASSWD_LEN + 1];
 
#endif
#if (defined(WIFI_GW) && (WIFI_GW==1)) || (defined(GW_SUPPORT_COUNTRY_CODE) && (GW_SUPPORT_COUNTRY_CODE==1))
    CHAR_T country_code[COUNTRY_CODE_LEN];
#endif
#if defined(GPRS_GW) && (GPRS_GW==1)
    CHAR_T imei[TUYA_IMEI_LEN + 1];
    CHAR_T sn[TUYA_SN_LEN + 1];
#endif
    BOOL_T prod_test;
#if defined(TY_BT_MOD) && TY_BT_MOD == 1
    CHAR_T bt_mac[BT_MAC_LEN + 1];
    CHAR_T bt_hid[BT_HID_LEN + 1];
#endif
    CHAR_T fac_pin[20 + 1];
} GW_BASE_IF_S;
 
// gw register status
typedef BYTE_T GW_WORK_STAT_T;
#define UNREGISTERED 0 // unregistered
#define REGISTERED 1 // registered & activate start
#define ACTIVATED 2 // already active
#define BLE_ACTIVING    (3)//start ble active
#define BLE_ACTIVATED   (4) // ble actived
 
typedef struct {
#if defined(WIFI_GW) && (WIFI_GW==1)
    GW_WF_NWC_STAT_T nc_tp;
    GW_WF_MD_T md;
    CHAR_T ssid[WIFI_SSID_LEN + 1];
    CHAR_T passwd[WIFI_PASSWD_LEN + 1];
#endif
    TY_DNS_PRIO_T dns_prio; // not saved in kv to save flash life-cycle
    GW_WORK_STAT_T stat;
    CHAR_T token[TOKEN_LEN + 1];
    CHAR_T region[REGION_LEN + 1];
    CHAR_T regist_key[REGIST_KEY_LEN + 1];
} GW_WORK_STAT_MAG_S;
 
typedef struct {
    GW_ABI abi;
    CHAR_T id[GW_ID_LEN + 1];
    CHAR_T sw_ver[SW_VER_LEN + 1];
    CHAR_T bs_ver[SW_VER_LEN + 1];
    CHAR_T prtl_ver[SW_VER_LEN + 1];
    CHAR_T lan_prtl_ver[SW_VER_LEN + 1];
    CHAR_T cad_ver[SW_VER_LEN + 1];
    CHAR_T cd_ver[SW_VER_LEN + 1];
    CHAR_T product_key[PRODUCT_KEY_LEN + 1];
    CHAR_T firmware_key[PRODUCT_KEY_LEN + 1];
 
    CHAR_T dev_sw_ver[SW_VER_LEN + 1];
    CHAR_T schema_id[SCHEMA_ID_LEN + 1];
    DEV_TYPE_T tp;
 
    BYTE_T attr_num;
    GW_ATTACH_ATTR_T attr[GW_ATTACH_ATTR_LMT];
 
    BOOL_T sync;
} GW_DESC_IF_S;
 
typedef struct {
    CHAR_T product_key[PRODUCT_KEY_LEN + 1];
    CHAR_T firmware_key[PRODUCT_KEY_LEN + 1];
} GW_STRIDE_UPDATE_S;
 
typedef struct {
    CHAR_T key[SEC_KEY_LEN + 1];
    CHAR_T local_key[LOCAL_KEY_LEN + 1];
    CHAR_T psk21_key[TUYA_PSK21_LEN + 1];
    CHAR_T http_url[HTTP_URL_LMT + 1];
    CHAR_T http_ip[HTTP_URL_LMT + 1];
    CHAR_T https_url[HTTP_URL_LMT + 1];
    CHAR_T https_ip[HTTP_URL_LMT + 1];
    CHAR_T httpsPSK_url[HTTP_URL_LMT + 1];
    CHAR_T httpsPSK_ip[HTTP_URL_LMT + 1];
 
    CHAR_T mq_psk_url[MQ_URL_LMT + 1];
    CHAR_T mq_psk_ip[MQ_URL_LMT + 1];
    CHAR_T mq_tls_url[MQ_URL_LMT + 1];
    CHAR_T mq_tls_ip[MQ_URL_LMT + 1];
    CHAR_T mq_proto_url[MQ_URL_LMT + 1];
    CHAR_T mq_proto_ip[MQ_URL_LMT + 1];
    CHAR_T ai_speech_url[HTTP_URL_LMT + 1];
    CHAR_T ai_speech_ip[HTTP_URL_LMT + 1];
    CHAR_T lowpower_url[MQ_URL_LMT + 1];
    CHAR_T lowpower_ip[MQ_URL_LMT + 1];
 
    CHAR_T time_zone[TIME_ZONE_LEN + 1];
    CHAR_T summer_time_zone[SUMMER_TM_ZONE_LEN + 1];
 
    CHAR_T wx_app_id[WXAPPID_LEN + 1];
    CHAR_T wx_uuid[WXUUID_LEN + 1];
    INT_T cloud_capability;
 
    BYTE_T dynamic_tls_mode;
} GW_ACTV_IF_S;
 
#define CLOUD_CAPABILITY_WIFI         0     // wifi
#define CLOUD_CAPABILITY_CABLE        1     // cable
#define CLOUD_CAPABILITY_GPRS         2     // gprs
#define CLOUD_CAPABILITY_NBIOT        3     // nb-iot
#define CLOUD_CAPABILITY_BLUETOOTH    10    // bt
#define CLOUD_CAPABILITY_BLEMESH      11    // blemesh
#define CLOUD_CAPABILITY_ZIGBEE       12    // zigbee
#define CLOUD_CAPABILITY_INFRARED     13    // infrared
#define CLOUD_CAPABILITY_SUBPIECES    14    // subpieces
#define CLOUD_CAPABILITY_SIGMESH      15    // sigmesh
#define CLOUD_CAPABILITY_MCU          16    // mcu
 
typedef BYTE_T DP_PV_STAT_E;
#define INVALID 0       // dp is invalid
#define VALID_LC 1      // dp is valid in local
#define VALID_ULING 2   // dp is uploading to cloud
#define VALID_CLOUD 3   // dp is synced with cloud
 
typedef BYTE_T DP_ID_REPT_TYPE_E;
#define DP_ID_REPT_RULE_ROUTE    (0x1) //dp report rule from route
 
typedef struct {
    UINT_T   period; // long filter period
    UINT_T   limit;  // dpcount limit in long filter period
    UINT_T   rept_cnt; // report counter
    TIME_S   fir_rept_timestamp;//the first report success timestamp
} DP_REPT_FLOW_CTRL_UNIT;
 
typedef struct {
    DP_REPT_FLOW_CTRL_UNIT filter_short;//flow control rules for short period
    DP_REPT_FLOW_CTRL_UNIT filter_long;//flow control rules for long period
} DP_REPT_FLOW_CTRL;
 
#if defined(RELIABLE_TRANSFER) && (RELIABLE_TRANSFER==1)
typedef struct {
    TIME_S cur_set_time;
    UINT_T cur_set_rept_num;
} DP_CUR_SET_REPT_CNTL_S;
#endif
 
typedef struct {
    DP_DESC_IF_S dp_desc;
    DP_PROP_VALUE_U prop;
    DP_PV_STAT_E pv_stat;
    BYTE_T       uling_cnt;
    DP_REPT_FLOW_CTRL rept_flow_ctrl;
#if defined(RELIABLE_TRANSFER) && (RELIABLE_TRANSFER==1)
    TIME_S rept_new_time;
    DP_PROP_VALUE_U cur_set;
    DP_CUR_SET_REPT_CNTL_S cur_set_rept;
    BYTE_T is_set_flag;//是否要检查当前下发的值与实际状态是否一样
#endif
} DP_CNTL_S;
 
 
typedef struct {
    BOOL_T preprocess;
} SCHEMA_OTHER_ATTR_S;
 
 
#define GRP_LMT 64 // group limit
#define SCENE_LMT 64 // scene limit
#define LOG_PHAT_MAX_LEN 64
 
typedef struct {
    CHAR_T gid[GRP_ID_LEN + 1];
} GRP_REC_S;
 
typedef struct {
    CHAR_T s_id[SCENE_ID_LEN + 1];
    CHAR_T g_id[GRP_ID_LEN + 1];
} SCENE_REC_S;
 
typedef struct {
    GRP_REC_S g_rec[GRP_LMT];
    BYTE_T cnt;
} GRP_MAG_S;
 
typedef struct {
    SCENE_REC_S s_rec[SCENE_LMT];
    BYTE_T cnt;
} SCENE_MAG_S;
 
typedef struct {
    BOOL_T attach_dp_if;
    BOOL_T preprocess;
} DEV_ACTV_ATTR_S;
 
typedef struct dev_cntl_n_s {
    CHAR_T id[DEV_ID_LEN + 1];
    DEV_ACTV_ATTR_S attr;
#if defined(RELIABLE_TRANSFER) && (RELIABLE_TRANSFER==1)
    BYTE_T reliable_transfer_flag;//1表示要可靠性检测
#endif
 
    MUTEX_HANDLE dp_mutex;//dp本地缓存互斥锁
    BYTE_T dp_num;
    DP_CNTL_S dp[0];
} DEV_CNTL_N_S;
 
typedef DEV_CNTL_N_S * (*subdev_dev_cntl_get_cb)(IN CHAR_T *id);
 
typedef struct {
    CHAR_T *serial_no;
    UINT_T ext_attribute;
    GW_EXT_STAT_T ext_stat;
 
    BOOL_T is_oem;
    BOOL_T is_init;
    BOOL_T is_stride;
    BOOL_T is_need_recovery;
 
    GW_BASE_IF_S gw_base;
    GW_WORK_STAT_MAG_S gw_wsm;
    GW_DESC_IF_S gw_if;
    GW_ACTV_IF_S gw_actv;
 
    DEV_CNTL_N_S *dev_cntl;
 
    TY_IOT_CBS_S cbs;
 
    TIME_S data_update_time;
    subdev_dev_cntl_get_cb subdev_dev_get_cb;
} GW_CNTL_S;
 
typedef BYTE_T GW_RESET_TP_T;
#define GRT_LOCAL 0     // reset is triggerd by device itself
#define GRT_REMOTE 1    // reset is triggerd by cloud/app
 
typedef struct {
    GW_RESET_TP_T gw_rst_tp;
    BOOL_T lazy;
} GW_RESET_S;
 
typedef struct {
    GW_RESET_TP_T tp;
    CHAR_T dev_id[DEV_ID_LEN + 1];
} DEV_RESET_S;
 
typedef enum {
    TY_COUNTRY_CODE_CN,
    TY_COUNTRY_CODE_US,
    TY_COUNTRY_CODE_JP,
    TY_COUNTRY_CODE_EU
} TUYA_COUNTRY_CODE_E;
 
DEV_CNTL_N_S *get_gw_dev_cntl(VOID);
 
GW_DESC_IF_S *get_gw_dev_if(VOID);
 
DEV_CNTL_N_S *get_dev_cntl(IN CHAR_T *id);
 
DP_CNTL_S *get_dev_dp_cntl(IN CHAR_T *id, IN CONST BYTE_T dpid);
 
GW_CNTL_S *get_gw_cntl(VOID);
 
CHAR_T *tuya_get_schema(VOID);
 
OPERATE_RET tuya_get_dp_info(IN CONST CHAR_T *dev_id, INT_T* dp_num, DP_CNTL_S** dp_info);
 
OPERATE_RET gw_get_gpd_type(IN CONST UINT_T type, OUT GW_PERMIT_DEV_TP_T *gpd);
 
OPERATE_RET gw_set_ext_attribute(UINT_T attr);
 
UINT_T gw_get_ext_attribute(VOID);
 
OPERATE_RET gw_create_dev_cntl(IN CONST CHAR_T * dev_id, IN CONST CHAR_T * sch_json, OUT DEV_CNTL_N_S **dev_cnt_out);
 
OPERATE_RET gw_destroy_dev_cntl(IN DEV_CNTL_N_S *dev_cnt);
 
OPERATE_RET gw_dup_dev_cntl(IN DEV_CNTL_N_S *dev_cnt_src,  OUT DEV_CNTL_N_S **dev_cnt_out);
 
OPERATE_RET gw_subdev_dev_cntl_get_register_cb(IN subdev_dev_cntl_get_cb cb);
 
OPERATE_RET gw_fast_unactive(IN CONST GW_RESET_S *rst_t);
 
OPERATE_RET gw_unregister(IN CONST GW_RESET_S *rst_t);
 
OPERATE_RET gw_unactive(IN CONST GW_RESET_S *rst_t);
 
OPERATE_RET gw_get_last_reset_region(INOUT CONST CHAR_T *region);
 
#ifdef __cplusplus
}
#endif
 
#include "tuya_devos_utils.h"
 
#endif