CCAux  2.7.2.0
CCAux API reference
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator
Config.h
Go to the documentation of this file.
1 /************************************************
2 *
3 * CROSSCONTROL AUX API
4 *
5 * Config.h
6 *
7 * Version 2.7.2.0, 2014-08-25
8 *
9 * (c) maximatecc 2013
10 *
11 * File description:
12 * Configuration of various settings
13 *
14 * Use the function GetConfig() to get a handle to pass on to the other functions.
15 * Use the method Config_release(CONFIGHANDLE) to return the handle.
16 *
17 * Example Usage:
18 * @include config_example.cpp
19 *
20 ************************************************/
21 #ifndef CC_CONFIG_H
22 #define CC_CONFIG_H
23 
24 #include "CCAuxErrors.h"
25 #include "CCAuxTypes.h"
26 #include "CCPlatform.h"
27 
28 #ifdef __cplusplus
29 namespace CrossControl {
30 #endif
31 
32  typedef void* CONFIGHANDLE;
33 
37  const unsigned char Video1Conf = (1 << 0);
38  const unsigned char Video2Conf = (1 << 1);
39  const unsigned char Video3Conf = (1 << 2);
40  const unsigned char Video4Conf = (1 << 3);
56  EXTERN_C
57  CCAUXDLL_API
58  CONFIGHANDLE
59  CCAUXDLL_CALLING_CONV
60  GetConfig();
61 
72  EXTERN_C
73  CCAUXDLL_API
74  void
75  CCAUXDLL_CALLING_CONV
76  Config_release(CONFIGHANDLE);
77 
92  EXTERN_C
93  CCAUXDLL_API
94  eErr
95  CCAUXDLL_CALLING_CONV
96  Config_getStartupTriggerConfig(CONFIGHANDLE, TriggerConf* config);
97 
108  EXTERN_C
109  CCAUXDLL_API
110  eErr
111  CCAUXDLL_CALLING_CONV
112  Config_getShortButtonPressAction(CONFIGHANDLE, PowerAction* action);
113 
124  EXTERN_C
125  CCAUXDLL_API
126  eErr
127  CCAUXDLL_CALLING_CONV
128  Config_getLongButtonPressAction(CONFIGHANDLE, PowerAction* action);
129 
140  EXTERN_C
141  CCAUXDLL_API
142  eErr
143  CCAUXDLL_CALLING_CONV
144  Config_getOnOffSigAction(CONFIGHANDLE, PowerAction* action);
145 
158  EXTERN_C
159  CCAUXDLL_API
160  eErr
161  CCAUXDLL_CALLING_CONV
162  Config_getFrontBtnTrigTime(CONFIGHANDLE, unsigned short* triggertime);
163 
175  EXTERN_C
176  CCAUXDLL_API
177  eErr
178  CCAUXDLL_CALLING_CONV
179  Config_getExtOnOffSigTrigTime(CONFIGHANDLE, unsigned long* triggertime);
180 
194  EXTERN_C
195  CCAUXDLL_API
196  eErr
197  CCAUXDLL_CALLING_CONV
198  Config_getButtonFunction(CONFIGHANDLE, unsigned char button_number, ButtonConfigEnum* button_config);
199 
211  EXTERN_C
212  CCAUXDLL_API
213  eErr
214  CCAUXDLL_CALLING_CONV
215  Config_getSuspendMaxTime(CONFIGHANDLE, unsigned short* maxTime);
216 
229  EXTERN_C
230  CCAUXDLL_API
231  eErr
232  CCAUXDLL_CALLING_CONV
233  Config_getCanStartupPowerConfig(CONFIGHANDLE, CCStatus* status);
234 
248  EXTERN_C
249  CCAUXDLL_API
250  eErr
251  CCAUXDLL_CALLING_CONV
252  Config_getVideoStartupPowerConfig(CONFIGHANDLE, unsigned char* config);
253 
266  EXTERN_C
267  CCAUXDLL_API
268  eErr
269  CCAUXDLL_CALLING_CONV
270  Config_getExtFanStartupPowerConfig(CONFIGHANDLE, CCStatus* status);
271 
284  EXTERN_C
285  CCAUXDLL_API
286  eErr
287  CCAUXDLL_CALLING_CONV
288  Config_getStartupVoltageConfig(CONFIGHANDLE, double* voltage);
289 
301  EXTERN_C
302  CCAUXDLL_API
303  eErr
304  CCAUXDLL_CALLING_CONV
305  Config_getHeatingTempLimit(CONFIGHANDLE, signed short* temperature);
306 
319  EXTERN_C
320  CCAUXDLL_API
321  eErr
322  CCAUXDLL_CALLING_CONV
323  Config_getPowerOnStartup(CONFIGHANDLE, CCStatus* status);
324 
336  EXTERN_C
337  CCAUXDLL_API
338  eErr
339  CCAUXDLL_CALLING_CONV
340  Config_setStartupTriggerConfig(CONFIGHANDLE, TriggerConf conf);
341 
355  EXTERN_C
356  CCAUXDLL_API
357  eErr
358  CCAUXDLL_CALLING_CONV
359  Config_setShortButtonPressAction(CONFIGHANDLE, PowerAction action);
360 
371  EXTERN_C
372  CCAUXDLL_API
373  eErr
374  CCAUXDLL_CALLING_CONV
375  Config_setLongButtonPressAction(CONFIGHANDLE, PowerAction action);
376 
387  EXTERN_C
388  CCAUXDLL_API
389  eErr
390  CCAUXDLL_CALLING_CONV
391  Config_setOnOffSigAction(CONFIGHANDLE, PowerAction action);
392 
405  EXTERN_C
406  CCAUXDLL_API
407  eErr
408  CCAUXDLL_CALLING_CONV
409  Config_setFrontBtnTrigTime(CONFIGHANDLE, unsigned short triggertime);
410 
422  EXTERN_C
423  CCAUXDLL_API
424  eErr
425  CCAUXDLL_CALLING_CONV
426  Config_setExtOnOffSigTrigTime(CONFIGHANDLE, unsigned long triggertime);
427 
438  EXTERN_C
439  CCAUXDLL_API
440  eErr
441  CCAUXDLL_CALLING_CONV
442  Config_setButtonFunction(CONFIGHANDLE, unsigned char button_number, ButtonConfigEnum button_config);
443 
455  EXTERN_C
456  CCAUXDLL_API
457  eErr
458  CCAUXDLL_CALLING_CONV
459  Config_setSuspendMaxTime(CONFIGHANDLE, unsigned short maxTime);
460 
473  EXTERN_C
474  CCAUXDLL_API
475  eErr
476  CCAUXDLL_CALLING_CONV
477  Config_setCanStartupPowerConfig(CONFIGHANDLE, CCStatus status);
478 
492  EXTERN_C
493  CCAUXDLL_API
494  eErr
495  CCAUXDLL_CALLING_CONV
496  Config_setVideoStartupPowerConfig(CONFIGHANDLE, unsigned char config);
497 
509  EXTERN_C
510  CCAUXDLL_API
511  eErr
512  CCAUXDLL_CALLING_CONV
513  Config_setExtFanStartupPowerConfig(CONFIGHANDLE, CCStatus status);
514 
527  EXTERN_C
528  CCAUXDLL_API
529  eErr
530  CCAUXDLL_CALLING_CONV
531  Config_setStartupVoltageConfig(CONFIGHANDLE, double voltage);
532 
544  EXTERN_C
545  CCAUXDLL_API
546  eErr
547  CCAUXDLL_CALLING_CONV
548  Config_setHeatingTempLimit(CONFIGHANDLE, signed short temperature);
549 
562  EXTERN_C
563  CCAUXDLL_API
564  eErr
565  CCAUXDLL_CALLING_CONV
566  Config_setPowerOnStartup(CONFIGHANDLE, CCStatus status);
567 
578  EXTERN_C
579  CCAUXDLL_API
580  eErr
581  CCAUXDLL_CALLING_CONV
582  Config_setRS485Enabled (CONFIGHANDLE, RS4XXPort port, bool enabled);
583 
594  EXTERN_C
595  CCAUXDLL_API
596  eErr
597  CCAUXDLL_CALLING_CONV
598  Config_getRS485Enabled (CONFIGHANDLE, RS4XXPort port, bool* enabled);
599 
600 
601 
602 #ifdef __cplusplus
603 } /* namespace CrossControl */
604 #endif
605 
606 #endif /* CC_CONFIG_H */
607 
Generated on Mon Aug 25 2014 17:48:49 for CCAux by   doxygen 1.8.3.1