hallcurrent8120a 2.0.0.0
hallcurrent8120a.h File Reference

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

Macros

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

Enumerations

enum  hallcurrent8120a_return_value_t { HALLCURRENT8120A_OK = 0 , HALLCURRENT8120A_ERROR = -1 }
 Hall Current 8 120A Click return value data. More...
 

Functions

void hallcurrent8120a_cfg_setup (hallcurrent8120a_cfg_t *cfg)
 Hall Current 8 120A configuration object setup function.
 
err_t hallcurrent8120a_init (hallcurrent8120a_t *ctx, hallcurrent8120a_cfg_t *cfg)
 Hall Current 8 120A initialization function.
 
err_t hallcurrent8120a_read_pin_value (hallcurrent8120a_t *ctx, uint16_t *data_out)
 Hall Current 8 120A read AN pin value function.
 
err_t hallcurrent8120a_read_pin_volt (hallcurrent8120a_t *ctx, float *data_out)
 Hall Current 8 120A read AN pin voltage level function.
 
err_t hallcurrent8120a_calibration (hallcurrent8120a_t *ctx)
 Hall Current 8 120A calibration function.
 
err_t hallcurrent8120a_get_voltage (hallcurrent8120a_t *ctx, float *avr_voltage)
 Hall Current 8 120A read voltage level function.
 
err_t hallcurrent8120a_get_current (hallcurrent8120a_t *ctx, float *current)
 Hall Current 8 120A get current level function.
 
uint8_t hallcurrent8120a_get_odc1 (hallcurrent8120a_t *ctx)
 Hall Current 8 120A get state of OC1 function.
 
uint8_t hallcurrent8120a_get_odc2 (hallcurrent8120a_t *ctx)
 Hall Current 8 120A get state of OC2 function.
 

Detailed Description

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

Enumeration Type Documentation

◆ hallcurrent8120a_return_value_t

Hall Current 8 120A Click return value data.

Predefined enum values for driver return values.

Enumerator
HALLCURRENT8120A_OK 
HALLCURRENT8120A_ERROR