magneto10.h File Reference

This file contains API for Magneto 10 Click Driver. More...

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

Go to the source code of this file.

Data Structures
struct	magneto10_t
	Magneto 10 Click context object. More...
struct	magneto10_cfg_t
	Magneto 10 Click configuration object. More...

Macros
#define	MAGNETO10_REG_STAT1   0x00
	Magneto 10 register map.
#define	MAGNETO10_REG_X_LSB   0x01
#define	MAGNETO10_REG_X_MSB   0x02
#define	MAGNETO10_REG_Y_LSB   0x03
#define	MAGNETO10_REG_Y_MSB   0x04
#define	MAGNETO10_REG_Z_LSB   0x05
#define	MAGNETO10_REG_Z_MSB   0x06
#define	MAGNETO10_REG_STAT2   0x07
#define	MAGNETO10_REG_T_LSB   0x08
#define	MAGNETO10_REG_T_MSB   0x09
#define	MAGNETO10_REG_CID   0x0A
#define	MAGNETO10_REG_DID   0x0B
#define	MAGNETO10_REG_CTRL   0x10
#define	MAGNETO10_REG_RST   0x11
#define	MAGNETO10_REG_OSR_DIG_FILT   0x14
#define	MAGNETO10_REG_T_EN_DIG_FILT_Z   0x15
#define	MAGNETO10_MODE_IDLE   0x00
	Magneto 10 operating mode values.
#define	MAGNETO10_MODE_SINGLE_MEAS   0x01
#define	MAGNETO10_MODE_CONT_MEAS_10HZ   0x02
#define	MAGNETO10_MODE_CONT_MEAS_20HZ   0x03
#define	MAGNETO10_MODE_CONT_MEAS_50HZ   0x04
#define	MAGNETO10_MODE_CONT_MEAS_100HZ   0x05
#define	MAGNETO10_MODE_SELF_TEST   0x06
#define	MAGNETO10_MODE_CONT_MEAS_200HZ   0x0A
#define	MAGNETO10_MODE_CONT_MEAS_500HZ   0x0B
#define	MAGNETO10_MODE_CONT_MEAS_800HZ   0x0C
#define	MAGNETO10_MODE_CONT_MEAS_1400HZ   0x0D
#define	MAGNETO10_MODE_POWER_DOWN   0x0F
#define	MAGNETO10_COMPANY_ID   0x98
	Magneto 10 identification values.
#define	MAGNETO10_DEVICE_ID   0xBA
#define	MAGNETO10_RESET   0x06
	Magneto 10 reset value.
#define	MAGNETO10_STAT1_RT   0x08
	Magneto 10 status values.
#define	MAGNETO10_STAT1_DRDY   0x01
#define	MAGNETO10_STAT2_DOR   0x02
#define	MAGNETO10_STAT2_HOVF   0x01
#define	MAGNETO10_TEMPERATURE_RES   50.0
	Magneto 10 temperature sensor macros.
#define	MAGNETO10_TEMPERATURE_ENABLE   0x01
#define	MAGNETO10_TEMPERATURE_DISABLE   0x00
#define	MAGNETO10_TEMPERATURE_EN_MASK   0x20
#define	MAGNETO10_MAG_FLUX_RESOLUTION   0.15
	Magneto 10 magnetic flux resolution.
#define	MAGNETO10_SET_DEV_ADDR   0x0C
	Magneto 10 device address setting.
#define	MAGNETO10_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	magneto10_return_value_t { MAGNETO10_OK = 0 , MAGNETO10_ERROR = -1 }
	Magneto 10 Click return value data. More...

Functions
void	magneto10_cfg_setup (magneto10_cfg_t *cfg)
	Magneto 10 configuration object setup function.
err_t	magneto10_init (magneto10_t *ctx, magneto10_cfg_t *cfg)
	Magneto 10 initialization function.
err_t	magneto10_default_cfg (magneto10_t *ctx)
	Magneto 10 default configuration function.
err_t	magneto10_mem_write_single (magneto10_t *ctx, uint8_t reg, uint8_t tx_data)
	Magneto 10 mem write single function.
err_t	magneto10_mem_write_multiple (magneto10_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
	Magneto 10 mem write multiple function.
err_t	magneto10_mem_direct_read (magneto10_t *ctx, uint8_t *rx_buf, uint8_t rx_len)
	Magneto 10 mem direct read function.
err_t	magneto10_mem_read (magneto10_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
	Magneto 10 mem read function.
err_t	magneto10_check_communication (magneto10_t *ctx)
	Magneto 10 check communication function.
err_t	magneto10_check_data_ready (magneto10_t *ctx)
	Magneto 10 check data ready function.
err_t	magneto10_get_magnetic_flux (magneto10_t *ctx, float *x_axis, float *y_axis, float *z_axis)
	Magneto 10 get magnetic flux function.
err_t	magneto10_get_temperature (magneto10_t *ctx, float *temperature)
	Magneto 10 get temperature function.
err_t	magneto10_reset (magneto10_t *ctx)
	Magneto 10 reset function.
err_t	magneto10_set_operating_mode (magneto10_t *ctx, uint8_t mode)
	Magneto 10 set operating mode function.
err_t	magneto10_enable_temperature_sensor (magneto10_t *ctx, uint8_t enable)
	Magneto 10 enable temperature sensor function.

Detailed Description

This file contains API for Magneto 10 Click Driver.

Enumeration Type Documentation

magneto10_return_value_t

enum magneto10_return_value_t

Magneto 10 Click return value data.

Predefined enum values for driver return values.

Enumerator
MAGNETO10_OK
MAGNETO10_ERROR