magneto13.h File Reference

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

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"

Go to the source code of this file.

Data Structures
struct	magneto13_t
	Magneto 13 Click context object. More...
struct	magneto13_cfg_t
	Magneto 13 Click configuration object. More...

Macros
#define	MAGNETO13_REG_ZERO_0   0x00
	Magneto 13 description register.
#define	MAGNETO13_REG_ZERO_1   0x01
#define	MAGNETO13_REG_BCT   0x02
#define	MAGNETO13_REG_ET_YX   0x03
#define	MAGNETO13_REG_MG_LT_HT_MG   0x06
#define	MAGNETO13_REG_IRQM_RAR_HYST   0x07
#define	MAGNETO13_REG_THR   0x08
#define	MAGNETO13_REG_RD   0x09
#define	MAGNETO13_REG_REF   0x0A
#define	MAGNETO13_REG_TRISTATE_SPI_PULL   0x0D
#define	MAGNETO13_REG_FW   0x0E
#define	MAGNETO13_REG_ERR_PAR_MEM_NVM   0x1A
#define	MAGNETO13_REG_M_GH_GL   0x1B
#define	MAGNETO13_CMD_READ_ANGLE   0x00
	Magneto 13 description command.
#define	MAGNETO13_CMD_CLEAR_ERR_FLAGS   0x01
#define	MAGNETO13_CMD_READ_REGISTER   0x02
#define	MAGNETO13_CMD_WRITE_REGISTER   0x04
#define	MAGNETO13_CMD_RESTORE_ALL_NVM   0x05
#define	MAGNETO13_CMD_STORE_ALL_NVM   0x06
#define	MAGNETO13_CMD_STORE_SINGLE_NVM   0x07
#define	MAGNETO13_CMD_BIT_MASK   0x07
	Magneto 13 descriptions of the command and register bit masks.
#define	MAGNETO13_REG_BIT_MASK   0x1F
#define	MAGNETO13_TRIMMING_X_DIS   0x00
	Magneto 13 description of trimming settings.
#define	MAGNETO13_TRIMMING_X_EN   0x01
#define	MAGNETO13_TRIMMING_Y_DIS   0x00
#define	MAGNETO13_TRIMMING_Y_EN   0x02
#define	MAGNETO13_MG_LT_LVL_0   0x00
	Magneto 13 description of magnetic field threshold settings.
#define	MAGNETO13_MG_LT_LVL_1   0x40
#define	MAGNETO13_MG_LT_LVL_2   0x80
#define	MAGNETO13_MG_LT_LVL_3   0xC0
#define	MAGNETO13_MG_HT_LVL_0   0x00
#define	MAGNETO13_MG_HT_LVL_1   0x10
#define	MAGNETO13_MG_HT_LVL_2   0x20
#define	MAGNETO13_MG_HT_LVL_3   0x30
#define	MAGNETO13_MG_BIT_MASK   0xF0
#define	MAGNETO13_MG_FLD_THD_DIS   0x00
#define	MAGNETO13_MG_FLD_THD_EN   0x01
#define	MAGNETO13_FLD_ST_OK   0x00
	Magneto 13 description of field strength level.
#define	MAGNETO13_FLD_ST_MGL   0x01
#define	MAGNETO13_FLD_ST_MGH   0x02
#define	MAGNETO13_FLD_ST_BIT_MASK   0x03
#define	MAGNETO13_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.
#define	MAGNETO13_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
#define	MAGNETO13_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	magneto13_return_value_t { MAGNETO13_OK = 0 , MAGNETO13_ERROR = -1 }
	Magneto 13 Click return value data. More...

Functions
void	magneto13_cfg_setup (magneto13_cfg_t *cfg)
	Magneto 13 configuration object setup function.
err_t	magneto13_init (magneto13_t *ctx, magneto13_cfg_t *cfg)
	Magneto 13 initialization function.
err_t	magneto13_default_cfg (magneto13_t *ctx)
	Magneto 13 default configuration function.
err_t	magneto13_write_reg (magneto13_t *ctx, uint8_t cmd, uint8_t reg, uint8_t data_in)
	Magneto 13 data writing function.
err_t	magneto13_read_reg (magneto13_t *ctx, uint8_t cmd, uint8_t reg, uint8_t *data_out)
	Magneto 13 data reading function.
err_t	magneto13_get_angle_raw_data (magneto13_t *ctx, uint16_t *raw_data)
	Magneto 13 gets the angle raw data function.
err_t	magneto13_get_angle (magneto13_t *ctx, float *angle)
	Magneto 13 gets the angular position function.
err_t	magneto13_set_mag_field_thd (magneto13_t *ctx, uint8_t mglt, uint8_t mght)
	Magneto 13 sets the magnetic field threshold function.
err_t	magneto13_enable_fld_thd_det (magneto13_t *ctx)
	Magneto 13 enables the magnetic field threshold detection function.
err_t	magneto13_get_field_strength (magneto13_t *ctx, uint8_t *field_strength)
	Magneto 13 gets the magnetic field strength function.
uint8_t	magneto13_get_error_flag (magneto13_t *ctx)
	Magneto 13 gets the error flag function.
uint8_t	magneto13_get_nvm_access_state (magneto13_t *ctx)
	Magneto 13 checks the access to the NVM function.
uint8_t	magneto13_get_interrupt (magneto13_t *ctx)
	Magneto 13 gets the interrupt on the angle change state function.

Detailed Description

This file contains API for Magneto 13 Click Driver.

Enumeration Type Documentation

magneto13_return_value_t

enum magneto13_return_value_t

Magneto 13 Click return value data.

Predefined enum values for driver return values.

Enumerator
MAGNETO13_OK
MAGNETO13_ERROR