Cordio Stack and Cordio Profiles  r2p3-02rel0
wdxs_stream.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief Wireless Data Exchange profile implementation - Stream Example.
6  *
7  * Copyright (c) 2013-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 WDXS_STREAM_H
21 #define WDXS_STREAM_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /*! \addtogroup WIRELESS_DATA_EXCHANGE_PROFILE
28  * \{ */
29 
30 /**************************************************************************************************
31  Constant Definitions
32 **************************************************************************************************/
33 
34 /** \name WDXS Stream Waveform Types
35  * Type of waveform to output from the Example Stream
36  */
37 /**@{*/
38 #define WDXS_STREAM_WAVEFORM_SINE 0
39 #define WDXS_STREAM_WAVEFORM_STEP 1
40 #define WDXS_STREAM_WAVEFORM_SAWTOOTH 2
41 /**@}*/
42 
43 /**************************************************************************************************
44  Function Declarations
45 **************************************************************************************************/
46 
47 /*************************************************************************************************/
48 /*!
49  * \brief Example of creating a WDXS stream.
50  *
51  * \return None.
52  */
53 /*************************************************************************************************/
54 void wdxsStreamInit(void);
55 
56 /*************************************************************************************************/
57 /*!
58  * \brief Changes the type of waveform transmitted by the stream.
59  *
60  * \param type - Identifier of the waveform
61  *
62  * \return None.
63  */
64 /*************************************************************************************************/
66 
67 /*! \} */ /* WIRELESS_DATA_EXCHANGE_PROFILE */
68 
69 #ifdef __cplusplus
70 }
71 #endif
72 
73 #endif /* WDXS_STREAM_H */
74 
void wdxsStreamInit(void)
Example of creating a WDXS stream.
void wdxsSetStreamWaveform(uint8_t type)
Changes the type of waveform transmitted by the stream.
unsigned char uint8_t
Unsigned 8-bit value.
Definition: wsf_types.h:63