CCAux  2.20.0.0
CCAux API reference
Functions
Config functions

Functions

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)
 

Detailed Description

Functions in the Config class

Function Documentation

◆ Config_getActionTriggerCfg()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getActionTriggerCfg ( CONFIGHANDLE  ,
ActionTriggerCfg  config,
PowerAction action 
)

Get action trigger configuration

Supported Platform(s): Yukon, V510, V710, V1000, V1200, X1200

Parameters
configSee enum ActionTriggerCfg.
actionSee enum PowerAction.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getButtonFunction()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getButtonFunction ( CONFIGHANDLE  ,
uint8_t  button_number,
ButtonConfigEnum button_config 
)

Get Button Function Configuration

Supported Platform(s): VC, VA, VS, VI2

Parameters
button_numberWhich button to configure (1-MAX_BUTTONS)
button_configBitfield for button configuration, see enum ButtonConfigEnum for details.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

for (int i = 1; i < 9; i++)
{
error = Config_getButtonFunction(pConfig, i, &btnconf);
if (error != ERR_SUCCESS)
{
cout << "Error(" << error << ") in function Config_getButtonFunction: " << GetErrorStringA(error)
<< std::endl;
}
else
{
cout << "Button " << (int)i << " is set to: ";
switch (btnconf)
{
cout << "Application only" << std::endl;
break;
cout << "Startup trigger" << std::endl;
break;
cout << "Action trigger" << std::endl;
break;
cout << "Action and Startup trigger" << std::endl;
break;
cout << "Backlight decrease" << std::endl;
break;
cout << "Backlight decrease and Startup trigger" << std::endl;
break;
cout << "Backlight increase" << std::endl;
break;
cout << "Backlight increase and Startup trigger" << std::endl;
break;
default:
cout << "Invalid value" << std::endl;
break;
}
}
}
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getButtonFunction(CONFIGHANDLE, uint8_t button_number, ButtonConfigEnum *button_config)
EXTERN_C CCAUXDLL_API char_t const *CCAUXDLL_CALLING_CONV GetErrorStringA(eErr errCode)
ButtonConfigEnum
Definition: CCAuxTypes.h:654
@ BUTTON_AS_BACKLIGHT_INCREASE
Definition: CCAuxTypes.h:663
@ BUTTON_AS_STARTUP_TRIG
Definition: CCAuxTypes.h:657
@ BUTTON_AS_ACTION_TRIG
Definition: CCAuxTypes.h:658
@ BUTTON_AS_BACKLIGHT_INCR_STARTUP_TRIG
Definition: CCAuxTypes.h:664
@ BUTTON_AS_BACKLIGHT_DECR_STARTUP_TRIG
Definition: CCAuxTypes.h:662
@ BUTTON_ONLY_MP_ACTION
Definition: CCAuxTypes.h:655
@ BUTTON_AS_ACTION_STARTUP_TRIG
Definition: CCAuxTypes.h:659
@ BUTTON_AS_BACKLIGHT_DECREASE
Definition: CCAuxTypes.h:661
eErr
Definition: CCAuxTypes.h:162
@ ERR_SUCCESS
Definition: CCAuxTypes.h:163

◆ Config_getCanStartupPowerConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getCanStartupPowerConfig ( CONFIGHANDLE  ,
CCStatus status 
)

Get Can power at startup configuration. The status of Can power at startup and at resume from suspended mode. At resume from suspend, this setting overrides the setting of the setCanPowerStatus function.

Supported Platform(s): XL, XL5, XM, XS, XA

Parameters
statusEnabled/Disabled
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getDigPowerOutputStartupConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getDigPowerOutputStartupConfig ( CONFIGHANDLE  ,
PowerOutput  output,
CCStatus enabled 
)

Get power output startup configuration. Power outputs 1 and 2 can be set to be turned on automatically at system startup.

Supported Platform(s): VS

Parameters
outputSelect power output (PowerOutput1 or PowerOutput2) .
enabledIs the power output configured to be enabled at startup?
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getExtFanStartupPowerConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getExtFanStartupPowerConfig ( CONFIGHANDLE  ,
CCStatus status 
)

