CCAux  2.12.0.0
CCAux API reference
DigIO.h
Go to the documentation of this file.
1 /************************************************
2 *
3 * CROSSCONTROL AUX API
4 *
5 * DigIO.h
6 *
7 * Version 2.12.0.0, 2017-12-21
8 *
9 * (c) CrossControl 2010-2017
10 *
11 
12  * File description:
13  * Read digital inputs
14  *
15  * Use the function GetDigIO() to get a handle to pass on to the other functions.
16  * Use the method DigIO_release(DIGIOHANDLE) to return the handle.
17  *
18  * Example Usage:
19  * @include digio_example.cpp
20  *
21  ************************************************/
22 #ifndef CC_DIGIO_H
23 #define CC_DIGIO_H
24 
25 #include "CCAuxErrors.h"
26 #include "CCPlatform.h"
27 
28 #ifdef __cplusplus
29 namespace CrossControl {
30 #endif
31 
32  typedef void* DIGIOHANDLE;
33 
37  const uint8_t DigitalIn_1 = (1 << 0);
38  const uint8_t DigitalIn_2 = (1 << 1);
39  const uint8_t DigitalIn_3 = (1 << 2);
40  const uint8_t DigitalIn_4 = (1 << 3);
41 
55  EXTERN_C
56  CCAUXDLL_API
57  DIGIOHANDLE
58  CCAUXDLL_CALLING_CONV
59  GetDigIO(void);
60 
71  EXTERN_C
72  CCAUXDLL_API
73  void
74  CCAUXDLL_CALLING_CONV
75  DigIO_release(DIGIOHANDLE);
76 
94  EXTERN_C
95  CCAUXDLL_API
96  eErr
97  CCAUXDLL_CALLING_CONV
98  DigIO_getDigIO (DIGIOHANDLE, uint8_t* status);
99 
117  EXTERN_C
118  CCAUXDLL_API
119  eErr
120  CCAUXDLL_CALLING_CONV
121  DigIO_setDigIO (DIGIOHANDLE, uint8_t state);
122 
149  EXTERN_C
150  CCAUXDLL_API
151  eErr
152  CCAUXDLL_CALLING_CONV
153  DigIO_getDigPowerOutput(DIGIOHANDLE, PowerOutput output, CCStatus* enabled, uint8_t* status);
154 
155 
172  EXTERN_C
173  CCAUXDLL_API
174  eErr
175  CCAUXDLL_CALLING_CONV
176  DigIO_setDigPowerOutput(DIGIOHANDLE, PowerOutput output, CCStatus enabled);
177 
178 
179 #ifdef __cplusplus
180 } /* namespace CrossControl */
181 #endif
182 
183 #endif /* CC_DIGIO_H */
184 
eErr
Definition: CCAuxTypes.h:154
const uint8_t DigitalIn_3
Definition: DigIO.h:39
const uint8_t DigitalIn_2
Definition: DigIO.h:38
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV DigIO_setDigIO(DIGIOHANDLE, uint8_t state)
CCStatus
Definition: CCAuxTypes.h:145
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV DigIO_setDigPowerOutput(DIGIOHANDLE, PowerOutput output, CCStatus enabled)
PowerOutput
Definition: CCAuxTypes.h:538
Definition: About.h:30
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV DigIO_release(DIGIOHANDLE)
const uint8_t DigitalIn_4
Definition: DigIO.h:40
unsigned char uint8_t
Definition: CCAuxTypes.h:47
void * DIGIOHANDLE
Definition: DigIO.h:32
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV DigIO_getDigIO(DIGIOHANDLE, uint8_t *status)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV DigIO_getDigPowerOutput(DIGIOHANDLE, PowerOutput output, CCStatus *enabled, uint8_t *status)
const uint8_t DigitalIn_1
Definition: DigIO.h:37
EXTERN_C CCAUXDLL_API DIGIOHANDLE CCAUXDLL_CALLING_CONV GetDigIO(void)