hallcurrent825a 2.0.0.0
hallcurrent825a.h File Reference

This file contains API for Hall Current 8 25A 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  hallcurrent825a_t
 Hall Current 8 25A Click context object. More...
 
struct  hallcurrent825a_cfg_t
 Hall Current 8 25A Click configuration object. More...
 

Macros

#define HALLCURRENT825A_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  hallcurrent825a_return_value_t { HALLCURRENT825A_OK = 0 , HALLCURRENT825A_ERROR = -1 }
 Hall Current 8 25A Click return value data. More...
 

Functions

void hallcurrent825a_cfg_setup (hallcurrent825a_cfg_t *cfg)
 Hall Current 8 25A configuration object setup function.
 
err_t hallcurrent825a_init (hallcurrent825a_t *ctx, hallcurrent825a_cfg_t *cfg)
 Hall Current 8 25A initialization function.
 
err_t hallcurrent825a_read_pin_value (hallcurrent825a_t *ctx, uint16_t *data_out)
 Hall Current 8 25A read AN pin value function.
 
err_t hallcurrent825a_read_pin_volt (hallcurrent825a_t *ctx, float *data_out)
 Hall Current 8 25A read AN pin voltage level function.
 
err_t hallcurrent825a_calibration (hallcurrent825a_t *ctx)
 Hall Current 8 25A calibration function.
 
err_t hallcurrent825a_get_voltage (hallcurrent825a_t *ctx, float *avr_voltage)
 Hall Current 8 25A read voltage level function.
 
err_t hallcurrent825a_get_current (hallcurrent825a_t *ctx, float *current)
 Hall Current 8 25A get current level function.
 
uint8_t hallcurrent825a_get_odc1 (hallcurrent825a_t *ctx)
 Hall Current 8 25A get state of OC1 function.
 
uint8_t hallcurrent825a_get_odc2 (hallcurrent825a_t *ctx)
 Hall Current 8 25A get state of OC2 function.
 

Detailed Description

This file contains API for Hall Current 8 25A Click Driver.

Enumeration Type Documentation

◆ hallcurrent825a_return_value_t

Hall Current 8 25A Click return value data.

Predefined enum values for driver return values.

Enumerator
HALLCURRENT825A_OK 
HALLCURRENT825A_ERROR