ups3.h File Reference

This file contains API for UPS 3 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"

Go to the source code of this file.

Data Structures
struct	ups3_t
	UPS 3 Click context object. More...
struct	ups3_cfg_t
	UPS 3 Click configuration object. More...

Macros
#define	UPS3_DIR_MODE_BACKUP   0x00
	UPS 3 description setting.
#define	UPS3_DIR_MODE_CHARGE   0x01
#define	UPS3_ENABLE_SHUTDOWN   0x00
	UPS 3 description setting.
#define	UPS3_ENABLE_NORMAL_OPERATION   0x01
#define	UPS3_GET_ERROR_CMPIN_OK   0x00
	UPS 3 general purpose comparator setting.
#define	UPS3_GET_ERROR_CMPIN_EMPTY   0x01
#define	UPS3_GET_CAP_OK_FBV_LOW   0x00
	UPS 3 voltage ok indicator setting.
#define	UPS3_GET_CAP_OK_FBV_HIGH   0x01
#define	UPS3_GET_CHRG_CHARGE_MODE   0x00
	UPS 3 charge/backup mode indicator setting.
#define	UPS3_GET_CHRG_BACKUP_MODE   0x01
#define	UPS3_SUCCESS   0
	UPS 3 error status.
#define	UPS3_ERROR   -1
#define	UPS3_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Functions
void	ups3_cfg_setup (ups3_cfg_t *cfg)
	UPS 3 configuration object setup function.
err_t	ups3_init (ups3_t *ctx, ups3_cfg_t *cfg)
	UPS 3 initialization function.
err_t	ups3_default_cfg (ups3_t *ctx)
	UPS 3 default configuration function.
uint8_t	ups3_get_error (ups3_t *ctx)
	UPS 3 get error function.
uint8_t	ups3_get_cap_ok (ups3_t *ctx)
	UPS 3 pin get capacitor ok function.
uint8_t	ups3_get_chrg (ups3_t *ctx)
	UPS 3 get charge/backup mode function.
err_t	ups3_select_dir_mode (ups3_t *ctx, uint8_t dir_mode)
	UPS 3 pin select direction of the operation modes function.
err_t	ups3_set_enable (ups3_t *ctx, uint8_t enable)
	UPS 3 enable device function.
err_t	ups3_hw_reset (ups3_t *ctx)
	UPS 3 reset the device function.

Detailed Description

This file contains API for UPS 3 Click Driver.