CCAux  2.15.2.0
CCAux API reference
Config.h
Go to the documentation of this file.
1 /************************************************
2  *
3  * CROSSCONTROL AUX API
4  *
5  * Config.h
6  *
7  * Version 2.15.2.0, 2020-07-08
8  *
9  * (c) CrossControl 2010-2020
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 uint8_t Video1Conf = (1 << 0);
39  const uint8_t Video2Conf = (1 << 1);
40  const uint8_t Video3Conf = (1 << 2);
41  const uint8_t 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, uint16_t* triggertime);
164 
176  EXTERN_C
177  CCAUXDLL_API
178  eErr
179  CCAUXDLL_CALLING_CONV
180  Config_getExtOnOffSigTrigTime(CONFIGHANDLE, uint32_t* triggertime);
181 
195  EXTERN_C
196  CCAUXDLL_API
197  eErr
198  CCAUXDLL_CALLING_CONV
199  Config_getButtonFunction(CONFIGHANDLE, uint8_t button_number, ButtonConfigEnum* button_config);
200 
212  EXTERN_C
213  CCAUXDLL_API
214  eErr
215  CCAUXDLL_CALLING_CONV
216  Config_getSuspendMaxTime(CONFIGHANDLE, uint16_t* 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, uint8_t* 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, float64_t* voltage);
290 
302  EXTERN_C
303  CCAUXDLL_API
304  eErr
305  CCAUXDLL_CALLING_CONV
306  Config_getHeatingTempLimit(CONFIGHANDLE, int16_t* 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, uint16_t triggertime);
412 
424  EXTERN_C
425  CCAUXDLL_API
426  eErr
427  CCAUXDLL_CALLING_CONV
428  Config_setExtOnOffSigTrigTime(CONFIGHANDLE, uint32_t triggertime);
429 
440  EXTERN_C
441  CCAUXDLL_API
442  eErr
443  CCAUXDLL_CALLING_CONV
444  Config_setButtonFunction(CONFIGHANDLE, uint8_t button_number, ButtonConfigEnum button_config);
445 
457  EXTERN_C
458  CCAUXDLL_API
459  eErr
460  CCAUXDLL_CALLING_CONV
461  Config_setSuspendMaxTime(CONFIGHANDLE, uint16_t 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, uint8_t 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, float64_t voltage);
534 
546  EXTERN_C
547  CCAUXDLL_API
548  eErr
549  CCAUXDLL_CALLING_CONV
550  Config_setHeatingTempLimit(CONFIGHANDLE, int16_t 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_setNextBootMode (CONFIGHANDLE, BootModeEnum mode);
646 
656  EXTERN_C
657  CCAUXDLL_API
658  eErr
659  CCAUXDLL_CALLING_CONV
660  Config_getNextBootMode (CONFIGHANDLE, BootModeEnum *mode);
661 
671  EXTERN_C
672  CCAUXDLL_API
673  eErr
674  CCAUXDLL_CALLING_CONV
675  Config_setOSAliveMonitoring (CONFIGHANDLE, CCStatus enabled);
676 
686  EXTERN_C
687  CCAUXDLL_API
688  eErr
689  CCAUXDLL_CALLING_CONV
690  Config_getOSAliveMonitoring (CONFIGHANDLE, CCStatus *enabled);
691 
701  EXTERN_C
702  CCAUXDLL_API
703  eErr
704  CCAUXDLL_CALLING_CONV
705  Config_getOnOffSignalState (CONFIGHANDLE, CCStatus *enabled);
706 
718  EXTERN_C
719  CCAUXDLL_API
720  eErr
721  CCAUXDLL_CALLING_CONV
722  Config_getDigPowerOutputStartupConfig(CONFIGHANDLE, PowerOutput output, CCStatus* enabled);
723 
735  EXTERN_C
736  CCAUXDLL_API
737  eErr
738  CCAUXDLL_CALLING_CONV
739  Config_setDigPowerOutputStartupConfig(CONFIGHANDLE, PowerOutput output, CCStatus enabled);
740 
754  EXTERN_C
755  CCAUXDLL_API
756  eErr
757  CCAUXDLL_CALLING_CONV
758  Config_getShortBeepSettings (CONFIGHANDLE, uint16_t* duration, uint16_t* frequency, uint16_t* volume);
759 
773  EXTERN_C
774  CCAUXDLL_API
775  eErr
776  CCAUXDLL_CALLING_CONV
777  Config_setShortBeepSettings (CONFIGHANDLE, uint16_t duration, uint16_t frequency, uint16_t volume);
778 
792  EXTERN_C
793  CCAUXDLL_API
794  eErr
795  CCAUXDLL_CALLING_CONV
796  Config_getLongBeepSettings (CONFIGHANDLE, uint16_t* duration, uint16_t* frequency, uint16_t* volume);
797 
811  EXTERN_C
812  CCAUXDLL_API
813  eErr
814  CCAUXDLL_CALLING_CONV
815  Config_setLongBeepSettings (CONFIGHANDLE, uint16_t duration, uint16_t frequency, uint16_t volume);
816 
817 
818 #ifdef __cplusplus
819 } /* namespace CrossControl */
820 #endif
821 
822 #endif /* CC_CONFIG_H */
823 
CrossControl::Config_setNextBootMode
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setNextBootMode(CONFIGHANDLE, BootModeEnum mode)
CrossControl::GetConfig
EXTERN_C CCAUXDLL_API CONFIGHANDLE CCAUXDLL_CALLING_CONV GetConfig()
CrossControl::eErr
eErr
Definition: CCAuxTypes.h:159
CrossControl::Config_getExtOnOffSigTrigTime
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getExtOnOffSigTrigTime(CONFIGHANDLE, uint32_t *triggertime)
CCPlatform.h
float64_t
double float64_t
Definition: CCAuxTypes.h:26
CrossControl::Config_getOnOffTriggerMode
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getOnOffTriggerMode(CONFIGHANDLE, ConfigOnOffTriggerMode *mode)
CrossControl::CCStatus
CCStatus
Definition: CCAuxTypes.h:150
CrossControl::Video1Conf
const uint8_t Video1Conf
Definition: Config.h:38
CrossControl::PowerOutput
PowerOutput
Definition: CCAuxTypes.h:546
CrossControl::Config_getFrontBtnTrigTime
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getFrontBtnTrigTime(CONFIGHANDLE, uint16_t *triggertime)
CrossControl::Config_release
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV Config_release(CONFIGHANDLE)
CrossControl::Config_getExtFanStartupPowerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getExtFanStartupPowerConfig(CONFIGHANDLE, CCStatus *status)
CrossControl::Config_getStartupVoltageConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getStartupVoltageConfig(CONFIGHANDLE, float64_t *voltage)
CrossControl::Config_getLongButtonPressAction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getLongButtonPressAction(CONFIGHANDLE, PowerAction *action)
CrossControl::Config_getPowerOnStartup
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getPowerOnStartup(CONFIGHANDLE, CCStatus *status)
CrossControl::Video4Conf
const uint8_t Video4Conf
Definition: Config.h:41
CrossControl
Definition: About.h:30
CrossControl::Config_getLongBeepSettings
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getLongBeepSettings(CONFIGHANDLE, uint16_t *duration, uint16_t *frequency, uint16_t *volume)
CrossControl::Config_getOnOffSigAction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getOnOffSigAction(CONFIGHANDLE, PowerAction *action)
CrossControl::Config_setPowerOnStartup
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setPowerOnStartup(CONFIGHANDLE, CCStatus status)
uint16_t
unsigned short uint16_t
Definition: CCAuxTypes.h:48
CrossControl::Config_setLongBeepSettings
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setLongBeepSettings(CONFIGHANDLE, uint16_t duration, uint16_t frequency, uint16_t volume)
CrossControl::CONFIGHANDLE
void * CONFIGHANDLE
Definition: Config.h:33
CrossControl::Config_setFrontBtnTrigTime
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setFrontBtnTrigTime(CONFIGHANDLE, uint16_t triggertime)
CrossControl::Config_setHeatingTempLimit
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setHeatingTempLimit(CONFIGHANDLE, int16_t temperature)
CrossControl::Video2Conf
const uint8_t Video2Conf
Definition: Config.h:39
uint32_t
unsigned int uint32_t
Definition: CCAuxTypes.h:49
CrossControl::TriggerConf
TriggerConf
Definition: CCAuxTypes.h:326
CrossControl::PowerAction
PowerAction
Definition: CCAuxTypes.h:346
CrossControl::RS4XXPort
RS4XXPort
Definition: CCAuxTypes.h:452
CrossControl::Config_setOnOffSigAction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setOnOffSigAction(CONFIGHANDLE, PowerAction action)
CrossControl::Config_getDigPowerOutputStartupConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getDigPowerOutputStartupConfig(CONFIGHANDLE, PowerOutput output, CCStatus *enabled)
uint8_t
unsigned char uint8_t
Definition: CCAuxTypes.h:47
CrossControl::Config_getCanStartupPowerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getCanStartupPowerConfig(CONFIGHANDLE, CCStatus *status)
CrossControl::Config_setLongButtonPressAction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setLongButtonPressAction(CONFIGHANDLE, PowerAction action)
CrossControl::Config_setExtOnOffSigTrigTime
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setExtOnOffSigTrigTime(CONFIGHANDLE, uint32_t triggertime)
CCAuxTypes.h
CCAuxErrors.h
CrossControl::Config_getNextBootMode
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getNextBootMode(CONFIGHANDLE, BootModeEnum *mode)
CrossControl::Config_setDigPowerOutputStartupConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setDigPowerOutputStartupConfig(CONFIGHANDLE, PowerOutput output, CCStatus enabled)
CrossControl::Config_getHeatingTempLimit
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getHeatingTempLimit(CONFIGHANDLE, int16_t *temperature)
CrossControl::Config_setCanStartupPowerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setCanStartupPowerConfig(CONFIGHANDLE, CCStatus status)
int16_t
signed short int16_t
Definition: CCAuxTypes.h:45
CrossControl::Config_setExtFanStartupPowerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setExtFanStartupPowerConfig(CONFIGHANDLE, CCStatus status)
CrossControl::Config_getButtonFunction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getButtonFunction(CONFIGHANDLE, uint8_t button_number, ButtonConfigEnum *button_config)
CrossControl::Config_getShortButtonPressAction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getShortButtonPressAction(CONFIGHANDLE, PowerAction *action)
CrossControl::Config_setStartupVoltageConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setStartupVoltageConfig(CONFIGHANDLE, float64_t voltage)
CrossControl::Config_setStartupTriggerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setStartupTriggerConfig(CONFIGHANDLE, TriggerConf conf)
CrossControl::Config_getSuspendMaxTime
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getSuspendMaxTime(CONFIGHANDLE, uint16_t *maxTime)
CrossControl::Config_setOnOffTriggerMode
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setOnOffTriggerMode(CONFIGHANDLE, ConfigOnOffTriggerMode mode)
CrossControl::BootModeEnum
BootModeEnum
Definition: CCAuxTypes.h:527
CrossControl::Config_setShortButtonPressAction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setShortButtonPressAction(CONFIGHANDLE, PowerAction action)
CrossControl::Config_getVideoStartupPowerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getVideoStartupPowerConfig(CONFIGHANDLE, uint8_t *config)
CrossControl::Config_setSuspendMaxTime
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setSuspendMaxTime(CONFIGHANDLE, uint16_t maxTime)
CrossControl::Config_getOSAliveMonitoring
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getOSAliveMonitoring(CONFIGHANDLE, CCStatus *enabled)
CrossControl::Config_getShortBeepSettings
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getShortBeepSettings(CONFIGHANDLE, uint16_t *duration, uint16_t *frequency, uint16_t *volume)
CrossControl::ButtonConfigEnum
ButtonConfigEnum
Definition: CCAuxTypes.h:512
CrossControl::Config_setShortBeepSettings
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setShortBeepSettings(CONFIGHANDLE, uint16_t duration, uint16_t frequency, uint16_t volume)
CrossControl::Config_setOSAliveMonitoring
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setOSAliveMonitoring(CONFIGHANDLE, CCStatus enabled)
CrossControl::Config_getStartupTriggerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getStartupTriggerConfig(CONFIGHANDLE, TriggerConf *config)
CrossControl::Config_getOnOffSignalState
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getOnOffSignalState(CONFIGHANDLE, CCStatus *enabled)
CrossControl::Config_setVideoStartupPowerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setVideoStartupPowerConfig(CONFIGHANDLE, uint8_t config)
CrossControl::Video3Conf
const uint8_t Video3Conf
Definition: Config.h:40
CrossControl::Config_getRS485Enabled
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getRS485Enabled(CONFIGHANDLE, RS4XXPort port, bool *enabled)
CrossControl::Config_setButtonFunction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setButtonFunction(CONFIGHANDLE, uint8_t button_number, ButtonConfigEnum button_config)
CrossControl::Config_setRS485Enabled
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setRS485Enabled(CONFIGHANDLE, RS4XXPort port, bool enabled)
CrossControl::ConfigOnOffTriggerMode
ConfigOnOffTriggerMode
Definition: CCAuxTypes.h:539
Generated on Wed Jul 8 2020 12:44:31 for CCAux by   doxygen 1.8.14