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

This file contains API for Hall Current 21 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  hallcurrent21_t
 Hall Current 21 Click context object. More...
 
struct  hallcurrent21_cfg_t
 Hall Current 21 Click configuration object. More...
 

Macros

#define HALLCURRENT21_INPUT_CHANNEL_VREF   0
 Hall Current 21 input channel selection. More...
 
#define HALLCURRENT21_INPUT_CHANNEL_VOUT   1
 
#define HALLCURRENT21_NUM_CONVERSIONS   200
 Hall Current 21 default ADC samples number for averaging. More...
 
#define HALLCURRENT21_ADC_RESOLUTION   0x0FFF
 Hall Current 21 ADC setting. More...
 
#define HALLCURRENT21_VREF_3V3   3.3
 
#define HALLCURRENT21_VREF_5V   5.0
 
#define HALLCURRENT21_TIMEOUT_MS   2000
 Hall Current 21 timeout setting. More...
 
#define HALLCURRENT21_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
 Data sample selection. More...
 
#define HALLCURRENT21_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
 
#define HALLCURRENT21_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  hallcurrent21_return_value_t { HALLCURRENT21_OK = 0, HALLCURRENT21_ERROR = -1 }
 Hall Current 21 Click return value data. More...
 

Functions

void hallcurrent21_cfg_setup (hallcurrent21_cfg_t *cfg)
 Hall Current 21 configuration object setup function. More...
 
err_t hallcurrent21_init (hallcurrent21_t *ctx, hallcurrent21_cfg_t *cfg)
 Hall Current 21 initialization function. More...
 
err_t hallcurrent21_read_raw_adc (hallcurrent21_t *ctx, uint8_t channel, uint16_t *raw_adc)
 Hall Current 21 read raw ADC value function. More...
 
err_t hallcurrent21_read_voltage (hallcurrent21_t *ctx, uint8_t channel, float *voltage)
 Hall Current 21 read voltage level function. More...
 
err_t hallcurrent21_read_voltage_avg (hallcurrent21_t *ctx, uint8_t channel, uint16_t num_conv, float *voltage_avg)
 Hall Current 21 read average voltage level function. More...
 
void hallcurrent21_set_vref (hallcurrent21_t *ctx, float vref)
 Hall Current 21 set vref function. More...
 
err_t hallcurrent21_calib_resolution (hallcurrent21_t *ctx, float calib_current)
 Hall Current 21 calib resolution function. More...
 
err_t hallcurrent21_read_current (hallcurrent21_t *ctx, float *current)
 Hall Current 21 read current function. More...
 

Detailed Description

This file contains API for Hall Current 21 Click Driver.

Enumeration Type Documentation

◆ hallcurrent21_return_value_t

Hall Current 21 Click return value data.

Predefined enum values for driver return values.

Enumerator
HALLCURRENT21_OK 
HALLCURRENT21_ERROR