magneto4.h File Reference

This file contains API for MAGNETO 4 Click driver. More...

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

Go to the source code of this file.

Data Structures
struct	magneto4_t
	Click ctx object definition. More...
struct	magneto4_cfg_t
	Click configuration structure definition. More...
struct	mag_status_t
	Click magnetic status structure definition. More...

Macros
#define	MAGNETO4_MAP_MIKROBUS(cfg, mikrobus)
#define	MAGNETO4_RETVAL   uint8_t
#define	MAGNETO4_OK   0x00
#define	MAGNETO4_INIT_ERROR   0xFF
#define	MAGNETO4_ENCODER_TO_ZERO_POSITION   0
#define	MAGNETO4_MAX_MAGNETIC_FIELD_VALUE   3000

Functions
void	magneto4_cfg_setup (magneto4_cfg_t *cfg)
	Config Object Initialization function.
MAGNETO4_RETVAL	magneto4_init (magneto4_t *ctx, magneto4_cfg_t *cfg)
	Initialization function.
void	magneto4_default_cfg (magneto4_t *ctx)
	Click Default Configuration function.
void	magneto4_generic_transfer (magneto4_t *ctx, uint8_t *rd_buf, uint16_t rd_len)
	Generic transfer function.
uint8_t	magneto4_get_out_a (magneto4_t *ctx)
	Get A ( AN ) pin status.
uint8_t	magneto4_get_out_b (magneto4_t *ctx)
	Get B ( RST ) pin status.
uint8_t	magneto4_get_index (magneto4_t *ctx)
	Get IND ( interrupt ) pin status.
uint32_t	magneto4_start_measurement (magneto4_t *ctx)
	Measurement function.
uint16_t	magneto4_get_magnetic_field (magneto4_t *ctx)
	Measurement Field.
uint8_t	magneto4_get_magnetic_status (magneto4_t *ctx, mag_status_t *mag_status)
	Get Magnetic measurement status.
uint8_t	magneto4_get_encoder_direction (magneto4_t *ctx)
	Encoder direction.
void	magneto4_get_encoder_position (magneto4_t *ctx)
	Encoder position.
void	magneto4_set_start_position (magneto4_t *ctx, int32_t encoder_pos)
	Set start encoder position.

Detailed Description

This file contains API for MAGNETO 4 Click driver.