magneto14.h File Reference

This file contains API for Magneto 14 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	magneto14_t
	Magneto 14 Click context object. More...
struct	magneto14_cfg_t
	Magneto 14 Click configuration object. More...

Macros
#define	MAGNETO14_REG_ZERO_0   0x00
	Magneto 14 description register.
#define	MAGNETO14_REG_ZERO_1   0x01
#define	MAGNETO14_REG_BCT   0x02
#define	MAGNETO14_REG_ET_YX   0x03
#define	MAGNETO14_REG_PPT_ILIP   0x04
#define	MAGNETO14_REG_PPT   0x05
#define	MAGNETO14_REG_MG_LT_HT_MG   0x06
#define	MAGNETO14_REG_RD   0x09
#define	MAGNETO14_REG_FW   0x0E
#define	MAGNETO14_REG_HYS   0x10
#define	MAGNETO14_REG_M_GH_GL   0x1B
#define	MAGNETO14_CMD_READ_ANGLE   0x00
	Magneto 14 description commands.
#define	MAGNETO14_CMD_READ_REGISTER   0x02
#define	MAGNETO14_CMD_WRITE_REGISTER   0x04
#define	MAGNETO14_CMD_RESTORE_ALL_NVM   0x05
#define	MAGNETO14_CMD_STORE_ALL_NVM   0x06
#define	MAGNETO14_CMD_STORE_SINGLE_NVM   0x07
#define	MAGNETO14_CMD_BIT_MASK   0x07
	Magneto 14 description of the command and register bit masks.
#define	MAGNETO14_REG_BIT_MASK   0x1F
#define	MAGNETO14_TRIMMING_X_DIS   0x00
	Magneto 14 description of trimming settings.
#define	MAGNETO14_TRIMMING_X_EN   0x01
#define	MAGNETO14_TRIMMING_Y_DIS   0x00
#define	MAGNETO14_TRIMMING_Y_EN   0x02
#define	MAGNETO14_MG_LT_LVL_0   0x00
	Magneto 14 description of magnetic field threshold settings.
#define	MAGNETO14_MG_LT_LVL_1   0x20
#define	MAGNETO14_MG_LT_LVL_2   0x40
#define	MAGNETO14_MG_LT_LVL_3   0x60
#define	MAGNETO14_MG_LT_LVL_4   0x80
#define	MAGNETO14_MG_LT_LVL_5   0xA0
#define	MAGNETO14_MG_LT_LVL_6   0xC0
#define	MAGNETO14_MG_LT_LVL_7   0xE0
#define	MAGNETO14_MG_HT_LVL_0   0x00
#define	MAGNETO14_MG_HT_LVL_1   0x04
#define	MAGNETO14_MG_HT_LVL_2   0x08
#define	MAGNETO14_MG_HT_LVL_3   0x0C
#define	MAGNETO14_MG_HT_LVL_4   0x10
#define	MAGNETO14_MG_HT_LVL_5   0x14
#define	MAGNETO14_MG_HT_LVL_6   0x18
#define	MAGNETO14_MG_HT_LVL_7   0x1C
#define	MAGNETO14_MG_BIT_MASK   0xFC
#define	MAGNETO14_MGH_ST_OK   0x00
	Magneto 14 description of field strength level.
#define	MAGNETO14_FLD_ST_OK   0x00
#define	MAGNETO14_FLD_ST_MGL   0x01
#define	MAGNETO14_FLD_ST_MGH   0x02
#define	MAGNETO14_FLD_ST_BIT_MASK   0x03
#define	MAGNETO14_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.
#define	MAGNETO14_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
#define	MAGNETO14_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	magneto14_return_value_t { MAGNETO14_OK = 0 , MAGNETO14_ERROR = -1 }
	Magneto 14 Click return value data. More...

Functions
void	magneto14_cfg_setup (magneto14_cfg_t *cfg)
	Magneto 14 configuration object setup function.
err_t	magneto14_init (magneto14_t *ctx, magneto14_cfg_t *cfg)
	Magneto 14 initialization function.
err_t	magneto14_default_cfg (magneto14_t *ctx)
	Magneto 14 default configuration function.
err_t	magneto14_write_reg (magneto14_t *ctx, uint8_t cmd, uint8_t reg, uint8_t data_in)
	Magneto 14 data writing function.
err_t	magneto14_read_reg (magneto14_t *ctx, uint8_t cmd, uint8_t reg, uint8_t *data_out)
	Magneto 14 data reading function.
err_t	magneto14_get_angle_raw_data (magneto14_t *ctx, uint16_t *raw_data)
	Magneto 14 gets the angle raw data function.
err_t	magneto14_get_angle (magneto14_t *ctx, float *angle)
	Magneto 14 gets the angular position function.
err_t	magneto14_set_mag_field_thd (magneto14_t *ctx, uint8_t mglt, uint8_t mght)
	Magneto 14 sets the magnetic field threshold function.
err_t	magneto14_get_field_strength (magneto14_t *ctx, uint8_t *field_strength)
	Magneto 14 gets the magnetic field strength function.
void	magneto14_set_pwm_pin (magneto14_t *ctx, uint8_t pwm_state)
	Magneto 14 set PWM pin function.
uint8_t	magneto14_get_mgh (magneto14_t *ctx)
	Magneto 14 gets the MGH function.

Detailed Description

This file contains API for Magneto 14 Click Driver.

Enumeration Type Documentation

magneto14_return_value_t

enum magneto14_return_value_t

Magneto 14 Click return value data.

Predefined enum values for driver return values.

Enumerator
MAGNETO14_OK
MAGNETO14_ERROR