Cordio Stack and Cordio Profiles  r2p3-02rel0
gyro_api.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief Example gyroscope service profile.
6 *
7  * Copyright (c) 2015-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 
20 #ifndef GYRO_API_H
21 #define GYRO_API_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /*! \addtogroup GYROSCOPE_SERVICE_PROFILE
28  * \{ */
29 
30 #include "wsf_types.h"
31 #include "wsf_os.h"
32 
33 /*************************************************************************************************/
34 /*!
35  * \brief Start service.
36  *
37  * \param handlerId Handler ID.
38  * \param timerEvt Timer message event.
39  *
40  * \return None.
41  */
42 /*************************************************************************************************/
43 void GyroStart(wsfHandlerId_t handlerId, uint8_t timerEvt);
44 
45 /*************************************************************************************************/
46 /*!
47  * \brief Stop service.
48  *
49  * \return None.
50  */
51 /*************************************************************************************************/
52 void GyroStop(void);
53 
54 /*************************************************************************************************/
55 /*!
56  * \brief Measurement stop handler.
57  *
58  * \return None.
59  */
60 /*************************************************************************************************/
61 void GyroMeasStop(void);
62 
63 /*************************************************************************************************/
64 /*!
65  * \brief Measurement start handler.
66  *
67  * \return None.
68  */
69 /*************************************************************************************************/
70 void GyroMeasStart(void);
71 
72 /*************************************************************************************************/
73 /*!
74  * \brief Measurement complete handler.
75  *
76  * \param connId Connection ID.
77  * \param x Gyroscope x-axis reading.
78  * \param y Gyroscope y-axis reading.
79  * \param z Gyroscope z-axis reading.
80  *
81  * \return None.
82  */
83 /*************************************************************************************************/
84 void GyroMeasComplete(dmConnId_t connId, int16_t x, int16_t y, int16_t z);
85 
86 /*! \} */ /* GYROSCOPE_SERVICE_PROFILE */
87 
88 #ifdef __cplusplus
89 };
90 #endif
91 
92 #endif /* GYRO_API_H */
void GyroStop(void)
Stop service.
uint8_t dmConnId_t
Connection identifier.
Definition: dm_api.h:501
void GyroMeasComplete(dmConnId_t connId, int16_t x, int16_t y, int16_t z)
Measurement complete handler.
void GyroMeasStart(void)
Measurement start handler.
Platform-independent data types.
uint8_t wsfHandlerId_t
Event handler ID data type.
Definition: wsf_os.h:74
void GyroMeasStop(void)
Measurement stop handler.
void GyroStart(wsfHandlerId_t handlerId, uint8_t timerEvt)
Start service.
Software foundation OS API.
unsigned char uint8_t
Unsigned 8-bit value.
Definition: wsf_types.h:63
signed short int16_t
Signed 16-bit value.
Definition: wsf_types.h:65