Get External fan power at startup configuration. The status at startup and at resume from suspended mode. At resume from suspend, this setting overrides the setting of the setExtFanPowerStatus function.

Supported Platform(s): XL, XL5, XM

Parameters
statusEnabled/Disabled
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getExtOnOffSigTrigTime()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getExtOnOffSigTrigTime ( CONFIGHANDLE  ,
uint32_t triggertime 
)

Get external on/off signal trigger time.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
triggertimeTime in seconds that the external signal has to be low for the unit to enter suspend mode or shut down (trigger an action). This time can be set from one second up to several years, if needed.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getFrontBtnTrigTime()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getFrontBtnTrigTime ( CONFIGHANDLE  ,
uint16_t triggertime 
)

Get front button trigger time for long press.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, X1200

Parameters
triggertimeTime in milliseconds that the button has to be pressed for the press to count as a long button press. A button press twice this time will generate a hard shut down. If this time is set under 4000ms, the hard shut down minimum time of 8s is used instead.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getHeatingTempLimit()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getHeatingTempLimit ( CONFIGHANDLE  ,
int16_t temperature 
)

Get the temperature limit for heating. When temperature is below this limit, the system is internally heated until the temperature rises above the limit. The default and minimum value is -25 degrees Celsius (Yukon development board -34). The maximum value is +5 degrees Celsius.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, Yukon, V510, V710, V1000, V1200, X1200

Parameters
temperatureThe current heating limit, in degrees Celsius
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getLongBeepSettings()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getLongBeepSettings ( CONFIGHANDLE  ,
uint16_t duration,
uint16_t frequency,
uint16_t volume 
)

Get Long Beep Settings The computer issues a long beep at certain system events, for example a long button press. This beep may be configured or disabled by setting any of the parameters to 0.

Supported Platform(s): VS, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
durationLong beep duration (VS: 0-65534 ms. V700, Yukon, V510, V710, V1000, V1200: 0-5000 ms)
frequencyLong beep frequency (VS: 700-10000 Hz. V700, Yukon, V510, V710, V1000, V1200: 750-10000 Hz)
volumeLong beep volume (VS: 0-2000. V700, Yukon, V510, V710, V1000, V1200: 0-100)
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getLongButtonPressAction()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getLongButtonPressAction ( CONFIGHANDLE  ,
PowerAction action 
)

Get long button press action. Gets the configured action for a long button press: NoAction, ActionSuspend or ActionShutDown. A long button press is determined by the FrontBtnTrigTime.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, Yukon, X1200

Parameters
actionThe configured action.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getNextBootMode()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getNextBootMode ( CONFIGHANDLE  ,
BootModeEnum mode 
)

Get BootMode for next boot

Supported Platform(s): VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
modeNext BootMode
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getOnOffSigAction()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getOnOffSigAction ( CONFIGHANDLE  ,
PowerAction action 
)

Get On/Off signal action. Gets the configured action for an On/Off signal event: NoAction, ActionSuspend or ActionShutDown. An On/Off signal event is determined by the ExtOnOffSigTrigTime.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
actionThe configured action.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getOnOffSignalState()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getOnOffSignalState ( CONFIGHANDLE  ,
CCStatus enabled 
)

Get OnOff signal state

Supported Platform(s): XM9, XL5, XA, XS, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
enabledIs OnOff signal enabled/disabled
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getOnOffTriggerMode()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getOnOffTriggerMode ( CONFIGHANDLE  ,
ConfigOnOffTriggerMode mode 
)

Get OnOff/Ignition/KeySwitch signal trigger mode.

Supported Platform(s): XM9, XL5, XA, XS, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
modeSignal trigger mode. See ConfigOnOffTriggerMode for details
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getOSAliveMonitoring()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getOSAliveMonitoring ( CONFIGHANDLE  ,
CCStatus enabled 
)

Get OS Alive Monitoring

Supported Platform(s): VS, VI2, V700, Yukon, V510, V710, V1000, V1200

Parameters
enabledIs OS Alive monitoring enabled/disabled
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getOSAliveMonitoringTimeout()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getOSAliveMonitoringTimeout ( CONFIGHANDLE  ,
uint16_t timeout 
)

Get OS Alive Monitoring timeout

