ammeter_api.h File Reference

API header file that all current measurement DLL plug-ins should use. More...

Go to the source code of this file.

Macros
#define	__bool_true_false_are_defined   1
#define	bool   char
#define	true   1
#define	false   0
#define	AMMETER_API_EXPORTS
#define	AMMETER_API   __declspec(dllexport)
#define	AMMETER_CALLBACK(A, Y, Z)   (A != NULL) ? A(Y, Z) : ((void)0)
	Callback macro definition for NULL check. More...
#define	AMMETER_STR_SIZE   256
	Callback result string data size. More...

Typedefs
typedef enum _AMMETER_API_STATUS_CODES	AMMETER_API_STATUS_CODES
	The Current measurement instrument API return status codes.
typedef void(*	_callback_ammeter) (int status, double val)
	Current measurement API callback function type definition. More...

Enumerations
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 }
	The Current measurement instrument API return status codes. More...

Functions
AMMETER_API int	ammeter_api_dbg_init (_dbg_params *dbg_params_t)
	Current measurement instrument debug session initialize. More...
AMMETER_API int	ammeter_api_dbg_close (void)
	Current measurement instrument debug session close. More...
AMMETER_API int	ammeter_api_init (const char *iface, _callback_ammeter callback_ammeter)
	Current measurement instrument initialize function. More...
AMMETER_API int	ammeter_api_close (void)
	Current measurement instrument close function and free allocated resources. More...
AMMETER_API int	ammeter_api_shunt_res (float shunt_res)
	Set the shunt resistor value. Only used if voltmeters or NI-DAQs are used to measure current. More...
AMMETER_API int	ammeter_api_range (double range)
	Set the ampere range that the instrument will operate. More...
AMMETER_API int	ammeter_api_resolution (double resolution)
	Set the resolution that the instrument will operate. More...
AMMETER_API int	ammeter_api_samples (uint32_t samples)
	Set the number of samples/measurements that the instrument will take and average. More...
AMMETER_API int	ammeter_api_gen_cmd (const char *gen_cmd)
	Set a SCPI command that will be passed to the instrument. Multiple, column separated commands, are supported. More...
AMMETER_API int	ammeter_api_measure (void)
	Perform a current measurement and return the result. More...

Detailed Description

API header file that all current measurement DLL plug-ins should use.

Copyright (C) 2022 Dialog Semiconductor. This computer program includes Confidential, Proprietary Information of Dialog Semiconductor. All Rights Reserved.

bluet.nosp@m.ooth.nosp@m..supp.nosp@m.ort@.nosp@m.diase.nosp@m.mi.c.nosp@m.om

Definition in file ammeter_api.h.