vcpmonitor4.h File Reference

This file contains API for VCP Monitor 4 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"

Go to the source code of this file.

Data Structures
struct	vcpmonitor4_t
	VCP Monitor 4 Click context object. More...
struct	vcpmonitor4_cfg_t
	VCP Monitor 4 Click configuration object. More...

Macros
#define	VCPMONITOR4_REG_CONFIG   0x00
	VCP Monitor 4 description register.
#define	VCPMONITOR4_REG_ADC_CONFIG   0x01
#define	VCPMONITOR4_REG_SHUNT_CAL   0x02
#define	VCPMONITOR4_REG_VSHUNT   0x04
#define	VCPMONITOR4_REG_VBUS   0x05
#define	VCPMONITOR4_REG_DIETEMP   0x06
#define	VCPMONITOR4_REG_CURRENT   0x07
#define	VCPMONITOR4_REG_POWER   0x08
#define	VCPMONITOR4_REG_DIAG_ALERT   0x0B
#define	VCPMONITOR4_REG_SOVL   0x0C
#define	VCPMONITOR4_REG_SUVL   0x0D
#define	VCPMONITOR4_REG_BOVL   0x0E
#define	VCPMONITOR4_REG_BUVL   0x0F
#define	VCPMONITOR4_REG_TEMP_LIMIT   0x10
#define	VCPMONITOR4_REG_PWR_LIMIT   0x11
#define	VCPMONITOR4_REG_MANUFACTURER_ID   0x3E
#define	VCPMONITOR4_REG_DEVICE_ID   0x3F
#define	VCPMONITOR4_CURRENT_LSB   0.000305
	VCP Monitor 4 description setting.
#define	VCPMONITOR4_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.
#define	VCPMONITOR4_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
#define	VCPMONITOR4_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	vcpmonitor4_return_value_t { vcpmonitor4_OK = 0 , vcpmonitor4_ERROR = -1 }
	VCP Monitor 4 Click return value data. More...

Functions
void	vcpmonitor4_cfg_setup (vcpmonitor4_cfg_t *cfg)
	VCP Monitor 4 configuration object setup function.
err_t	vcpmonitor4_init (vcpmonitor4_t *ctx, vcpmonitor4_cfg_t *cfg)
	VCP Monitor 4 initialization function.
err_t	vcpmonitor4_default_cfg (vcpmonitor4_t *ctx)
	VCP Monitor 4 default configuration function.
err_t	vcpmonitor4_generic_write (vcpmonitor4_t *ctx, uint8_t reg, uint16_t data_in)
	VCP Monitor 4 data writing function.
err_t	vcpmonitor4_generic_read (vcpmonitor4_t *ctx, uint8_t reg, uint32_t *data_out)
	VCP Monitor 4 data reading function.
uint8_t	vcpmonitor4_get_alert (vcpmonitor4_t *ctx)
	Get alert pin state.
err_t	vcpmonitor4_get_temperature (vcpmonitor4_t *ctx, float *temperature)
	Get device temperature.
err_t	vcpmonitor4_get_vbus (vcpmonitor4_t *ctx, float *vbus)
	Get BUS voltage.
err_t	vcpmonitor4_get_vshunt (vcpmonitor4_t *ctx, float *vshunt)
	Get Shunt voltage.
err_t	vcpmonitor4_get_current (vcpmonitor4_t *ctx, float *current)
	Get Current.
err_t	vcpmonitor4_get_power (vcpmonitor4_t *ctx, float *power)
	Get Shunt voltage.

Detailed Description

This file contains API for VCP Monitor 4 Click Driver.

Enumeration Type Documentation

vcpmonitor4_return_value_t

enum vcpmonitor4_return_value_t

VCP Monitor 4 Click return value data.

Predefined enum values for driver return values.

Enumerator
vcpmonitor4_OK
vcpmonitor4_ERROR