Documentation

Documentation

Includes

tuya_hal_network.h

#include "tuya_hal_network.h"
#include "tuya_hal_network.h"

tuya_hal_wifi.h

#include "tuya_hal_wifi.h"
#include "tuya_hal_wifi.h"

Macros

Marco __WIFI_NETCFG_FRAME_TRANSPORTER_H__

#define __WIFI_NETCFG_FRAME_TRANSPORTER_H__

      

Functions

Func wifiNetcfgFrameTransporterChannelInitAndStart

int wifiNetcfgFrameTransporterChannelInitAndStart();
/*配网开始时,执行信道初始化*/

Func destroyWifiNetcfgFrameTransporter

void destroyWifiNetcfgFrameTransporter();
/*
	销毁wifi_netcfg_frame_transporter实例,释放内存
*/

Func WifiNetcfgFrameTransporterSessionInit

int WifiNetcfgFrameTransporterSessionInit();
/*配网模块全局初始化,创建并初始化TransporterSession,必须在getTransporter之前调用*/

Func WifiNetcfgFrameTransporterSessionUninit

int WifiNetcfgFrameTransporterSessionUninit();
/*配网模块全局销毁,在配网活动结束之后调用*/

Vars

Variable ptrWifiNetcfgFrameTransporter_t

ptrWifiNetcfgFrameTransporter_t getWifiNetcfgFrameTransporter();
/*
	获取或创建wifi_netcfg_frame_transporter的实例,线程安全
*/

Consts

Types

Typedefs

Typedef fnProbeRequestTransportCallBack_t

typedef int (*fnProbeRequestTransportCallBack_t)(void* ptrArgs, BYTE_T channel);


      

Typedef fnAuthTransportCallBack_t

typedef int (*fnAuthTransportCallBack_t)(void* ptrArgs, BYTE_T channel);


      

Typedef fnBeaconTransportCallBack_t

typedef int (*fnBeaconTransportCallBack_t)(void* ptrArgs, BYTE_T channel);


      

Typedef TransporteeParameters_t,*ptrTransporteeParameters_t;

typedef struct TransporteeParameters_s{
 fnProbeRequestTransportCallBack_t fnProbeRequestTransport;
 fnAuthTransportCallBack_t fnAuthTransport;
 fnBeaconTransportCallBack_t fnBeaconTransport;
 void* ptrArgs;
}TransporteeParameters_t,*ptrTransporteeParameters_t;


      

Typedef fnRegister

typedef int (*fnRegister)(int netcfg_type, ptrTransporteeParameters_t pParam);
/*
	transportee: 
		register->start->ungister
		isRun
	transporter:
		transporter is inited and started in WifiNetcfgFrameTransporterSessionInit
		and will be:
		lock->stop 
		getApInfo
		in transportee.
*/

Typedef fnStart

typedef int (*fnStart)(int netcfg_type);


      

Typedef bool

typedef bool (*fnIsRun)(int netcfg_type);


      

Typedef fnUnregister

typedef int (*fnUnregister)(int netcfg_type);


      

Typedef fnLock

typedef int (*fnLock)(bool lockState);


      

Typedef fnStartTransporter

typedef int (*fnStartTransporter)();


      

Typedef fnStopTransporter

typedef int (*fnStopTransporter)();


      

Typedef fnGetApInfo

typedef int (*fnGetApInfo)(AP_IF_S **ppApArray, uint32_t * pApNum);


      

Typedef *ptrWifiNetcfgFrameTransporter_t;

typedef struct WifiNetcfgFrameTransporter_s{
 fnRegister		registerTransporteeFn;
 fnStart		startTransporteeFn;
 fnIsRun		isRunTransporteeFn;
 fnUnregister unregisterTransporteeFn;
 
 fnLock		lockTransporterChannelFn;
   fnStartTransporter        startTransporterFn;
 fnStopTransporter		stopTransporterFn;
 fnGetApInfo	getApInfoFn;
}WifiNetcfgFrameTransporter_t, *ptrWifiNetcfgFrameTransporter_t;