profet23a 2.0.0.0
profet23a.h File Reference

This file contains API for PROFET 2 3A 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  profet23a_t
 PROFET 2 3A Click context object. More...
 
struct  profet23a_cfg_t
 PROFET 2 3A Click configuration object. More...
 

Macros

#define PROFET23A_MODE_ON   1
 PROFET mode settings.
 
#define PROFET23A_MODE_OFF   2
 
#define PROFET23A_DIAGNOSTIC_ON   3
 
#define PROFET23A_DIAGNOSTIC_OFF   4
 
#define PROFET23A_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  profet23a_return_value_t { PROFET23A_OK = 0 , PROFET23A_ERROR = -1 , PROFET23A_ERROR_CHANNEL = -2 }
 PROFET 2 3A Click return value data. More...
 
enum  profet23a_channel_t { PROFET23A_CHANNEL_0 = 0 , PROFET23A_CHANNEL_1 = 1 }
 PROFET 2 3A channel select. More...
 

Functions

void profet23a_cfg_setup (profet23a_cfg_t *cfg)
 PROFET 2 3A configuration object setup function.
 
err_t profet23a_init (profet23a_t *ctx, profet23a_cfg_t *cfg)
 PROFET 2 3A initialization function.
 
err_t profet23a_default_cfg (profet23a_t *ctx)
 PROFET 2 3A default configuration function.
 
err_t profet23a_read_an_pin_value (profet23a_t *ctx, uint16_t *data_out)
 Read AN pin value function.
 
err_t profet23a_read_an_pin_voltage (profet23a_t *ctx, float *data_out)
 Read AN pin voltage level function.
 
void profet23a_set_dsl (profet23a_t *ctx, uint8_t state)
 Set diagnostic select pin state.
 
void profet23a_set_den (profet23a_t *ctx, uint8_t state)
 Set diagnostic enable pin state.
 
void profet23a_set_in1 (profet23a_t *ctx, uint8_t state)
 Set channel 1 enable pin state.
 
void profet23a_set_in0 (profet23a_t *ctx, uint8_t state)
 Set channel 0 enable pin state.
 
err_t profet23a_set_mode (profet23a_t *ctx, profet23a_channel_t channel, uint8_t mode)
 Set mode device mode for specific channel channel.
 

Detailed Description

This file contains API for PROFET 2 3A Click Driver.

Enumeration Type Documentation

◆ profet23a_channel_t

PROFET 2 3A channel select.

Specified setting for channel select of PROFET 2 3A Click driver.

Enumerator
PROFET23A_CHANNEL_0 
PROFET23A_CHANNEL_1 

◆ profet23a_return_value_t

PROFET 2 3A Click return value data.

Predefined enum values for driver return values.

Enumerator
PROFET23A_OK 
PROFET23A_ERROR 
PROFET23A_ERROR_CHANNEL