ZB_TM52_SWITCH/Projects/macro/switch_ota_app_V1.0.5/protocol.h

/**
 * @file  protocol.h
 * @brief declaration of fuction in  protocol.c
 * @author qinlang
 * @date 2022.05.06
 * @par email:
 * @par email:qinlang.chen@tuya.com
 * @copyright HANGZHOU TUYA INFORMATION TECHNOLOGY CO.,LTD
 * @par company
 * http://www.tuya.com
 */
#ifndef __PROTOCOL_H_
#define __PROTOCOL_H_

#ifdef __cplusplus
extern "C"
{
#endif
/******************************************************************************
                                配置产品类别须知:
1:根据实际设计电路板，设置产品SKU,必须修改参数“switchSKU”为对应产品类别
2:根据涂鸦ZigBee固件类别，需设置对应的宏定义



                                OTA设置须知：
1.开启OTA（需先下载“BootLoader”程序），宏定义“SUPPORT_MCU_OTA”打开，并设置编译下载环境参数
2.关闭OTA, 注释宏定义“SUPPORT_MCU_OTA”，并设置编译下载环境参数
******************************************************************************/
//#define REALSE 1 // 生产模式，看门狗打开
//#define DEBUG 1  // 研发调试用

// #define BEACON_TEST 1 //开启信标产测
// #define  switchSKU  0x01//////产品SKU, 混合面板bit7=1;纯场景面板，bit3=1;--del by zzw 20240319,取消SKU设计以宏定义类别为准
// 01:ZIGBEE-1键，02：ZIGBEE-2键，03：ZIGBEE-3键，06：ZIGBEE-6键（纯开关+混合场景）

// 6键轻触系列 --通用定义
//#define  ZIGBEE_ZTU_T1_SW  1//一路开关，产品ID： 20bwwjts
//#define  ZIGBEE_ZTU_T2_SW  1//二路开关，产品ID： qjy7kox3
#define  ZIGBEE_ZTU_T3_SW  1//三路开关，产品ID： rereby5a
//#define ZIGBEE_ZTU_T6_SCENCE_SW 1 // 6路混合场景，产品ID： m757kw7n

///< product INFORMATION
///< mcu version
#ifdef ZIGBEE_ZTU_T3_SW        // 臣仕账户，3键零火开关
#define PRODUCT_KEY "lvz4kebs" // 开发平台创建产品后生成的16位字符产品唯一标识
#define MCU_VER "1.0.1"        // MAX 3.3.15   BIT 7~0  XX.XX.XXXX
#endif

#ifdef ZIGBEE_ZTU_T2_SW        // 希智账户，3键零火开关
#define PRODUCT_KEY "qjy7kox3" // 开发平台创建产品后生成的16位字符产品唯一标识
#define MCU_VER "1.0.1"        // MAX 3.3.15   BIT 7~0  XX.XX.XXXX
#endif

#ifdef ZIGBEE_ZTU_T1_SW        // 希智账户，3键零火开关
#define PRODUCT_KEY "20bwwjts" // 开发平台创建产品后生成的16位字符产品唯一标识
#define MCU_VER "1.0.1"        // MAX 3.3.15   BIT 7~0  XX.XX.XXXX
#endif

#ifdef ZIGBEE_ZTU_T6_SCENCE_SW // 希智账户，6键零火开关
#ifdef DEBUG
#define PRODUCT_KEY "gulwpbcg" // 开发平台创建产品后生成的16位字符产品唯一标识
#define MCU_VER "1.0.1"        // MAX 3.3.15   BIT 7~0  XX.XX.XXXX
#else
#define PRODUCT_KEY "m757kw7n" // 开发平台创建产品后生成的16位字符产品唯一标识
#define MCU_VER "1.0.1"        // MAX 3.3.15   BIT 7~0  XX.XX.XXXX
#endif
#endif

#define ZIGBEE_UART_QUEUE_LMT 256 // using to save data received from uart
// modified by zzw  20240126 256->128,OTA恢复
#define ZIGBEE_UART_RECV_BUF_LMT 128 //
#define ZIGBEE_UART_SEND_BUF_LMT 128 //

    typedef enum
    {
        MCU_TYPE_DC_POWER = 1,
        MCU_TYPE_LOWER_POWER,
        MCU_TYPE_SCENE
    } MCU_TYPE_E;

/**
 * if mcu need to support the time function, this macro definition should be opened
 * and need complete mcu_write_rtctime function
 *
 */

// #define    SUPPORT_MCU_RTC_CHECK             //start time calibration

/**
 * if mcu need to support OTA, this macro definition should be opened
 */
#define SUPPORT_MCU_OTA // support mcu ota
// modify by zzw 20240302 开启MCU OTA功能

/**
 * if mcu need to support mcu type checking, this macro definition should be opened
 *
 */
// #define    CHECK_MCU_TYPE               //support mcu type check

/**
 * if mcu need to support zigbee network parameter setting, this macro definition should be opened
 *
 */
// #define  SET_ZIGBEE_NWK_PARAMETER        //support zigbee nwk parameter setting

/**
 * if mcu need to send a broadcast data, this macro definition should be opened
 *
 */
// #define  BROADCAST_DATA_SEND           //support broadcast data sending

/**
 * DP data list,this code will be generate by cloud platforms
 */
#if (defined ZIGBEE_ZTU_T3_SW) || (defined ZIGBEE_ZTU_T2_SW) || (defined ZIGBEE_ZTU_T1_SW)
// #ifdef ZIGBEE_ZTU_T3_SW            // 希智账户，3键零火开关
// 开关 1(可下发可上报)
// 备注:
#define DPID_SWITCH_1 1
// 开关 2(可下发可上报)
// 备注:
#define DPID_SWITCH_2 2
// 开关 3(可下发可上报)
// 备注:
#define DPID_SWITCH_3 3

// 开关上电状态设置(可下发可上报)
// 备注:
#define DPID_RELAY_STATUS 14
// 指示灯亮度(可下发可上报)
// 备注:
#define DPID_LIGHT_MODE 15
// 人感开关(可下发可上报)
// 备注:
#define DPID_BACKLIGHT_SWITCH 16
// 点动开关（延时关）(可下发可上报)
// 备注:/#1通道号（bit--0开关，bit7-bit1--通道号）
/// #2#3点动倒计时时间
#define DPID_SWITCH_INCHING 19
// 开关1上电状态设置(可下发可上报)
// 备注:
#define DPID_RELAY_STATUS_1 29
// 开关2上电状态设置(可下发可上报)
// 备注:
#define DPID_RELAY_STATUS_2 30
// 开关3上电状态设置(可下发可上报)
// 备注:
#define DPID_RELAY_STATUS_3 31

//增加电量(可下发可上报)
//备注:
#define DPID_ADD_ELE 20
//当前电流(只上报)
//备注:
#define DPID_CUR_CURRENT 21
//当前功率(只上报)
//备注:
#define DPID_CUR_POWER 22
//当前电压(只上报)
//备注:
#define DPID_CUR_VOLTAGE 23


#endif

#ifdef ZIGBEE_ZTU_T6_SCENCE_SW // 希智账户，6键零火开关

// 场景1(可下发可上报)
// 备注:
#define DPID_SCENE_1 1
// 场景2(可下发可上报)
// 备注:
#define DPID_SCENE_2 2
// 场景3(可下发可上报)
// 备注:
#define DPID_SCENE_3 3
// 场景4(可下发可上报)
// 备注:
#define DPID_SCENE_4 4
// 场景5(可下发可上报)
// 备注:
#define DPID_SCENE_5 5
// 场景6(可下发可上报)
// 备注:
#define DPID_SCENE_6 6
// 模式1(可下发可上报)
// 备注:
#define DPID_MODE_1 18
// 模式2(可下发可上报)
// 备注:
#define DPID_MODE_2 19
// 模式3(可下发可上报)
// 备注:
#define DPID_MODE_3 20
// 开关1(可下发可上报)
// 备注:
#define DPID_SWITCH_1 24
// 开关2(可下发可上报)
// 备注:
#define DPID_SWITCH_2 25
// 开关3(可下发可上报)
// 备注:
#define DPID_SWITCH_3 26
// 人感开关(可下发可上报)
// 备注:
#define DPID_BACKLIGHT_SWITCH 36
// 指示灯亮度(可下发可上报)
// 备注:
#define DPID_LIGHT_MODE 37
// 上电状态设置(可下发可上报)
// 备注:
#define DPID_RELAY_STATUS 38
// 开关1上电状态设置(可下发可上报)
// 备注:
#define DPID_RELAY_STATUS_1 39
// 开关2上电状态设置(可下发可上报)
// 备注:
#define DPID_RELAY_STATUS_2 40
// 开关3上电状态设置(可下发可上报)
// 备注:
#define DPID_RELAY_STATUS_3 41
// 点动开关（延时关）(可下发可上报)
// 备注:
#define DPID_SWITCH_INCHING 101

#endif

    void base64_decode_three_bytes(const char input[4], unsigned char output[3]);
    void HexToDisHex(unsigned char *pbDest, unsigned char *pbSrc, int nLen);
    void DisHexToHex(unsigned char *pbDest, unsigned char *pbSrc, int nLen);

    /**
     * @brief encapsulates a generic send function, developer should use their own function to completing this fuction
     * @param[in] {value} send signle data
     * @return  void
     */
    void uart_transmit_output(unsigned char value);

    /**
     * @brief Upload all dp information of the system, and realize the synchronization of APP and muc data
     * @param[in] {void}
     * @return  void
     */
    void all_data_update(void);

    /**
     * @brief mcu check local RTC time
     * @param[in] {time} timestamp
     * @return  void
     */
    void mcu_write_rtctime(unsigned char time[]);

    /**
     * @brief Zigbee functional test feedback
     * @param[in] {void}
     * @return  void
     */
    void zigbee_test_result(void);

    /**
     * @brief this function will handle uart received frame data
     * @param[in] {dpid}   dp id
     * @param[in] {value}  dp data
     * @param[in] {length} lenght of dp data
     * @return  handle result
     */
    unsigned char dp_download_handle(unsigned char dpid, const unsigned char value[], unsigned short length);

    /**
     * @brief get received cmd total number
     * @param[in] {void}
     * @return  received cmd total number
     */
    unsigned char get_download_cmd_total(void);

    /**
     * @brief received zigbee net_work state handle
     * @param[in] {zigbee_work_state}  zigbee current network state
     * @return  void
     */
    void zigbee_work_state_event(unsigned char zigbee_work_state);
    /**
     * @brief received reset zigbee response
     * @param[in] {state} response state
     * @return  void
     */
    void mcu_reset_zigbee_event(unsigned char state);

    /**
     * @brief check mcu version response
     * @param[in] {void}
     * @return  void
     */
    void response_mcu_ota_version_event(void);

#ifdef SUPPORT_MCU_OTA
    /**
     * @brief mcu ota update notify response
     * @param[in] {offset} offset of file
     * @return  void
     */
    void response_mcu_ota_notify_event(unsigned char offset);
    /**
     * @brief received mcu ota data request response
     * @param[in] {fw_offset}  offset of file
     * @param[in] {data}  received data
     * @return  void
     */
    // void reveived_mcu_ota_data_handle(unsigned int fw_offset,char *data);

    /**
     * @brief mcu send ota data request
     * @param[in] {offset} offset of file
     * @return  void
     */
    void mcu_ota_fw_request_event(unsigned char offset);

    /**
     * @brief mcu ota data result notify
     * @param[in] {offset} offset of file
     * @return  void
     */
    void mcu_ota_result_event(unsigned char offset);

    /**
     * @brief mcu ota data handle
     * @param[in] {fw_offset} frame offset
     * @param[in] {data} received data
     * @return  void
     */
    void ota_fw_data_handle(unsigned int fw_offset, char *data1, unsigned char data_len); // modified by zzw 51不允许用“data”做变量名
#endif

#ifdef BEACON_TEST
    /**
     * @brief beacon test notify,which used in testing
     * @param[in] {void}
     * @return  void
     */
    void mcu_received_beacon_test_handle(void);
#endif

#ifdef CHECK_ZIGBEE_NETWORK
    /**
     * @brief check zigbee nwkstate,before start join nwk, check nwk if state is not 0x02,can start jion,
     * else delay 5s
     *
     * @param[in] {void}
     * @return  void
     */
    void mcu_check_zigbee_nwk_state(void);
#endif

#ifdef READ_DP_DATA_NOTIFY
    /**
     * @brief when gateway repower or relink clould, or zigbee module join sucess, repower, this commod will notify
     * mcu, to sys dp data, mcu itself decide whether report.
     *
     * @param[in] {void}
     * @return  void
     */
    void read_dp_data_notify_hanlde(void);
#endif

#ifdef __cplusplus
}
#endif
#endif