Supported Platform(s): Yukon, V510, V710, V1000, V1200

Parameters
timeoutTimeout for the boot watchdog
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getPowerOnStartup()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getPowerOnStartup ( CONFIGHANDLE  ,
CCStatus status 
)

Get power on start-up behavior. If enabled, the unit always starts when power is turned on, disregarding the setting for StartupTriggerConfig at that time. The StartupTriggerConfig still applies if the unit is shut down or suspended, without removing the power supply.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
statusEnabled/Disabled
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getPreIgnitionTrigTime()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getPreIgnitionTrigTime ( CONFIGHANDLE  ,
uint32_t triggertime 
)

Get preignition signal trigger time.

Supported Platform(s): Yukon, V510, V710, V1000, V1200, X1200

Parameters
triggertimeTime in seconds that the preignition signal has to be low for the unit to enter suspend mode or shut down (trigger an action). This time can be set from one second up to several years, if needed.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getRS485Enabled()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getRS485Enabled ( CONFIGHANDLE  ,
RS4XXPort  port,
bool *  enabled 
)

Get RS485 mode configuration for RS4XX port.

Supported Platform(s): XA, XS

Parameters
portRS4XX port (RS4XXPort1-4)
enabledIs the RS485 port enabled (true/false)
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getShortBeepSettings()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getShortBeepSettings ( CONFIGHANDLE  ,
uint16_t duration,
uint16_t frequency,
uint16_t volume 
)

Get Short Beep Settings The computer issues a short beep at certain system events such as boot or button press. This beep may be configured or disabled by setting any of the parameters to 0.

Supported Platform(s): VS, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
durationShort beep duration (VS: 0-65534 ms. V700, Yukon, V510, V710, V1000, V1200: 0-5000 ms)
frequencyShort beep frequency (VS: 700-10000 Hz. V700, Yukon, V510, V710, V1000, V1200: 750-10000 Hz)
volumeShort beep volume (VS: 0-2000. V700, Yukon, V510, V710, V1000, V1200: 0-100)
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getShortButtonPressAction()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getShortButtonPressAction ( CONFIGHANDLE  ,
PowerAction action 
)

Get short button press action. Gets the configured action for a short button press: NoAction, ActionSuspend or ActionShutDown.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, Yukon, X1200

Parameters
actionThe configured action.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getStartupTriggerCfg()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getStartupTriggerCfg ( CONFIGHANDLE  ,
StartupTriggerCfg  config,
CCStatus status 
)

Get Start-up trigger configuration. See enum StartupTriggerCfg for more details.

Supported Platform(s): Yukon, V510, V710, V1000, V1200, X1200

Parameters
configSee enum StartupTriggerCfg.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getStartupTriggerConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getStartupTriggerConfig ( CONFIGHANDLE  ,
TriggerConf config 
)

Get Start-up trigger configuration. Is the front button and/or the external on/off (ignition) signal enabled as triggers for startup and wake up from suspended mode? VC platform: CI state change and Can activity also available as wakeup triggers from suspend mode. See enum TriggerConf for more details.

Supported Platform(s): XL, XM, XL5, XM9, XS, XA, VC, VA, VS, VI2, V700

