CCAux Documentation

Introduction

This documentation is generated from the CCAux source code. CCAux (CrossControl Common Aux control) is an API that gives access to settings, features and many hardware interfaces; backlight, buzzer, diagnostics, frontled, lightsensor and analog video interfaces.
The API is available for multiple platforms and operating systems:
Linux on the legacy platforms (supported in an older version of the API):
XA, XS, VC, VA, XM, VI2, VS and X900.
Linux on the current platforms (supported in the latest version of the API):
X1200, V700 and Yukon platform (CCpilot V1000, V1200, V510, V710, V705) products in all variations.
Windows (XP, 7, 8, 10) on the X900, X1200, XM and XL platforms.

The known issues and changelog presented here also cover the following CrossControl applications (which are using the API and are released in conjunction with it):

• ccsettings
• ccvideo
• ccsettingsconsole
• touchcalibrator
• ccauxd

Go directly to the functions by class or the table of supported functions per platform.

Changelog

Version 2.20.0.0 - All platforms

• License of the API and related sources changed to LGPLv2.1
• Add mcp2210 proxy for improved SPI performance (X900)
• Add ROHM BU2730 light sensor userspace driver (X1200)
• Support standalone compilation of the API in the CC Linux SDK
• New function AuxVersion_getAllCanFdMcuVersions()
• Add bootmode configuration support (X1200)
• Bugfix: Possible corruption after SS and IOMCU update

Version 2.19.0.0 - All platforms

• Added the 510/710 as supported platforms
• Clean up and tidy the API sources
• V700: support for About_getUserEepromData() and About_setUserEepromData()
• New function AuxVersion_getFullSSVersion()
• New function AuxVersion_getIOMCUVersion()
• New function Button_getButtonDownStatus()
• New function Button_getBacklightPattern()
• New function Button_setBacklightPattern()
• New function Button_getBootBacklightPattern()
• New function Button_setBootBacklightPattern()
• New function Button_getStartupButtons()
• New function Button_setStartupButtons()
• New function Button_getWakeupButtons()
• New function Button_setWakeupButtons()
• New function Button_getSuspendButtons()
• New function Button_setSuspendButtons()
• New function Button_getShutdownButtons()
• New function Button_setShutdownButtons()
• New function Button_getLongPressTime()
• New function Button_setLongPressTime()
• New function CfgIn_getActiveIomcu()
• New function CfgIn_setActiveIomcu()
• New function FirmwareUpgrade_startIOMCUUpgrade()
• New function FirmwareUpgrade_startIOMCUVerification()
• New function PWMOut_getActiveIomcu()
• New function PWMOut_setActiveIomcu()

Version 2.18.7.0 - All platforms

• Added support for checking trigger availability from SS.
• New function Config_getTriggerAvailability()

Version 2.18.6.0 - All platforms

• Added support to read DMCU version numbers
• New function AuxVersion_getDMCUVersion()

Version 2.18.5.0 - All platforms

• Added support for the user configurable eeprom section at the end of the ICM eeprom.
• Updated Function prototype Config_getPreIgnitionTrigTime()
• Updated Function prototype Config_setPreIgnitionTrigTime()

Version 2.18.4.0 - All platforms

• Added support for the user configurable eeprom section at the end of the ICM eeprom.
• Updated Function prototype Config_getWakeupTriggerCfg()
• Updated Function prototype Config_setWakeupTriggerCfg()

Version 2.18.3.0 - Yukon platforms

• New Function Config_getStartupTriggerCfg()
• New Function Config_setStartupTriggerCfg()
• New Function Config_getActionTriggerCfg()
• New Function Config_setActionTriggerCfg()
• New Function Config_getWakeupTriggerCfg()
• New Function Config_setWakeupTriggerCfg()

Version 2.18.2.0 - Yukon platforms

• New Function Config_getSuspendMaxTimeShutdownAfterResume()
• New Function Config_setSuspendMaxTimeShutdownAfterResume()

Version 2.18.1.0 - VS, VI2, X900, Yukon platforms

