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

This file contains API for Hall Current 19 Click Driver. More...

#include "mikrosdk_version.h"
#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  hallcurrent19_t
 Hall Current 19 Click context object. More...
 
struct  hallcurrent19_cfg_t
 Hall Current 19 Click configuration object. More...
 

Macros

#define HALLCURRENT19_SENSITIVITY_V_TO_A   0.1
 Hall Current 19 Current calculation values. More...
 
#define HALLCURRENT19_ZERO_CURRENT_OFFSET   0.5
 
#define HALLCURRENT19_NUM_CONVERSIONS   1000
 
#define HALLCURRENT19_OUTPUT_VOLTAGE   3.0f
 
#define HALLCURRENT19_OCD_ACTIVE   0
 Hall Current 19 Over Current Detection values. More...
 
#define HALLCURRENT19_OCD_INACTIVE   1
 
#define HALLCURRENT19_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  hallcurrent19_return_value_t { HALLCURRENT19_OK = 0 , HALLCURRENT19_ERROR = -1 }
 Hall Current 19 Click return value data. More...
 

Functions

void hallcurrent19_cfg_setup (hallcurrent19_cfg_t *cfg)
 Hall Current 19 configuration object setup function. More...
 
err_t hallcurrent19_init (hallcurrent19_t *ctx, hallcurrent19_cfg_t *cfg)
 Hall Current 19 initialization function. More...
 
err_t hallcurrent19_default_cfg (hallcurrent19_t *ctx)
 Hall Current 19 default configuration function. More...
 
err_t hallcurrent19_read_an_pin_value (hallcurrent19_t *ctx, uint16_t *data_out)
 Hall Current 19 read AN pin value function. More...
 
err_t hallcurrent19_read_voltage (hallcurrent19_t *ctx, float *data_out)
 Hall Current 19 read AN pin voltage level function. More...
 
uint8_t hallcurrent19_get_oc1 (hallcurrent19_t *ctx)
 Hall Current 19 get over current detection 1 state function. More...
 
uint8_t hallcurrent19_get_oc2 (hallcurrent19_t *ctx)
 Hall Current 19 get over current detection 2 state function. More...
 
err_t hallcurrent19_set_zero_ref (hallcurrent19_t *ctx)
 Hall Current 19 set zero reference function. More...
 
err_t hallcurrent19_get_current (hallcurrent19_t *ctx, float *current)
 Hall Current 19 get current function. More...
 

Detailed Description

This file contains API for Hall Current 19 Click Driver.

Enumeration Type Documentation

◆ hallcurrent19_return_value_t

Hall Current 19 Click return value data.

Predefined enum values for driver return values.

Enumerator
HALLCURRENT19_OK 
HALLCURRENT19_ERROR