diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi.md b/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi.md index dc342d18d08530705b9cf9e6a2d92b6325f2524f..4010893f082cb29cf18a9f8aaeeff6c7ea0bbec6 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi.md @@ -15,8 +15,8 @@ | Public 属性 | 描述 | | -------- | -------- | -| ( [start](#start) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357382009.xml#xref459063066083932,link:zh-cn_topic_0000001357382009.xml](zh-cn_topic_0000001357382009.xml) \*iwifi) | 创建HAL和驱动之间的通道及获取驱动网卡信息,该函数调用在创建IWiFi实体后进行。 [更多...](#start) | -| ( [stop](#stop) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357382009.xml#xref1577893620083932,link:zh-cn_topic_0000001357382009.xml](zh-cn_topic_0000001357382009.xml) \*iwifi) | 销毁HAL和驱动之间的通道,该函数调用在销毁IWiFi实体前进行。 [更多...](#stop) | +| ( [start](#start) )(struct IWiFi \*iwifi) | 创建HAL和驱动之间的通道及获取驱动网卡信息,该函数调用在创建IWiFi实体后进行。 [更多...](#start) | +| ( [stop](#stop) )(struct IWiFi \*iwifi) | 销毁HAL和驱动之间的通道,该函数调用在销毁IWiFi实体前进行。 [更多...](#stop) | | ( [getSupportFeature](#getsupportfeature) )(uint8_t \*supType, uint32_t size) | 获取该设备支持的WLAN特性(不考虑当前的使用状态)。 [更多...](#getsupportfeature) | | ( [getSupportCombo](#getsupportcombo) )(uint64_t \*combo, uint32_t size) | 获取多网卡共存情况。 [更多...](#getsupportcombo) | | ( [createFeature](#createfeature) )(int32_t type, struct [IWiFiBaseFeature](_i_wi_fi_base_feature.md) \*\*ifeature) | 根据输入类型创建对应的特性[IWiFiBaseFeature](_i_wi_fi_base_feature.md)。 [更多...](#createfeature) | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_ap.md b/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_ap.md index 3c1cb098d39636f278ed93fd654864d1e06ed091..2b291fba5e1a5852eee597b9d401ea72884f5b70 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_ap.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_ap.md @@ -16,8 +16,8 @@ | Public 属性 | 描述 | | -------- | -------- | | [baseFeature](#basefeature) | 基本特性。 | -| ( [getAsscociatedStas](#getasscociatedstas) )(const struct [ERROR:Invalid link:zh-cn_topic_0000001304062480.xml#xref1123713694083932,link:zh-cn_topic_0000001304062480.xml](zh-cn_topic_0000001304062480.xml) \*apFeature, struct [StaInfo](_sta_info.md) \*staInfo, uint32_t count, uint32_t \*num) | 获取连接上的所有STA的信息(目前只包含MAC地址)。 [更多...](#getasscociatedstas) | -| ( [setCountryCode](#setcountrycode) )(const struct [ERROR:Invalid link:zh-cn_topic_0000001304062480.xml#xref2129805954083932,link:zh-cn_topic_0000001304062480.xml](zh-cn_topic_0000001304062480.xml) \*apFeature, const char \*code, uint32_t len) | 设置国家码(表示AP射频所在的国家,规定了AP射频特性,包括AP的发送功率、支持的信道等。其目的是为了使AP的射频特性符合不同国家或区域的法律法规要求)。 [更多...](#setcountrycode) | +| ( [getAsscociatedStas](#getasscociatedstas) )(const struct IWiFiAp \*apFeature, struct [StaInfo](_sta_info.md) \*staInfo, uint32_t count, uint32_t \*num) | 获取连接上的所有STA的信息(目前只包含MAC地址)。 [更多...](#getasscociatedstas) | +| ( [setCountryCode](#setcountrycode) )(const struct IWiFiAp \*apFeature, const char \*code, uint32_t len) | 设置国家码(表示AP射频所在的国家,规定了AP射频特性,包括AP的发送功率、支持的信道等。其目的是为了使AP的射频特性符合不同国家或区域的法律法规要求)。 [更多...](#setcountrycode) | ## **详细描述** @@ -63,7 +63,7 @@ int32_t(* IWiFiAp::getAsscociatedStas) (const struct IWiFiAp *apFeature, struct | 名称 | 描述 | | -------- | -------- | -| apFeature | 输入参数,AP特性[ERROR:Invalid link:zh-cn_topic_0000001304062480.xml#xref901054971083932,link:zh-cn_topic_0000001304062480.xml](zh-cn_topic_0000001304062480.xml)。 | +| apFeature | 输入参数,AP特性。 | | staInfo | 输出参数,保存与AP连接的STA的基本信息。 | | count | 输入参数,staInfo结构体数组的元素个数。 | | num | 输出参数,实际连接的STA的个数。 | @@ -90,7 +90,7 @@ int32_t(* IWiFiAp::setCountryCode) (const struct IWiFiAp *apFeature, const char | 名称 | 描述 | | -------- | -------- | -| apFeature | 输入参数,AP特性[ERROR:Invalid link:zh-cn_topic_0000001304062480.xml#xref1659529054083932,link:zh-cn_topic_0000001304062480.xml](zh-cn_topic_0000001304062480.xml)。 | +| apFeature | 输入参数,AP特性。 | | code | 输入参数,设置的国家码。 | | len | 输入参数,国家码长度。 | diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_base_feature.md b/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_base_feature.md index 62b1e1935fa3195138d56566bcb5a55b77bb1098..0f440188c6e2ce31ffc78229a6d82c8e53a3702a 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_base_feature.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_base_feature.md @@ -17,13 +17,13 @@ | -------- | -------- | | [ifName](#ifname) [[IFNAME_MAX_LEN](_w_l_a_n.md#ga63637ece87095ff8d153f650434ecf97)] | 网卡名称。 | | **type** | 特性的类型,参考[FeatureType](_w_l_a_n.md#featuretype)。 | -| ( [getNetworkIfaceName](#getnetworkifacename) )(const struct [ERROR:Invalid link:zh-cn_topic_0000001357621445.xml#xref1160037662083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml) \*baseFeature) | 根据基本特性获取网卡名称。 [更多...](#getnetworkifacename) | -| ( [getFeatureType](#getfeaturetype) )(const struct [ERROR:Invalid link:zh-cn_topic_0000001357621445.xml#xref2042681197083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml) \*baseFeature) | 获取基本特性的类型[FeatureType](_w_l_a_n.md#featuretype)。 [更多...](#getfeaturetype) | -| ( [setMacAddress](#setmacaddress) )(const struct [ERROR:Invalid link:zh-cn_topic_0000001357621445.xml#xref1120460385083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml) \*baseFeature, unsigned char \*mac, uint8_t len) | 根据传入参数设置对应网卡的MAC地址。 [更多...](#setmacaddress) | -| ( [getDeviceMacAddress](#getdevicemacaddress) )(const struct [ERROR:Invalid link:zh-cn_topic_0000001357621445.xml#xref330712474083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml) \*baseFeature, unsigned char \*mac, uint8_t len) | 获取设备的MAC地址。 [更多...](#getdevicemacaddress) | -| ( [getValidFreqsWithBand](#getvalidfreqswithband) )(const struct [ERROR:Invalid link:zh-cn_topic_0000001357621445.xml#xref1369279207083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml) \*baseFeature, int32_t band, int32_t \*freqs, uint32_t count, uint32_t \*num) | 获取指定频段(2.4G或者5G)下支持的频率。 [更多...](#getvalidfreqswithband) | -| ( [setTxPower](#settxpower) )(const struct [ERROR:Invalid link:zh-cn_topic_0000001357621445.xml#xref1878860227083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml) \*baseFeature, int32_t power) | 设置发射功率。 [更多...](#settxpower) | -| ( [getChipId](#getchipid) )(const struct [ERROR:Invalid link:zh-cn_topic_0000001357621445.xml#xref407053875083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml) \*baseFeature, uint8_t \*chipId) | 获得当前驱动的芯片ID。 [更多...](#getchipid) | +| ( [getNetworkIfaceName](#getnetworkifacename) )(const struct IWiFiBaseFeature \*baseFeature) | 根据基本特性获取网卡名称。 [更多...](#getnetworkifacename) | +| ( [getFeatureType](#getfeaturetype) )(const struct IWiFiBaseFeature \*baseFeature) | 获取基本特性的类型[FeatureType](_w_l_a_n.md#featuretype)。 [更多...](#getfeaturetype) | +| ( [setMacAddress](#setmacaddress) )(const struct IWiFiBaseFeature \*baseFeature, unsigned char \*mac, uint8_t len) | 根据传入参数设置对应网卡的MAC地址。 [更多...](#setmacaddress) | +| ( [getDeviceMacAddress](#getdevicemacaddress) )(const struct IWiFiBaseFeature \*baseFeature, unsigned char \*mac, uint8_t len) | 获取设备的MAC地址。 [更多...](#getdevicemacaddress) | +| ( [getValidFreqsWithBand](#getvalidfreqswithband) )(const struct IWiFiBaseFeature \*baseFeature, int32_t band, int32_t \*freqs, uint32_t count, uint32_t \*num) | 获取指定频段(2.4G或者5G)下支持的频率。 [更多...](#getvalidfreqswithband) | +| ( [setTxPower](#settxpower) )(const struct IWiFiBaseFeature \*baseFeature, int32_t power) | 设置发射功率。 [更多...](#settxpower) | +| ( [getChipId](#getchipid) )(const struct IWiFiBaseFeature \*baseFeature, uint8_t \*chipId) | 获得当前驱动的芯片ID。 [更多...](#getchipid) | | ( [getIfNamesByChipId](#getifnamesbychipid) )(const uint8_t chipId, char \*\*ifNames, uint32_t \*num) | 通过芯片ID获得当前芯片所有的网卡名称。 [更多...](#getifnamesbychipid) | @@ -58,7 +58,7 @@ int32_t(* IWiFiBaseFeature::getChipId) (const struct IWiFiBaseFeature *baseFeatu | 名称 | 描述 | | -------- | -------- | -| baseFeature | 输入参数,基本特性[ERROR:Invalid link:zh-cn_topic_0000001357621445.xml#xref473855951083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)。 | +| baseFeature | 输入参数,基本特性。 | | chipId | 输出参数,获得的芯片ID。 | **返回:** @@ -83,7 +83,7 @@ int32_t(* IWiFiBaseFeature::getDeviceMacAddress) (const struct IWiFiBaseFeature | 名称 | 描述 | | -------- | -------- | -| baseFeature | 输入参数,基本特性[ERROR:Invalid link:zh-cn_topic_0000001357621445.xml#xref1226402066083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)。 | +| baseFeature | 输入参数,基本特性。 | | mac | 输出参数,获得的MAC地址。 | | len | 输入参数,获得的MAC地址长度。 | @@ -109,7 +109,7 @@ int32_t(*IWiFiBaseFeature::getFeatureType) (const struct IWiFiBaseFeature *baseF | 名称 | 描述 | | -------- | -------- | -| baseFeature | 输入参数,基本特性[ERROR:Invalid link:zh-cn_topic_0000001357621445.xml#xref1934582661083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)。 | +| baseFeature | 输入参数,基本特性。 | **返回:** @@ -159,7 +159,7 @@ const char*(* IWiFiBaseFeature::getNetworkIfaceName) (const struct IWiFiBaseFeat | 名称 | 描述 | | -------- | -------- | -| baseFeature | 输入参数,基本特性[ERROR:Invalid link:zh-cn_topic_0000001357621445.xml#xref1207169342083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)。 | +| baseFeature | 输入参数,基本特性。 | **返回:** @@ -183,7 +183,7 @@ int32_t(* IWiFiBaseFeature::getValidFreqsWithBand) (const struct IWiFiBaseFeatur | 名称 | 描述 | | -------- | -------- | -| baseFeature | 输入参数,基本特性[ERROR:Invalid link:zh-cn_topic_0000001357621445.xml#xref1345697859083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)。 | +| baseFeature | 输入参数,基本特性。 | | band | 输入参数,指定的一个频段。 | | freqs | 输出参数,保存支持的频率。 | | count | 输入参数,频率数组的元素个数。 | @@ -223,7 +223,7 @@ int32_t(* IWiFiBaseFeature::setMacAddress) (const struct IWiFiBaseFeature *baseF | 名称 | 描述 | | -------- | -------- | -| baseFeature | 输入参数,基本特性[ERROR:Invalid link:zh-cn_topic_0000001357621445.xml#xref1858718007083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)。 | +| baseFeature | 输入参数,基本特性。 | | mac | 输入参数,设置的MAC地址。 | | len | 输入参数,设置的MAC地址长度。 | @@ -249,7 +249,7 @@ int32_t(* IWiFiBaseFeature::setTxPower) (const struct IWiFiBaseFeature *baseFeat | 名称 | 描述 | | -------- | -------- | -| baseFeature | 输入参数,基本特性[ERROR:Invalid link:zh-cn_topic_0000001357621445.xml#xref793467134083932,link:zh-cn_topic_0000001357621445.xml](zh-cn_topic_0000001357621445.xml)。 | +| baseFeature | 输入参数,基本特性。 | | power | 输入参数,设置的发射功率。 | **返回:** diff --git a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_sta.md b/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_sta.md index 7a4b3ffe73111dbdcbdb95f0f784cbba4f008bb1..aff3e568d7d0cae1422620565645673dbcb5508e 100644 --- a/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_sta.md +++ b/zh-cn/device-dev/reference/hdi-apis/_i_wi_fi_sta.md @@ -16,7 +16,7 @@ | Public 属性 | 描述 | | -------- | -------- | | [baseFeature](#basefeature) | 基本特性。 | -| ( [setScanningMacAddress](#setscanningmacaddress) )(const struct [ERROR:Invalid link:zh-cn_topic_0000001304541952.xml#xref1079443811083932,link:zh-cn_topic_0000001304541952.xml](zh-cn_topic_0000001304541952.xml) \*staFeature, unsigned char \*scanMac, uint8_t len) | 设置扫描单个MAC地址。 [更多...](#setscanningmacaddress) | +| ( [setScanningMacAddress](#setscanningmacaddress) )(const struct IWiFiSta \*staFeature, unsigned char \*scanMac, uint8_t len) | 设置扫描单个MAC地址。 [更多...](#setscanningmacaddress) | | ( [startScan](#startscan) )(const char \*ifName, WifiScan \*scan) | 启动扫描。 [更多...](#startscan) | @@ -63,7 +63,7 @@ int32_t(* IWiFiSta::setScanningMacAddress) (const struct IWiFiSta *staFeature, u | 名称 | 描述 | | -------- | -------- | -| staFeature | 输入参数,STA特性[ERROR:Invalid link:zh-cn_topic_0000001304541952.xml#xref557822862083932,link:zh-cn_topic_0000001304541952.xml](zh-cn_topic_0000001304541952.xml)。 | +| staFeature | 输入参数,STA特性。 | | scanMac | 输入参数,设置STA扫描的MAC地址。 | | len | 输入参数,MAC地址的长度。 |