hallcurrent  2.0.0.0
Data Structures | Macros | Functions
hallcurrent.h File Reference

This file contains API for Hall Current Click driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"

Go to the source code of this file.

Data Structures

struct  hallcurrent_t
 Click ctx object definition. More...
 
struct  hallcurrent_cfg_t
 Click configuration structure definition. More...
 

Macros

#define HALLCURRENT_MAP_MIKROBUS(cfg, mikrobus)
 
#define HALLCURRENT_RETVAL   uint8_t
 
#define HALLCURRENT_OK   0x00
 
#define HALLCURRENT_INIT_ERROR   0xFF
 

Functions

void hallcurrent_cfg_setup (hallcurrent_cfg_t *cfg)
 Config Object Initialization function. More...
 
HALLCURRENT_RETVAL hallcurrent_init (hallcurrent_t *ctx, hallcurrent_cfg_t *cfg)
 Initialization function. More...
 
void hallcurrent_generic_transfer (hallcurrent_t *ctx, spi_master_transfer_data_t *block)
 Generic transfer function. More...
 
uint16_t hallcurrent_read_data (hallcurrent_t *ctx)
 Generic read 16-bit data function. More...
 
uint8_t hallcurrent_chack_status (hallcurrent_t *ctx)
 Check status of read data function. More...
 
float hallcurrent_read_current (hallcurrent_t *ctx)
 Read electric current function. More...
 

Detailed Description

This file contains API for Hall Current Click driver.