CfgIn.h

Go to the documentation of this file.

 
/*
 *  Copyright (C) 2010-2023 CrossControl AB - All rights reserved
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 * This source code is licensed under the proprietary CrossControl software
 * license v 1.0. Please refer to the software license text for details or
 * contact info@crosscontrol.com for more info.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */
/*
 *  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 release 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, uint16_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_getActiveIomcu(CFGINHANDLE, uint8_t *ioindex);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV CfgIn_setActiveIomcu(CFGINHANDLE, uint8_t ioindex);
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#endif /* CC_CFGIN_H */