driver_qmc5883l.h

Go to the documentation of this file.

 
#ifndef DRIVER_QMC5883L_H
#define DRIVER_QMC5883L_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



typedef enum
{
    QMC5883L_BOOL_FALSE = 0x00,        
    QMC5883L_BOOL_TRUE  = 0x01,        
} qmc5883l_bool_t;

typedef enum
{
    QMC5883L_STATUS_DOR  = (1 << 2),        
    QMC5883L_STATUS_OVL  = (1 << 1),        
    QMC5883L_STATUS_DRDY = (1 << 0),        
} qmc5883l_status_t;

typedef enum
{
    QMC5883L_MODE_STANDBY    = 0x00,        
    QMC5883L_MODE_CONTINUOUS = 0x01,        
} qmc5883l_mode_t;

typedef enum
{
    QMC5883L_OUTPUT_RATE_10HZ  = 0x00,        
    QMC5883L_OUTPUT_RATE_50HZ  = 0x01,        
    QMC5883L_OUTPUT_RATE_100HZ = 0x02,        
    QMC5883L_OUTPUT_RATE_200HZ = 0x03,        
} qmc5883l_output_rate_t;

typedef enum
{
    QMC5883L_FULL_SCALE_2GAUSS = 0x00,        
    QMC5883L_FULL_SCALE_8GAUSS = 0x01,        
} qmc5883l_full_scale_t;

typedef enum
{
    QMC5883L_OVER_SAMPLE_512 = 0x00,        
    QMC5883L_OVER_SAMPLE_256 = 0x01,        
    QMC5883L_OVER_SAMPLE_128 = 0x02,        
    QMC5883L_OVER_SAMPLE_64  = 0x03,        
} qmc5883l_over_sample_t;

typedef struct qmc5883l_handle_s
{
    uint8_t (*iic_init)(void);                                                          
    uint8_t (*iic_deinit)(void);                                                        
    uint8_t (*iic_read)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);         
    uint8_t (*iic_write)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);        
    void (*delay_ms)(uint32_t ms);                                                      
    void (*debug_print)(const char *const fmt, ...);                                    
    uint8_t inited;                                                                     
} qmc5883l_handle_t;

typedef struct qmc5883l_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} qmc5883l_info_t;



#define DRIVER_QMC5883L_LINK_INIT(HANDLE, STRUCTURE)   memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_QMC5883L_LINK_IIC_INIT(HANDLE, FUC)    (HANDLE)->iic_init = FUC

#define DRIVER_QMC5883L_LINK_IIC_DEINIT(HANDLE, FUC)  (HANDLE)->iic_deinit = FUC

#define DRIVER_QMC5883L_LINK_IIC_READ(HANDLE, FUC)    (HANDLE)->iic_read = FUC

#define DRIVER_QMC5883L_LINK_IIC_WRITE(HANDLE, FUC)   (HANDLE)->iic_write = FUC

#define DRIVER_QMC5883L_LINK_DELAY_MS(HANDLE, FUC)    (HANDLE)->delay_ms = FUC

#define DRIVER_QMC5883L_LINK_DEBUG_PRINT(HANDLE, FUC) (HANDLE)->debug_print = FUC



uint8_t qmc5883l_info(qmc5883l_info_t *info);

uint8_t qmc5883l_init(qmc5883l_handle_t *handle);

uint8_t qmc5883l_deinit(qmc5883l_handle_t *handle);

uint8_t qmc5883l_read(qmc5883l_handle_t *handle, int16_t raw[3], float m_gauss[3]);

uint8_t qmc5883l_read_temperature(qmc5883l_handle_t *handle, int16_t *raw, float *deg);

uint8_t qmc5883l_get_status(qmc5883l_handle_t *handle, uint8_t *status);

uint8_t qmc5883l_set_mode(qmc5883l_handle_t *handle, qmc5883l_mode_t mode);

uint8_t qmc5883l_get_mode(qmc5883l_handle_t *handle, qmc5883l_mode_t *mode);

uint8_t qmc5883l_set_output_rate(qmc5883l_handle_t *handle, qmc5883l_output_rate_t rate);

uint8_t qmc5883l_get_output_rate(qmc5883l_handle_t *handle, qmc5883l_output_rate_t *rate);

uint8_t qmc5883l_set_full_scale(qmc5883l_handle_t *handle, qmc5883l_full_scale_t scale);

uint8_t qmc5883l_get_full_scale(qmc5883l_handle_t *handle, qmc5883l_full_scale_t *scale);

uint8_t qmc5883l_set_over_sample(qmc5883l_handle_t *handle, qmc5883l_over_sample_t sample);

uint8_t qmc5883l_get_over_sample(qmc5883l_handle_t *handle, qmc5883l_over_sample_t *sample);

uint8_t qmc5883l_set_interrupt(qmc5883l_handle_t *handle, qmc5883l_bool_t enable);

uint8_t qmc5883l_get_interrupt(qmc5883l_handle_t *handle, qmc5883l_bool_t *enable);

uint8_t qmc5883l_set_pointer_roll_over(qmc5883l_handle_t *handle, qmc5883l_bool_t enable);

uint8_t qmc5883l_get_pointer_roll_over(qmc5883l_handle_t *handle, qmc5883l_bool_t *enable);

uint8_t qmc5883l_soft_reset(qmc5883l_handle_t *handle);

uint8_t qmc5883l_set_period(qmc5883l_handle_t *handle, uint8_t fbr);

uint8_t qmc5883l_get_period(qmc5883l_handle_t *handle, uint8_t *fbr);



uint8_t qmc5883l_set_reg(qmc5883l_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t qmc5883l_get_reg(qmc5883l_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif