nochanges
Dependents: BLE_Acceleration_Statejudging
Fork of nRF51822 by
nordic/nrf-sdk/ble/ble_services/ble_ias.h@37:c29c330d942c, 2014-07-07 (annotated)
- Committer:
- Rohit Grover
- Date:
- Mon Jul 07 13:43:31 2014 +0100
- Revision:
- 37:c29c330d942c
changes required to upgrade to V7 of the soft-device
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Rohit Grover |
37:c29c330d942c | 1 | /* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved. |
Rohit Grover |
37:c29c330d942c | 2 | * |
Rohit Grover |
37:c29c330d942c | 3 | * The information contained herein is property of Nordic Semiconductor ASA. |
Rohit Grover |
37:c29c330d942c | 4 | * Terms and conditions of usage are described in detail in NORDIC |
Rohit Grover |
37:c29c330d942c | 5 | * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT. |
Rohit Grover |
37:c29c330d942c | 6 | * |
Rohit Grover |
37:c29c330d942c | 7 | * Licensees are granted free, non-transferable use of the information. NO |
Rohit Grover |
37:c29c330d942c | 8 | * WARRANTY of ANY KIND is provided. This heading must NOT be removed from |
Rohit Grover |
37:c29c330d942c | 9 | * the file. |
Rohit Grover |
37:c29c330d942c | 10 | * |
Rohit Grover |
37:c29c330d942c | 11 | */ |
Rohit Grover |
37:c29c330d942c | 12 | |
Rohit Grover |
37:c29c330d942c | 13 | /** @file |
Rohit Grover |
37:c29c330d942c | 14 | * |
Rohit Grover |
37:c29c330d942c | 15 | * @defgroup ble_sdk_srv_ias Immediate Alert Service |
Rohit Grover |
37:c29c330d942c | 16 | * @{ |
Rohit Grover |
37:c29c330d942c | 17 | * @ingroup ble_sdk_srv |
Rohit Grover |
37:c29c330d942c | 18 | * @brief Immediate Alert Service module. |
Rohit Grover |
37:c29c330d942c | 19 | * |
Rohit Grover |
37:c29c330d942c | 20 | * @details This module implements the Immediate Alert Service with the Alert Level characteristic. |
Rohit Grover |
37:c29c330d942c | 21 | * During initialization it adds the Immediate Alert Service and Alert Level characteristic |
Rohit Grover |
37:c29c330d942c | 22 | * to the BLE stack database. |
Rohit Grover |
37:c29c330d942c | 23 | * |
Rohit Grover |
37:c29c330d942c | 24 | * The application must supply an event handler for receiving Immediate Alert Service |
Rohit Grover |
37:c29c330d942c | 25 | * events. Using this handler, the service will notify the application when the |
Rohit Grover |
37:c29c330d942c | 26 | * Alert Level characteristic value changes. |
Rohit Grover |
37:c29c330d942c | 27 | * |
Rohit Grover |
37:c29c330d942c | 28 | * The service also provides a function for letting the application poll the current |
Rohit Grover |
37:c29c330d942c | 29 | * value of the Alert Level characteristic. |
Rohit Grover |
37:c29c330d942c | 30 | * |
Rohit Grover |
37:c29c330d942c | 31 | * @note The application must propagate BLE stack events to the Immediate Alert Service |
Rohit Grover |
37:c29c330d942c | 32 | * module by calling ble_ias_on_ble_evt() from the @ref ble_stack_handler callback. |
Rohit Grover |
37:c29c330d942c | 33 | * |
Rohit Grover |
37:c29c330d942c | 34 | * @note Attention! |
Rohit Grover |
37:c29c330d942c | 35 | * To maintain compliance with Nordic Semiconductor ASA Bluetooth profile |
Rohit Grover |
37:c29c330d942c | 36 | * qualification listings, this section of source code must not be modified. |
Rohit Grover |
37:c29c330d942c | 37 | */ |
Rohit Grover |
37:c29c330d942c | 38 | |
Rohit Grover |
37:c29c330d942c | 39 | #ifndef BLE_IAS_H__ |
Rohit Grover |
37:c29c330d942c | 40 | #define BLE_IAS_H__ |
Rohit Grover |
37:c29c330d942c | 41 | |
Rohit Grover |
37:c29c330d942c | 42 | #include <stdint.h> |
Rohit Grover |
37:c29c330d942c | 43 | #include "ble.h" |
Rohit Grover |
37:c29c330d942c | 44 | |
Rohit Grover |
37:c29c330d942c | 45 | /**@brief Immediate Alert Service event type. */ |
Rohit Grover |
37:c29c330d942c | 46 | typedef enum |
Rohit Grover |
37:c29c330d942c | 47 | { |
Rohit Grover |
37:c29c330d942c | 48 | BLE_IAS_EVT_ALERT_LEVEL_UPDATED /**< Alert Level Updated event. */ |
Rohit Grover |
37:c29c330d942c | 49 | } ble_ias_evt_type_t; |
Rohit Grover |
37:c29c330d942c | 50 | |
Rohit Grover |
37:c29c330d942c | 51 | /**@brief Immediate Alert Service event. */ |
Rohit Grover |
37:c29c330d942c | 52 | typedef struct |
Rohit Grover |
37:c29c330d942c | 53 | { |
Rohit Grover |
37:c29c330d942c | 54 | ble_ias_evt_type_t evt_type; /**< Type of event. */ |
Rohit Grover |
37:c29c330d942c | 55 | union |
Rohit Grover |
37:c29c330d942c | 56 | { |
Rohit Grover |
37:c29c330d942c | 57 | uint8_t alert_level; /**< New Alert Level value. */ |
Rohit Grover |
37:c29c330d942c | 58 | } params; |
Rohit Grover |
37:c29c330d942c | 59 | } ble_ias_evt_t; |
Rohit Grover |
37:c29c330d942c | 60 | |
Rohit Grover |
37:c29c330d942c | 61 | // Forward declaration of the ble_ias_t type. |
Rohit Grover |
37:c29c330d942c | 62 | typedef struct ble_ias_s ble_ias_t; |
Rohit Grover |
37:c29c330d942c | 63 | |
Rohit Grover |
37:c29c330d942c | 64 | /**@brief Immediate Alert Service event handler type. */ |
Rohit Grover |
37:c29c330d942c | 65 | typedef void (*ble_ias_evt_handler_t) (ble_ias_t * p_ias, ble_ias_evt_t * p_evt); |
Rohit Grover |
37:c29c330d942c | 66 | |
Rohit Grover |
37:c29c330d942c | 67 | /**@brief Immediate Alert Service init structure. This contains all options and data needed for |
Rohit Grover |
37:c29c330d942c | 68 | * initialization of the service. */ |
Rohit Grover |
37:c29c330d942c | 69 | typedef struct |
Rohit Grover |
37:c29c330d942c | 70 | { |
Rohit Grover |
37:c29c330d942c | 71 | ble_ias_evt_handler_t evt_handler; /**< Event handler to be called for handling events in the Immediate Alert Service. */ |
Rohit Grover |
37:c29c330d942c | 72 | } ble_ias_init_t; |
Rohit Grover |
37:c29c330d942c | 73 | |
Rohit Grover |
37:c29c330d942c | 74 | /**@brief Immediate Alert Service structure. This contains various status information for the |
Rohit Grover |
37:c29c330d942c | 75 | * service. */ |
Rohit Grover |
37:c29c330d942c | 76 | typedef struct ble_ias_s |
Rohit Grover |
37:c29c330d942c | 77 | { |
Rohit Grover |
37:c29c330d942c | 78 | ble_ias_evt_handler_t evt_handler; /**< Event handler to be called for handling events in the Immediate Alert Service. */ |
Rohit Grover |
37:c29c330d942c | 79 | uint16_t service_handle; /**< Handle of Immediate Alert Service (as provided by the BLE stack). */ |
Rohit Grover |
37:c29c330d942c | 80 | ble_gatts_char_handles_t alert_level_handles; /**< Handles related to the Alert Level characteristic. */ |
Rohit Grover |
37:c29c330d942c | 81 | } ble_ias_t; |
Rohit Grover |
37:c29c330d942c | 82 | |
Rohit Grover |
37:c29c330d942c | 83 | /**@brief Function for initializing the Immediate Alert Service. |
Rohit Grover |
37:c29c330d942c | 84 | * |
Rohit Grover |
37:c29c330d942c | 85 | * @param[out] p_ias Immediate Alert Service structure. This structure will have to be |
Rohit Grover |
37:c29c330d942c | 86 | * supplied by the application. It will be initialized by this function, |
Rohit Grover |
37:c29c330d942c | 87 | * and will later be used to identify this particular service instance. |
Rohit Grover |
37:c29c330d942c | 88 | * @param[in] p_ias_init Information needed to initialize the service. |
Rohit Grover |
37:c29c330d942c | 89 | * |
Rohit Grover |
37:c29c330d942c | 90 | * @return NRF_SUCCESS on successful initialization of service, otherwise an error code. |
Rohit Grover |
37:c29c330d942c | 91 | */ |
Rohit Grover |
37:c29c330d942c | 92 | uint32_t ble_ias_init(ble_ias_t * p_ias, const ble_ias_init_t * p_ias_init); |
Rohit Grover |
37:c29c330d942c | 93 | |
Rohit Grover |
37:c29c330d942c | 94 | /**@brief Function for handling the Application's BLE Stack events. |
Rohit Grover |
37:c29c330d942c | 95 | * |
Rohit Grover |
37:c29c330d942c | 96 | * @details Handles all events from the BLE stack of interest to the Immediate Alert Service. |
Rohit Grover |
37:c29c330d942c | 97 | * |
Rohit Grover |
37:c29c330d942c | 98 | * @param[in] p_ias Immediate Alert Service structure. |
Rohit Grover |
37:c29c330d942c | 99 | * @param[in] p_ble_evt Event received from the BLE stack. |
Rohit Grover |
37:c29c330d942c | 100 | */ |
Rohit Grover |
37:c29c330d942c | 101 | void ble_ias_on_ble_evt(ble_ias_t * p_ias, ble_evt_t * p_ble_evt); |
Rohit Grover |
37:c29c330d942c | 102 | |
Rohit Grover |
37:c29c330d942c | 103 | /**@brief Function for getting current value of the Alert Level characteristic. |
Rohit Grover |
37:c29c330d942c | 104 | * |
Rohit Grover |
37:c29c330d942c | 105 | * @param[in] p_ias Immediate Alert Service structure. |
Rohit Grover |
37:c29c330d942c | 106 | * @param[out] p_alert_level Current Alert Level value. |
Rohit Grover |
37:c29c330d942c | 107 | */ |
Rohit Grover |
37:c29c330d942c | 108 | uint32_t ble_ias_alert_level_get(ble_ias_t * p_ias, uint8_t * p_alert_level); |
Rohit Grover |
37:c29c330d942c | 109 | |
Rohit Grover |
37:c29c330d942c | 110 | #endif // BLE_IAS_H__ |
Rohit Grover |
37:c29c330d942c | 111 | |
Rohit Grover |
37:c29c330d942c | 112 | /** @} */ |