magneto5 2.0.0.0
magneto5.h File Reference

This file contains API for Magneto 5 Click driver. More...

#include "drv_digital_out.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  magneto5_t
 Click ctx object definition. More...
 
struct  magneto5_cfg_t
 Click configuration structure definition. More...
 

Macros

#define MAGNETO5_MAP_MIKROBUS(cfg, mikrobus)
 
#define MAGNETO5_RETVAL   uint8_t
 
#define MAGNETO5_OK   0x00
 
#define MAGNETO5_INIT_ERROR   0xFF
 
#define MAGNETO5_REG_X_OUT_LOW   0x00
 
#define MAGNETO5_REG_X_OUT_HIGH   0x01
 
#define MAGNETO5_REG_Y_OUT_LOW   0x02
 
#define MAGNETO5_REG_Y_OUT_HIGH   0x03
 
#define MAGNETO5_REG_Z_OUT_LOW   0x04
 
#define MAGNETO5_REG_Z_OUT_HIGH   0x05
 
#define MAGNETO5_REG_STATUS   0x06
 
#define MAGNETO5_REG_INTERNAL_CONTROL_0   0x07
 
#define MAGNETO5_REG_INTERNAL_CONTROL_1   0x08
 
#define MAGNETO5_REG_PRODUCT_ID   0x20
 
#define MAGNETO_STATUS_MEASUREMENT_DONE   0x01
 
#define MAGNETO_STATUS_PUMP_ON   0x02
 
#define MAGNETO_STATUS_READ_DONE   0x04
 
#define MAGNETO_STATUS_SELFTEST_OK   0x08
 
#define MAGNETO5_ERROR   0x00
 
#define MAGNETO5_PRODUCT_ID   0x06
 
#define MAGNETO5_AXIS_X   0x00
 
#define MAGNETO5_AXIS_Y   0x02
 
#define MAGNETO5_AXIS_Z   0x04
 
#define MAGNETO5_CR0_RESET   0x40
 
#define MAGNETO5_CR0_SET   0x20
 
#define MAGNETO5_CR0_REFILL_CAP   0x80
 
#define MAGNETO5_CR0_NO_BOOST   0x10
 
#define MAGNETO5_CR0_MEASUREMENT_MODE_0   0x00
 
#define MAGNETO5_CR0_MEASUREMENT_MODE_1   0x04
 
#define MAGNETO5_CR0_MEASUREMENT_MODE_2   0x08
 
#define MAGNETO5_CR0_MEASUREMENT_MODE_3   0x0C
 
#define MAGNETO5_CR0_CONTINUOUS_MODE   0x02
 
#define MAGNETO5_CR0_TAKE_MEASUREMENT   0x01
 
#define MAGNETO5_CR1_SOFT_RESET   0x80
 
#define MAGNETO5_CR1_TEMP_TEST   0x40
 
#define MAGNETO5_CR1_SELFTEST_XYZ   0x20
 
#define MAGNETO5_CR1_FACTORY_USE_X   0x10
 
#define MAGNETO5_CR1_FACTORY_USE_Y   0x08
 
#define MAGNETO5_CR1_FACTORY_USE_Z   0x04
 
#define MAGNETO5_CH0_16bits_8ms   0x00
 
#define MAGNETO5_CH1_16bits_4ms   0x01
 
#define MAGNETO5_CH2_14bits_2ms   0x02
 
#define MAGNETO5_CH3_12bits_1ms   0x03
 

Functions

void magneto5_cfg_setup (magneto5_cfg_t *cfg)
 Config Object Initialization function.
 
MAGNETO5_RETVAL magneto5_init (magneto5_t *ctx, magneto5_cfg_t *cfg)
 Initialization function.
 
void magneto5_default_cfg (magneto5_t *ctx)
 Click Default Configuration function.
 
void magneto5_generic_write (magneto5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function.
 
void magneto5_generic_read (magneto5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function.
 
uint8_t magneto5_set_status_reg (magneto5_t *ctx)
 Functions reads status register.
 
uint8_t magneto5_get_product_id (magneto5_t *ctx)
 Functions reads product ID from register.
 
void magneto5_get_axis_data (magneto5_t *ctx, int16_t *axis_buffer, uint8_t max_resolution)
 Functions reads axis data.
 
float magneto5_get_axis_value (magneto5_t *ctx, uint8_t axis, uint8_t max_resolution)
 Functions reads axis data value.
 
void magneto5_config_register_0 (magneto5_t *ctx, uint8_t config_data)
 Functions sets configuration register 0.
 
void magneto5_config_register_1 (magneto5_t *ctx, uint8_t config_data)
 Functions sets configuration register 1.
 
void magneto5_reset (magneto5_t *ctx)
 Functions for reset data.
 

Detailed Description

This file contains API for Magneto 5 Click driver.