CCAux  2.17.0.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.0.0", 2019-10-22
8 *
9 * (c) CrossControl 2010-2019
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 
344  EXTERN_C
345  CCAUXDLL_API
346  eErr
347  CCAUXDLL_CALLING_CONV
348  Config_setStartupTriggerConfig(CONFIGHANDLE, TriggerConf conf);
349 
363  EXTERN_C
364  CCAUXDLL_API
365  eErr
366  CCAUXDLL_CALLING_CONV
367  Config_setShortButtonPressAction(CONFIGHANDLE, PowerAction action);
368 
379  EXTERN_C
380  CCAUXDLL_API
381  eErr
382  CCAUXDLL_CALLING_CONV
383  Config_setLongButtonPressAction(CONFIGHANDLE, PowerAction action);
384 
395  EXTERN_C
396  CCAUXDLL_API
397  eErr
398  CCAUXDLL_CALLING_CONV
399  Config_setOnOffSigAction(CONFIGHANDLE, PowerAction action);
400 
415  EXTERN_C
416  CCAUXDLL_API
417  eErr
418  CCAUXDLL_CALLING_CONV
419  Config_setFrontBtnTrigTime(CONFIGHANDLE, uint16_t triggertime);
420 
432  EXTERN_C
433  CCAUXDLL_API
434  eErr
435  CCAUXDLL_CALLING_CONV
436  Config_setExtOnOffSigTrigTime(CONFIGHANDLE, uint32_t triggertime);
437 
448  EXTERN_C
449  CCAUXDLL_API
450  eErr
451  CCAUXDLL_CALLING_CONV
452  Config_setButtonFunction(CONFIGHANDLE, uint8_t button_number, ButtonConfigEnum button_config);
453 
465  EXTERN_C
466  CCAUXDLL_API
467  eErr
468  CCAUXDLL_CALLING_CONV
469  Config_setSuspendMaxTime(CONFIGHANDLE, uint16_t maxTime);
470 
483  EXTERN_C
484  CCAUXDLL_API
485  eErr
486  CCAUXDLL_CALLING_CONV
487  Config_setCanStartupPowerConfig(CONFIGHANDLE, CCStatus status);
488 
502  EXTERN_C
503  CCAUXDLL_API
504  eErr
505  CCAUXDLL_CALLING_CONV
506  Config_setVideoStartupPowerConfig(CONFIGHANDLE, uint8_t config);
507 
519  EXTERN_C
520  CCAUXDLL_API
521  eErr
522  CCAUXDLL_CALLING_CONV
523  Config_setExtFanStartupPowerConfig(CONFIGHANDLE, CCStatus status);
524 
537  EXTERN_C
538  CCAUXDLL_API
539  eErr
540  CCAUXDLL_CALLING_CONV
541  Config_setStartupVoltageConfig(CONFIGHANDLE, float64_t voltage);
542 
554  EXTERN_C
555  CCAUXDLL_API
556  eErr
557  CCAUXDLL_CALLING_CONV
558  Config_setHeatingTempLimit(CONFIGHANDLE, int16_t temperature);
559 
572  EXTERN_C
573  CCAUXDLL_API
574  eErr
575  CCAUXDLL_CALLING_CONV
576  Config_setPowerOnStartup(CONFIGHANDLE, CCStatus status);
577 
588  EXTERN_C
589  CCAUXDLL_API
590  eErr
591  CCAUXDLL_CALLING_CONV
592  Config_setRS485Enabled (CONFIGHANDLE, RS4XXPort port, bool enabled);
593 
604  EXTERN_C
605  CCAUXDLL_API
606  eErr
607  CCAUXDLL_CALLING_CONV
608  Config_getRS485Enabled (CONFIGHANDLE, RS4XXPort port, bool* enabled);
609 
619  EXTERN_C
620  CCAUXDLL_API
621  eErr
622  CCAUXDLL_CALLING_CONV
623  Config_setOnOffTriggerMode (CONFIGHANDLE, ConfigOnOffTriggerMode mode);
624 
634  EXTERN_C
635  CCAUXDLL_API
636  eErr
637  CCAUXDLL_CALLING_CONV
638  Config_getOnOffTriggerMode (CONFIGHANDLE, ConfigOnOffTriggerMode* mode);
639 
649  EXTERN_C
650  CCAUXDLL_API
651  eErr
652  CCAUXDLL_CALLING_CONV
653  Config_setNextBootMode (CONFIGHANDLE, BootModeEnum mode);
654 
664  EXTERN_C
665  CCAUXDLL_API
666  eErr
667  CCAUXDLL_CALLING_CONV
668  Config_getNextBootMode (CONFIGHANDLE, BootModeEnum *mode);
669 
679  EXTERN_C
680  CCAUXDLL_API
681  eErr
682  CCAUXDLL_CALLING_CONV
683  Config_setOSAliveMonitoring (CONFIGHANDLE, CCStatus enabled);
684 
694  EXTERN_C
695  CCAUXDLL_API
696  eErr
697  CCAUXDLL_CALLING_CONV
698  Config_getOSAliveMonitoring (CONFIGHANDLE, CCStatus *enabled);
699 
709  EXTERN_C
710  CCAUXDLL_API
711  eErr
712  CCAUXDLL_CALLING_CONV
713  Config_getOnOffSignalState (CONFIGHANDLE, CCStatus *enabled);
714 
726  EXTERN_C
727  CCAUXDLL_API
728  eErr
729  CCAUXDLL_CALLING_CONV
730  Config_getDigPowerOutputStartupConfig(CONFIGHANDLE, PowerOutput output, CCStatus* enabled);
731 
743  EXTERN_C
744  CCAUXDLL_API
745  eErr
746  CCAUXDLL_CALLING_CONV
747  Config_setDigPowerOutputStartupConfig(CONFIGHANDLE, PowerOutput output, CCStatus enabled);
748 
762  EXTERN_C
763  CCAUXDLL_API
764  eErr
765  CCAUXDLL_CALLING_CONV
766  Config_getShortBeepSettings (CONFIGHANDLE, uint16_t* duration, uint16_t* frequency, uint16_t* volume);
767 
781  EXTERN_C
782  CCAUXDLL_API
783  eErr
784  CCAUXDLL_CALLING_CONV
785  Config_setShortBeepSettings (CONFIGHANDLE, uint16_t duration, uint16_t frequency, uint16_t volume);
786 
800  EXTERN_C
801  CCAUXDLL_API
802  eErr
803  CCAUXDLL_CALLING_CONV
804  Config_getLongBeepSettings (CONFIGHANDLE, uint16_t* duration, uint16_t* frequency, uint16_t* volume);
805 
819  EXTERN_C
820  CCAUXDLL_API
821  eErr
822  CCAUXDLL_CALLING_CONV
823  Config_setLongBeepSettings (CONFIGHANDLE, uint16_t duration, uint16_t frequency, uint16_t volume);
824 
826 #ifdef __cplusplus
827 } /* namespace CrossControl */
828 #endif
829 
830 #endif /* CC_CONFIG_H */
831 
CrossControl::Config_setCanStartupPowerConfig
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setCanStartupPowerConfig(CONFIGHANDLE, CCStatus status)
CrossControl::eErr
eErr
Definition: CCAuxTypes.h:159
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:150
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:559
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:339
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:359
CrossControl::Config_setLongButtonPressAction
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setLongButtonPressAction(CONFIGHANDLE, PowerAction action)
CrossControl::RS4XXPort
RS4XXPort
Definition: CCAuxTypes.h:465
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:540
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:525
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:552
CrossControl::Config_getOSAliveMonitoring
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getOSAliveMonitoring(CONFIGHANDLE, CCStatus *enabled)
Generated on Tue Oct 22 2019 17:00:44 for CCAux by   doxygen 1.8.14