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

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

Data Structures
struct	magneto6_data_t
	Magneto 6 Click data object. More...

struct	magneto6_t
	Magneto 6 Click context object. More...

struct	magneto6_cfg_t
	Magneto 6 Click configuration object. More...

Macros
#define	MAGNETO6_REG_MAGNETIC_X_MSB 0x00
	Magneto 6 register list.

#define	MAGNETO6_REG_MAGNETIC_Y_MSB 0x01

#define	MAGNETO6_REG_MAGNETIC_Z_MSB 0x02

#define	MAGNETO6_REG_TEMPERATURE_MSB 0x03

#define	MAGNETO6_REG_MAGNETIC_XY_LSB 0x04

#define	MAGNETO6_REG_TEMPERATURE_Z_LSB 0x05

#define	MAGNETO6_REG_DIAG 0x06

#define	MAGNETO6_REG_CONFIG 0x10

#define	MAGNETO6_REG_MOD1 0x11

#define	MAGNETO6_REG_MOD2 0x13

#define	MAGNETO6_REG_VERSION 0x16

#define	MAGNETO6_CONFIG_DISABLE_TEMP 0x80
	Magneto 6 CONFIG register setting.

#define	MAGNETO6_CONFIG_ENABLE_ANGULAR_XY 0x40

#define	MAGNETO6_CONFIG_TRIGGER_DISABLE 0x00

#define	MAGNETO6_CONFIG_TRIGGER_MSB 0x10

#define	MAGNETO6_CONFIG_TRIGGER_REG_READ 0x20

#define	MAGNETO6_CONFIG_TRIGGER_MASK 0x30

#define	MAGNETO6_CONFIG_SHORT_RANGE_SENS_EN 0x08

#define	MAGNETO6_CONFIG_TL_COMP_TC0 0x00

#define	MAGNETO6_CONFIG_TL_COMP_TC1 0x02

#define	MAGNETO6_CONFIG_TL_COMP_TC2 0x04

#define	MAGNETO6_CONFIG_TL_COMP_TC3 0x06

#define	MAGNETO6_CONFIG_TL_COMP_MASK 0x06

#define	MAGNETO6_CONFIG_PARITY_BIT 0x01

#define	MAGNETO6_MOD1_FUSE_PARITY 0x80
	Magneto 6 MOD1 register setting.

#define	MAGNETO6_MOD1_I2C_ADDR_0 0x00

#define	MAGNETO6_MOD1_I2C_ADDR_1 0x20

#define	MAGNETO6_MOD1_I2C_ADDR_2 0x40

#define	MAGNETO6_MOD1_I2C_ADDR_3 0x60

#define	MAGNETO6_MOD1_I2C_ADDR_MASK 0x60

#define	MAGNETO6_MOD1_1BYTE_READ_EN 0x10

#define	MAGNETO6_MOD1_COLLISION_AVOID 0x08

#define	MAGNETO6_MOD1_INT_DISABLE 0x04

#define	MAGNETO6_MOD1_MODE_LOW_POWER 0x00

#define	MAGNETO6_MOD1_MODE_MASTER 0x01

#define	MAGNETO6_MOD1_MODE_FAST 0x03

#define	MAGNETO6_MOD1_MODE_MASK 0x03

#define	MAGNETO6_MOD2_FUPDATE_SLOW 0x80
	Magneto 6 MOD2 register setting.

#define	MAGNETO6_MOD2_FACTORY_MASK 0x7F

#define	MAGNETO6_DIAG_BUS_PARITY 0x80
	Magneto 6 DIAG register setting.

#define	MAGNETO6_DIAG_FUSE_PARITY 0x40

#define	MAGNETO6_DIAG_CFG_PARITY 0x20

#define	MAGNETO6_DIAG_T_BIT 0x10

#define	MAGNETO6_DIAG_PD3_FLAG 0x08

#define	MAGNETO6_DIAG_PD0_FLAG 0x04

#define	MAGNETO6_DIAG_FRAME_COUNTER_MASK 0x03

#define	MAGNETO6_VERSION_FACTORY_MASK 0xC0
	Magneto 6 VERSION register setting.

#define	MAGNETO6_VERSION_TYPE_MASK 0x30

#define	MAGNETO6_VERSION_HWV_MASK 0x0F

#define	MAGNETO6_TEMP_25_DIGIT 1180
	Magneto 6 measurement setting.

#define	MAGNETO6_TEMP_25 25

#define	MAGNETO6_TEMP_RES 0.24f

#define	MAGNETO6_MAGNETIC_RES_MILLI_T 0.13f

#define	MAGNETO6_I2C_TIMEOUT 100000ul
	Magneto 6 I2C timeout setting.

#define	MAGNETO6_DEVICE_ADDRESS_0 0x35
	Magneto 6 device address setting.

#define	MAGNETO6_DEVICE_ADDRESS_1 0x22

#define	MAGNETO6_DEVICE_ADDRESS_2 0x78

#define	MAGNETO6_DEVICE_ADDRESS_3 0x44

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

Enumerations
enum	magneto6_return_value_t { MAGNETO6_OK = 0 , MAGNETO6_ERROR = -1 }
	Magneto 6 Click return value data. More...

Functions
void	magneto6_cfg_setup (magneto6_cfg_t *cfg)
	Magneto 6 configuration object setup function.

err_t	magneto6_init (magneto6_t ctx, magneto6_cfg_t cfg)
	Magneto 6 initialization function.

err_t	magneto6_default_cfg (magneto6_t *ctx)
	Magneto 6 default configuration function.

err_t	magneto6_write_reg (magneto6_t *ctx, uint8_t reg, uint8_t data_in)
	Magneto 6 write reg function.

err_t	magneto6_read_reg (magneto6_t ctx, uint8_t reg, uint8_t data_out, uint8_t len)
	Magneto 6 read reg function.

void	magneto6_set_ien_pin (magneto6_t *ctx, uint8_t state)
	Magneto 6 set ien pin function.

uint8_t	magneto6_get_int_pin (magneto6_t *ctx)
	Magneto 6 get int pin function.

err_t	magneto6_read_data (magneto6_t ctx, magneto6_data_t data_out)
	Magneto 6 read data function.

Detailed Description

This file contains API for Magneto 6 Click Driver.

Enumeration Type Documentation

◆ magneto6_return_value_t

enum magneto6_return_value_t

Magneto 6 Click return value data.

Predefined enum values for driver return values.

Enumerator
MAGNETO6_OK
MAGNETO6_ERROR

Data Structures

Macros

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ magneto6_return_value_t