CfgIn.h

Go to the documentation of this file.

/************************************************
*
*  CROSSCONTROL AUX API
*
*  CfgIn.h
*
*  Version 2.17.0.0", 2019-10-22
*
*  (c) CrossControl 2010-2019
*

 *  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, uint8_t channel, CfgInModeEnum set_mode);

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

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    CfgIn_getValue (CFGINHANDLE, uint8_t channel, uint16_t* sample_value);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    CfgIn_getPwmValue (CFGINHANDLE, uint8_t channel, float32_t* frequency, uint8_t* duty_cycle);
    
  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    CfgIn_getFrequencyValue (CFGINHANDLE, uint8_t channel, float32_t* frequency);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    CfgIn_getMinFrequencyThreshold (CFGINHANDLE, uint8_t channel, float32_t* frequency);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    CfgIn_setMinFrequencyThreshold (CFGINHANDLE, uint8_t channel, float32_t frequency);

    EXTERN_C
      CCAUXDLL_API
      eErr
      CCAUXDLL_CALLING_CONV
      CfgIn_setFrequencyFilterLevel (CFGINHANDLE, uint8_t level);

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

#endif /* CC_CFGIN_H */