currentlimit6 2.0.0.0
currentlimit6.h File Reference

This file contains API for Current Limit 6 Click Driver. More...

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

Go to the source code of this file.

Data Structures

struct  currentlimit6_t
 Current Limit 6 Click context object. More...
 
struct  currentlimit6_cfg_t
 Current Limit 6 Click configuration object. More...
 

Macros

#define CURRENTLIMIT6_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
 Data sample selection.
 
#define CURRENTLIMIT6_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
 
#define CURRENTLIMIT6_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  currentlimit6_return_value_t { CURRENTLIMIT6_OK = 0 , CURRENTLIMIT6_ERROR = -1 }
 Current Limit 6 Click return value data. More...
 
enum  currentlimit6_pwr_mode_value_t { CURRENTLIMIT6_PWR_OFF = 0 , CURRENTLIMIT6_PWR_ON = 1 }
 Current Limit 6 Click power mode data. More...
 

Functions

void currentlimit6_cfg_setup (currentlimit6_cfg_t *cfg)
 Current Limit 6 configuration object setup function.
 
err_t currentlimit6_init (currentlimit6_t *ctx, currentlimit6_cfg_t *cfg)
 Current Limit 6 initialization function.
 
err_t currentlimit6_default_cfg (currentlimit6_t *ctx)
 Current Limit 6 default configuration function.
 
err_t currentlimit6_power_mode (currentlimit6_t *ctx, currentlimit6_pwr_mode_value_t pwr_mode)
 Current Limit 6 power mode function.
 
err_t currentlimit6_generic_write (currentlimit6_t *ctx, uint8_t data_in)
 Current Limit 6 data writing function.
 
err_t currentlimit6_set_current_limit (currentlimit6_t *ctx, float current_limit)
 Current Limit 6 set current limit function.
 
uint8_t currentlimit6_check_limit_exceeded (currentlimit6_t *ctx)
 Current Limit 6 check limit exceeded function.
 
uint8_t currentlimit6_check_voltage_err (currentlimit6_t *ctx)
 Current Limit 6 check voltage error function.
 

Detailed Description

This file contains API for Current Limit 6 Click Driver.

Enumeration Type Documentation

◆ currentlimit6_pwr_mode_value_t

Current Limit 6 Click power mode data.

Predefined enum values for driver power mode values.

Enumerator
CURRENTLIMIT6_PWR_OFF 
CURRENTLIMIT6_PWR_ON 

◆ currentlimit6_return_value_t

Current Limit 6 Click return value data.

Predefined enum values for driver return values.

Enumerator
CURRENTLIMIT6_OK 
CURRENTLIMIT6_ERROR