gyro8.h File Reference

This file contains API for Gyro 8 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	gyro8_t
	Gyro 8 Click context object. More...
struct	gyro8_cfg_t
	Gyro 8 Click configuration object. More...

Macros
#define	GYRO8_REG_RATE   0x01
	Gyro 8 register list.
#define	GYRO8_REG_TEMP   0x07
#define	GYRO8_REG_RATE_STATUS_1   0x09
#define	GYRO8_REG_RATE_STATUS_2   0x0A
#define	GYRO8_REG_ACC_STATUS   0x0F
#define	GYRO8_REG_TEST   0x15
#define	GYRO8_REG_RESET_CONTROL   0x16
#define	GYRO8_REG_SERIAL_ID0   0x18
#define	GYRO8_REG_SERIAL_ID1   0x19
#define	GYRO8_REG_COMMON_STATUS   0x1B
#define	GYRO8_REG_ID   0x1D
#define	GYRO8_REG_STATUS_SUMMARY   0x1F
#define	GYRO8_ID   0x0500
	Gyro 8 identification setting.
#define	GYRO8_TEMP_SENS   14.7f
	Gyro 8 temperature and angular calculation values.
#define	GYRO8_TEMP_OFFSET   60.0f
#define	GYRO8_GYRO_SENS   50.0f
#define	GYRO8_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.
#define	GYRO8_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
#define	GYRO8_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	gyro8_return_value_t { GYRO8_OK = 0 , GYRO8_ERROR = -1 }
	Gyro 8 Click return value data. More...

Functions
void	gyro8_cfg_setup (gyro8_cfg_t *cfg)
	Gyro 8 configuration object setup function.
err_t	gyro8_init (gyro8_t *ctx, gyro8_cfg_t *cfg)
	Gyro 8 initialization function.
err_t	gyro8_default_cfg (gyro8_t *ctx)
	Gyro 8 default configuration function.
err_t	gyro8_write_register (gyro8_t *ctx, uint8_t reg, uint16_t data_in)
	Gyro 8 write register function.
err_t	gyro8_read_register (gyro8_t *ctx, uint8_t reg, uint16_t *data_out)
	Gyro 8 read register function.
void	gyro8_set_rst_pin (gyro8_t *ctx, uint8_t state)
	Gyro 8 set rst pin function.
void	gyro8_reset_device (gyro8_t *ctx)
	Gyro 8 reset device function.
err_t	gyro8_check_communication (gyro8_t *ctx)
	Gyro 8 check communication function.
err_t	gyro8_read_serial_id (gyro8_t *ctx, uint32_t *serial_id)
	Gyro 8 read serial id function.
err_t	gyro8_read_temperature (gyro8_t *ctx, float *temperature)
	Gyro 8 read temperature function.
err_t	gyro8_read_angular_rate (gyro8_t *ctx, float *rate)
	Gyro 8 read angular rate function.

Detailed Description

This file contains API for Gyro 8 Click Driver.

Enumeration Type Documentation

gyro8_return_value_t

enum gyro8_return_value_t

Gyro 8 Click return value data.

Predefined enum values for driver return values.

Enumerator
GYRO8_OK
GYRO8_ERROR