Parameters
configSee enum TriggerConf.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = Config_getStartupTriggerConfig(pConfig, &trig);
if (err == ERR_SUCCESS)
{
cout << "Start-up trigger is set to: ";
switch (trig)
{
cout << "Front button only" << endl;
break;
cout << "On/Off signal only" << endl;
break;
cout << "Front button or On/off signal" << endl;
break;
// The below values are only available on the VC platform
cout << "Wake up on CAN and Buttons" << endl;
break;
cout << "Wake up on CAN and On/Off/Ignition signal" << endl;
break;
cout << "Wake up on CAN, Buttons and On/Off/Ignition signal" << endl;
break;
cout << "Wake up on CI and Button State Change" << endl;
break;
cout << "Wake up on CI and OnOff Signal State Change" << endl;
break;
cout << "Wake up on CI, Button and OnOff Signal State Change" << endl;
break;
cout << "Wake up on CI, CAN and Button State Change" << endl;
break;
cout << "Wake up on CI, CAN and OnOff Signal State Change" << endl;
break;
case All_Events:
cout << "Wake up on all events" << endl;
break;
default:
cout << "Error - Undefined StartupTrigger" << endl;
break;
}
}
else
{
cout << "Error(" << err << ") in function getStartupTriggerConfig: " << GetErrorStringA(err) << endl;
}
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_getStartupTriggerConfig(CONFIGHANDLE, TriggerConf *config)
@ CI_Button_OnOff_Activity
Definition: CCAuxTypes.h:375
@ CAN_Button_OnOff_Activity
Definition: CCAuxTypes.h:372
@ All_Events
Definition: CCAuxTypes.h:378
@ Both_Button_And_Signal_Enabled
Definition: CCAuxTypes.h:369
@ CI_OnOff_Activity
Definition: CCAuxTypes.h:374
@ CI_Button_Activity
Definition: CCAuxTypes.h:373
@ CAN_OnOff_Activity
Definition: CCAuxTypes.h:371
@ OnOff_Signal_Enabled
Definition: CCAuxTypes.h:368
@ CI_CAN_Button_Activity
Definition: CCAuxTypes.h:376
@ Front_Button_Enabled
Definition: CCAuxTypes.h:367
@ CI_CAN_OnOff_Activity
Definition: CCAuxTypes.h:377
@ CAN_Button_Activity
Definition: CCAuxTypes.h:370

◆ Config_getStartupVoltageConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getStartupVoltageConfig ( CONFIGHANDLE  ,
float64_t voltage 
)

Get the voltage threshold required for startup. The external voltage must be stable above this value for the unit to start up. The default and minimum value is 9V. It could be set to a higher value for a 24V system.

Supported Platform(s): XL, XL5, XM, XM9, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
voltageThe current voltage setting. (9V .. 28V)
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getSuspendMaxTime()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getSuspendMaxTime ( CONFIGHANDLE  ,
uint16_t maxTime 
)

Get suspend mode maximum time.

Supported Platform(s): XL, XM, XM9 (CC Linux), VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
maxTimeMaximum suspend time in minutes. After this time in suspended mode, the unit will shut down to save power. A value of 0 means that the automatic shut down function is not used.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getSuspendMaxTimeShutdownAfterResume()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getSuspendMaxTimeShutdownAfterResume ( CONFIGHANDLE  ,
CCStatus shutdown 
)

Get the setting for whether the system should shutdown or not after resume from timeout. After automatic wakeup from timeout (See Config_getSuspendMaxTime), the system can automatically shutdown or just wake up.

Supported Platform(s): Yukon, V510, V710, V1000, V1200, X1200

Parameters
shutdownEnabled/Disabled
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getSystemMode()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getSystemMode ( CONFIGHANDLE  ,
SystemMode mode 
)

Get the current system mode (state, boot mode) from SS.

Supported Platform(s): VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
modeThe current running mode, according to SS.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getTriggerAvailability()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getTriggerAvailability ( CONFIGHANDLE  ,
TriggerType  trigger,
CCStatus available 
)

Get the availability status of a trigger.

Supported Platform(s): Yukon, V510, V710, V1000, V1200, X1200

Parameters
triggerTrigger to check availability for.
availableAvailability status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getVideoStartupPowerConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getVideoStartupPowerConfig ( CONFIGHANDLE  ,
uint8_t config 
)

Get Video power at startup configuration. The status of Video power at startup and at resume from suspended mode. At resume from suspend, this setting overrides the setting of the setVideoPowerStatus function.

Supported Platform(s): XL, XL5, XM, XS, XA

Parameters
configBitwise representation of the four video channels. See the VideoXConf defines. if the bit is 1, the power is enabled, else disabled.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_getWakeupTriggerCfg()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_getWakeupTriggerCfg ( CONFIGHANDLE  ,
WakeupTriggerCfg  config,
CCStatus status 
)

Get Wake-up trigger configuration. See enum WakeupTriggerCfg for more details.

Supported Platform(s): Yukon, V510, V710, V1000, V1200, X1200

Parameters
configSee enum WakeupTriggerCfg
statusstatus (Enabled/Disabled)
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_release()

EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV CrossControl::Config_release ( CONFIGHANDLE  )

