Documentation

Documentation

Includes

tuya_cloud_com_defs.h

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

Macros

Marco TUYA_DEVOS_ACTIVATE_H

#define TUYA_DEVOS_ACTIVATE_H

      

Functions

Func tuya_devos_activate_init

OPERATE_RET tuya_devos_activate_init(tuya_activate_t *param);
/**
 * @brief Initialize activation module
 * 
 * @param[in] param Init param, see tuya_activate_t
 * 
 * @return OPRT_OK on success. Others on error, please refer to tuya_error_code.h
 */

Func tuya_devos_activate_start

OPERATE_RET tuya_devos_activate_start(VOID);
/**
 * @brief Start activate process
 * 
 * @return OPRT_OK on success. Others on error, please refer to tuya_error_code.h
 */

Func tuya_devos_activate_stop

OPERATE_RET tuya_devos_activate_stop(VOID);
/**
 * @brief Stop activate process
 * 
 * @return OPRT_OK on success. Others on error, please refer to tuya_error_code.h
 */

Func gw_set_udf

OPERATE_RET gw_set_udf(IN CONST CHAR_T *udf);
/**
 * @brief Set user defined features(udf) for activation
 * 
 * @return OPRT_OK on success. Others on error, please refer to tuya_error_code.h
 */

Func gw_get_udf

CHAR_T * gw_get_udf(VOID);
/**
 * @brief Get user defined features(udf) for activation
 * 
 * @return NULL on error
 */

Func gw_active_set_support_election

OPERATE_RET gw_active_set_support_election(BOOL_T enable);
/**
 * @brief Set election enable or not
 * 
 * @param[in] enable election is supported or not
 * 
 * @return OPRT_OK on success. Others on error, please refer to tuya_error_code.h
 */

Func gw_active_get_support_election

BOOL_T gw_active_get_support_election(VOID);
/**
 * @brief Get election enable or not
 * 
 * @return TRUE on enable, False on disable
 */

Func gw_active_set_ext_param

OPERATE_RET gw_active_set_ext_param(IN CHAR_T *param);
/**
 * @brief Set extension params for activation
 * 
 * @param[in] param Extension params
 * 
 * @return OPRT_OK on success. Others on error, please refer to tuya_error_code.h
 */

Func gw_active_get_ext_param

CHAR_T * gw_active_get_ext_param(VOID);
/**
 * @brief Get extension params for activation
 * 
 * @return NULL on error
 */

Func gw_active_result_parse

OPERATE_RET gw_active_result_parse(ty_cJSON* result, bool isWifiActive);
/**
 * @brief Parse activation result
 * 
 * @param[in] result Json encoded activation result
 * @param[in] isWifiActive Is activated by Wi-Fi or not
 * 
 * @return OPRT_OK on success. Others on error, please refer to tuya_error_code.h
 */

Func set_gw_active

VOID set_gw_active(GW_WORK_STAT_T stat);
/**
 * @brief Set activation state
 * 
 * @param[in] stat Work state, see GW_WORK_STAT_T
 */

Func get_gw_active

GW_WORK_STAT_T get_gw_active(VOID);
/**
 * @brief Get activation state
 * 
 * @return Work state, see GW_WORK_STAT_T
 */

Vars

Consts

Types

Typedefs

Typedef tuya_activate_t;

typedef struct {
   UINT_T resved;
}tuya_activate_t;