1# HdiLpfenceWififence
2
3
4## 概述
5
6为低功耗围栏服务提供Wi-Fi围栏的API
7
8本模块接口提供添加Wi-Fi围栏，删除Wi-Fi围栏，获取Wi-Fi围栏状态，获取Wi-Fi围栏使用信息的功能。 应用场景：一般用于判断设备是否在室内特定位置，如居所内或商场的某个店铺内。
9
10**起始版本：** 4.0
11
12
13## 汇总
14
15
16### 文件
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [IWififenceCallback.idl](_i_wififence_callback_8idl.md) | 定义Wi-Fi围栏模块回调接口。 |
21| [IWififenceInterface.idl](_i_wififence_interface_8idl.md) | 定义Wi-Fi围栏模块回调接口。 |
22| [WififenceTypes.idl](_wififence_types_8idl.md) | 定义Wi-Fi围栏使用的数据类型。 |
23
24
25### 类
26
27| 名称 | 描述 |
28| -------- | -------- |
29| interface  [IWififenceCallback](interface_i_wififence_callback.md) | 定义Wi-Fi围栏模块的回调函数 |
30| interface  [IWififenceInterface](interface_i_wififence_interface.md) | 定义对Wi-Fi围栏模块进行基本操作的接口。 |
31| struct  [WififenceRequest](_wififence_request.md) | 定义添加Wi-Fi围栏的数据结构。 |
32| struct  [WififenceSize](_wififence_size.md) | 定义Wi-Fi围栏使用信息的数据结构。 |
33
34
35### 枚举
36
37| 名称 | 描述 |
38| -------- | -------- |
39| [WififenceTransition](#wififencetransition) { WIFIFENCE_TRANSITION_ENTERED = (1 << 0) , WIFIFENCE_TRANSITION_EXITED = (1 << 1) } | 枚举Wi-Fi围栏状态事件。 |
40| [WififenceAlgoType](#wififencealgotype) { TYPE_ONE_BSSID = 1 , TYPE_FP_MATCH = 2 } | 枚举Wi-Fi围栏的匹配算法。 |
41
42
43## 枚举类型说明
44
45
46### WififenceAlgoType
47
48```
49enum WififenceAlgoType
50```
51
52**描述**
53
54
55枚举Wi-Fi围栏的匹配算法。
56
57**起始版本：** 4.0
58
59| 枚举值 | 描述 |
60| -------- | -------- |
61| TYPE_ONE_BSSID | Wi-Fi围栏中MAC地址与设备扫描的MAC地址有交集时，即认为设备在围栏内。 |
62| TYPE_FP_MATCH | Wi-Fi围栏中MAC地址和RSSI值与设备扫描的MAC地址和RSSI值相似度达到一定阈值时，即认为设备在围栏内。 |
63
64
65### WififenceTransition
66
67```
68enum WififenceTransition
69```
70
71**描述**
72
73
74枚举Wi-Fi围栏状态事件。
75
76**起始版本：** 4.0
77
78| 枚举值 | 描述 |
79| -------- | -------- |
80| WIFIFENCE_TRANSITION_ENTERED | 设备在Wi-Fi围栏范围内。 |
81| WIFIFENCE_TRANSITION_EXITED | 设备在Wi-Fi围栏范围外。 |
82