Delete the Config object.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Returns
-

Example Usage:

assert(pConfig);
conf_example(pConfig);
Config_release(pConfig);
EXTERN_C CCAUXDLL_API CONFIGHANDLE CCAUXDLL_CALLING_CONV GetConfig(void)
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV Config_release(CONFIGHANDLE)
void * CONFIGHANDLE
Definition: Config.h:33

◆ Config_setActionTriggerCfg()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setActionTriggerCfg ( CONFIGHANDLE  ,
ActionTriggerCfg  config,
PowerAction  action 
)

Set action trigger configuration NoAction, ActionSuspend or ActionShutDown.

Supported Platform(s): Yukon, V510, V710, V1000, V1200, X1200

Parameters
configSee enum ActionTriggerCfg.
actionSee enum PowerAction.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setButtonFunction()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setButtonFunction ( CONFIGHANDLE  ,
uint8_t  button_number,
ButtonConfigEnum  button_config 
)

Set button function configuration

Supported Platform(s): VC, VA, VS, VI2

Parameters
button_numberWhich button to configure (1-MAX_BUTTONS)
button_configBitfield for button configuration, see enum ButtonConfigEnum for details.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setCanStartupPowerConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setCanStartupPowerConfig ( CONFIGHANDLE  ,
CCStatus  status 
)

Set Can power at startup configuration. The status of Can power at startup and at resume from suspended mode. At resume from suspend, this setting overrides the setting of the setCanPowerStatus function.

Supported Platform(s): XL, XL5, XM, XS, XA

Parameters
statusEnabled/Disabled
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setDigPowerOutputStartupConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setDigPowerOutputStartupConfig ( CONFIGHANDLE  ,
PowerOutput  output,
CCStatus  enabled 
)

Set power output startup configuration. Power outputs 1 and 2 can be set to be turned on automatically at system startup.

Supported Platform(s): VS

Parameters
outputSelect power output (PowerOutput1 or PowerOutput2).
enabledConfigure the power output to be enabled at startup.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setExtFanStartupPowerConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setExtFanStartupPowerConfig ( CONFIGHANDLE  ,
CCStatus  status 
)

Set External fan power at startup configuration. The status at startup and at resume from suspended mode. At resume from suspend, this setting overrides the setting of the setExtFanPowerStatus function.

Supported Platform(s): XL, XL5, XM

Parameters
statusEnabled/Disabled
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setExtOnOffSigTrigTime()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setExtOnOffSigTrigTime ( CONFIGHANDLE  ,
uint32_t  triggertime 
)

Set external on/off signal trigger time.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
triggertimeTime in seconds that the external signal has to be low for the unit to enter suspend mode or shut down (trigger an action). This time can be set from one second up to several years, if needed.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setFrontBtnTrigTime()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setFrontBtnTrigTime ( CONFIGHANDLE  ,
uint16_t  triggertime 
)

Set front button trigger time for long press.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, X1200

Parameters
triggertimeTime in milliseconds that the button has to be pressed for the press to count as a long button press. A button press twice this time will generate a hard shut down. If this time is set under 4000ms, the hard shut down minimum time of 8s is used instead.

NOTE: On VS the triggertime is limited to maximum 14000 ms.

Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setHeatingTempLimit()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setHeatingTempLimit ( CONFIGHANDLE  ,
int16_t  temperature 
)

Set the temperature limit for heating. When temperature is below this limit, the system is internally heated until the temperature rises above the limit. The default and minimum value is -25 degrees Celsius (Yukon development board -34). The maximum value is +5 degrees Celsius.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, Yukon, V510, V710, V1000, V1200, X1200

Parameters
temperatureThe heating limit, in degrees Celsius
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setLongBeepSettings()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setLongBeepSettings ( CONFIGHANDLE  ,
uint16_t  duration,
uint16_t  frequency,
uint16_t  volume 
)

Set Long Beep Settings The computer issues a long beep at certain system events, for example a long button press. This beep may be configured or disabled by setting any of the parameters to 0.

