Config functions

Functions
EXTERN_C CCAUXDLL_API CONFIGHANDLE CCAUXDLL_CALLING_CONV	GetConfig ()
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_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_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_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_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_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_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_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_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)

Detailed Description

Video channel 4 config

Functions in the Config class

Function Documentation

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_number	Which button to configure (1-MAX_BUTTONS)
button_config	Bitfield 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:

  CrossControl::ButtonConfigEnum btnconf;
  CrossControl::eErr error;
  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)
      {
      case BUTTON_ONLY_MP_ACTION: cout << "Application only" << std::endl; break;
      case BUTTON_AS_STARTUP_TRIG:  cout << "Startup trigger" << std::endl; break;
      case BUTTON_AS_ACTION_TRIG: cout << "Action trigger" << std::endl; break;
      case BUTTON_AS_ACTION_STARTUP_TRIG: cout << "Action and Startup trigger" << std::endl; break;
      case BUTTON_AS_BACKLIGHT_DECREASE: cout << "Backlight decrease" << std::endl; break;
      case BUTTON_AS_BACKLIGHT_DECR_STARTUP_TRIG: cout << "Backlight decrease and Startup trigger" << std::endl; break;
      case BUTTON_AS_BACKLIGHT_INCREASE: cout << "Backlight increase" << std::endl; break;
      case BUTTON_AS_BACKLIGHT_INCR_STARTUP_TRIG: cout << "Backlight increase and Startup trigger" << std::endl; break;
      default: cout << "Invalid value" << std::endl; break;
      }
    }
  }

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, XM, XS, XA

Parameters

status

Enabled/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

output	Select power output (PowerOutput1 or PowerOutput2) .
enabled	Is 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, XM

Parameters

status

Enabled/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, XM, XM9, XS, XA, VC, VS, VI2

Parameters

triggertime

Time 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, XM, XM9, XS, XA, VC

Parameters

triggertime

Time 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. The maximum value is +5 degrees Celsius.

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

Parameters

temperature

The current heating limit, in degrees Celsius (-25 to +5)

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

Parameters

duration	Long beep duration (ms)
frequency	Long beep frequency (Hz)
volume	Long beep volume (0-2000)

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, XM, XM9, XS, XA, VC, VS, VI2

Parameters

action

The 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

Parameters

mode	Next 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, XM, XM9, XS, XA, VC, VS, VI2

Parameters

action

The 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): XA, XS, VC, VA, VS, VI2

Parameters

enabled

Is 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): XA, XS, VC, VA, VS, VI2

Parameters

mode	Signal 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

Parameters

enabled

Is OS Alive monitoring enabled/disabled

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, XM, XM9, XS, XA, VC, VS, VI2

Parameters

status

Enabled/Disabled

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

port	RS4XX port (RS4XXPort1-4)
enabled	Is 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

Parameters

duration	Short beep duration (ms)
frequency	Short beep frequency (Hz)
volume	Short beep volume (0-2000)

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, XM, XM9, XS, XA, VC, VS, VI2

Parameters

action

The configured action.

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, XM9, XS, XA, VC, VS, VI2

Parameters

config

See 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)
    {
    case Front_Button_Enabled: cout << "Front button only" << endl; break;
    case OnOff_Signal_Enabled:  cout << "On/Off signal only" << endl; break;
    case Both_Button_And_Signal_Enabled: cout << "Front button or On/off signal" << endl; break;

      // The below values are only available on the VC platform     
    case CAN_Button_Activity: cout << "Wake up on CAN and Buttons" << endl; break;
    case CAN_OnOff_Activity: cout << "Wake up on CAN and On/Off/Ignition signal" << endl; break;
    case CAN_Button_OnOff_Activity: cout << "Wake up on CAN, Buttons and On/Off/Ignition signal" << endl; break;
    case CI_Button_Activity: cout << "Wake up on CI and Button State Change" << endl; break;
    case CI_OnOff_Activity: cout << "Wake up on CI and OnOff Signal State Change" << endl; break;
    case CI_Button_OnOff_Activity: cout << "Wake up on CI, Button and OnOff Signal State Change" << endl; break;
    case CI_CAN_Button_Activity: cout << "Wake up on CI, CAN and Button State Change" << endl; break;
    case CI_CAN_OnOff_Activity: 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;
  } 

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, XM, XM9

Parameters

voltage

The 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, VC, VI2

Parameters

maxTime

Maximum 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_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, XM, XS, XA

Parameters

config

Bitwise 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_release()

EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV CrossControl::Config_release

(

CONFIGHANDLE

)

Delete the Config object.

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

Returns

-

Example Usage:

  CONFIGHANDLE pConfig = ::GetConfig();
  assert(pConfig);

  conf_example(pConfig);

  Config_release(pConfig);

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_number	Which button to configure (1-MAX_BUTTONS)
button_config	Bitfield 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, XM, XS, XA

Parameters

status

Enabled/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

output	Select power output (PowerOutput1 or PowerOutput2).
enabled	Configure 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, XM

Parameters

status

Enabled/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, XM, XM9, XS, XA, VC, VS, VI2

Parameters

triggertime

Time 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, XM, XM9, XS, XA, VC, VS, VI2

Parameters

triggertime

Time 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. The maximum value is +5 degrees Celsius.

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

Parameters

temperature

The heating limit, in degrees Celsius (-25 to +5)

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

Parameters

duration	Long beep duration (ms)
frequency	Long beep frequency (Hz)
volume	Long beep volume (0-2000)

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, XM, XM9, XS, XA, VC, VS, VI2

Parameters

action

The 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

Parameters

mode	BootMode 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, XM, XM9, XS, XA, VC, VS, VI2

Parameters

action

The 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): XA, XS, VC, VA, VS, VI2

Parameters

mode	Signal 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

Parameters

enabled

Enable/Disable OS Alive Monitoring

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, XM, XM9, XS, XA, VC, VS, VI2

Parameters

status

Enabled/Disabled

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

port	RS4XX port (RS4XXPort1-4)
enabled	RS485 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

Parameters

duration	Short beep duration (ms)
frequency	Short beep frequency (Hz)
volume	Short beep volume (0-2000)

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, XM, XM9, XS, XA, VC, VS, VI2

Parameters

action

The action to set.

Returns

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

Example Usage:

  err = Config_setShortButtonPressAction(pConfig, ActionSuspend);
  if (err == ERR_SUCCESS) 
  {
    cout << "ShortButtonPressAction set to Suspend!" << endl;
  }
  else
  {
    cout << "Error(" << err << ") in function setShortButtonPressAction: " << GetErrorStringA(err) << endl;
  }

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. See enum TriggerConf for more details.

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

Parameters

conf	See 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, XM, XM9

Parameters

voltage

The 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, VC, VI2

Parameters

maxTime

Maximum 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_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

config

Bitwise 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.

GetConfig()

EXTERN_C CCAUXDLL_API CONFIGHANDLE CCAUXDLL_CALLING_CONV CrossControl::GetConfig

(

)

Factory function that creates instances of the Config object.

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

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:

  CONFIGHANDLE pConfig = ::GetConfig();
  assert(pConfig);

  conf_example(pConfig);

  Config_release(pConfig);