CfgIn.h

Go to the documentation of this file.

/************************************************
*
*  CROSSCONTROL AUX API
*
*  CfgIn.h
*
*  Version 2.7.2.0, 2014-08-25
*
*  (c) maximatecc 2013
*
*  File description: 
*  Configurable inputs
*
*  Use the function GetCfgIn() to get a handle to pass on to the other functions.
*  Use the method CfgIn_release(CFGINHANDLE) to return the handle.
*
*  Example Usage:
*  @include cfgin_example.cpp
*
************************************************/
#ifndef CC_CFGIN_H
#define CC_CFGIN_H

#include "CCAuxErrors.h"
#include "CCPlatform.h"

#ifdef __cplusplus
namespace CrossControl {
#endif

  typedef void* CFGINHANDLE;

  EXTERN_C
    CCAUXDLL_API
    CFGINHANDLE
    CCAUXDLL_CALLING_CONV
    GetCfgIn(void);

  EXTERN_C
    CCAUXDLL_API
    void
    CCAUXDLL_CALLING_CONV
    CfgIn_release(CFGINHANDLE);


  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    CfgIn_setCfgInMode (CFGINHANDLE, unsigned char channel, CfgInModeEnum set_mode);


  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    CfgIn_getCfgInMode (CFGINHANDLE, unsigned char channel, CfgInModeEnum* get_mode);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    CfgIn_getValue (CFGINHANDLE, unsigned char channel, unsigned short* sample_value);


  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    CfgIn_getPwmValue (CFGINHANDLE, unsigned char channel, float* frequency, unsigned char* duty_cycle);


#ifdef __cplusplus
} /* namespace CrossControl */
#endif

#endif /* CC_CFGIN_H */