• Bugfix: Added parameter checks and updated parameter descriptions for the functions Config_setShortBeepSettings and Config_setLongBeepSettings.
• New Function Config_getOSAliveMonitoringTimeout()
• New Function Config_setOSAliveMonitoringTimeout()

Version 2.18.0.0 - Yukon platform

• New feature: Added initial support for new platform. (Yukon)
• Added support for settable minimum backlight intensity for automatic backlight (default value 1). (ALL)
• New Function FirmwareUpgrade_startDMCUUpgrade()
• New Function FirmwareUpgrade_startDMCUVerification()
• New Function Diagnostic_getHardShutDowns()
• New Function Diagnostic_getTimerExt()
• New Function FrontLED_setActive()
• New Function FrontLED_getActive()
• New Function FrontLED_setColorExt()
• New Function FrontLED_getColorExt()
• New Function FrontLED_setBootLEDConfigExt()
• New Function FrontLED_getBootLEDConfigExt()
• New Function FrontLED_setPostBootLEDConfigExt()
• New Function FrontLED_getPostBootLEDConfigExt()
• New Function Lightsensor_setActive()
• New Function Lightsensor_getActive()
• New Function Backlight_setActive()
• New Function Backlight_getActive()
• New Function Buzzer_setActive()
• New Function Buzzer_getActive()
• ccsettingsconsole: New DMCU releated functions added (status led/buzzer/backlight/lightsensor) (Yukon)

Version 2.17.6.0 - V700 platform

• Change: Removed CAN_POWER and invalid backlight control (V700)
• ccsettingsconsole: Removed unsupported features. (V700)
• ccsettingsconsole: Bugfix: –about=RawEEPROM prints segfault. (V700)
• ccsettingsconsole: New feature: CPU temp can now be read. (V700)
• ccsettingsconsole: New feature: Added support for setting minimum automatic backlight intensity. (ALL)
• ccsettingsconsole: New feature: Added support for beep settings. (V700, VS)
• ccsettingsconsole: New feature: Added support for setting boot and post-boot LED settings. (V700, VS, VI2)
• ccsettingsconsole: Bugfix: Wrong order for ADC voltage strings (V700)

Version 2.17.5.0 - XL5, V700 platforms

• Backlight parameters settable from registry (CCAuxService - XM9-Win, XL5-Win)
• Initial release for v700 platform

Version 2.17.3.0 - XL5 platform

• Bugifx for Video_getDecoderReg which was broken in 2.9.0.0 (XM,XL)
• Initial release for XL5 platform

Version 2.17.2.0 - XM9 platform

• Removed telematics support (XM9)
• Removed suspend support (XM9-Windows)

Version 2.17.1.0 - XM9-Win platform

• Support for SS firmware update over SPI (XM9-Win)
• Now supporting the Config_getOnOffSignalState function (XM9)

Version 2.17.0.0 - XM9, VS, VI2 platforms

• Suspend support added - VS platform
• NTSC video support added - VS platform
• Bugfix in several Backlight functions. No longer allow automatic BL for devices without light sensor.
• Bugfix for About_getUnitSerial() - VS platform
• Bugfix: Config_set/getOnOffTriggerMode now returns ERR_NOT_SUPPORTED when used with SS older than 1.1.0.0 as using Config_setOnOffTriggerMode could make the device not able to boot with older SS versions - VS platform
• New function AuxVersion_getCanFdApiVersion() - XM9 platform
• New function AuxVersion_getFullOSVersion()
• New funciton AuxVersion_getFullCCAuxVersion()
• ccsettingsconsole: Added error message if user tries to update SS from normal system - (VS & VI2)
• ccsettingsconsole: Added support to get/set CAN-FD data baud rate - (XM9)
• ccsettingsconsole: System Report added (ccsettingsconsole –about=SystemReport)
• ccsettings: Added support to get/set CAN-FD data baud rate (XM9)
• ccsettings: Tag names of CCAux and OS versions are now shown in version tab and in the system report
• ccsettings: Added CAN-FD MCU to version tab (XM9)
• ccsettings: Added CAN-FD MCU SW update & verification (XM9)

Version 2.16.2.0 - XM2, XM9, VS, VI2 platforms

