xref: /OK3568_Linux_fs/docs/cn/Linux/Wifibt/WIFIBT编程接口/最新WIFI接口说明.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1RK平台WIFI API说明
2
3test/			 测试源码目录
4include/		 API头文件目录
5librkwifibt.so   WiFi应用依赖库
6
7//test目录说明:
8//RK WiFi自测程序,WiFi相关API的使用可参考rk_wifi_test.c
9main.c
10rk_wifi_test.c
11
12//SOFTAP相关的实现源码
13softap/
14
15//编程注意事项:
161. RK_wifi_register_callback:切记不要在WiFi的回调函数里面做任何耗时或阻塞的操作,它仅仅反馈WiFi的状态;
172. RK_wifi_enable(0/1): 打开或关闭时,一定要等待RK_WIFI_State_OPEN/RK_WIFI_State_OFF事件反馈,再做下一步操作;
183. RK_wifi_scan_r/RK_wifi_getSavedInfo 这两个API会返回数据给应用,切记要释放返回的指针,防止内存泄露,参考rk_wifi_test.c
194. RK_wifi_enable之前要注册RK_wifi_register_callback回调,监听连接的状态。
205. RK_wifi_connect是非阻塞函数,返回不等于连接成功,要在callback里面确认上一次的连接结果,否则下一次connect调用不会被执行。
21
22//其它
23如果库或程序运行错误请确保buildroot配置确保如下配置打开:
24BR2_PACKAGE_WPA_SUPPLICANT_WPA_CLIENT_SO
25BR2_PACKAGE_BLUEZ5_UTILS
26
27//错误示范:
28
29
30API说明:
31//EVENT 事件回调函数,事件如下:
32typedef enum {
33	RK_WIFI_State_IDLE = 0,
34	RK_WIFI_State_CONNECTING,
35	RK_WIFI_State_CONNECTFAILED,
36	RK_WIFI_State_CONNECTFAILED_WRONG_KEY,
37	RK_WIFI_State_CONNECTED,
38	RK_WIFI_State_DISCONNECTED,
39	RK_WIFI_State_OPEN,
40	RK_WIFI_State_OFF,
41	RK_WIFI_State_SCAN_RESULTS,
42	RK_WIFI_State_DHCP_OK,
43} RK_WIFI_RUNNING_State_e;
44int RK_wifi_register_callback(RK_wifi_state_callback cb);
45
46//获取当前WiFi状态
47int RK_wifi_running_getState(RK_WIFI_RUNNING_State_e* pState);
48
49//获取当前WiFi的详细信息:
50typedef struct {
51	int id;
52	char bssid[BSSID_BUF_LEN];
53	char ssid[SSID_BUF_LEN];
54	int freq;
55	char mode[20];
56	char wpa_state[20];
57	char ip_address[20];
58	char mac_address[20];
59	int reason;
60} RK_WIFI_INFO_Connection_s;
61int RK_wifi_running_getConnectionInfo(RK_WIFI_INFO_Connection_s* pInfo);
62
63//打开关闭WIFI
64int RK_wifi_enable(int enable);
65
66//发起扫描:
67int RK_wifi_scan(void);
68
69//获取扫描结果,以json格式返回
70char* RK_wifi_scan_r(void);
71
72//连接WiFi
73int RK_wifi_connect(char* ssid, const char* psk);
74
75//连接WEP加密的WiFi
76int RK_wifi_connect_wep(char* ssid, const char* psk);
77
78//断开WiFi
79int RK_wifi_disconnect_network(void);
80
81//忘记之前连接SSID
82int RK_wifi_forget_with_ssid(char *ssid);
83
84//取消正在连接的WiFi
85int RK_wifi_cancel(void);
86
87//获取之前连接过的WiFi, ap_cnt为之前连过的个数
88typedef struct {
89	int id;
90	char bssid[BSSID_BUF_LEN];
91	char ssid[SSID_BUF_LEN];
92	char state[STATE_BUF_LEN];
93} RK_WIFI_SAVED_INFO_s;
94int RK_wifi_getSavedInfo(RK_WIFI_SAVED_INFO_s **pInfo, int *ap_cnt);
95
96//连接之前连接过的WiFi,参数为SSID
97int RK_wifi_connect_with_ssid(char* ssid);
98
99//恢复WiFi出厂设置
100int RK_wifi_reset(void);
101
102//SOFTAP模式下获取WIFI扫描结果,以json格式返回
103char *RK_wifi_scan_for_softap(void)
104
105
106//SOFTAP功能开源,源码参考test/softap/softap.c
107//回调event
108typedef enum {
109	RK_SOFTAP_STATE_IDLE=0,
110	RK_SOFTAP_STATE_CONNECTTING,
111	RK_SOFTAP_STATE_SUCCESS,
112	RK_SOFTAP_STATE_FAIL,
113	RK_SOFTAP_STATE_DISCONNECT,
114} RK_SOFTAP_STATE;
115int RK_softap_register_callback(RK_SOFTAP_STATE_CALLBACK cb)
116
117//启动热点,psk为空则为不加密,IP网关地址(暂未使用,softap固定为:10.201.126.1,可以根据实际需求更改)
118int wifi_start_hostapd(char *ssid, char *psk, char *ip)
119
120//关闭热点
121int wifi_stop_hostapd(void)
122
123//SOFTAP配网DEMO
124//启动一个名为name的热点,并开始配网流程,正常情况下手机在setting界面找到并连接上面启动的热点
125int RK_softap_start(char *name, RK_SOFTAP_SERVER_TYPE server_type)
126{
127	//打开WiFi
128	RK_wifi_enable(1);
129	//启动热点
130	wifi_start_hostapd(name, NULL, NULL);
131	//启动跟手机数据交互服务,依赖手机APK端的实现,根据实际需求修改
132	startTcpServer();
133
134	return 0;
135}
136
137//startTcpServer启动一个跟手机交互的线程,端口:#define SOCKET_PORT 8443
138static void *threadAccept(void *arg)
139{
140	... ...
141	while (1)
142		fd_client = accept(fd_server, (struct sockaddr *)&addr_client, &len_addr_client);
143		handleRequest(fd_client);
144			if (strstr(buf, REQUEST_WIFI_LIST)) {
145				//收到手机侧的获取WiFi列表命令
146				sendWifiList(fd_client, buf);
147					RK_wifi_scan();
148					RK_wifi_scan_for_softap();
149					send(fd, send_msg, sizeof(send_msg), 0);
150			} else if (strstr(buf, REQUEST_WIFI_SET_UP)) {
151				//收到手机侧的获取WiFi列表命令
152				wifiSetup(fd_client, buf);
153					//解析手机发来的ssid/psk,然后调用连接API
154					RK_wifi_connect(softap_ssid, softap_psk);
155			} else if (strstr(buf, REQUEST_IS_WIFI_CONNECTED)) {
156				isWifiConnected(fd_client, buf);
157					//手机侧循环发送获取WiFi的连接状态
158					if (!RK_wifi_running_getConnectionInfo(&info)) {
159						if (strncmp(info.wpa_state, "COMPLETED", 9) == 0) //如果连接成功
160							isConn = 1;
161					}
162					snprintf(msg, sizeof(msg), HTTP_RESPOSE_MESSAGE, 1, isConn ? "1" : "0");
163					send(fd, msg, sizeof(msg), 0) //发送成功的信息给手机
164			} else if (strstr(buf, REQUEST_POST_CONNECT_RESULT)) {
165				//收到手机侧的配网完成指令
166				doConnectResult(fd_client, buf);
167					wifi_stop_hostapd();//关闭热点
168			}
169	... ...
170}
171
172//关闭配网
173int RK_softap_stop(void);