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

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

Data Structures
struct	magneto11_t
	Magneto 11 Click context object. More...

struct	magneto11_cfg_t
	Magneto 11 Click configuration object. More...

Macros
#define	MAGNETO11_REG_DATA_LSB 0x00
	Magneto 11 register list.

#define	MAGNETO11_REG_DATA_MSB 0x01

#define	MAGNETO11_REG_CONFIG 0x02

#define	MAGNETO11_REG_OFFSET_LSB 0x03

#define	MAGNETO11_REG_OFFSET_MSB 0x04

#define	MAGNETO11_REG_SENSITIVITY 0x0B

#define	MAGNETO11_DATA_RESOLUTION 0x03FF
	Magneto 11 data output values.

#define	MAGNETO11_DATA_OCF_MASK 0x0800

#define	MAGNETO11_DATA_PARITY_MASK 0x0400

#define	MAGNETO11_SENSITIVITY_RES_50mT 0x00
	Magneto 11 sensitivity values.

#define	MAGNETO11_SENSITIVITY_RES_25mT 0x01

#define	MAGNETO11_SENSITIVITY_RES_12p5mT 0x02

#define	MAGNETO11_SENSITIVITY_RES_18p75mT 0x03

#define	MAGNETO11_SENSITIVITY_RES_MASK 0x03

#define	MAGNETO11_SENSITIVITY_LSB_50mT 0.09766

#define	MAGNETO11_SENSITIVITY_LSB_25mT 0.04883

#define	MAGNETO11_SENSITIVITY_LSB_12p5mT 0.02441

#define	MAGNETO11_SENSITIVITY_LSB_18p75mT 0.03662

#define	MAGNETO11_CONFIG_SPEED_FAST 0x00
	Magneto 11 config values.

#define	MAGNETO11_CONFIG_SPEED_SLOW 0x04

#define	MAGNETO11_CONFIG_POLARITY_NORMAL 0x00

#define	MAGNETO11_CONFIG_POLARITY_REVERSED 0x02

#define	MAGNETO11_CONFIG_OP_NORMAL 0x00

#define	MAGNETO11_CONFIG_OP_POWER_DOWN 0x01

#define	MAGNETO11_DEV_ADDR_GND 0x56
	Magneto 11 device address setting.

#define	MAGNETO11_DEV_ADDR_VCC 0x57

#define	MAGNETO11_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	magneto11_return_value_t { MAGNETO11_OK = 0 , MAGNETO11_ERROR = -1 }
	Magneto 11 Click return value data. More...

Functions
void	magneto11_cfg_setup (magneto11_cfg_t *cfg)
	Magneto 11 configuration object setup function.

err_t	magneto11_init (magneto11_t ctx, magneto11_cfg_t cfg)
	Magneto 11 initialization function.

err_t	magneto11_default_cfg (magneto11_t *ctx)
	Magneto 11 default configuration function.

err_t	magneto11_generic_write (magneto11_t ctx, uint8_t reg, uint8_t tx_buf, uint8_t tx_len)
	Magneto 11 I2C writing function.

err_t	magneto11_generic_read (magneto11_t ctx, uint8_t reg, uint8_t rx_buf, uint8_t rx_len)
	Magneto 11 I2C reading function.

err_t	magneto11_get_magnetic_field (magneto11_t ctx, float mag_field)
	Magneto 11 get magnetic field function.

err_t	magneto11_get_offset (magneto11_t ctx, uint16_t offset)
	Magneto 11 get offset function.

err_t	magneto11_set_config (magneto11_t *ctx, uint8_t config)
	Magneto 11 set config function.

err_t	magneto11_set_sensitivity (magneto11_t *ctx, uint8_t sensitivity)
	Magneto 11 set sensitivity function.

Detailed Description

This file contains API for Magneto 11 Click Driver.

Enumeration Type Documentation

Magneto 11 Click return value data.

Predefined enum values for driver return values.

Enumerator
MAGNETO11_OK
MAGNETO11_ERROR