Cordio Stack and Cordio Profiles  r2p3-02rel0
fmpl_api.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief Find Me profile, locator role.
6  *
7  * Copyright (c) 2011-2018 Arm Ltd. All Rights Reserved.
8  * Arm Ltd. confidential and proprietary.
9  *
10  * IMPORTANT. Your use of this file is governed by a Software License Agreement
11  * ("Agreement") that must be accepted in order to download or otherwise receive a
12  * copy of this file. You may not use or copy this file for any purpose other than
13  * as described in the Agreement. If you do not agree to all of the terms of the
14  * Agreement do not use this file and delete all copies in your possession or control;
15  * if you do not have a copy of the Agreement, you must contact Arm Ltd. prior
16  * to any use, copying or further distribution of this software.
17  */
18 /*************************************************************************************************/
19 #ifndef FMPL_API_H
20 #define FMPL_API_H
21 
22 #include "att_api.h"
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /*! \addtogroup FIND_ME_PROFILE
29  * \{ */
30 
31 /**************************************************************************************************
32  Macros
33 **************************************************************************************************/
34 
35 /*! \brief Enumeration of handle indexes of characteristics to be discovered for immediate alert service */
36 enum
37 {
38  FMPL_IAS_AL_HDL_IDX, /*!< \brief Alert level */
39  FMPL_IAS_HDL_LIST_LEN /*!< \brief Handle list length */
40 };
41 
42 /**************************************************************************************************
43  Function Declarations
44 **************************************************************************************************/
45 
46 /*************************************************************************************************/
47 /*!
48  * \brief Perform service and characteristic discovery for Immediate Alert service. Note
49  * that pHdlList must point to an array of handles of length \ref FMPL_IAS_HDL_LIST_LEN.
50  * If discovery is successful the handles of discovered characteristics and
51  * descriptors will be set in pHdlList.
52  *
53  * \param connId Connection identifier.
54  * \param pHdlList Characteristic handle list.
55  *
56  * \return None.
57  */
58 /*************************************************************************************************/
59 void FmplIasDiscover(dmConnId_t connId, uint16_t *pHdlList);
60 
61 /*************************************************************************************************/
62 /*!
63  * \brief Send an immediate alert to the peer device.
64  *
65  * \param connId DM connection ID.
66  * \param handle Attribute handle.
67  * \param alert Alert value.
68  *
69  * \return None.
70  */
71 /*************************************************************************************************/
72 void FmplSendAlert(dmConnId_t connId, uint16_t handle, uint8_t alert);
73 
74 /*! \} */ /* FIND_ME_PROFILE */
75 
76 #ifdef __cplusplus
77 };
78 #endif
79 
80 #endif /* FMPL_API_H */
uint8_t dmConnId_t
Connection identifier.
Definition: dm_api.h:501
void FmplIasDiscover(dmConnId_t connId, uint16_t *pHdlList)
Perform service and characteristic discovery for Immediate Alert service. Note that pHdlList must poi...
Alert level.
Definition: fmpl_api.h:38
void FmplSendAlert(dmConnId_t connId, uint16_t handle, uint8_t alert)
Send an immediate alert to the peer device.
unsigned short uint16_t
Unsigned 16-bit value.
Definition: wsf_types.h:67
Handle list length.
Definition: fmpl_api.h:39
Attribute protocol client and server API.
unsigned char uint8_t
Unsigned 8-bit value.
Definition: wsf_types.h:63