currentsens2 2.1.0.0
Data Structures | Macros | Enumerations | Functions
currentsens2.h File Reference

This file contains API for Current Sens 2 Click Driver. More...

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

Go to the source code of this file.

Data Structures

struct  currentsens2_t
 Current Sens 2 Click context object. More...
 
struct  currentsens2_cfg_t
 Current Sens 2 Click configuration object. More...
 

Macros

#define CURRENTSENS2_CONV_FACTOR   10
 Current Sens 2 description setting. More...
 
#define CURRENTSENS2_NUM_CONVERSIONS   10
 
#define CURRENTSENS2_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  currentsens2_return_value_t { CURRENTSENS2_OK = 0 , CURRENTSENS2_ERROR = -1 }
 Current Sens 2 Click return value data. More...
 

Functions

void currentsens2_cfg_setup (currentsens2_cfg_t *cfg)
 Current Sens 2 configuration object setup function. More...
 
err_t currentsens2_init (currentsens2_t *ctx, currentsens2_cfg_t *cfg)
 Current Sens 2 initialization function. More...
 
err_t currentsens2_read_an_pin_value (currentsens2_t *ctx, uint16_t *data_out)
 Current Sens 2 read AN pin value function. More...
 
err_t currentsens2_read_an_pin_voltage (currentsens2_t *ctx, float *data_out)
 Current Sens 2 read AN pin voltage level function. More...
 
uint8_t currentsens2_get_int_pin (currentsens2_t *ctx)
 Current Sens 2 get int pin state function. More...
 
err_t currentsens2_tare (currentsens2_t *ctx)
 Current Sens 2 tare function. More...
 
err_t currentsens2_get_current (currentsens2_t *ctx, float *current)
 Current Sens 2 read current function. More...
 

Detailed Description

This file contains API for Current Sens 2 Click Driver.

Enumeration Type Documentation

◆ currentsens2_return_value_t

Current Sens 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
CURRENTSENS2_OK 
CURRENTSENS2_ERROR