force2 2.0.0.0
force2.h File Reference

This file contains API for Force 2 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  force2_t
 Force 2 Click context object. More...
 
struct  force2_cfg_t
 Force 2 Click configuration object. More...
 

Macros

#define FORCE2_FORCE_MIN   0.0f
 Force 2 setting.
 
#define FORCE2_FORCE_MAX   15.0f
 
#define FORCE2_VREF   3.3f
 
#define FORCE2_MAP_MIKROBUS(cfg, mikrobus)    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN );
 MikroBUS pin mapping.
 

Enumerations

enum  force2_return_value_t { FORCE2_OK = 0 , FORCE2_ERROR = -1 }
 Force 2 Click return value data. More...
 

Functions

void force2_cfg_setup (force2_cfg_t *cfg)
 Force 2 configuration object setup function.
 
err_t force2_init (force2_t *ctx, force2_cfg_t *cfg)
 Force 2 initialization function.
 
err_t force2_read_an_pin_value (force2_t *ctx, uint16_t *data_out)
 Force 2 read AN pin value function.
 
err_t force2_read_an_pin_voltage (force2_t *ctx, float *data_out)
 Force 2 read AN pin voltage level function.
 

Detailed Description

This file contains API for Force 2 Click Driver.

Enumeration Type Documentation

◆ force2_return_value_t

Force 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
FORCE2_OK 
FORCE2_ERROR