テスト用です。

Dependencies:   mbed

Committer:
jksoft
Date:
Tue Oct 11 11:09:42 2016 +0000
Revision:
0:8468a4403fea
SB??ver;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jksoft 0:8468a4403fea 1 /* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.
jksoft 0:8468a4403fea 2 *
jksoft 0:8468a4403fea 3 * The information contained herein is property of Nordic Semiconductor ASA.
jksoft 0:8468a4403fea 4 * Terms and conditions of usage are described in detail in NORDIC
jksoft 0:8468a4403fea 5 * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
jksoft 0:8468a4403fea 6 *
jksoft 0:8468a4403fea 7 * Licensees are granted free, non-transferable use of the information. NO
jksoft 0:8468a4403fea 8 * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
jksoft 0:8468a4403fea 9 * the file.
jksoft 0:8468a4403fea 10 *
jksoft 0:8468a4403fea 11 */
jksoft 0:8468a4403fea 12
jksoft 0:8468a4403fea 13 /** @file
jksoft 0:8468a4403fea 14 *
jksoft 0:8468a4403fea 15 * @defgroup ble_sdk_lib_conn_params Connection Parameters Negotiation
jksoft 0:8468a4403fea 16 * @{
jksoft 0:8468a4403fea 17 * @ingroup ble_sdk_lib
jksoft 0:8468a4403fea 18 * @brief Module for initiating and executing a connection parameters negotiation procedure.
jksoft 0:8468a4403fea 19 */
jksoft 0:8468a4403fea 20
jksoft 0:8468a4403fea 21 #ifndef BLE_CONN_PARAMS_H__
jksoft 0:8468a4403fea 22 #define BLE_CONN_PARAMS_H__
jksoft 0:8468a4403fea 23
jksoft 0:8468a4403fea 24 #include <stdint.h>
jksoft 0:8468a4403fea 25 #include "ble.h"
jksoft 0:8468a4403fea 26 #include "ble_srv_common.h"
jksoft 0:8468a4403fea 27
jksoft 0:8468a4403fea 28 #ifdef __cplusplus
jksoft 0:8468a4403fea 29 extern "C" {
jksoft 0:8468a4403fea 30 #endif // #ifdef __cplusplus
jksoft 0:8468a4403fea 31
jksoft 0:8468a4403fea 32 /**@brief Connection Parameters Module event type. */
jksoft 0:8468a4403fea 33 typedef enum
jksoft 0:8468a4403fea 34 {
jksoft 0:8468a4403fea 35 BLE_CONN_PARAMS_EVT_FAILED , /**< Negotiation procedure failed. */
jksoft 0:8468a4403fea 36 BLE_CONN_PARAMS_EVT_SUCCEEDED /**< Negotiation procedure succeeded. */
jksoft 0:8468a4403fea 37 } ble_conn_params_evt_type_t;
jksoft 0:8468a4403fea 38
jksoft 0:8468a4403fea 39 /**@brief Connection Parameters Module event. */
jksoft 0:8468a4403fea 40 typedef struct
jksoft 0:8468a4403fea 41 {
jksoft 0:8468a4403fea 42 ble_conn_params_evt_type_t evt_type; /**< Type of event. */
jksoft 0:8468a4403fea 43 } ble_conn_params_evt_t;
jksoft 0:8468a4403fea 44
jksoft 0:8468a4403fea 45 /**@brief Connection Parameters Module event handler type. */
jksoft 0:8468a4403fea 46 typedef void (*ble_conn_params_evt_handler_t) (ble_conn_params_evt_t * p_evt);
jksoft 0:8468a4403fea 47
jksoft 0:8468a4403fea 48 /**@brief Connection Parameters Module init structure. This contains all options and data needed for
jksoft 0:8468a4403fea 49 * initialization of the connection parameters negotiation module. */
jksoft 0:8468a4403fea 50 typedef struct
jksoft 0:8468a4403fea 51 {
jksoft 0:8468a4403fea 52 ble_gap_conn_params_t * p_conn_params; /**< Pointer to the connection parameters desired by the application. When calling ble_conn_params_init, if this parameter is set to NULL, the connection parameters will be fetched from host. */
jksoft 0:8468a4403fea 53 uint32_t first_conn_params_update_delay; /**< Time from initiating event (connect or start of notification) to first time sd_ble_gap_conn_param_update is called (in number of timer ticks). */
jksoft 0:8468a4403fea 54 uint32_t next_conn_params_update_delay; /**< Time between each call to sd_ble_gap_conn_param_update after the first (in number of timer ticks). Recommended value 30 seconds as per BLUETOOTH SPECIFICATION Version 4.0. */
jksoft 0:8468a4403fea 55 uint8_t max_conn_params_update_count; /**< Number of attempts before giving up the negotiation. */
jksoft 0:8468a4403fea 56 uint16_t start_on_notify_cccd_handle; /**< If procedure is to be started when notification is started, set this to the handle of the corresponding CCCD. Set to BLE_GATT_HANDLE_INVALID if procedure is to be started on connect event. */
jksoft 0:8468a4403fea 57 bool disconnect_on_fail; /**< Set to TRUE if a failed connection parameters update shall cause an automatic disconnection, set to FALSE otherwise. */
jksoft 0:8468a4403fea 58 ble_conn_params_evt_handler_t evt_handler; /**< Event handler to be called for handling events in the Connection Parameters. */
jksoft 0:8468a4403fea 59 ble_srv_error_handler_t error_handler; /**< Function to be called in case of an error. */
jksoft 0:8468a4403fea 60 } ble_conn_params_init_t;
jksoft 0:8468a4403fea 61
jksoft 0:8468a4403fea 62
jksoft 0:8468a4403fea 63 /**@brief Function for initializing the Connection Parameters module.
jksoft 0:8468a4403fea 64 *
jksoft 0:8468a4403fea 65 * @note If the negotiation procedure should be triggered when notification/indication of
jksoft 0:8468a4403fea 66 * any characteristic is enabled by the peer, then this function must be called after
jksoft 0:8468a4403fea 67 * having initialized the services.
jksoft 0:8468a4403fea 68 *
jksoft 0:8468a4403fea 69 * @param[in] p_init This contains information needed to initialize this module.
jksoft 0:8468a4403fea 70 *
jksoft 0:8468a4403fea 71 * @return NRF_SUCCESS on successful initialization, otherwise an error code.
jksoft 0:8468a4403fea 72 */
jksoft 0:8468a4403fea 73 uint32_t ble_conn_params_init(const ble_conn_params_init_t * p_init);
jksoft 0:8468a4403fea 74
jksoft 0:8468a4403fea 75 /**@brief Function for stopping the Connection Parameters module.
jksoft 0:8468a4403fea 76 *
jksoft 0:8468a4403fea 77 * @details This function is intended to be used by the application to clean up the connection
jksoft 0:8468a4403fea 78 * parameters update module. This will stop the connection parameters update timer if
jksoft 0:8468a4403fea 79 * running, thereby preventing any impending connection parameters update procedure. This
jksoft 0:8468a4403fea 80 * function must be called by the application when it needs to clean itself up (for
jksoft 0:8468a4403fea 81 * example, before disabling the bluetooth SoftDevice) so that an unwanted timer expiry
jksoft 0:8468a4403fea 82 * event can be avoided.
jksoft 0:8468a4403fea 83 *
jksoft 0:8468a4403fea 84 * @return NRF_SUCCESS on successful initialization, otherwise an error code.
jksoft 0:8468a4403fea 85 */
jksoft 0:8468a4403fea 86 uint32_t ble_conn_params_stop(void);
jksoft 0:8468a4403fea 87
jksoft 0:8468a4403fea 88 /**@brief Function for changing the current connection parameters to a new set.
jksoft 0:8468a4403fea 89 *
jksoft 0:8468a4403fea 90 * @details Use this function to change the connection parameters to a new set of parameter
jksoft 0:8468a4403fea 91 * (ie different from the ones given at init of the module).
jksoft 0:8468a4403fea 92 * This function is usefull for scenario where most of the time the application
jksoft 0:8468a4403fea 93 * needs a relatively big connection interval, and just sometimes, for a temporary
jksoft 0:8468a4403fea 94 * period requires shorter connection interval, for example to transfer a higher
jksoft 0:8468a4403fea 95 * amount of data.
jksoft 0:8468a4403fea 96 * If the given parameters does not match the current connection's parameters
jksoft 0:8468a4403fea 97 * this function initiates a new negotiation.
jksoft 0:8468a4403fea 98 *
jksoft 0:8468a4403fea 99 * @param[in] new_params This contains the new connections parameters to setup.
jksoft 0:8468a4403fea 100 *
jksoft 0:8468a4403fea 101 * @return NRF_SUCCESS on successful initialization, otherwise an error code.
jksoft 0:8468a4403fea 102 */
jksoft 0:8468a4403fea 103 uint32_t ble_conn_params_change_conn_params(ble_gap_conn_params_t *new_params);
jksoft 0:8468a4403fea 104
jksoft 0:8468a4403fea 105 /**@brief Function for handling the Application's BLE Stack events.
jksoft 0:8468a4403fea 106 *
jksoft 0:8468a4403fea 107 * @details Handles all events from the BLE stack that are of interest to this module.
jksoft 0:8468a4403fea 108 *
jksoft 0:8468a4403fea 109 * @param[in] p_ble_evt The event received from the BLE stack.
jksoft 0:8468a4403fea 110 */
jksoft 0:8468a4403fea 111 void ble_conn_params_on_ble_evt(ble_evt_t * p_ble_evt);
jksoft 0:8468a4403fea 112
jksoft 0:8468a4403fea 113 #endif // BLE_CONN_PARAMS_H__
jksoft 0:8468a4403fea 114
jksoft 0:8468a4403fea 115 /** @} */
jksoft 0:8468a4403fea 116
jksoft 0:8468a4403fea 117 #ifdef __cplusplus
jksoft 0:8468a4403fea 118 }
jksoft 0:8468a4403fea 119 #endif // #ifdef __cplusplus