mag3110.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2014 PHYTEC Messtechnik GmbH
 * SPDX-FileCopyrightText: 2017 HAW Hamburg
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

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

enum {
    MAG3110_OK,                 
    MAG3110_ERROR_I2C,          
    MAG3110_ERROR_DEV,          
    MAG3110_ERROR_CNF,          
};

#ifndef CONFIG_MAG3110_I2C_ADDRESS
#define CONFIG_MAG3110_I2C_ADDRESS             0x0E
#endif

#define MAG3110_DROS_8000_16    0 
#define MAG3110_DROS_4000_32    1 
#define MAG3110_DROS_2000_64    2 
#define MAG3110_DROS_1000_128   3 
#define MAG3110_DROS_4000_16    4 
#define MAG3110_DROS_2000_32    5 
#define MAG3110_DROS_1000_64    6 
#define MAG3110_DROS_0500_128   7 
#define MAG3110_DROS_2000_16    8 
#define MAG3110_DROS_1000_32    9 
#define MAG3110_DROS_0500_64    10 
#define MAG3110_DROS_0250_128   11 
#define MAG3110_DROS_1000_16    12 
#define MAG3110_DROS_0500_32    13 
#define MAG3110_DROS_0250_64    14 
#define MAG3110_DROS_0125_128   15 
#define MAG3110_DROS_0500_16    16 
#define MAG3110_DROS_0250_32    17 
#define MAG3110_DROS_0125_64    18 
#define MAG3110_DROS_0063_128   19 
#define MAG3110_DROS_0250_16    20 
#define MAG3110_DROS_0125_32    21 
#define MAG3110_DROS_0063_64    22 
#define MAG3110_DROS_0031_128   23 
#define MAG3110_DROS_0125_16    24 
#define MAG3110_DROS_0063_32    25 
#define MAG3110_DROS_0031_64    26 
#define MAG3110_DROS_0016_128   27 
#define MAG3110_DROS_0063_16    28 
#define MAG3110_DROS_0031_32    29 
#define MAG3110_DROS_0016_64    30 
#define MAG3110_DROS_0008_128   31 
#define MAG3110_DROS_DEFAULT    MAG3110_DROS_0125_128 

typedef struct {
    i2c_t i2c;                  
    uint8_t addr;               
    uint8_t type;               
    uint8_t dros;               
    int16_t offset[3];          
} mag3110_params_t;

typedef struct {
    mag3110_params_t params;    
} mag3110_t;

typedef struct {
    int16_t x;                  
    int16_t y;                  
    int16_t z;                  
} mag3110_data_t;

int mag3110_init(mag3110_t *dev, const mag3110_params_t *params);

int mag3110_set_user_offset(const mag3110_t *dev, int16_t x, int16_t y, int16_t z);

int mag3110_set_active(const mag3110_t *dev);

int mag3110_set_standby(const mag3110_t *dev);

int mag3110_is_ready(const mag3110_t *dev);

int mag3110_read(const mag3110_t *dev, mag3110_data_t *data);

int mag3110_read_dtemp(const mag3110_t *dev, int8_t *dtemp);
 
#ifdef __cplusplus
}
#endif