All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
vexanalog.h
Go to the documentation of this file.
1 /*-----------------------------------------------------------------------------*/
2 /* */
3 /* Copyright (c) James Pearman */
4 /* 2013 */
5 /* All Rights Reserved */
6 /* */
7 /*-----------------------------------------------------------------------------*/
8 /* */
9 /* Module: vexadc.h */
10 /* Author: James Pearman */
11 /* Created: 7 May 2013 */
12 /* */
13 /* Revisions: */
14 /* V1.00 4 July 2013 - Initial release */
15 /* */
16 /*-----------------------------------------------------------------------------*/
17 /* */
18 /* This file is part of ConVEX. */
19 /* */
20 /* The author is supplying this software for use with the VEX cortex */
21 /* control system. ConVEX is free software; you can redistribute it */
22 /* and/or modify it under the terms of the GNU General Public License */
23 /* as published by the Free Software Foundation; either version 3 of */
24 /* the License, or (at your option) any later version. */
25 /* */
26 /* ConVEX is distributed in the hope that it will be useful, */
27 /* but WITHOUT ANY WARRANTY; without even the implied warranty of */
28 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
29 /* GNU General Public License for more details. */
30 /* */
31 /* You should have received a copy of the GNU General Public License */
32 /* along with this program. If not, see <http://www.gnu.org/licenses/>. */
33 /* */
34 /* A special exception to the GPL can be applied should you wish to */
35 /* distribute a combined work that includes ConVEX, without being obliged */
36 /* to provide the source code for any proprietary components. */
37 /* See the file exception.txt for full details of how and when the */
38 /* exception can be applied. */
39 /* */
40 /* The author can be contacted on the vex forums as jpearman */
41 /* or electronic mail using jbpearman_at_mac_dot_com */
42 /* Mentor for team 8888 RoboLancers, Pasadena CA. */
43 /* */
44 /*-----------------------------------------------------------------------------*/
45 
46 #ifndef __VEXADC__
47 #define __VEXADC__
48 
49 /*-----------------------------------------------------------------------------*/
50 /** @file vexanalog.h
51  * @brief Analog port driver macros and prototypes
52 *//*---------------------------------------------------------------------------*/
53 
54 /*-----------------------------------------------------------------------------*/
55 /** @brief enumeration for the 8 analog ports */
56 /*-----------------------------------------------------------------------------*/
57 /** @details
58  * The cortex has 8 analog ports, kVexAnalog_None causes enum to be signed.
59  */
60 typedef enum {
61  kVexAnalog_None = -1,
62  kVexAnalog_1 = 0,
63  kVexAnalog_2,
64  kVexAnalog_3,
65  kVexAnalog_4,
66  kVexAnalog_5,
67  kVexAnalog_6,
68  kVexAnalog_7,
69  kVexAnalog_8,
70 
71  kVexAnalog_Num
72  } tVexAnalogPin;
73 
74 #ifdef __cplusplus
75 extern "C" {
76 #endif
77 
78 void vexAdcInit( void );
79 int16_t vexAdcGet( int16_t index );
80 void vexAdcDebug( vexStream *chp, int argc, char *argv[] );
81 
82 #ifdef __cplusplus
83 }
84 #endif
85 
86 #endif // __VEXADC__