About.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2023 CrossControl AB
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; with
 * version 2.1 of the License.
 */
/*
 *  File description:
 *  Get information about the CCpilot computer.
 *
 *  Use the function GetAbout() to get a handle to pass on to the other functions.
 *  Use the method About_release(ABOUTHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include about_example.cpp
 *
 ************************************************/
 
#ifndef CC_ABOUT_H_
#define CC_ABOUT_H_
 
#include "CCAuxErrors.h"
#include "CCPlatform.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
typedef void *ABOUTHANDLE;
 
EXTERN_C
CCAUXDLL_API
ABOUTHANDLE
CCAUXDLL_CALLING_CONV
GetAbout(void);
 
EXTERN_C
CCAUXDLL_API
void CCAUXDLL_CALLING_CONV About_release(ABOUTHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getMainPCBSerial(ABOUTHANDLE, char_t *buff, int32_t len);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getUnitSerial(ABOUTHANDLE, char_t *buff, int32_t len);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getMainPCBArt(ABOUTHANDLE, char_t *buff, int32_t length);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getMainManufacturingDate(ABOUTHANDLE, char_t *buff, int32_t len);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getMainHWversion(ABOUTHANDLE, char_t *buff, int32_t len);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getMainProdRev(ABOUTHANDLE, char_t *buff, int32_t len);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getMainProdArtNr(ABOUTHANDLE, char_t *buff, int32_t len);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getNrOfETHConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getNrOfCANConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getNrOfVideoConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getNrOfUSBConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getNrOfSerialConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getNrOfDigIOConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getIsDisplayAvailable(ABOUTHANDLE, bool *available);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getIsTouchScreenAvailable(ABOUTHANDLE, bool *available);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getIsPCBBluetoothAvailable(ABOUTHANDLE, bool *available);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getDisplayResolution(ABOUTHANDLE, char_t *buff, int32_t len);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getAddOnPCBSerial(ABOUTHANDLE, char_t *buff, int32_t len);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getAddOnPCBArt(ABOUTHANDLE, char_t *buff, int32_t length);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getAddOnManufacturingDate(ABOUTHANDLE, char_t *buff, int32_t len);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getAddOnHWversion(ABOUTHANDLE, char_t *buff, int32_t len);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getIsWLANMounted(ABOUTHANDLE, bool *mounted);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getIsGPSMounted(ABOUTHANDLE, bool *mounted);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getIsGPRSMounted(ABOUTHANDLE, bool *mounted);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getIsBTMounted(ABOUTHANDLE, bool *mounted);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getFrontPcbRev(ABOUTHANDLE, uint8_t *major, uint8_t *minor);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getIsIOExpanderMounted(ABOUTHANDLE, bool *mounted);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getIOExpanderValue(ABOUTHANDLE, uint16_t *value);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_hasOsBooted(ABOUTHANDLE, bool *bootComplete);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getIsAnybusMounted(ABOUTHANDLE, bool *mounted);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getNrOfCfgInConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getNrOfPWMOutConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getNrOfButtons(ABOUTHANDLE, int32_t *numbuttons);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getNrOfAnalogInputs(ABOUTHANDLE, int32_t *numanalogins);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_getUserEepromData(ABOUTHANDLE, char_t *buff, uint16_t length);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV About_setUserEepromData(ABOUTHANDLE, uint16_t startpos, const char_t *buff, uint16_t length);
 
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#endif /* CC_ABOUT_H_ */