Cordio Stack and Cordio Profiles  r2p3-02rel0
htpc_api.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief Health Thermometer profile client.
6  *
7  * Copyright (c) 2012-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 HTPC_API_H
20 #define HTPC_API_H
21 
22 #include "att_api.h"
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /*! \addtogroup HEALTH_THERMOMETER_PROFILE
29  * \{ */
30 
31 /**************************************************************************************************
32  Macros
33 **************************************************************************************************/
34 
35 /*! \brief Health Thermometer service enumeration of handle indexes of characteristics to be discovered */
36 enum
37 {
38  HTPC_HTS_TM_HDL_IDX, /*!< \brief Temperature measurement */
39  HTPC_HTS_TM_CCC_HDL_IDX, /*!< \brief Temperature measurement CCC descriptor */
40  HTPC_HTS_IT_HDL_IDX, /*!< \brief Intermediate temperature */
41  HTPC_HTS_IT_CCC_HDL_IDX, /*!< \brief Intermediate temperature CCC descriptor */
42  HTPC_HTS_TT_HDL_IDX, /*!< \brief Temperature type */
43  HTPC_HTS_HDL_LIST_LEN /*!< \brief Handle list length */
44 };
45 
46 /**************************************************************************************************
47  Function Declarations
48 **************************************************************************************************/
49 
50 /*************************************************************************************************/
51 /*!
52  * \brief Perform service and characteristic discovery for Health Thermometer service.
53  * Parameter pHdlList must point to an array of length \ref HTPC_HTS_HDL_LIST_LEN.
54  * If discovery is successful the handles of discovered characteristics and
55  * descriptors will be set in pHdlList.
56  *
57  * \param connId Connection identifier.
58  * \param pHdlList Characteristic handle list.
59  *
60  * \return None.
61  */
62 /*************************************************************************************************/
63 void HtpcHtsDiscover(dmConnId_t connId, uint16_t *pHdlList);
64 
65 /*************************************************************************************************/
66 /*!
67  * \brief Process a value received in an ATT read response, notification, or indication
68  * message. Parameter pHdlList must point to an array of length \ref HTPC_HTS_HDL_LIST_LEN.
69  * If the ATT handle of the message matches a handle in the handle list the value
70  * is processed, otherwise it is ignored.
71  *
72  * \param pHdlList Characteristc handle list.
73  * \param pMsg ATT callback message.
74  *
75  * \return \ref ATT_SUCCESS if handle is found, \ref ATT_ERR_NOT_FOUND otherwise.
76  */
77 /*************************************************************************************************/
79 
80 /*! \} */ /* HEALTH_THERMOMETER_PROFILE */
81 
82 #ifdef __cplusplus
83 };
84 #endif
85 
86 #endif /* HTPC_API_H */
uint8_t dmConnId_t
Connection identifier.
Definition: dm_api.h:501
ATT callback event.
Definition: att_api.h:154
Handle list length.
Definition: htpc_api.h:43
uint8_t HtpcHtsValueUpdate(uint16_t *pHdlList, attEvt_t *pMsg)
Process a value received in an ATT read response, notification, or indication message. Parameter pHdlList must point to an array of length HTPC_HTS_HDL_LIST_LEN. If the ATT handle of the message matches a handle in the handle list the value is processed, otherwise it is ignored.
Temperature measurement.
Definition: htpc_api.h:38
Temperature type.
Definition: htpc_api.h:42
Intermediate temperature CCC descriptor.
Definition: htpc_api.h:41
void HtpcHtsDiscover(dmConnId_t connId, uint16_t *pHdlList)
Perform service and characteristic discovery for Health Thermometer service. Parameter pHdlList must ...
unsigned short uint16_t
Unsigned 16-bit value.
Definition: wsf_types.h:67
Temperature measurement CCC descriptor.
Definition: htpc_api.h:39
Attribute protocol client and server API.
Intermediate temperature.
Definition: htpc_api.h:40
unsigned char uint8_t
Unsigned 8-bit value.
Definition: wsf_types.h:63