magneto7 2.0.0.0
magneto7.h File Reference

This file contains API for Magneto 7 Click driver. More...

#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  magneto7_t
 Click ctx object definition. More...
 
struct  magneto7_cfg_t
 Click configuration structure definition. More...
 

Macros

#define MAGNETO7_MAP_MIKROBUS(cfg, mikrobus)
 
#define MAGNETO7_RETVAL   uint8_t
 
#define MAGNETO7_OK   0x00
 
#define MAGNETO7_INIT_ERROR   0xFF
 
#define MAGNETO7_DEV_ADDR_L   0x0E
 
#define MAGNETO7_DEV_ADDR_H   0x0F
 
#define MAGNETO7_INFO_L   0x0D
 
#define MAGNETO7_INFO_H   0x0E
 
#define MAGNETO7_WIA   0x0F
 
#define MAGNETO7_DATA_X_L   0x10
 
#define MAGNETO7_DATA_X_H   0x11
 
#define MAGNETO7_DATA_Y_L   0x12
 
#define MAGNETO7_DATA_Y_H   0x13
 
#define MAGNETO7_DATA_Z_L   0x14
 
#define MAGNETO7_DATA_Z_H   0x15
 
#define MAGNETO7_STA1   0x18
 
#define MAGNETO7_CNTL_1   0x1B
 
#define MAGNETO7_CNTL_2   0x1C
 
#define MAGNETO7_CNTL_3   0x1D
 
#define MAGNETO7_AVE_A   0x40
 
#define MAGNETO7_CNTL_4_L   0x5C
 
#define MAGNETO7_CNTL_4_H   0x5D
 
#define MAGNETO7_TEMP_L   0x60
 
#define MAGNETO7_TEMP_H   0x61
 
#define MAGNETO7_OFF_X_L   0x6C
 
#define MAGNETO7_OFF_X_H   0x6D
 
#define MAGNETO7_OFF_Y_L   0x72
 
#define MAGNETO7_OFF_Y_H   0x73
 
#define MAGNETO7_OFF_Z_L   0x78
 
#define MAGNETO7_OFF_Z_H   0x79
 
#define MAGNETO7_FINEOUTPUTX_L   0x90
 
#define MAGNETO7_FINEOUTPUTX_H   0x91
 
#define MAGNETO7_FINEOUTPUTY_L   0x92
 
#define MAGNETO7_FINEOUTPUTY_H   0x93
 
#define MAGNETO7_FINEOUTPUTZ_L   0x94
 
#define MAGNETO7_FINEOUTPUTZ_H   0x95
 
#define MAGNETO7_GAIN_PARA_X_L   0x9C
 
#define MAGNETO7_GAIN_PARA_X_H   0x9D
 
#define MAGNETO7_GAIN_PARA_Y_L   0x9E
 
#define MAGNETO7_GAIN_PARA_Y_H   0x9F
 
#define MAGNETO7_GAIN_PARA_Z_L   0xA0
 
#define MAGNETO7_GAIN_PARA_Z_H   0xA1
 
#define MAGNETO7_X_AXIS   0x00
 
#define MAGNETO7_Y_AXIS   0x01
 
#define MAGNETO7_Z_AXIS   0x02
 
#define MAGNETO7_SENSOR_RES_12_BIT   0x00
 
#define MAGNETO7_SENSOR_RES_14_BIT   0x01
 

Functions

void magneto7_cfg_setup (magneto7_cfg_t *cfg)
 Config Object Initialization function.
 
MAGNETO7_RETVAL magneto7_init (magneto7_t *ctx, magneto7_cfg_t *cfg)
 Initialization function.
 
uint8_t magneto7_default_cfg (magneto7_t *ctx)
 Click Default Configuration function.
 
void magneto7_generic_write (magneto7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function.
 
void magneto7_generic_read (magneto7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function.
 
uint8_t magneto7_int_get (magneto7_t *ctx)
 Getting INT pin state function.
 
uint8_t magneto7_get_register (magneto7_t *ctx, uint8_t register_address, uint8_t *data_buffer, uint8_t n_data)
 Getting register value(s) function.
 
uint8_t magneto7_set_register (magneto7_t *ctx, uint8_t register_address, uint8_t *data_buffer, uint8_t n_data)
 Setting register value(s) function.
 
uint8_t magneto7_set_offset (magneto7_t *ctx, uint8_t offset_axis, uint8_t offset_value)
 Setting offset values function.
 
void magneto7_get_temperature (magneto7_t *ctx, uint16_t *device_temperature)
 Getting raw device temperature value function.
 
void magneto7_get_data (magneto7_t *ctx, int16_t *x_axis, int16_t *y_axis, int16_t *z_axis)
 Getting data function.
 
void magneto7_get_fine_data (magneto7_t *ctx, uint16_t *x_axis, uint16_t *y_axis, uint16_t *z_axis)
 Getting fine data function.
 
float magneto7_convert_to_ut (magneto7_t *ctx, int16_t raw_data, uint8_t sensor_resolution)
 Getting fine data function.
 
void magneto7_get_gain_para (magneto7_t *ctx, uint16_t *x_axis, uint16_t *y_axis, uint16_t *z_axis)
 Getting gain data function.
 

Detailed Description

This file contains API for Magneto 7 Click driver.