Documentation

Documentation

Includes

tuya_cloud_types.h

#include "tuya_cloud_types.h"
#include "tuya_cloud_types.h"

tuya_cloud_com_defs.h

#include "tuya_cloud_com_defs.h"
#include "tuya_cloud_com_defs.h"

tuya_cloud_wifi_defs.h

#include "tuya_cloud_wifi_defs.h"
#include "tuya_cloud_wifi_defs.h"

Macros

Marco __MF_TEST_H

#define __MF_TEST_H

      

Functions

Func mf_init

OPERATE_RET mf_init(IN CONST MF_IMPORT_INTF_S *intf,\
                      IN CONST CHAR_T *file_name,IN CONST CHAR_T *file_ver,IN BOOL_T wrMacEn);
/**
 * @brief mf test init fucntion
 * 
 * @param[in] intf mf test configure data
 * @param[in] file_name APP bin name
 * @param[in] file_ver User Software version
 * @param[in] wrMacEn Need wirte MAC or not
 *
 * @note some fireware need write MAC when mf test
 *
 * @return OPRT_OK on success. Others on error, please refer to tuya_error_code.h
 */

Func mf_test_is_timeout

BOOL_T mf_test_is_timeout(VOID);
/**
 * @brief judge if mf test is timeout
 *
 * @return TRUE/FALSE
 */

Func mf_user_param_cb_set

VOID mf_user_param_cb_set(MF_USER_PARAM_CB cb);
/**
 * @brief set callback function for product test
 * 
 * @param[in] cb 
 *
 */

Func mf_cmd_product_send

VOID mf_cmd_product_send(IN CONST USHORT_T cmd,IN CONST BYTE_T *data,IN CONST UINT_T len);
/**
 * @brief The entry of product test
 * @param[in] cmd Test command
 * @param[in] data Test data
 * @param[in] len Test data len
 *
 */

Func mf_test_ignore_close_flag

VOID mf_test_ignore_close_flag(VOID);
/**
 * @brief ignore mf test closed flag
 *
 */

Func mf_test_set_thread_priority

VOID mf_test_set_thread_priority(UINT_T pri);
/***********************************************************
*  Function: mf_test_set_thread_priority
*  Input: none
*  Output: none 
*  Return: none
***********************************************************/

Func mf_test_facpin_get

OPERATE_RET mf_test_facpin_get(OUT CHAR_T facpin[20 + 1]);
/**
 * @brief get facpin
 * 
 * @param[out] facpin
 *
 * @return OPRT_OK on success. Others on error, please refer to tuya_error_code.h
 */

Func wd_mf_test_close_if_write

OPERATE_RET wd_mf_test_close_if_write(IN BOOL_T mf_close);
/**
 * @brief close mf test,save the flag in flash
 * 
 * @param[in] mf_close Close flag
 *
 * @return OPRT_OK on success. Others on error, please refer to tuya_error_code.h
 */

Func wd_mf_test_close_if_read

BOOL_T wd_mf_test_close_if_read(VOID);
/**
 * @brief read the flag in flash,to check if mf test closed
 *
 * @return TRUE/FLASE
 */

Vars

Consts

Types

Typedefs

Typedef MF_UART_INIT_CB

typedef VOID (*MF_UART_INIT_CB)(UINT_T baud,UINT_T bufsz);
/**
 * @brief callback for URAT init function
 * 
 * @param[in] baud data bits:8bit,parity:none,stop bits:1
 * @param[in] bufsz Size of buff
 * 
 */

Typedef MF_UART_SEND_CB

typedef VOID (*MF_UART_SEND_CB)(IN BYTE_T *data,IN CONST UINT_T len);
/**
 * @brief callback for URAT send function
 * 
 * @param[in] data Send data buf
 * @param[in] len Send data buf len
 * 
 */

Typedef MF_UART_RECV_CB

typedef UINT_T (*MF_UART_RECV_CB)(OUT BYTE_T *buf,IN CONST UINT_T len);
/**
 * @brief callback for URAT receive function
 * 
 * @param[in] len buf len
 * @param[out] buf Received data buf
 * 
 * @return read data len
 */

Typedef MF_GPIO_TEST_CB

typedef BOOL_T (*MF_GPIO_TEST_CB)(IN CONST CHAR_T *in, OUT CHAR_T *out);
#else
typedef BOOL_T (*MF_GPIO_TEST_CB)(VOID);


      

Typedef MF_PRE_GPIO_TEST_CB

typedef BOOL_T (*MF_PRE_GPIO_TEST_CB)(VOID);
/**
 * @brief callback for preposed GPIO test
 *
 * @return TRUE/FALSE
 */

Typedef MF_USER_PRODUCT_TEST_CB

typedef OPERATE_RET (*MF_USER_PRODUCT_TEST_CB)(USHORT_T cmd,UCHAR_T *data, UINT_T len, OUT UCHAR_T **ret_data,OUT USHORT_T *ret_len);
/**
 * @brief callback for user product test
 * 
 * @param[in] cmd Test command
 * @param[in] data Test data
 * @param[in] len Test data len
 * @param[out] ret_data Test return data
 * @param[out] ret_len Test return data len
 *
 * @return OPRT_OK on success. Others on error, please refer to tuya_error_code.h
 */

Typedef MF_UART_FREE_CB

typedef VOID (*MF_UART_FREE_CB)(VOID);
/**
 * @brief callback for UART free function
 *
 */

Typedef MF_USER_CALLBACK

typedef VOID (*MF_USER_CALLBACK)(VOID);
/**
 * @brief callback for user
 *
 */

Typedef MF_IMPORT_INTF_S;

typedef struct {
   MF_UART_INIT_CB uart_init;
   MF_UART_FREE_CB uart_free;
   MF_UART_SEND_CB uart_send;
   MF_UART_RECV_CB uart_recv;
   MF_GPIO_TEST_CB gpio_test;
   MF_USER_PRODUCT_TEST_CB mf_user_product_test; 
   MF_USER_CALLBACK user_callback;
   MF_USER_CALLBACK user_enter_mf_callback;
   MF_PRE_GPIO_TEST_CB user_pre_gpio_test;
}MF_IMPORT_INTF_S;
/**
 * @brief Definition of mf test init configure
 */

Typedef MF_USER_PARAM_CB

typedef OPERATE_RET (*MF_USER_PARAM_CB)(IN CONST BYTE_T *data, IN CONST UINT_T len);
/**
 * @brief callback after write user param finish
 * 
 * @param[in] data The data user in
 * @param[in] len Data len
 *
 * @return OPRT_OK on success. Others on error, please refer to tuya_error_code.h
 */

Typedef VOID_T

typedef VOID_T (*APP_PROD_CB)(BOOL_T flag, SCHAR_T rssi);
/**
 * @brief callback for app product test
 * 
 * @param[in] flag 
 * @param[in] rssi
 *
 */