Config.h

Go to the documentation of this file.

 
/*
 *  Copyright (C) 2010-2022 CrossControl AB - All rights reserved
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 * This source code is licensed under the proprietary CrossControl software
 * license v 1.0.Please refer to the software license text for details or
 * contact info@crosscontrol.com for more info.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */
/*
 *  File description:
 *  Configuration of various settings
 *
 *  Use the function GetConfig() to get a handle to pass on to the other functions.
 *  Use the method Config_release(CONFIGHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include config_example.cpp
 *
 ************************************************/
#ifndef CC_CONFIG_H
#define CC_CONFIG_H
 
#include "CCAuxErrors.h"
#include "CCAuxTypes.h"
#include "CCPlatform.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
typedef void *CONFIGHANDLE;
 
const uint8_t Video1Conf = (1 << 0); 
const uint8_t Video2Conf = (1 << 1); 
const uint8_t Video3Conf = (1 << 2); 
const uint8_t Video4Conf = (1 << 3); 
EXTERN_C
CCAUXDLL_API
CONFIGHANDLE
CCAUXDLL_CALLING_CONV
GetConfig(void);
 
EXTERN_C
CCAUXDLL_API
void CCAUXDLL_CALLING_CONV Config_release(CONFIGHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getStartupTriggerConfig(CONFIGHANDLE, TriggerConf *config);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getStartupTriggerCfg(CONFIGHANDLE, StartupTriggerCfg config, CCStatus *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getShortButtonPressAction(CONFIGHANDLE, PowerAction *action);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getLongButtonPressAction(CONFIGHANDLE, PowerAction *action);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getOnOffSigAction(CONFIGHANDLE, PowerAction *action);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getFrontBtnTrigTime(CONFIGHANDLE, uint16_t *triggertime);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getExtOnOffSigTrigTime(CONFIGHANDLE, uint32_t *triggertime);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getPreIgnitionTrigTime(CONFIGHANDLE, uint32_t *triggertime);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getButtonFunction(CONFIGHANDLE, uint8_t button_number,
                                                    ButtonConfigEnum *button_config);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getSuspendMaxTime(CONFIGHANDLE, uint16_t *maxTime);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getSuspendMaxTimeShutdownAfterResume(CONFIGHANDLE, CCStatus *shutdown);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getCanStartupPowerConfig(CONFIGHANDLE, CCStatus *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getVideoStartupPowerConfig(CONFIGHANDLE, uint8_t *config);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getExtFanStartupPowerConfig(CONFIGHANDLE, CCStatus *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getStartupVoltageConfig(CONFIGHANDLE, float64_t *voltage);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getHeatingTempLimit(CONFIGHANDLE, int16_t *temperature);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getPowerOnStartup(CONFIGHANDLE, CCStatus *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setStartupTriggerConfig(CONFIGHANDLE, TriggerConf conf);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setStartupTriggerCfg(CONFIGHANDLE, StartupTriggerCfg config, CCStatus status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setShortButtonPressAction(CONFIGHANDLE, PowerAction action);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setLongButtonPressAction(CONFIGHANDLE, PowerAction action);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setOnOffSigAction(CONFIGHANDLE, PowerAction action);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setFrontBtnTrigTime(CONFIGHANDLE, uint16_t triggertime);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setExtOnOffSigTrigTime(CONFIGHANDLE, uint32_t triggertime);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setPreIgnitionTrigTime(CONFIGHANDLE, uint32_t triggertime);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setButtonFunction(CONFIGHANDLE, uint8_t button_number,
                                                    ButtonConfigEnum button_config);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setSuspendMaxTime(CONFIGHANDLE, uint16_t maxTime);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setSuspendMaxTimeShutdownAfterResume(CONFIGHANDLE, CCStatus shutdown);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setCanStartupPowerConfig(CONFIGHANDLE, CCStatus status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setVideoStartupPowerConfig(CONFIGHANDLE, uint8_t config);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setExtFanStartupPowerConfig(CONFIGHANDLE, CCStatus status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setStartupVoltageConfig(CONFIGHANDLE, float64_t voltage);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setHeatingTempLimit(CONFIGHANDLE, int16_t temperature);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setPowerOnStartup(CONFIGHANDLE, CCStatus status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setRS485Enabled(CONFIGHANDLE, RS4XXPort port, bool enabled);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getRS485Enabled(CONFIGHANDLE, RS4XXPort port, bool *enabled);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setOnOffTriggerMode(CONFIGHANDLE, ConfigOnOffTriggerMode mode);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getOnOffTriggerMode(CONFIGHANDLE, ConfigOnOffTriggerMode *mode);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getActionTriggerCfg(CONFIGHANDLE, ActionTriggerCfg config, PowerAction *action);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setActionTriggerCfg(CONFIGHANDLE, ActionTriggerCfg config, PowerAction action);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getWakeupTriggerCfg(CONFIGHANDLE, WakeupTriggerCfg config, CCStatus *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setWakeupTriggerCfg(CONFIGHANDLE, WakeupTriggerCfg config, CCStatus status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setNextBootMode(CONFIGHANDLE, BootModeEnum mode);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getNextBootMode(CONFIGHANDLE, BootModeEnum *mode);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setOSAliveMonitoring(CONFIGHANDLE, CCStatus enabled);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getOSAliveMonitoring(CONFIGHANDLE, CCStatus *enabled);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setOSAliveMonitoringTimeout(CONFIGHANDLE, uint16_t timeout);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getOSAliveMonitoringTimeout(CONFIGHANDLE, uint16_t *timeout);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getOnOffSignalState(CONFIGHANDLE, CCStatus *enabled);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getDigPowerOutputStartupConfig(CONFIGHANDLE, PowerOutput output, CCStatus *enabled);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setDigPowerOutputStartupConfig(CONFIGHANDLE, PowerOutput output, CCStatus enabled);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getShortBeepSettings(CONFIGHANDLE, uint16_t *duration, uint16_t *frequency,
                                                       uint16_t *volume);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setShortBeepSettings(CONFIGHANDLE, uint16_t duration, uint16_t frequency,
                                                       uint16_t volume);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getLongBeepSettings(CONFIGHANDLE, uint16_t *duration, uint16_t *frequency,
                                                      uint16_t *volume);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_setLongBeepSettings(CONFIGHANDLE, uint16_t duration, uint16_t frequency,
                                                      uint16_t volume);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getSystemMode(CONFIGHANDLE, SystemMode *mode);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Config_getTriggerAvailability(CONFIGHANDLE, TriggerType trigger, CCStatus *available);
 
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#endif /* CC_CONFIG_H */