driver_hmc5883l.h

Go to the documentation of this file.

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



typedef enum
{
    HMC5883L_AVERAGE_SAMPLE_1 = 0x00,        
    HMC5883L_AVERAGE_SAMPLE_2 = 0x01,        
    HMC5883L_AVERAGE_SAMPLE_4 = 0x02,        
    HMC5883L_AVERAGE_SAMPLE_8 = 0x03,        
} hmc5883l_average_sample_t;

typedef enum
{
    HMC5883L_DATA_OUTPUT_RATE_0P75 = 0x00,        
    HMC5883L_DATA_OUTPUT_RATE_1P5  = 0x01,        
    HMC5883L_DATA_OUTPUT_RATE_3    = 0x02,        
    HMC5883L_DATA_OUTPUT_RATE_7P5  = 0x03,        
    HMC5883L_DATA_OUTPUT_RATE_15   = 0x04,        
    HMC5883L_DATA_OUTPUT_RATE_30   = 0x05,        
    HMC5883L_DATA_OUTPUT_RATE_75   = 0x06,        
} hmc5883l_data_output_rate_t;

typedef enum
{
    HMC5883L_MODE_NORMAL        = 0x00,        
    HMC5883L_MODE_POSITIVE_BIAS = 0x01,        
    HMC5883L_MODE_NEGATIVE_BIAS = 0x02,        
} hmc5883l_mode_t;

typedef enum
{
    HMC5883L_GAIN_1370 = 0x00,        
    HMC5883L_GAIN_1090 = 0x01,        
    HMC5883L_GAIN_820  = 0x02,        
    HMC5883L_GAIN_660  = 0x03,        
    HMC5883L_GAIN_440  = 0x04,        
    HMC5883L_GAIN_390  = 0x05,        
    HMC5883L_GAIN_330  = 0x06,        
    HMC5883L_GAIN_230  = 0x07,        
} hmc5883l_gain_t;

typedef struct hmc5883l_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;                                                                     
} hmc5883l_handle_t;

typedef struct hmc5883l_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;           
} hmc5883l_info_t;



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

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

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

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

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

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

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



uint8_t hmc5883l_info(hmc5883l_info_t *info);

uint8_t hmc5883l_init(hmc5883l_handle_t *handle);

uint8_t hmc5883l_deinit(hmc5883l_handle_t *handle);

uint8_t hmc5883l_single_read(hmc5883l_handle_t *handle, int16_t raw[3], float m_gauss[3]);

uint8_t hmc5883l_start_continuous_read(hmc5883l_handle_t *handle);

uint8_t hmc5883l_stop_continuous_read(hmc5883l_handle_t *handle);

uint8_t hmc5883l_continuous_read(hmc5883l_handle_t *handle, int16_t raw[3], float m_gauss[3]);

uint8_t hmc5883l_set_average_sample(hmc5883l_handle_t *handle, hmc5883l_average_sample_t average_sample);

uint8_t hmc5883l_get_average_sample(hmc5883l_handle_t *handle, hmc5883l_average_sample_t *average_sample);

uint8_t hmc5883l_set_data_output_rate(hmc5883l_handle_t *handle, hmc5883l_data_output_rate_t data_rate);

uint8_t hmc5883l_get_data_output_rate(hmc5883l_handle_t *handle, hmc5883l_data_output_rate_t *data_rate);

uint8_t hmc5883l_set_mode(hmc5883l_handle_t *handle, hmc5883l_mode_t mode);

uint8_t hmc5883l_get_mode(hmc5883l_handle_t *handle, hmc5883l_mode_t *mode);

uint8_t hmc5883l_set_gain(hmc5883l_handle_t *handle, hmc5883l_gain_t gain);

uint8_t hmc5883l_get_gain(hmc5883l_handle_t *handle, hmc5883l_gain_t *gain);

uint8_t hmc5883l_enable_high_speed_iic(hmc5883l_handle_t *handle);

uint8_t hmc5883l_disable_high_speed_iic(hmc5883l_handle_t *handle);



uint8_t hmc5883l_set_reg(hmc5883l_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t hmc5883l_get_reg(hmc5883l_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif