angle9.h File Reference

This file contains API for Angle 9 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	angle9_t
	Angle 9 Click context object. More...
struct	angle9_cfg_t
	Angle 9 Click configuration object. More...

Macros
#define	ANGLE9_REG_EWA   0x02
	Angle 9 registers list. More...
#define	ANGLE9_REG_EWDH   0x04
#define	ANGLE9_REG_EWDL   0x06
#define	ANGLE9_REG_EWCS   0x08
#define	ANGLE9_REG_ERA   0x0A
#define	ANGLE9_REG_ERCS   0x0C
#define	ANGLE9_REG_ERDH   0x0E
#define	ANGLE9_REG_ERDL   0x10
#define	ANGLE9_REG_CTRL   0x1E
#define	ANGLE9_REG_ANG   0x20
#define	ANGLE9_REG_STA   0x22
#define	ANGLE9_REG_ERR   0x24
#define	ANGLE9_REG_WARN   0x26
#define	ANGLE9_REG_TSEN   0x28
#define	ANGLE9_REG_FIELD   0x2A
#define	ANGLE9_REG_HANG   0x30
#define	ANGLE9_REG_ANG15   0x32
#define	ANGLE9_REG_ZANG   0x34
#define	ANGLE9_REG_KEY   0x3C
#define	ANGLE9_WRITE_BIT   0x40
	Angle 9 SPI frame setting. More...
#define	ANGLE9_DATA_RESOLUTION   0x0FFFu
	Angle 9 calculation values. More...
#define	ANGLE9_FULL_CIRCLE   360.0f
#define	ANGLE9_TEMP_RESOLUTION   8.0f
#define	ANGLE9_TEMP_OFFSET   25.0f
#define	ANGLE9_ODD_PARITY   0x01
	Angle 9 ODD parity flag. More...
#define	ANGLE9_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection. More...
#define	ANGLE9_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
#define	ANGLE9_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping. More...

Enumerations
enum	angle9_return_value_t { ANGLE9_OK = 0, ANGLE9_ERROR = -1 }
	Angle 9 Click return value data. More...

Functions
void	angle9_cfg_setup (angle9_cfg_t *cfg)
	Angle 9 configuration object setup function. More...
err_t	angle9_init (angle9_t *ctx, angle9_cfg_t *cfg)
	Angle 9 initialization function. More...
err_t	angle9_write_register (angle9_t *ctx, uint8_t reg, uint16_t data_in)
	Angle 9 write register function. More...
err_t	angle9_read_register (angle9_t *ctx, uint8_t reg, uint16_t *data_out)
	Angle 9 read register function. More...
uint8_t	angle9_get_pwm_pin (angle9_t *ctx)
	Angle 9 get pwm pin function. More...
err_t	angle9_read_angle (angle9_t *ctx, float *angle)
	Angle 9 read angle function. More...
err_t	angle9_read_temperature (angle9_t *ctx, float *temperature)
	Angle 9 read temperature function. More...
err_t	angle9_read_field_strength (angle9_t *ctx, uint16_t *field_str)
	Angle 9 read field strength function. More...

Detailed Description

This file contains API for Angle 9 Click Driver.

Enumeration Type Documentation

angle9_return_value_t

enum angle9_return_value_t

Angle 9 Click return value data.

Predefined enum values for driver return values.

Enumerator
ANGLE9_OK
ANGLE9_ERROR