diff --git a/BUILD.gn b/BUILD.gn new file mode 100755 index 0000000..3af5644 --- /dev/null +++ b/BUILD.gn @@ -0,0 +1,23 @@ +# Copyright (c) 2020 Huawei Device Co., Ltd. +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +static_library("wifiaware") { + sources = [ "frameworks/source/wifiaware.c" ] + include_dirs = [ + "interfaces/kits", + "hals", + "//foundation/communication/wifi_lite/interfaces/wifiservice", + "$ohos_vendor_adapter_dir/hals/communication/wifi_lite/wifiservice/source", + ] + deps = [ "$ohos_vendor_adapter_dir/hals/communication/wifi_lite/wifiaware:hal_wifiaware" ] +} diff --git a/LICENSE b/LICENSE new file mode 100755 index 0000000..4a45986 --- /dev/null +++ b/LICENSE @@ -0,0 +1,177 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/README.en.md b/README.en.md deleted file mode 100644 index 3db1dd8..0000000 --- a/README.en.md +++ /dev/null @@ -1,36 +0,0 @@ -# communication_wifi_aware - -#### Description -{**When you're done, you can delete the content in this README and update the file with details for others getting started with your repository**} - -#### Software Architecture -Software architecture description - -#### Installation - -1. xxxx -2. xxxx -3. xxxx - -#### Instructions - -1. xxxx -2. xxxx -3. xxxx - -#### Contribution - -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request - - -#### Gitee Feature - -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README.md b/README.md old mode 100644 new mode 100755 index 7e2ec4b..568e70a --- a/README.md +++ b/README.md @@ -1,39 +1,25 @@ -# communication_wifi_aware +# Wi-Fi Aware -#### 介绍 -{**以下是 Gitee 平台说明，您可以替换此简介** -Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台（同时支持 SVN）。专为开发者提供稳定、高效、安全的云端软件开发协作平台 -无论是个人、团队、或是企业，都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)} +- [Introduction](#section11660541593) +- [Directory Structure](#section1464106163817) +- [Constraints](#section13591154411) -#### 软件架构 -软件架构说明 +## Introduction +The Wi-Fi Aware module provides near-field communication capabilities for applications. -#### 安装教程 +## Directory Structure -1. xxxx -2. xxxx -3. xxxx +``` +foundation/communication/wifi_aware/ # Wi-Fi Aware directory +├── frameworks +│ └── source # Wi-Fi Aware source file +├── hals # Hardware abstraction layer (HAL) header files +└── interfaces + └── kits # External APIs +``` -#### 使用说明 +## Constraints -1. xxxx -2. xxxx -3. xxxx +The Wi-Fi Aware module is compiled using the C language. Currently, only the Hi3861 development board is supported. If you want to use other chips, you need to implement OpenHarmony integration APIs and place your implementation code in the **vendor** directory. -#### 参与贡献 - -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request - - -#### 特技 - -1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README_zh.md b/README_zh.md new file mode 100755 index 0000000..ed3eec4 --- /dev/null +++ b/README_zh.md @@ -0,0 +1,25 @@ +# 项目介绍 + +- [简介](#section11660541593) +- [目录](#section1464106163817) +- [约束](#section13591154411) + +## 简介 + +Wi-Fi Aware模块提供了进场通信能力，该模块可被上层应用所使用。 + +## 目录 + +``` +foundation/communication/wifi_aware/ # 模块目录 +├── frameworks +│ └── source # 模块源文件 +├── hals # 硬件抽象层头文件 +└── interfaces + └── kits # 模块对外提供接口文件 +``` + +## 约束 + +WiFi Aware模块使用C语言编写，目前仅支持Hi3861开发板。如果您想接入其它芯片，那么仅需要适配实现鸿蒙的集成接口即可，将实现放在device下。 + diff --git a/frameworks/source/wifiaware.c b/frameworks/source/wifiaware.c new file mode 100755 index 0000000..e803137 --- /dev/null +++ b/frameworks/source/wifiaware.c @@ -0,0 +1,171 @@ +/* + * Copyright (c) 2020 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include "wifiaware.h" +#include +#include "hal_wifiaware.h" +#include "wifi_device_util.h" +#include "wifi_hotspot.h" + +#define WIFIAWARE_TX_LOW_POWER (-61) +#define SHA256_BYTE_LEN 32 +#define WIFIAWARE_MAX_POWER (-42) +#define WIFIAWARE_MIN_POWER (-70) +static signed char g_power = WIFIAWARE_TX_LOW_POWER; + +int InitNAN(void) +{ + int ret; + char ifname[WIFI_IFNAME_MAX_SIZE + 1] = {0}; + + if (IsHotspotActive() != WIFI_HOTSPOT_ACTIVE) { + return WIFIAWARE_FAIL; + } + + if (GetHotspotChannel() != WIFIAWARE_DEFAULT_CHANNEL) { + return WIFIAWARE_FAIL; + } + + ret = GetHotspotInterfaceName(ifname, sizeof(ifname)); + if (ret != WIFI_SUCCESS) { + return WIFIAWARE_FAIL; + } + + if (HalWifiSdpInit(ifname) != 0) { + return WIFIAWARE_FAIL; + } + + return WIFIAWARE_SUCCESS; +} + +int SubscribeService(const char* svcName, unsigned char localHandle, RecvCallback recvCB) +{ + int svcNameLen; + unsigned char shaSvcName[SHA256_BYTE_LEN] = {0}; + + if (svcName == 0 || recvCB == 0) { + return WIFIAWARE_FAIL; + } + + svcNameLen = strlen(svcName); + if (svcNameLen == 0) { + return WIFIAWARE_FAIL; + } + + if (HalCipherHashSha256(svcName, svcNameLen, shaSvcName, sizeof(shaSvcName)) != 0) { + return WIFIAWARE_FAIL; + } + + if (HalWifiSdpStartService((char*)shaSvcName, localHandle, (HalRecvCallback)recvCB, HAL_WIFI_SDP_SUBSCRIBE) != 0) { + return WIFIAWARE_FAIL; + } + + return WIFIAWARE_SUCCESS; +} + +int SendData(unsigned char* macAddr, unsigned char peerHandle, unsigned char localHandle, + unsigned char* msg, int len) +{ + if (HalWifiSdpSend(macAddr, peerHandle, localHandle, msg, len) != 0) { + return WIFIAWARE_FAIL; + } + + return WIFIAWARE_SUCCESS; +} + +int StopSubscribe(unsigned char localHandle) +{ + if (HalWifiSdpStopService(localHandle, HAL_WIFI_SDP_SUBSCRIBE) != 0) { + return WIFIAWARE_FAIL; + } + + return WIFIAWARE_SUCCESS; +} + +int DeinitNAN(void) +{ + if (HalWifiSdpDeinit() != 0) { + return WIFIAWARE_FAIL; + } + + return WIFIAWARE_SUCCESS; +} + +int SetLowPower(int powerSwitch) +{ + int ret; + char ifname[WIFI_IFNAME_MAX_SIZE + 1] = {0}; + + ret = GetHotspotInterfaceName(ifname, sizeof(ifname)); + if (ret != WIFI_SUCCESS) { + return WIFIAWARE_FAIL; + } + + switch (powerSwitch) { + case WIFIAWARE_LOW_POWER_SWITCH_ON: + if (HalWifiSdpAdjustTxPower(ifname, g_power) != 0) { + return WIFIAWARE_FAIL; + } + break; + case WIFIAWARE_LOW_POWER_SWITCH_OFF: + if (HalWifiSdpRestoreTxPower(ifname) != 0) { + return WIFIAWARE_FAIL; + } + break; + default: + return WIFIAWARE_FAIL; + } + + return WIFIAWARE_SUCCESS; +} + +int SetPower(signed char value) +{ + g_power = value; + return WIFIAWARE_SUCCESS; +} + +char GetPower(void) +{ + return g_power; +} + +int NanBeaconSwitch(unsigned char enable) +{ + char ifname[WIFI_IFNAME_MAX_SIZE + 1] = {0}; + + if (GetHotspotInterfaceName(ifname, sizeof(ifname)) != WIFI_SUCCESS) { + return WIFIAWARE_FAIL; + } + if (HalWifiSdpBeaconSwitch(ifname, enable) != 0) { + return WIFIAWARE_FAIL; + } + + return WIFIAWARE_SUCCESS; +} + +int NanSetRetryTimes(unsigned int retries) +{ + if (HalWifiSdpSetRetryTimes(retries) != 0) { + return WIFIAWARE_FAIL; + } + + return WIFIAWARE_SUCCESS; +} + +int NanGetSyncMode(void) +{ + return HalWifiSdpGetSyncMode(); +} diff --git a/hals/hal_wifiaware.h b/hals/hal_wifiaware.h new file mode 100755 index 0000000..7811b93 --- /dev/null +++ b/hals/hal_wifiaware.h @@ -0,0 +1,63 @@ +/* + * Copyright (c) 2020 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef HAL_WIFIAWARE_H +#define HAL_WIFIAWARE_H + +#ifdef __cplusplus +#if __cplusplus +extern "C" { +#endif +#endif /* __cplusplus */ + +enum { + HAL_WIFI_SDP_PUBLISH = 0x01, + HAL_WIFI_SDP_SUBSCRIBE = 0x02, + HAL_WIFI_SDP_BUTT +}; + +typedef int (*HalRecvCallback)(unsigned char* macAddr, unsigned char peerHandle, unsigned char localHandle, + unsigned char* msg, unsigned char len); + +int HalWifiSdpInit(const char* ifname); + +unsigned int HalCipherHashSha256(const char* input, unsigned int inputLen, unsigned char* hash, unsigned hashLen); + +int HalWifiSdpStartService(const char* svcName, unsigned char localHandle, HalRecvCallback recvCB, unsigned char role); + +int HalWifiSdpSend(unsigned char* macAddr, unsigned char peerHandle, unsigned char localHandle, + unsigned char* msg, int len); + +int HalWifiSdpStopService(unsigned char localHandle, unsigned char role); + +int HalWifiSdpDeinit(void); + +int HalWifiSdpAdjustTxPower(const char *ifname, signed char power); + +int HalWifiSdpRestoreTxPower(const char *ifname); + +int HalWifiSdpBeaconSwitch(const char *ifname, unsigned char enable); + +int HalWifiSdpSetRetryTimes(unsigned int retries); + +int HalWifiSdpGetSyncMode(void); + +#ifdef __cplusplus +#if __cplusplus +} +#endif +#endif /* __cplusplus */ + +#endif // HAL_WIFIAWARE_H \ No newline at end of file diff --git a/interfaces/kits/wifiaware.h b/interfaces/kits/wifiaware.h new file mode 100755 index 0000000..4a7a43f --- /dev/null +++ b/interfaces/kits/wifiaware.h @@ -0,0 +1,278 @@ +/* + * Copyright (c) 2020 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @addtogroup wifiaware + * @{ + * + * @brief Enables devices to interact with neighboring devices without connecting to a Wi-Fi network. + * + * + * Using the capabilities provided by this module, a Wi-Fi device can quickly discover and connect to other devices. \n + * + * @since 1.0 + * @version 1.0 + */ + +/** + * @file wifiaware.h + * + * @brief Defines functions of the Wi-Fi Aware module. + * + * You can use the functions to: \n + * + * + * @since 1.0 + * @version 1.0 + */ + +#ifndef WIFI_AWARE_H +#define WIFI_AWARE_H + +#ifdef __cplusplus +#if __cplusplus +extern "C" { +#endif +#endif /* __cplusplus */ + +/** + * @brief Indicates that short-distance transmission is enabled. + * + */ +#define WIFIAWARE_LOW_POWER_SWITCH_ON 1 +/** + * @brief Indicates that short-distance transmission is disabled. + * + */ +#define WIFIAWARE_LOW_POWER_SWITCH_OFF 0 + +/** + * @brief Indicates a successful operation. + * + */ +#define WIFIAWARE_SUCCESS 0 +/** + * @brief Indicates an operation failure. + * + */ +#define WIFIAWARE_FAIL (-1) + +/** + * @brief Indicates the default channel of Wi-Fi Aware, which is channel 6. + * + */ +#define WIFIAWARE_DEFAULT_CHANNEL 6 + +/** + * @brief Enumerates Neighbor Awareness Networking (NAN) synchronization modes. + * + */ +enum NanSyncMode { + /** Huawei private NAN synchronization */ + NAN_SYNC_MODE_PRIVATE, + /** Standard NAN synchronization */ + NAN_SYNC_MODE_STANDARD, + /** Both Huawei private and standard NAN synchronization */ + NAN_SYNC_MODE_BOTH, + /** BUTT value, which represents the total number of enumerated values (excluding the BUTT value itself) */ + NAN_SYNC_MODE_BUTT +}; + +/** + * @brief Defines the type of the callback that is invoked when the subscription service receives a message. + * + * This callback only processes time-efficient transactions. To process time-consuming transactions, you need to create + * specific tasks. + * + * @param macAddr Indicates the MAC address of the device that sends the message. + * @param peerHandle Indicates the instance ID of the device that sends the message. + * @param localHandle Indicates the instance ID of the device that receives the message. + * @param msg Indicates the message received. + * @param len Indicates the length of the message received. + * @return Returns {@link WIFIAWARE_SUCCESS} if the callback is invoked successfully; returns {@link WIFIAWARE_FAIL} + * otherwise. + * @since 1.0 + * @version 1.0 + */ +typedef int (*RecvCallback)(unsigned char* macAddr, unsigned char peerHandle, unsigned char localHandle, + unsigned char* msg, unsigned char len); + +/** + * @brief Initializes the Wi-Fi Aware module. + * + * Before using this function, ensure that the access point (AP) interface is enabled on the device and channel 6 is + * used. Otherwise, calling this function will fail. \n + * You can enable the AP interface using the corresponding function or AT command. \n + * + * @return Returns {@link WIFIAWARE_SUCCESS} if the Wi-Fi Aware module is initialized; returns {@link WIFIAWARE_FAIL} + * otherwise. + * @since 1.0 + * @version 1.0 + */ +int InitNAN(void); + +/** + * @brief Deinitializes the Wi-Fi Aware module. + * + * This function takes effect regardless of whether the module has been initialized. \n + * + * @return Returns {@link WIFIAWARE_SUCCESS} if the Wi-Fi Aware module is deinitialized; returns {@link WIFIAWARE_FAIL} + * otherwise. + * @since 1.0 + * @version 1.0 + */ +int DeinitNAN(void); + +/** + * @brief Starts the Wi-Fi Aware subscription service. + * + * + * Before using this function, call {@link InitNAN} to initialize the Wi-Fi Aware module. \n + * + * @param svcName Indicates the service name. It is a string and cannot be NULL. + * @param localHandle Indicates the instance ID of the local device associated with the service name. The value ranges + * from 1 to 255. It is used for identify authentication during device interaction. + * @param recvCB Indicates the callback invoked when the Wi-Fi Aware subscription service receives a message. + * @return Returns {@link WIFIAWARE_SUCCESS} if the Wi-Fi Aware subscription service is started; + * returns {@link WIFIAWARE_FAIL} otherwise. + * @since 1.0 + * @version 1.0 + */ +int SubscribeService(const char* svcName, unsigned char localHandle, RecvCallback recvCB); + +/** + * @brief Sends user data to the peer device. + * + * + * This is an asynchronous function. The return value only indicates whether the user data has been sent to + * the hardware driver. \n + * As this function does not check whether the MAC address and instance ID are valid, the caller should + * ensure their validity. \n + * + * @param macAddr Indicates the MAC address of the peer device. It contains 6 bytes. + * @param peerHandle Indicates the instance ID of the peer device. It contains 1 to 255 bytes. + * @param localHandle Indicates the instance ID of the local device specified when starting the Wi-Fi Aware + * subscription service. + * @param msg Indicates the user data to send. It cannot exceed 255 bytes. + * @param len Indicates the length of the user data to send. + * @return Returns {@link WIFIAWARE_SUCCESS} if the user data is sent to the hardware driver; + * returns {@link WIFIAWARE_FAIL} otherwise. + * @since 1.0 + * @version 1.0 + */ +int SendData(unsigned char* macAddr, unsigned char peerHandle, unsigned char localHandle, + unsigned char* msg, int len); + +/** + * @brief Stops the Wi-Fi Aware subscription service. + * + * + * Before using this function, call {@link InitNAN} to initialize the Wi-Fi Aware module. \n + * This function takes effect regardless of whether the Wi-Fi Aware subscription service has been started. \n + * + * @param localHandle Indicates the instance ID of the local device specified when starting the Wi-Fi Aware + * subscription service. + * @return Returns {@link WIFIAWARE_SUCCESS} if the Wi-Fi Aware subscription service is stopped; + * returns {@link WIFIAWARE_FAIL} otherwise. + * @since 1.0 + * @version 1.0 + */ +int StopSubscribe(unsigned char localHandle); + +/** + * @brief Sets whether to enable short-distance transmission. + * + * Short-distance transmission is determined by {@link WIFIAWARE_LOW_POWER_SWITCH_ON} + * and {@link WIFIAWARE_LOW_POWER_SWITCH_OFF}. \n + * When short-distance transmission is enabled, messages can be sent to devices + * within a distance of 30 cm from the local device. \n + * Before using this function, ensure that the AP interface is enabled. \n + * + * @param powerSwitch Specifies whether to enable short-distance transmission. The value can be + * {@link WIFIAWARE_LOW_POWER_SWITCH_ON} or {@link WIFIAWARE_LOW_POWER_SWITCH_OFF}. + * @return Returns {@link WIFIAWARE_SUCCESS} if short-distance transmission is set; + * returns {@link WIFIAWARE_FAIL} otherwise. + * @since 1.0 + * @version 1.0 + */ +int SetLowPower(int powerSwitch); + +/** + * @brief Sets the transmit power in short-distance transmission mode. + * + * If you call {@link SetLowPower} with powerSwitch set to {@link WIFIAWARE_LOW_POWER_SWITCH_ON},the Wi-Fi Aware + * module enters the short-distance transmission mode and sends data at the transmit power set by this function. \n + * Before using this function, ensure that the AP has been started. \n + * + * @param power Indicates the transmit power to set. The recommended value range is -70 dB to -42 dB, and the default + * value is -61 dB. + * @return Returns {@link WIFIAWARE_SUCCESS} if the transmit power is set; returns {@link WIFIAWARE_FAIL} otherwise. + * @since 2.2 + * @version 1.0 + */ +int SetPower(signed char value); + +/** + * @brief Sets whether the AP can be discovered. + * + * By default, the AP can be discovered. + * Before using this function, ensure that the AP has been started. \n + * + * @param enable Specifies whether the AP can be discovered. The value true indicates that the AP can be + * discovered, and false indicates the opposite. + * @return Returns {@link WIFIAWARE_SUCCESS} if the setting is successful; returns {@link WIFIAWARE_FAIL} otherwise. + * @since 2.2 + * @version 1.0 + */ +int NanBeaconSwitch(unsigned char enable); + +/** + * @brief Sets the number of NAN packet retransmissions in short-distance transmission mode. + * + * When you call {@link SendData} to send packets, the Wi-Fi Aware module will retransmit the packets based on the + * number set using this function once packet transmission fails. \n + * Before using this function, ensure that the AP has been started. \n + * + * @param retries Indicates the number of NAN packet retransmissions to set. The recommended value range is 0 to 200, + * and the default value is 200. + * @return Returns {@link WIFIAWARE_SUCCESS} if the number of NAN packet retransmissions is set; + * returns {@link WIFIAWARE_FAIL} otherwise. + * @since 2.2 + * @version 1.0 + */ +int NanSetRetryTimes(unsigned int retries); + +/** + * @brief Obtains the NAN synchronization mode supported by the Wi-Fi Aware module. + * + * @return Returns the NAN synchronization mode, as enumerated in {@link NanSyncMode}. + * @since 2.2 + * @version 1.0 + */ +int NanGetSyncMode(void); + +#ifdef __cplusplus +#if __cplusplus +} +#endif +#endif /* __cplusplus */ + +#endif +/** @} */ \ No newline at end of file