• CCpilot XM9 support.
• Added the following functions:
  • CanSetting_getFlexibleDataBaudrates()
    
  • CanSetting_setFlexibleDataBaudrates()
    
  • AuxVersion_getCanFdMcuVersion()
    

Version 2.16.1.0 - XM2 platform

• Bugfix for supported platforms of About_getNrOfPWMOutConnections().
• Bugfix for supported platforms of the Telematic class functions.
• Bugfix for Video_getDecoderReg() function. Fixes bug introduced in 2.9.0.0 where this function stopped working.

Version 2.16.0.0 - VS and VI2 platforms

• Bugfix for ICM EEPROM read/writes - VS and VI2 platforms
• Updated description of how to use error status byte in DigIO_getDigPowerOutput() - VS platform
• Added support for About_getNrOfCfgInConnections() - VS platform
• Bugfix for About_getNrOfSerialConnections() - VS platform

Version 2.15.1.0 - VC platform

• Bugfix for a multithreading issue affecting the following classes:
  • About
  • Auxversion
  • Backlight
  • Battery
  • Buzzer
  • CfgIn
  • Config
  • Diagnostic
  • FrontLED
  • Telematics

Version 2.15.0.0 - VI2 platform

• New function About_getNrOfAnalogInputs() - VI2 platform
• Bugfix for CFGIN_NOT_IN_USE - VI2 platform
• Added examples for SoftKey class - VI2 platform

Version 2.14.0.23 - XM9 platform

• See separate release notes.

Version 2.14.0.0 - all platforms

• New function About_getIsPCBBluetoothAvailable() for reading PCB Bluetooth chip status from EEPROM - VI2 platform
• Bugfix for About_getNrOfButtons() - VI2 platform
• Bugfix for opening files from read only file system - All platforms

Version 2.13.2.25 - XM9 platform

• See separate release notes.

Version 2.13.0.0 - VS and VI2 platforms

• Initial support for VI2 platform
• New class SoftKey for VI2 platform pushbutton’s status and backlight
• Added support for AuxVersion_getFPGAVersion() - VS platform

Version 2.12.0.0 - VS platform

• New functions Buzzer_getScaledVolume(), Buzzer_setScaledVolume() for all platforms. Replaces Buzzer_getVolume(), Buzzer_setVolume() which may be removed in a future version.
• CrossControl Software License Agreement replaces the Maximatecc Software License Agreement.

Version 2.11.0.0 - VS platform

• New functions Config_getShortBeepSettings(), Config_setShortBeepSettings(), Config_getLongBeepSettings(), Config_setLongBeepSettings(), FrontLED_getBootLEDConfig(), FrontLED_setBootLEDConfig(), FrontLED_getPostBootLEDConfig() and FrontLED_setPostBootLEDConfig() for VS platform.
• About_getNrOfUSBConnections() now reports correct number of USB ports for VS platform.
• About_hasOsBooted() support added for VS platform.

Version 2.10.0.0 - VS platform

• Initial support for VS platform.
• New functions DigIO_getDigPowerOutput(), DigIO_setDigPowerOutput(), Config_getDigPowerOutputStartupConfig() and Config_setDigPowerOutputStartupConfig() for VS platform.

Version 2.9.0.0 - XA/XS/VC/VA and XM2 Linux platforms

• The entire api code base is converted to use typedefs for integer and float types (int8_t, int16_t etc.), defined in CCAuxTypes.h. This may affect your build if you use functions that previously had "unsigned long" arguments. They should be converted to "unsigned int" or "uint32_t".
• Memory leaks, security and reliability fixes.
• ccsettingsconsole: Limited backlight and lightsensor support.
• Improved stability of firmware updates.

Version 2.8.3.0 - VC/VA Linux platforms

• Support for VA platform.
• Code corrections based on static analysis which should lead to improved reliability.
• Config_getOnOffSignalState() API function added.
• Config_getOnOffTriggerMode() and Config_setOnOffTriggerMode() API functions added.
• Using modified stm32flash for stm32 flashing in Linux.
• The function Telematics_getGPSAntennaStatus() is not supported in the XA/XS platform.
• The function Telematics_getGPSAntennaStatus() is only supported on revision A XM AI add-on boards.

