hmc5883l.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Gunar Schorcht
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef HMC5883L_H
#define HMC5883L_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdbool.h>
#include <stdint.h>
 
#include "periph/gpio.h"
#include "periph/i2c.h"
 
typedef enum {
    HMC5883L_OK             =  0,  
    HMC5883L_ERROR_I2C      = -1,  
    HMC5883L_ERROR_WRONG_ID = -2,  
    HMC5883L_ERROR_NO_DATA  = -3,  
    HMC5883L_ERROR_RAW_DATA = -4,  
    HMC5883L_ERROR_COMMON   = -5,  
} hmc5883l_error_codes_t;
 
typedef enum {
    HMC5883L_DOR_0_75 = 0x00,   
    HMC5883L_DOR_1_5  = 0x04,   
    HMC5883L_DOR_3    = 0x08,   
    HMC5883L_DOR_7_5  = 0x0c,   
    HMC5883L_DOR_15   = 0x10,   
    HMC5883L_DOR_30   = 0x14,   
    HMC5883L_DOR_75   = 0x18,   
} hmc5883l_dor_t;
 
typedef enum {
    HMC5883L_MEAS_MODE_NORMAL   = 0x00, 
    HMC5883L_MEAS_MODE_BIAS_POS = 0x01, 
    HMC5883L_MEAS_MODE_BIAS_NEG = 0x02, 
} hmc5883l_meas_mode_t;
 
typedef enum {
    HMC5883L_MEAS_AVG_NONE = 0x00,  
    HMC5883L_MEAS_AVG_2    = 0x20,  
    HMC5883L_MEAS_AVG_4    = 0x40,  
    HMC5883L_MEAS_AVG_8    = 0x60,  
} hmc5883l_meas_avg_t;
 
typedef enum {
    HMC5883L_OP_MODE_CONTINUOUS = 0x00, 
    HMC5883L_OP_MODE_SINGLE     = 0x01, 
    HMC5883L_OP_MODE_IDLE       = 0x02, 
} hmc5883l_op_mode_t;
 
typedef enum {
    HMC5883L_GAIN_1370 = 0x00,  
    HMC5883L_GAIN_1090 = 0x20,  
    HMC5883L_GAIN_820  = 0x40,  
    HMC5883L_GAIN_660  = 0x60,  
    HMC5883L_GAIN_440  = 0x80,  
    HMC5883L_GAIN_390  = 0xa0,  
    HMC5883L_GAIN_330  = 0xc0,  
    HMC5883L_GAIN_230  = 0xe0,  
} hmc5883l_gain_t;
 
typedef struct {
    int16_t x;  
    int16_t y;  
    int16_t z;  
} hmc5883l_data_t;
 
typedef struct {
    int16_t x; 
    int16_t y; 
    int16_t z; 
} hmc5883l_raw_data_t;
 
#if MODULE_HMC5883L_INT || DOXYGEN
 
typedef void (*hmc5883l_drdy_int_cb_t)(void *);
 
#endif /* MODULE_HMC5883L_INT || DOXYGEN */
 
typedef struct {
    unsigned dev;    
#if MODULE_HMC5883L_INT
    gpio_t int_pin;  
#endif
    hmc5883l_meas_mode_t meas_mode; 
    hmc5883l_meas_avg_t  meas_avg;  
    hmc5883l_dor_t       dor;       
    hmc5883l_op_mode_t   op_mode;   
    hmc5883l_gain_t      gain;      
} hmc5883l_params_t;
 
typedef struct {
    unsigned dev;    
#if MODULE_HMC5883L_INT
    gpio_t int_pin;  
#endif
    hmc5883l_op_mode_t   op_mode;   
    hmc5883l_gain_t      gain;      
} hmc5883l_t;
 
int hmc5883l_init(hmc5883l_t *dev, const hmc5883l_params_t *params);
 
#if MODULE_HMC5883L_INT || DOXYGEN
 
int hmc5883l_init_int(hmc5883l_t *dev, hmc5883l_drdy_int_cb_t cb, void *arg);
 
#endif /* MODULE_HMC5883L_INT || DOXYGEN */
 
int hmc5883l_data_ready(const hmc5883l_t *dev);
 
int hmc5883l_read(const hmc5883l_t *dev, hmc5883l_data_t *data);
 
int hmc5883l_read_raw(const hmc5883l_t *dev, hmc5883l_raw_data_t *raw);
 
int hmc5883l_power_down(hmc5883l_t *dev);
 
int hmc5883l_power_up(hmc5883l_t *dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* HMC5883L_H */