diff options
Diffstat (limited to 'thirdparty/nRF5_SDK_15.0.0_a53641a/examples/ble_central/experimental/ble_app_hrs_nfc_c/nfc_pair_m.h')
-rw-r--r-- | thirdparty/nRF5_SDK_15.0.0_a53641a/examples/ble_central/experimental/ble_app_hrs_nfc_c/nfc_pair_m.h | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/examples/ble_central/experimental/ble_app_hrs_nfc_c/nfc_pair_m.h b/thirdparty/nRF5_SDK_15.0.0_a53641a/examples/ble_central/experimental/ble_app_hrs_nfc_c/nfc_pair_m.h new file mode 100644 index 0000000..5d303a4 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/examples/ble_central/experimental/ble_app_hrs_nfc_c/nfc_pair_m.h @@ -0,0 +1,95 @@ +/** + * Copyright (c) 2016 - 2018, Nordic Semiconductor ASA + * + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form, except as embedded into a Nordic + * Semiconductor ASA integrated circuit in a product or a software update for + * such product, must reproduce the above copyright notice, this list of + * conditions and the following disclaimer in the documentation and/or other + * materials provided with the distribution. + * + * 3. Neither the name of Nordic Semiconductor ASA nor the names of its + * contributors may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * 4. This software, with or without modification, must only be used with a + * Nordic Semiconductor ASA integrated circuit. + * + * 5. Any software provided in binary form under this license must not be reverse + * engineered, decompiled, modified and/or disassembled. + * + * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS + * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE + * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + */ +/**@brief Application BLE NFC pairing module. + * + * @details This module contains functions used by the application to perform + * BLE Connection Handover pairing using NFC technology. It controls + * NFC reader and sends responses to the BLE stack pairing events. + */ + +#ifndef NFC_PAIR_M_H__ +#define NFC_PAIR_M_H__ + +#include <stdbool.h> +#include "ble_advdata.h" +#include "sdk_errors.h" +#include "ble_gap.h" + +/** + * @brief Function for initializing the NFC part of the application. + */ +void nfc_init(void); + +/** + * @brief Function for reading the NFC tag content. + * + * @details If an NFC tag has been read, the device disables the NFC reader and initiates + * BLE scanning to find and connect to the device whose tag has been found. + */ +void nfc_tag_process(void); + +/** + * @brief Function for checking if the given BLE device address matches the one which + * was found in the Connection Handover NDEF message. + * + * @param[in] p_peer_addr BLE device address to check. + * + * @retval true If the device addresses match. + * @retval false If the device addresses do not match. + */ +bool nfc_oob_pairing_tag_match(ble_gap_addr_t const * const p_peer_addr); + +/** + * @brief Function for notifying the NFC part of the application that the read Connection Handover + * NDEF Message is no longer valid. + */ +void nfc_oob_pairing_tag_invalidate(void); + +/** + * @brief Function for enabling the NFC reader and BLE pairing with a peripheral device. + */ +void nfc_pair_start(void); + +/** + * @brief Function for disabling the NFC reader and BLE pairing with a peripheral device. + */ +void nfc_pair_stop(void); + +#endif // NFC_PAIR_M_H__ |