Supported Platform(s): VS, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
durationLong beep duration (VS: 0-65534 ms. V700, Yukon, V510, V710, V1000, V1200: 0-5000 ms)
frequencyLong beep frequency (VS: 700-10000 Hz. V700, Yukon, V510, V710, V1000, V1200: 750-10000 Hz)
volumeLong beep volume (VS: 0-2000. V700, Yukon, V510, V710, V1000, V1200: 0-100)
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setLongButtonPressAction()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setLongButtonPressAction ( CONFIGHANDLE  ,
PowerAction  action 
)

Set long button press action. Sets the configured action for a long button press: NoAction, ActionSuspend or ActionShutDown. A long button press is determined by the FrontBtnTrigTime.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, Yukon, X1200

Parameters
actionThe action to set.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setNextBootMode()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setNextBootMode ( CONFIGHANDLE  ,
BootModeEnum  mode 
)

Set BootMode for next boot. Default mode is restored after boot.

Supported Platform(s): VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
modeBootMode for next boot.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setOnOffSigAction()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setOnOffSigAction ( CONFIGHANDLE  ,
PowerAction  action 
)

Set On/Off signal action. Sets the configured action for an On/Off signal event: NoAction, ActionSuspend or ActionShutDown. An On/Off signal event is determined by the ExtOnOffSigTrigTime.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
actionThe action to set.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setOnOffTriggerMode()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setOnOffTriggerMode ( CONFIGHANDLE  ,
ConfigOnOffTriggerMode  mode 
)

Set OnOff/Ignition/KeySwitch signal trigger mode.

Supported Platform(s): XM9, XL5, XA, XS, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
modeSignal trigger mode. See ConfigOnOffTriggerMode for details
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setOSAliveMonitoring()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setOSAliveMonitoring ( CONFIGHANDLE  ,
CCStatus  enabled 
)

Set OS Alive Monitoring

Supported Platform(s): VS, VI2, V700, Yukon, V510, V710, V1000, V1200

Parameters
enabledEnable/Disable OS Alive Monitoring
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setOSAliveMonitoringTimeout()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setOSAliveMonitoringTimeout ( CONFIGHANDLE  ,
uint16_t  timeout 
)

Set OS Alive Monitoring timeout

Supported Platform(s): Yukon, V510, V710, V1000, V1200

Parameters
timeoutTimeout for the boot watchdog
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setPowerOnStartup()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setPowerOnStartup ( CONFIGHANDLE  ,
CCStatus  status 
)

Set power on start-up behavior. If enabled, the unit always starts when power is turned on, disregarding the setting for StartupTriggerConfig at that time. The StartupTriggerConfig still applies if the unit is shut down or suspended, without removing the power supply.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
statusEnabled/Disabled
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setPreIgnitionTrigTime()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setPreIgnitionTrigTime ( CONFIGHANDLE  ,
uint32_t  triggertime 
)

Set preignition signal trigger time.

Supported Platform(s): Yukon, V510, V710, V1000, V1200, X1200

Parameters
triggertimeTime in seconds that the preignition signal has to be low for the unit to enter suspend mode or shut down (trigger an action). This time can be set from one second up to several years, if needed.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setRS485Enabled()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setRS485Enabled ( CONFIGHANDLE  ,
RS4XXPort  port,
bool  enabled 
)

Set RS485 mode enabled or disabled for RS4XX port.

Supported Platform(s): XA, XS

Parameters
portRS4XX port (RS4XXPort1-4)
enabledRS485 enabled (true/false)
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setShortBeepSettings()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setShortBeepSettings ( CONFIGHANDLE  ,
uint16_t  duration,
uint16_t  frequency,
uint16_t  volume 
)

Set Short Beep Settings The computer issues a short beep at certain system events such as boot or button press. This beep may be configured or disabled by setting any of the parameters to 0.

Supported Platform(s): VS, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
durationShort beep duration (VS: 0-65534 ms. V700, Yukon, V510, V710, V1000, V1200: 0-5000 ms)
frequencyShort beep frequency (VS: 700-10000 Hz. V700, Yukon, V510, V710, V1000, V1200: 750-10000 Hz)
volumeShort beep volume (VS: 0-2000. V700, Yukon, V510, V710, V1000, V1200: 0-100)
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setShortButtonPressAction()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setShortButtonPressAction ( CONFIGHANDLE  ,
PowerAction  action 
)

