ammeter_api.h

Go to the documentation of this file.

 
#ifndef _AMMETER_API_H_
#define _AMMETER_API_H_
 
/****************************************************************************************/
/* INCLUDE FILES                                                                        */
/****************************************************************************************/
 // @defgroup instruments
 
 
 
#ifndef __bool_true_false_are_defined
#define __bool_true_false_are_defined 1
#ifndef __cplusplus /* In C++, 'bool', 'true' and 'false' and keywords */
#define bool char
#define true 1
#define false 0
#else
#ifdef __GNUC__
/* GNU C++ supports direct inclusion of stdbool.h to provide C99
compatibility by defining _Bool */
#define BOOL bool
#endif
#endif
#endif /* __bool_true_false_are_defined */
 
#define AMMETER_API_EXPORTS
#ifdef AMMETER_API_EXPORTS
#define AMMETER_API __declspec(dllexport)
#else
#define AMMETER_API __declspec(dllimport)
#endif
 
 
 
#define AMMETER_CALLBACK(A, Y, Z) (A != NULL) ? A(Y, Z) : ((void)0)
 
#define AMMETER_STR_SIZE                   256
typedef enum _AMMETER_API_STATUS_CODES
{
    AMMETER_API_SUCCESS                     = 0,
    AMMETER_API_ERROR,
    AMMETER_API_INVALID_DBG_PARAMS,
    AMMETER_API_DBG_DLL_ERROR,
    AMMETER_API_START,
    AMMETER_API_READ_OK
}AMMETER_API_STATUS_CODES;
#ifdef __cplusplus    // If used by C++ code,
extern "C" {          // we need to export the C interface
#endif
 
typedef void (*_callback_ammeter)(int status, double val);
 
AMMETER_API int ammeter_api_dbg_init(_dbg_params *dbg_params_t);
 
AMMETER_API int ammeter_api_dbg_close(void);
 
AMMETER_API int ammeter_api_init(const char *iface,
    _callback_ammeter callback_ammeter);
 
AMMETER_API int ammeter_api_close(void);
 
AMMETER_API int ammeter_api_shunt_res(float shunt_res);
 
AMMETER_API int ammeter_api_range(double range);
 
AMMETER_API int ammeter_api_resolution(double resolution);
 
AMMETER_API int ammeter_api_samples(uint32_t samples);
 
AMMETER_API int ammeter_api_gen_cmd(const char *gen_cmd);
 
AMMETER_API int ammeter_api_measure(void);
 
#ifdef __cplusplus
}
#endif // @defgroup ammeter_api
 
#endif //_AMMETER_API_H_