Version 2.7.4.0 - VC Linux platform

• Bugfixes and documentation updates.

Version 2.7.3.0 - VC Linux platform

• Added functions CfgIn_getMinFrequencyThreshold() and CfgIn_setMinFrequencyThreshold().
• Added restrictions on the usage of start-up triggers in combination with button configurations.

Version 2.7.2.0 - XM/XL Windows x86, x64 platform, VC Linux platform

• XM/XL, Windows: Fixed a bug introduced in 2.7.0.0 where the light sensor data could not be read on XM/XL.
• CCSettingsConsole: Fixed an issue where some commands did not work in Windows.

Version 2.7.1.0 - XM/XL Windows x86, x64 platform, VC Linux platform

• ccvideo: Fixed an issue where channels were not displayed correctly in the menu.
  

Version 2.7.0.0 - XM/XL Windows x86, x64 platform, VC Linux platform

• VC: Support for the VC platform (Linux).
  
• XM/XL: Support for the XM 2.0 platform (Windows/Linux).
  
• Added the following classes/functions for the VC platform:
  • Class CfgIn - Functions for managing configurable inputs
  • Class PWMOut - Functions for managing PWM outputs
  • About_getNrOfCfgInConnections()
  • About_getNrOfPWMOutConnections()
  • About_getNrOfButtons()
  • About_getNrOfButtons()
  • Config_getButtonFunction()
  • Config_setButtonFunction()
• Added the following functions for all platforms:
  • About_getUserEepromData()
  • About_setUserEepromData()
  
  
• Known issues:
  • XA/XS: Same as 2.4.7.0 release
  • XM/XL: Same as 2.5.0.0 release
  • VC: -

Version 2.6.2.0 - XM/XL Windows x86, x64 platform

• XM/XL: Fix for an issue with the function Video_getActiveChannel() in x86 API on x64 OS.
  
• XM/XL: Support for Power_getCanOCDStatus() and Power_getVideoOCDStatus() with SS v1.2.0.0 or later.
• XM/XL: Support for optional integrated WLAN on CCpilot XL4.
• XM/XL: CCsettings: Improved Telematic GUI when not all interfaces are available.
• XM/XL: SnbService: Improved unit type descriptions: "CCpilot XM" instead of just "XM".
• XM/XL: CCsettings, CCvideo and TouchCalibrator: QT x86 libraries updated to v4.8.5.
  
  
• Known issues:
  • XA/XS: Same as 2.4.7.0 release
  • XM/XL: Same as 2.5.0.0 release

Version 2.6.1.0 - XM/XL Windows x86, x64 platform and XA/XS Linux platform

• XA/XS: Functions added: Video_getGraphicsOverlay() and Video_setGraphicsOverlay().
• XM/XL: 64-bit support. Both x86 and x64 versions of the API can be installed at the same time on x64 systems.
• XM/XL: SnbService is now a selectable component in the installer.
• XM/XL: CCsettings: Factory default settings for XL4 updated: ShortButtonPressAction=ActionShutDown, OnOffSigAction=NoAction
  
  
• Known issues:
  • XA/XS: Same as 2.4.7.0 release
  • XM/XL: Same as 2.5.0.0 release

Version 2.5.0.0 - XM/XL x86 platform

• CCAux2 API: Support for the XL platform. The XL platform is almost identical to the XM platform in terms of API support.
• CCAux2 API: Added SMART support for a second card used in XL (new functions Smart_getRemainingLifeTime2(), Smart_getDeviceSerial2() and Smart_getInitialTime2()).
• CCAux2 API: Bugfix for crash when incorrect filename was supplied to the functions FirmwareUpgrade_startFpgaUpgrade() and FirmwareUpgrade_startFpgaVerification().
• CCvideo: Fixed a bug where selecting video 3 and 4 both selected video 3. The bug was only present in CCvideo v2.4.0.0 for XM and not in previous versions.
• CCvideo,CCAuxDrv: On the XL platform, video channel 3 and 4 are not available on both devices as on XM. Instead ch1 and ch2 can be selected for both devices.
  Only one channel can be shown at the same time per device and a device is on the XL platform equal to a physical connector.