Set short button press action. Sets the configured action for a short button press: NoAction, ActionSuspend or ActionShutDown.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, Yukon, X1200

Parameters
actionThe action to set.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

if (err == ERR_SUCCESS)
{
cout << "ShortButtonPressAction set to Suspend!" << endl;
}
else
{
cout << "Error(" << err << ") in function setShortButtonPressAction: " << GetErrorStringA(err) << endl;
}
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Config_setShortButtonPressAction(CONFIGHANDLE, PowerAction action)
@ ActionSuspend
Definition: CCAuxTypes.h:443

◆ Config_setStartupTriggerCfg()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setStartupTriggerCfg ( CONFIGHANDLE  ,
StartupTriggerCfg  config,
CCStatus  status 
)

Set Start-up trigger configuration. See enum StartupTriggerCfg for more details.

Supported Platform(s): Yukon, V510, V710, V1000, V1200, X1200

Parameters
confSee enum StartupTriggerCfg.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setStartupTriggerConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setStartupTriggerConfig ( CONFIGHANDLE  ,
TriggerConf  conf 
)

Set Start-up trigger configuration. Should the front button and/or the external on/off (ignition) signal be enabled as triggers for startup and wake up from suspended mode? VC,VA platforms: CI state change and Can activity also available as wakeup triggers from suspend mode. V700 platform: Only external on/off (ignition signal) is accepted. See enum TriggerConf for more details.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700

Parameters
confSee enum TriggerConf.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setStartupVoltageConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setStartupVoltageConfig ( CONFIGHANDLE  ,
float64_t  voltage 
)

Set the voltage threshold required for startup. The external voltage must be stable above this value for the unit to start up. The default and minimum value is 9V. It could be set to a higher value for a 24V system.

Supported Platform(s): XL, XL5, XM, XM9, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
voltageThe voltage to set (9V .. 28V).
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setSuspendMaxTime()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setSuspendMaxTime ( CONFIGHANDLE  ,
uint16_t  maxTime 
)

Set suspend mode maximum time.

Supported Platform(s): XL, XM, XM9 (CC Linux), VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
maxTimeMaximum suspend time in minutes. After this time in suspended mode, the unit will shut down to save power. A value of 0 means that this function is not used.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setSuspendMaxTimeShutdownAfterResume()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setSuspendMaxTimeShutdownAfterResume ( CONFIGHANDLE  ,
CCStatus  shutdown 
)

Set the setting for whether the system should shutdown or not after resume from timeout. After automatic wakeup from timeout (See Config_setSuspendMaxTime), the system can automatically shutdown or just wake up.

Supported Platform(s): Yukon, V510, V710, V1000, V1200, X1200

Parameters
shutdownEnabled/Disabled
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setVideoStartupPowerConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setVideoStartupPowerConfig ( CONFIGHANDLE  ,
uint8_t  config 
)

Set Video power at startup configuration. The status of Video power at startup and at resume from suspended mode. At resume from suspend, this setting overrides the setting of the setVideoPowerStatus function.

Supported Platform(s): XL, XM, XS, XA

Parameters
configBitwise representation of the four video channels. See the VideoXConf defines. if the bit is 1, the power is enabled, else disabled.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Config_setWakeupTriggerCfg()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Config_setWakeupTriggerCfg ( CONFIGHANDLE  ,
WakeupTriggerCfg  config,
CCStatus  status 
)

Set Wake-up trigger configuration. See enum WakeupTriggerCfg for more details.

Supported Platform(s): Yukon, V510, V710, V1000, V1200, X1200

Parameters
configSee enum WakeupTriggerCfg.
statusstatus (Enabled/Disabled)
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ GetConfig()

EXTERN_C CCAUXDLL_API CONFIGHANDLE CCAUXDLL_CALLING_CONV CrossControl::GetConfig ( void  )

Factory function that creates instances of the Config object.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Returns
CONFIGHANDLE to an allocated Config object. The returned handle needs to be deallocated using the Config_release(CONFIGHANDLE) method when it's no longer needed. Returns NULL if it fails to allocate memory.

Example Usage:

assert(pConfig);
conf_example(pConfig);
Config_release(pConfig);