CCAux  2.17.5.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.17.5.0", 2020-10-19
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);
62  EXTERN_C
63  CCAUXDLL_API
64  CONFIGHANDLE
65  CCAUXDLL_CALLING_CONV
66  GetConfig();
67 
78  EXTERN_C
79  CCAUXDLL_API
80  void
81  CCAUXDLL_CALLING_CONV
82  Config_release(CONFIGHANDLE);
83 
99  EXTERN_C
100  CCAUXDLL_API
101  eErr
102  CCAUXDLL_CALLING_CONV
103  Config_getStartupTriggerConfig(CONFIGHANDLE, TriggerConf* config);
104 
115  EXTERN_C
116  CCAUXDLL_API
117  eErr
118  CCAUXDLL_CALLING_CONV
119  Config_getShortButtonPressAction(CONFIGHANDLE, PowerAction* action);
120 
131  EXTERN_C
132  CCAUXDLL_API
133  eErr
134  CCAUXDLL_CALLING_CONV
135  Config_getLongButtonPressAction(CONFIGHANDLE, PowerAction* action);
136 
147  EXTERN_C
148  CCAUXDLL_API
149  eErr
150  CCAUXDLL_CALLING_CONV
151  Config_getOnOffSigAction(CONFIGHANDLE, PowerAction* action);
152 
165  EXTERN_C
166  CCAUXDLL_API
167  eErr
168  CCAUXDLL_CALLING_CONV
169  Config_getFrontBtnTrigTime(CONFIGHANDLE, uint16_t* triggertime);
170 
182  EXTERN_C
183  CCAUXDLL_API
184  eErr
185  CCAUXDLL_CALLING_CONV
186  Config_getExtOnOffSigTrigTime(CONFIGHANDLE, uint32_t* triggertime);
187 
201  EXTERN_C
202  CCAUXDLL_API
203  eErr
204  CCAUXDLL_CALLING_CONV
205  Config_getButtonFunction(CONFIGHANDLE, uint8_t button_number, ButtonConfigEnum* button_config);
206 
218  EXTERN_C
219  CCAUXDLL_API
220  eErr
221  CCAUXDLL_CALLING_CONV
222  Config_getSuspendMaxTime(CONFIGHANDLE, uint16_t* maxTime);
223 
236  EXTERN_C
237  CCAUXDLL_API
238  eErr
239  CCAUXDLL_CALLING_CONV
240  Config_getCanStartupPowerConfig(CONFIGHANDLE, CCStatus* status);
241 
255  EXTERN_C
256  CCAUXDLL_API
257  eErr
258  CCAUXDLL_CALLING_CONV
259  Config_getVideoStartupPowerConfig(CONFIGHANDLE, uint8_t* config);
260 
273  EXTERN_C
274  CCAUXDLL_API
275  eErr
276  CCAUXDLL_CALLING_CONV
277  Config_getExtFanStartupPowerConfig(CONFIGHANDLE, CCStatus* status);
278 
291  EXTERN_C
292  CCAUXDLL_API
293  eErr
294  CCAUXDLL_CALLING_CONV
295  Config_getStartupVoltageConfig(CONFIGHANDLE, float64_t* voltage);
296 
308  EXTERN_C
309  CCAUXDLL_API
310  eErr
311  CCAUXDLL_CALLING_CONV
312  Config_getHeatingTempLimit(CONFIGHANDLE, int16_t* temperature);
313 
326  EXTERN_C
327  CCAUXDLL_API
328  eErr
329  CCAUXDLL_CALLING_CONV
330  Config_getPowerOnStartup(CONFIGHANDLE, CCStatus* status);
331 
345  EXTERN_C
346  CCAUXDLL_API
347  eErr
348  CCAUXDLL_CALLING_CONV
349  Config_setStartupTriggerConfig(CONFIGHANDLE, TriggerConf conf);
350 
364  EXTERN_C
365  CCAUXDLL_API
366  eErr
367  CCAUXDLL_CALLING_CONV
368  Config_setShortButtonPressAction(CONFIGHANDLE, PowerAction action);
369 
380  EXTERN_C
381  CCAUXDLL_API
382  eErr
383  CCAUXDLL_CALLING_CONV
384  Config_setLongButtonPressAction(CONFIGHANDLE, PowerAction action);
385 
396  EXTERN_C
397  CCAUXDLL_API
398  eErr
399  CCAUXDLL_CALLING_CONV
400  Config_setOnOffSigAction(CONFIGHANDLE, PowerAction action);
401 
416  EXTERN_C
417  CCAUXDLL_API
418  eErr
419  CCAUXDLL_CALLING_CONV
420  Config_setFrontBtnTrigTime(CONFIGHANDLE, uint16_t triggertime);
421 
433  EXTERN_C
434  CCAUXDLL_API
435  eErr
436  CCAUXDLL_CALLING_CONV
437  Config_setExtOnOffSigTrigTime(CONFIGHANDLE, uint32_t triggertime);
438 
449  EXTERN_C
450  CCAUXDLL_API
451  eErr
452  CCAUXDLL_CALLING_CONV
453  Config_setButtonFunction(CONFIGHANDLE, uint8_t button_number, ButtonConfigEnum button_config);
454 
466  EXTERN_C
467  CCAUXDLL_API
468  eErr
469  CCAUXDLL_CALLING_CONV
470  Config_setSuspendMaxTime(CONFIGHANDLE, uint16_t maxTime);
471 
484  EXTERN_C
485  CCAUXDLL_API
486  eErr
487  CCAUXDLL_CALLING_CONV
488  Config_setCanStartupPowerConfig(CONFIGHANDLE, CCStatus status);
489 
503  EXTERN_C
504  CCAUXDLL_API
505  eErr
506  CCAUXDLL_CALLING_CONV
507  Config_setVideoStartupPowerConfig(CONFIGHANDLE, uint8_t config);
508 
520  EXTERN_C
521  CCAUXDLL_API
522  eErr
523  CCAUXDLL_CALLING_CONV
524  Config_setExtFanStartupPowerConfig(CONFIGHANDLE, CCStatus status);
525 
538  EXTERN_C
539  CCAUXDLL_API
540  eErr
541  CCAUXDLL_CALLING_CONV
542  Config_setStartupVoltageConfig(CONFIGHANDLE, float64_t voltage);
543 
555  EXTERN_C
556  CCAUXDLL_API
557  eErr
558  CCAUXDLL_CALLING_CONV
559  Config_setHeatingTempLimit(CONFIGHANDLE, int16_t temperature);
560 
573  EXTERN_C
574  CCAUXDLL_API
575  eErr
576  CCAUXDLL_CALLING_CONV
577  Config_setPowerOnStartup(CONFIGHANDLE, CCStatus status);
578 
589  EXTERN_C
590  CCAUXDLL_API
591  eErr
592  CCAUXDLL_CALLING_CONV
593  Config_setRS485Enabled (CONFIGHANDLE, RS4XXPort port, bool enabled);
594 
605  EXTERN_C
606  CCAUXDLL_API
607  eErr
608  CCAUXDLL_CALLING_CONV
609  Config_getRS485Enabled (CONFIGHANDLE, RS4XXPort port, bool* enabled);
610 
620  EXTERN_C
621  CCAUXDLL_API
622  eErr
623  CCAUXDLL_CALLING_CONV
624  Config_setOnOffTriggerMode (CONFIGHANDLE, ConfigOnOffTriggerMode mode);
625 
635  EXTERN_C
636  CCAUXDLL_API
637  eErr
638  CCAUXDLL_CALLING_CONV
639  Config_getOnOffTriggerMode (CONFIGHANDLE, ConfigOnOffTriggerMode* mode);
640 
650  EXTERN_C
651  CCAUXDLL_API
652  eErr
653  CCAUXDLL_CALLING_CONV
654  Config_setNextBootMode (CONFIGHANDLE, BootModeEnum mode);
655 
665  EXTERN_C
666  CCAUXDLL_API
667  eErr
668  CCAUXDLL_CALLING_CONV
669  Config_getNextBootMode (CONFIGHANDLE, BootModeEnum *mode);
670 
680  EXTERN_C
681  CCAUXDLL_API
682  eErr
683  CCAUXDLL_CALLING_CONV
684  Config_setOSAliveMonitoring (CONFIGHANDLE, CCStatus enabled);
685 
695  EXTERN_C
696  CCAUXDLL_API
697  eErr
698  CCAUXDLL_CALLING_CONV
699  Config_getOSAliveMonitoring (CONFIGHANDLE, CCStatus *enabled);
700 
710  EXTERN_C
711  CCAUXDLL_API
712  eErr
713  CCAUXDLL_CALLING_CONV
714  Config_getOnOffSignalState (CONFIGHANDLE, CCStatus *enabled);
715 
727  EXTERN_C
728  CCAUXDLL_API
729  eErr
730  CCAUXDLL_CALLING_CONV
731  Config_getDigPowerOutputStartupConfig(CONFIGHANDLE, PowerOutput output, CCStatus* enabled);
732 
744  EXTERN_C
745  CCAUXDLL_API
746  eErr
747  CCAUXDLL_CALLING_CONV
748  Config_setDigPowerOutputStartupConfig(CONFIGHANDLE, PowerOutput output, CCStatus enabled);
749 
763  EXTERN_C
764  CCAUXDLL_API
765  eErr
766  CCAUXDLL_CALLING_CONV
767  Config_getShortBeepSettings (CONFIGHANDLE, uint16_t* duration, uint16_t* frequency, uint16_t* volume);
768 
782  EXTERN_C
783  CCAUXDLL_API
784  eErr
785  CCAUXDLL_CALLING_CONV
786  Config_setShortBeepSettings (CONFIGHANDLE, uint16_t duration, uint16_t frequency, uint16_t volume);
787 
801  EXTERN_C
802  CCAUXDLL_API
803  eErr
804  CCAUXDLL_CALLING_CONV
805  Config_getLongBeepSettings (CONFIGHANDLE, uint16_t* duration, uint16_t* frequency, uint16_t* volume);
806 
820  EXTERN_C
821  CCAUXDLL_API
822  eErr
823  CCAUXDLL_CALLING_CONV
824  Config_setLongBeepSettings (CONFIGHANDLE, uint16_t duration, uint16_t frequency, uint16_t volume);
825 
827 #ifdef __cplusplus
828 } /* namespace CrossControl */
829 #endif
830 
831 #endif /* CC_CONFIG_H */
832 
CrossControl::Config_setCanStartupPowerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setCanStartupPowerConfig(CONFIGHANDLE, CCStatus status)
CrossControl::eErr
eErr
Definition: CCAuxTypes.h:162
CrossControl::Config_getCanStartupPowerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getCanStartupPowerConfig(CONFIGHANDLE, CCStatus *status)
CCPlatform.h
CrossControl::Config_getLongButtonPressAction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getLongButtonPressAction(CONFIGHANDLE, PowerAction *action)
float64_t
double float64_t
Definition: CCAuxTypes.h:26
CrossControl::Config_getRS485Enabled
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getRS485Enabled(CONFIGHANDLE, RS4XXPort port, bool *enabled)
CrossControl::CCStatus
CCStatus
Definition: CCAuxTypes.h:153
CrossControl::Config_getOnOffSignalState
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getOnOffSignalState(CONFIGHANDLE, CCStatus *enabled)
CrossControl::Config_setExtOnOffSigTrigTime
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setExtOnOffSigTrigTime(CONFIGHANDLE, uint32_t triggertime)
CrossControl::Video1Conf
const uint8_t Video1Conf
Definition: Config.h:38
CrossControl::Config_setDigPowerOutputStartupConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setDigPowerOutputStartupConfig(CONFIGHANDLE, PowerOutput output, CCStatus enabled)
CrossControl::PowerOutput
PowerOutput
Definition: CCAuxTypes.h:562
CrossControl::Config_getDigPowerOutputStartupConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getDigPowerOutputStartupConfig(CONFIGHANDLE, PowerOutput output, CCStatus *enabled)
CrossControl::Config_setHeatingTempLimit
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setHeatingTempLimit(CONFIGHANDLE, int16_t temperature)
CrossControl::Config_getHeatingTempLimit
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getHeatingTempLimit(CONFIGHANDLE, int16_t *temperature)
CrossControl::Video4Conf
const uint8_t Video4Conf
Definition: Config.h:41
CrossControl
Definition: About.h:30
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::CONFIGHANDLE
void * CONFIGHANDLE
Definition: Config.h:33
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_getFrontBtnTrigTime
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getFrontBtnTrigTime(CONFIGHANDLE, uint16_t *triggertime)
CrossControl::Video2Conf
const uint8_t Video2Conf
Definition: Config.h:39
uint32_t
unsigned int uint32_t
Definition: CCAuxTypes.h:49
CrossControl::GetConfig
EXTERN_C CCAUXDLL_API CONFIGHANDLE CCAUXDLL_CALLING_CONV GetConfig()
CrossControl::TriggerConf
TriggerConf
Definition: CCAuxTypes.h:342
CrossControl::Config_setButtonFunction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setButtonFunction(CONFIGHANDLE, uint8_t button_number, ButtonConfigEnum button_config)
CrossControl::PowerAction
PowerAction
Definition: CCAuxTypes.h:362
CrossControl::Config_setLongButtonPressAction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setLongButtonPressAction(CONFIGHANDLE, PowerAction action)
CrossControl::RS4XXPort
RS4XXPort
Definition: CCAuxTypes.h:468
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_setVideoStartupPowerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setVideoStartupPowerConfig(CONFIGHANDLE, uint8_t config)
CrossControl::Config_setOnOffTriggerMode
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setOnOffTriggerMode(CONFIGHANDLE, ConfigOnOffTriggerMode mode)
uint8_t
unsigned char uint8_t
Definition: CCAuxTypes.h:47
CrossControl::Config_setRS485Enabled
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setRS485Enabled(CONFIGHANDLE, RS4XXPort port, bool enabled)
CrossControl::Config_release
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV Config_release(CONFIGHANDLE)
CrossControl::Config_setShortButtonPressAction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setShortButtonPressAction(CONFIGHANDLE, PowerAction action)
CrossControl::Config_setFrontBtnTrigTime
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setFrontBtnTrigTime(CONFIGHANDLE, uint16_t triggertime)
CCAuxTypes.h
CCAuxErrors.h
CrossControl::Config_getExtOnOffSigTrigTime
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getExtOnOffSigTrigTime(CONFIGHANDLE, uint32_t *triggertime)
CrossControl::Config_getButtonFunction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getButtonFunction(CONFIGHANDLE, uint8_t button_number, ButtonConfigEnum *button_config)
CrossControl::Config_getNextBootMode
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getNextBootMode(CONFIGHANDLE, BootModeEnum *mode)
CrossControl::Config_setOSAliveMonitoring
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setOSAliveMonitoring(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)
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_setStartupVoltageConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setStartupVoltageConfig(CONFIGHANDLE, float64_t voltage)
CrossControl::Config_setLongBeepSettings
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setLongBeepSettings(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_getStartupTriggerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getStartupTriggerConfig(CONFIGHANDLE, TriggerConf *config)
CrossControl::Config_getVideoStartupPowerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getVideoStartupPowerConfig(CONFIGHANDLE, uint8_t *config)
CrossControl::Config_setStartupTriggerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setStartupTriggerConfig(CONFIGHANDLE, TriggerConf conf)
CrossControl::Config_getPowerOnStartup
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getPowerOnStartup(CONFIGHANDLE, CCStatus *status)
CrossControl::Config_getShortButtonPressAction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getShortButtonPressAction(CONFIGHANDLE, PowerAction *action)
CrossControl::Config_setOnOffSigAction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setOnOffSigAction(CONFIGHANDLE, PowerAction action)
CrossControl::BootModeEnum
BootModeEnum
Definition: CCAuxTypes.h:543
CrossControl::Config_getSuspendMaxTime
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getSuspendMaxTime(CONFIGHANDLE, uint16_t *maxTime)
CrossControl::Config_setSuspendMaxTime
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setSuspendMaxTime(CONFIGHANDLE, uint16_t maxTime)
CrossControl::Config_getOnOffTriggerMode
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getOnOffTriggerMode(CONFIGHANDLE, ConfigOnOffTriggerMode *mode)
CrossControl::ButtonConfigEnum
ButtonConfigEnum
Definition: CCAuxTypes.h:528
CrossControl::Config_getExtFanStartupPowerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getExtFanStartupPowerConfig(CONFIGHANDLE, CCStatus *status)
CrossControl::Config_setNextBootMode
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setNextBootMode(CONFIGHANDLE, BootModeEnum mode)
CrossControl::Video3Conf
const uint8_t Video3Conf
Definition: Config.h:40
CrossControl::Config_getStartupVoltageConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getStartupVoltageConfig(CONFIGHANDLE, float64_t *voltage)
CrossControl::ConfigOnOffTriggerMode
ConfigOnOffTriggerMode
Definition: CCAuxTypes.h:555
CrossControl::Config_getOSAliveMonitoring
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getOSAliveMonitoring(CONFIGHANDLE, CCStatus *enabled)
Generated on Mon Oct 19 2020 14:44:39 for CCAux by   doxygen 1.8.14