current4 2.0.0.0
current4.h File Reference

This file contains API for Current 4 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  current4_t
 Current 4 Click context object. More...
 
struct  current4_cfg_t
 Current 4 Click configuration object. More...
 

Macros

#define CURRENT4_MAP_MIKROBUS(cfg, mikrobus)    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN );
 MikroBUS pin mapping.
 

Enumerations

enum  current4_return_value_t { CURRENT4_OK = 0 , CURRENT4_ERROR = -1 }
 Current 4 Click return value data. More...
 

Functions

void current4_cfg_setup (current4_cfg_t *cfg)
 Current 4 configuration object setup function.
 
err_t current4_init (current4_t *ctx, current4_cfg_t *cfg)
 Current 4 initialization function.
 
err_t current4_read_an_pin_value (current4_t *ctx, uint16_t *data_out)
 Read AN pin value function.
 
err_t current4_read_an_pin_voltage (current4_t *ctx, float *data_out)
 Read AN pin voltage level function.
 
err_t current4_read_load_current (current4_t *ctx, float *load_current)
 Read load current.
 

Detailed Description

This file contains API for Current 4 Click Driver.

Enumeration Type Documentation

◆ current4_return_value_t

Current 4 Click return value data.

Predefined enum values for driver return values.

Enumerator
CURRENT4_OK 
CURRENT4_ERROR