• CCAux2CS: Added support for SMART interface for the C# dll
• CCAux2CS: Rewrote the following functions and changed their declaration to use System.String as output. The old overloads now return ERR_NOT_SUPPORTED:
  About_getMainPCBSerial()
  About_getUnitSerial()
  About_getMainPCBArt()
  About_getMainManufacturingDate()
  About_getMainHWversion()
  About_getMainProdRev()
  About_getMainProdArtNr()
  About_getAddOnPCBSerial()
  About_getAddOnPCBArt()
  About_getAddOnManufacturingDate()
  About_getAddOnHWversion()
  FirmwareUpgrade_startFpgaUpgrade()
  FirmwareUpgrade_startFpgaVerification()
  FirmwareUpgrade_startSSUpgrade()
  FirmwareUpgrade_startSSVerification()
  FirmwareUpgrade_startFrontUpgrade()
  FirmwareUpgrade_startFrontVerification()
  Video_takeSnapshot()
  
  
• Known issues:
  • Some API functions are missing from ccsettingsconsole and CCAux2CS.

Version 2.4.7.0 - XM Linux platform

• XM: Improved fault-handling in function PowerMgr_registerControlledSuspendOrShutDown()
  
  
• Known issues:
  • Same as 2.4.6.0 release

Version 2.4.6.0 - XA/XS platform

• XA/XS: Improve initialization of video channels 3/4
• XA/XS: Prevent scrolling when changing between video channels 3/4
• Calling Buzzer_buzze() no longer leaks memory
  
  
• Known issues:
  • Same as 2.4.0.0 release (minus Buzzer_buzze memory leak)

Version 2.4.2.0 - XA/XS platform

• XA/XS: Config_getRS485Enabled() and Config_setRS485Enabled() now uses settings file for intermediate storage
  
  
• Known issues:
  • Same as 2.4.0.0 release

Version 2.4.0.0 - XA/XS, XM platforms

• Removed the following functions: Config_get/set TFT Mode/Scan/Mirror
• Optimized version queries of different firmware components
• Bugfixes for Backlight and Lightsensor
• The factory defaults settings in CCsettings no longer generates errors
• CCSettings and StartupGUI rebranded for maximatecc
• CCSettings now adapts to the number of CAN ports available
• Added the following function blocks: Battery, PowerMgr and SmartSmart from 1.x API
• XM: CCAux2 is now fully supported on the XM platform with the same functionality as in the 1.6.4.0 release.
• XM: CCAux api 1.6.4.0 will be available for backwards compability. It is compatible back to the 1.3.1.0 release.
• XA/XS: Config_setRS485Enabled() now sets MP_RS422_MODE GPIO pins to correct state
• XA/XS: Video_setMirroring() implemented
• XA/XS: Playing two video channels simultaneously now works (1/2+3/4)
• XA/XS: Video can be cropped from left/right for channels 3/4
• XA/XS: Various other improvements for video channels 3/4
• XA/XS: Video standard now reported correctly
• XA/XS: ccvideo context menu now appearing consistently
• XA/XS: ccvideo context menu hanging now fixed
• XA/XS: ccvideo blanking now fixed
• XA/XS: ccvideo now handles rotation
• XA/XS: ccsettingsconsole now up to date
• XA/XS: Context menu no longer opened while calibrating
• XA/XS: The PowerOnAtStartup setting ("Always start when power turned on" in CCsettings) was always read as Enabled
• XA/XS: 1V2 is now a supported ADC channel on some instances
• XA/XS: Added TS_TCHAUTOCAL in TouchScreen class
• ccauxd: Fixed issues that caused crash when shutting the daemon off
• ccauxd: Added support for PowerMgr
  
  
• Known issues:
  • XA/XS: When automatic backlight is enabled, updating SS or Front uC software is very slow and may fail. Workaround: Make sure automatic backlight is disabled before attempting to do any firmware upgrade.
  • XA/XS: CCSettings - Advanced: After Firmware update, the shutdown button does not work. Workaround: Turn off power to the device.
  • Some info/functions are missing from ccsettingsconsole
  • XA/XS: About_hasOsBooted() can return true even when not all drivers have not been loaded (API)
  • XA/XS: Calling Buzzer_buzze() in non-blocking mode leaks memory

