tmrmixsens 2.0.0.0

Functions

void tmrmixsens_cfg_setup (tmrmixsens_cfg_t *cfg)
 Config Object Initialization function.
 
TMRMIXSENS_RETVAL tmrmixsens_init (tmrmixsens_t *ctx, tmrmixsens_cfg_t *cfg)
 Initialization function.
 
tmrmixsens_data_t tmrmixsens_generic_read (tmrmixsens_t *ctx)
 Generic read function.
 
uint8_t tmrmixsens_get_omnipolar (tmrmixsens_t *ctx)
 Get state of the omnipolar ( OMN ) pin function.
 
uint8_t tmrmixsens_get_bipolar (tmrmixsens_t *ctx)
 Get state of the bipolar ( BI ) pin function.
 

Detailed Description

Function Documentation

◆ tmrmixsens_cfg_setup()

void tmrmixsens_cfg_setup ( tmrmixsens_cfg_t * cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ tmrmixsens_generic_read()

tmrmixsens_data_t tmrmixsens_generic_read ( tmrmixsens_t * ctx)

Generic read function.

Parameters
ctxClick object.
Returns
ADC data

@description This function read ADC data.

◆ tmrmixsens_get_bipolar()

uint8_t tmrmixsens_get_bipolar ( tmrmixsens_t * ctx)

Get state of the bipolar ( BI ) pin function.

Parameters
ctxClick object.
Returns
state of the bipolar:
  • 0 : inactive, Nort pole;
  • 1 : active state, South pole;

@description This function respond to changes north or south magnetic pole and return a state of the bipolar ( BI ) pin on the TMR mix-sens Click.

◆ tmrmixsens_get_omnipolar()

uint8_t tmrmixsens_get_omnipolar ( tmrmixsens_t * ctx)

Get state of the omnipolar ( OMN ) pin function.

Parameters
ctxClick object.
Returns
state of the omnipolar:
  • 0 : inactive;
  • 1 : active state;

@description This function react to the presence of a magnetic field and returns a state of the omnipolar ( OMN ) pin on the TMR mix-sens Click.

◆ tmrmixsens_init()

TMRMIXSENS_RETVAL tmrmixsens_init ( tmrmixsens_t * ctx,
tmrmixsens_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.