lis3mdl.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2015 HAW Hamburg
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
#include "periph/i2c.h"
#include "periph/gpio.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
    int16_t x_axis;                  
    int16_t y_axis;                  
    int16_t z_axis;                  
} lis3mdl_3d_data_t;

typedef enum {
    LIS3MDL_XY_MODE_LOW    = 0x00,   
    LIS3MDL_XY_MODE_MEDIUM = 0x20,   
    LIS3MDL_XY_MODE_HIGH   = 0x40,   
    LIS3MDL_XY_MODE_ULTRA  = 0x60,   
} lis3mdl_xy_mode_t;

typedef enum {
    LIS3MDL_Z_MODE_LOW    = 0x00,    
    LIS3MDL_Z_MODE_MEDIUM = 0x04,    
    LIS3MDL_Z_MODE_HIGH   = 0x08,    
    LIS3MDL_Z_MODE_ULTRA  = 0x0C,    
} lis3mdl_z_mode_t;

typedef enum {
    LIS3MDL_ODR_0_625Hz = 0x00,      
    LIS3MDL_ODR_1_25Hz  = 0x04,      
    LIS3MDL_ODR_2_5Hz   = 0x08,      
    LIS3MDL_ODR_10Hz    = 0x10,      
    LIS3DML_ODR_20HZ    = 0x14,      
    LIS3DML_ODR_40HZ    = 0x18,      
    LIS3MDL_ODR_80HZ    = 0x1C,      
} lis3mdl_odr_t;

typedef enum {
    LIS3MDL_SCALE_4G  = 0x00,        
    LIS3MDL_SCALE_8G  = 0x20,        
    LIS3MDL_SCALE_12G = 0x40,        
    LIS3MDL_SCALE_16G = 0x60,        
} lis3mdl_scale_t;

typedef enum {
    LIS3MDL_OP_CONT_CONV = 0x00,     
    LIS3MDL_OP_SNGL_CONV = 0x01,     
    LIS3MDL_OP_PDOWN     = 0x11,     
} lis3mdl_op_t;

typedef struct {
    i2c_t i2c;                       
    uint8_t addr;                    
    lis3mdl_xy_mode_t xy_mode;       
    lis3mdl_z_mode_t z_mode;         
    lis3mdl_odr_t odr;               
    lis3mdl_scale_t scale;           
    lis3mdl_op_t op_mode;            
} lis3mdl_params_t;

typedef struct {
    lis3mdl_params_t params;         
} lis3mdl_t;

int lis3mdl_init(lis3mdl_t *dev, const lis3mdl_params_t *params);

void lis3mdl_read_mag(const lis3mdl_t *dev, lis3mdl_3d_data_t *data);

void lis3mdl_read_temp(const lis3mdl_t *dev, int16_t *value);

void lis3mdl_enable(const lis3mdl_t *dev);

void lis3mdl_disable(const lis3mdl_t *dev);
 
#ifdef __cplusplus
}
#endif