CCAux  2.8.3.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.8.3.0, 2016-04-06
8 *
9 * (c) maximatecc 2013
10 *
11 
12  * File description:
13  * Configuration of various settings
14  *
15  * Use the function GetConfig() to get a handle to pass on to the other functions.
16  * Use the method Config_release(CONFIGHANDLE) to return the handle.
17  *
18  * Example Usage:
19  * @include config_example.cpp
20  *
21  ************************************************/
22 #ifndef CC_CONFIG_H
23 #define CC_CONFIG_H
24 
25 #include "CCAuxErrors.h"
26 #include "CCAuxTypes.h"
27 #include "CCPlatform.h"
28 
29 #ifdef __cplusplus
30 namespace CrossControl {
31 #endif
32 
33  typedef void* CONFIGHANDLE;
34 
38  const unsigned char Video1Conf = (1 << 0);
39  const unsigned char Video2Conf = (1 << 1);
40  const unsigned char Video3Conf = (1 << 2);
41  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 
93  EXTERN_C
94  CCAUXDLL_API
95  eErr
96  CCAUXDLL_CALLING_CONV
97  Config_getStartupTriggerConfig(CONFIGHANDLE, TriggerConf* config);
98 
109  EXTERN_C
110  CCAUXDLL_API
111  eErr
112  CCAUXDLL_CALLING_CONV
113  Config_getShortButtonPressAction(CONFIGHANDLE, PowerAction* action);
114 
125  EXTERN_C
126  CCAUXDLL_API
127  eErr
128  CCAUXDLL_CALLING_CONV
129  Config_getLongButtonPressAction(CONFIGHANDLE, PowerAction* action);
130 
141  EXTERN_C
142  CCAUXDLL_API
143  eErr
144  CCAUXDLL_CALLING_CONV
145  Config_getOnOffSigAction(CONFIGHANDLE, PowerAction* action);
146 
159  EXTERN_C
160  CCAUXDLL_API
161  eErr
162  CCAUXDLL_CALLING_CONV
163  Config_getFrontBtnTrigTime(CONFIGHANDLE, unsigned short* triggertime);
164 
176  EXTERN_C
177  CCAUXDLL_API
178  eErr
179  CCAUXDLL_CALLING_CONV
180  Config_getExtOnOffSigTrigTime(CONFIGHANDLE, unsigned long* triggertime);
181 
195  EXTERN_C
196  CCAUXDLL_API
197  eErr
198  CCAUXDLL_CALLING_CONV
199  Config_getButtonFunction(CONFIGHANDLE, unsigned char button_number, ButtonConfigEnum* button_config);
200 
212  EXTERN_C
213  CCAUXDLL_API
214  eErr
215  CCAUXDLL_CALLING_CONV
216  Config_getSuspendMaxTime(CONFIGHANDLE, unsigned short* maxTime);
217 
230  EXTERN_C
231  CCAUXDLL_API
232  eErr
233  CCAUXDLL_CALLING_CONV
234  Config_getCanStartupPowerConfig(CONFIGHANDLE, CCStatus* status);
235 
249  EXTERN_C
250  CCAUXDLL_API
251  eErr
252  CCAUXDLL_CALLING_CONV
253  Config_getVideoStartupPowerConfig(CONFIGHANDLE, unsigned char* config);
254 
267  EXTERN_C
268  CCAUXDLL_API
269  eErr
270  CCAUXDLL_CALLING_CONV
271  Config_getExtFanStartupPowerConfig(CONFIGHANDLE, CCStatus* status);
272 
285  EXTERN_C
286  CCAUXDLL_API
287  eErr
288  CCAUXDLL_CALLING_CONV
289  Config_getStartupVoltageConfig(CONFIGHANDLE, double* voltage);
290 
302  EXTERN_C
303  CCAUXDLL_API
304  eErr
305  CCAUXDLL_CALLING_CONV
306  Config_getHeatingTempLimit(CONFIGHANDLE, signed short* temperature);
307 
320  EXTERN_C
321  CCAUXDLL_API
322  eErr
323  CCAUXDLL_CALLING_CONV
324  Config_getPowerOnStartup(CONFIGHANDLE, CCStatus* status);
325 
338  EXTERN_C
339  CCAUXDLL_API
340  eErr
341  CCAUXDLL_CALLING_CONV
342  Config_setStartupTriggerConfig(CONFIGHANDLE, TriggerConf conf);
343 
357  EXTERN_C
358  CCAUXDLL_API
359  eErr
360  CCAUXDLL_CALLING_CONV
361  Config_setShortButtonPressAction(CONFIGHANDLE, PowerAction action);
362 
373  EXTERN_C
374  CCAUXDLL_API
375  eErr
376  CCAUXDLL_CALLING_CONV
377  Config_setLongButtonPressAction(CONFIGHANDLE, PowerAction action);
378 
389  EXTERN_C
390  CCAUXDLL_API
391  eErr
392  CCAUXDLL_CALLING_CONV
393  Config_setOnOffSigAction(CONFIGHANDLE, PowerAction action);
394 
407  EXTERN_C
408  CCAUXDLL_API
409  eErr
410  CCAUXDLL_CALLING_CONV
411  Config_setFrontBtnTrigTime(CONFIGHANDLE, unsigned short triggertime);
412 
424  EXTERN_C
425  CCAUXDLL_API
426  eErr
427  CCAUXDLL_CALLING_CONV
428  Config_setExtOnOffSigTrigTime(CONFIGHANDLE, unsigned long triggertime);
429 
440  EXTERN_C
441  CCAUXDLL_API
442  eErr
443  CCAUXDLL_CALLING_CONV
444  Config_setButtonFunction(CONFIGHANDLE, unsigned char button_number, ButtonConfigEnum button_config);
445 
457  EXTERN_C
458  CCAUXDLL_API
459  eErr
460  CCAUXDLL_CALLING_CONV
461  Config_setSuspendMaxTime(CONFIGHANDLE, unsigned short maxTime);
462 
475  EXTERN_C
476  CCAUXDLL_API
477  eErr
478  CCAUXDLL_CALLING_CONV
479  Config_setCanStartupPowerConfig(CONFIGHANDLE, CCStatus status);
480 
494  EXTERN_C
495  CCAUXDLL_API
496  eErr
497  CCAUXDLL_CALLING_CONV
498  Config_setVideoStartupPowerConfig(CONFIGHANDLE, unsigned char config);
499 
511  EXTERN_C
512  CCAUXDLL_API
513  eErr
514  CCAUXDLL_CALLING_CONV
515  Config_setExtFanStartupPowerConfig(CONFIGHANDLE, CCStatus status);
516 
529  EXTERN_C
530  CCAUXDLL_API
531  eErr
532  CCAUXDLL_CALLING_CONV
533  Config_setStartupVoltageConfig(CONFIGHANDLE, double voltage);
534 
546  EXTERN_C
547  CCAUXDLL_API
548  eErr
549  CCAUXDLL_CALLING_CONV
550  Config_setHeatingTempLimit(CONFIGHANDLE, signed short temperature);
551 
564  EXTERN_C
565  CCAUXDLL_API
566  eErr
567  CCAUXDLL_CALLING_CONV
568  Config_setPowerOnStartup(CONFIGHANDLE, CCStatus status);
569 
580  EXTERN_C
581  CCAUXDLL_API
582  eErr
583  CCAUXDLL_CALLING_CONV
584  Config_setRS485Enabled (CONFIGHANDLE, RS4XXPort port, bool enabled);
585 
596  EXTERN_C
597  CCAUXDLL_API
598  eErr
599  CCAUXDLL_CALLING_CONV
600  Config_getRS485Enabled (CONFIGHANDLE, RS4XXPort port, bool* enabled);
601 
611  EXTERN_C
612  CCAUXDLL_API
613  eErr
614  CCAUXDLL_CALLING_CONV
615  Config_setOnOffTriggerMode (CONFIGHANDLE, ConfigOnOffTriggerMode mode);
616 
626  EXTERN_C
627  CCAUXDLL_API
628  eErr
629  CCAUXDLL_CALLING_CONV
630  Config_getOnOffTriggerMode (CONFIGHANDLE, ConfigOnOffTriggerMode* mode);
631 
641  EXTERN_C
642  CCAUXDLL_API
643  eErr
644  CCAUXDLL_CALLING_CONV
645  Config_getOnOffSignalState (CONFIGHANDLE, CCStatus *enabled);
646 
647 #ifdef __cplusplus
648 } /* namespace CrossControl */
649 #endif
650 
651 #endif /* CC_CONFIG_H */
652 
Generated on Wed Apr 6 2016 19:46:22 for CCAux by   doxygen 1.8.3.1