Version 2.3.0.0 - XA/XS platform

• Functions added: Backlight_getHWStatus(), Config_getRS485Enabled() and Config_setRS485Enabled()
• CCSettings: Led tab improved
• CCSettings: Hide unsupported options in Power tab
• CCSettings: Hide suspend options if unsupported by HW
• CCSettings: Fixed rotation glitches
• Bugfixes
  
  
• Known issues:
  • Same as 2.2.0.0 release

Version 2.2.0.0 - XA/XS platform

• Functions added: About_getIsAnybusMounted(), Config_setTFTMode(), Config_getTFTMode(), Video_showFrame() and About_getIOExpanderValue()
• Fixed rotation issues with GUI applications
• Many bugfixes
  
  
• Known issues:
  • When automatic backlight is enabled, updating SS or Front uC software is very slow and may fail. Workaround: Make sure automatic backlight is disabled before attempting to do any firmware upgrade.
  • CCSettings - Advanced: After Firmware update, the shutdown button does not work. Workaround: Turn off power to the device.
  • Some info/functions are missing from ccsettingsconsole
  • About_hasOsBooted() can return true even when not all drivers have not been loaded (API)
  • Calling Buzzer_buzze() in non-blocking mode leaks memory
  • ccvideo: Rightclick (long press) menu not appearing consistently
  • Calling Video_showVideo() for ports 3/4 will not return if no camera is attached
  • Cannot show analog video from two ports simultaneously (1/2+3/4), trying to do so leads to crash
  • For ports 3/4, video sometimes scrolls or has wrong size when starting the application first time
  • API calls for analog video currently not supported: get/setMirroring, get/setCropping (for ports 3/4), get/setDeInterlaceMode, get/setScaling, get/setColorKeys
  • ccvideo: Selecting "Mirror image" does not have an effect

Version 2.1.0.0 - XA/XS platform

• Functions added: Power_getVideoOCDStatus(), Power_getCanOCDStatus() and About_hasOsBooted()
• Touch calibration can be started from CCSettings
• 7" touch calibration now supported
• Many bugfixes
  
  
• Known issues:
  • About_hasOsBooted() can return true even when not all drivers have not been loaded
  • Analog video API only supports VIDEO1/2 ports
  • Video control only supports positioning and resizing
  • The factory defaults button in the Advanced tab in CCSettings produces some error messages. These can be ignored

Version 2.0.0.0 - XA/XS platform

• Initial release
• The CCAux API v1.x from the CCpilot XM platform has been rewritten to ensure compability between releases
• Porting to CCpilot XA/XS platform nearly complete. Some new platform specific functions remain to be implemented
• The API gives access to several hardware interfaces, for example backlight, buzzer, diagnostics, frontled, lightsensor and analog video interfaces
  
  
• Known issues:
  • Digital input/output does not work correctly
  • CAN settings interface does not work
  • Analog video API only supports VIDEO1/2 ports
  • Video control only supports positioning and resizing
  • SS/Front software update - sometimes crashes before update has begun. When this happens (segmentation fault or Open failed error), restart the unit and try again
  • Font issue in CCSettings causes some text to disappear
  • TouchCalibrator cannot be started from within CCSettings. Instead it can be started manually: # TouchCalibrator -qws
    
  • The factory defaults button in the Advanced tab in CCSettings produces some error messages. These can be ignored
  • Error messages related to automatic backlight will show the very first time the Display tab in CCsettings is opened. These can be ignored.
  • GetHWErrorStatusString functions do not return correct description of error messages

Known Issues

• XA/XS: Unsupported API calls for analog video: get/setDeInterlaceMode, get/setScaling, get/setColorKeys, get/setCropping (for ports 3/4)
• XA/XS: ccvideostream: de-interlacing artifacts with certain output window sizes