• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# HdiLpfenceWififence
2
3
4## 概述
5
6为低功耗围栏服务提供Wi-Fi围栏的API。
7
8本模块接口提供添加Wi-Fi围栏,删除Wi-Fi围栏,获取Wi-Fi围栏状态,获取Wi-Fi围栏使用信息的功能。
9
10应用场景:一般用于判断设备是否在室内特定位置,如居所内或商场的某个店铺内。
11
12**Since:**
13
144.0
15
16**Version:**
17
181.0
19
20
21## 汇总
22
23
24### 文件
25
26  | 名称 | 描述 |
27| -------- | -------- |
28| [IWififenceCallback.idl](_i_wififence_callback_8idl.md) | 定义Wi-Fi围栏模块回调接口。 |
29| [IWififenceInterface.idl](_i_wififence_interface_8idl.md) | 定义Wi-Fi围栏模块回调接口。 |
30| [WififenceTypes.idl](_wififence_types_8idl.md) | 定义Wi-Fi围栏使用的数据类型。 |
31
32
33### 类
34
35  | 名称 | 描述 |
36| -------- | -------- |
37| [IWififenceCallback](interface_i_wififence_callback.md) | interface<br/>导入Wi-Fi围栏模块的数据类型。 |
38| [IWififenceInterface](interface_i_wififence_interface.md) | interface<br/>导入Wi-Fi围栏模块的数据类型。 |
39| [WififenceRequest](_wififence_request.md) | struct<br/>定义添加Wi-Fi围栏的数据结构。 |
40| [WififenceSize](_wififence_size.md) | struct<br/>定义Wi-Fi围栏使用信息的数据结构。 |
41
42
43### 枚举
44
45  | 名称 | 描述 |
46| -------- | -------- |
47| [WififenceTransition](#wififencetransition)&nbsp;{&nbsp;WIFIFENCE_TRANSITION_ENTERED&nbsp;=&nbsp;(1&nbsp;&lt;&lt;&nbsp;0)&nbsp;,&nbsp;WIFIFENCE_TRANSITION_EXITED&nbsp;=&nbsp;(1&nbsp;&lt;&lt;&nbsp;1)&nbsp;} | 枚举Wi-Fi围栏状态事件。 |
48| [WififenceAlgoType](#wififencealgotype)&nbsp;{&nbsp;TYPE_ONE_BSSID&nbsp;=&nbsp;1&nbsp;,&nbsp;TYPE_FP_MATCH&nbsp;=&nbsp;2&nbsp;} | 枚举Wi-Fi围栏的匹配算法。 |
49
50
51### 关键字
52
53  | 名称 | 描述 |
54| -------- | -------- |
55| package&nbsp;ohos.hdi.location.lpfence.wififence.v1_0 | Wi-Fi围栏模块接口的包路径。 |
56
57
58## 枚举类型说明
59
60
61### WififenceAlgoType
62
63
64```
65enum WififenceAlgoType
66```
67
68**描述:**
69
70枚举Wi-Fi围栏的匹配算法。
71
72  | 枚举值 | 描述 |
73| -------- | -------- |
74| TYPE_ONE_BSSID | Wi-Fi围栏中MAC地址与设备扫描的MAC地址有交集时,即认为设备在围栏内。 |
75| TYPE_FP_MATCH | Wi-Fi围栏中MAC地址和RSSI值与设备扫描的MAC地址和RSSI值相似度达到一定阈值时,即认为设备在围栏内。 |
76
77
78### WififenceTransition
79
80
81```
82enum WififenceTransition
83```
84
85**描述:**
86
87枚举Wi-Fi围栏状态事件。
88
89  | 枚举值 | 描述 |
90| -------- | -------- |
91| WIFIFENCE_TRANSITION_ENTERED | 设备在Wi-Fi围栏范围内。 |
92| WIFIFENCE_TRANSITION_EXITED | 设备在Wi-Fi围栏范围外。 |
93