bmm150.h

Go to the documentation of this file.

/*
 * Author: Jon Trulson <jtrulson@ics.com>
 * Copyright (c) 2017 Intel Corporation.
 *
 * The MIT License
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#pragma once

#include <unistd.h>
#include <string.h>

#include <mraa/i2c.h>
#include <mraa/spi.h>
#include <mraa/gpio.h>

#include "upm.h"

#include "bmm150_defs.h"

#ifdef __cplusplus
extern "C" {
#endif

    typedef struct _bmm150_context {
        mraa_i2c_context i2c;
        mraa_spi_context spi;
        mraa_gpio_context gpioCS;   // SPI CS pin
        mraa_gpio_context gpioINT;  // intr
        mraa_gpio_context gpioDR;   // DR (Data Ready) intr

        // using SPI?
        bool isSPI;
        BMM150_OPERATION_MODE_T opmode;

        // mag data
        float magX;
        float magY;
        float magZ;

        // hall resistance (it is NOT futile!)
        uint16_t hall;

        // trimming data
        int8_t dig_x1;
        int8_t dig_y1;

        int16_t dig_z4;
        int8_t dig_x2;
        int8_t dig_y2;

        int16_t dig_z2;
        uint16_t dig_z1;
        uint16_t dig_xyz1;
        int16_t dig_z3;
        int8_t dig_xy2;
        uint8_t dig_xy1;
    } *bmm150_context;


    bmm150_context bmm150_init(int bus, int addr, int cs);

    void bmm150_close(bmm150_context dev);

    upm_result_t bmm150_update(const bmm150_context dev);

    uint8_t bmm150_get_chip_id(const bmm150_context dev);

    void bmm150_get_magnetometer(const bmm150_context dev,
                                 float *x, float *y, float *z);

    upm_result_t bmm150_devinit(const bmm150_context dev,
                                BMM150_USAGE_PRESETS_T usage);

    upm_result_t bmm150_set_preset_mode(const bmm150_context dev,
                                        BMM150_USAGE_PRESETS_T usage);

    upm_result_t bmm150_reset(const bmm150_context dev);

    upm_result_t bmm150_set_output_data_rate(const bmm150_context dev,
                                             BMM150_DATA_RATE_T odr);

    upm_result_t bmm150_set_power_bit(const bmm150_context dev, bool power);

    upm_result_t bmm150_set_opmode(const bmm150_context dev,
                                   BMM150_OPERATION_MODE_T opmode);

    BMM150_OPERATION_MODE_T bmm150_get_opmode(const bmm150_context dev);

    uint8_t bmm150_get_interrupt_enable(const bmm150_context dev);

    upm_result_t bmm150_set_interrupt_enable(const bmm150_context dev,
                                             uint8_t bits);

    uint8_t bmm150_get_interrupt_config(const bmm150_context dev);

    upm_result_t bmm150_set_interrupt_config(const bmm150_context dev,
                                             uint8_t bits);

    uint8_t bmm150_get_interrupt_status(const bmm150_context dev);

    upm_result_t bmm150_set_repetitions_xy(const bmm150_context dev,
                                           uint8_t reps);

    upm_result_t bmm150_set_repetitions_z(const bmm150_context dev,
                                          uint8_t reps);

    upm_result_t bmm150_install_isr(const bmm150_context dev,
                                    BMM150_INTERRUPT_PINS_T intr,
                                    int gpio, mraa_gpio_edge_t level,
                                    void (*isr)(void *), void *arg);

    void bmm150_uninstall_isr(const bmm150_context dev,
                              BMM150_INTERRUPT_PINS_T intr);

    uint8_t bmm150_read_reg(const bmm150_context dev, uint8_t reg);

    int bmm150_read_regs(const bmm150_context dev, uint8_t reg,
                         uint8_t *buffer, int len);

    upm_result_t bmm150_write_reg(const bmm150_context dev,
                                  uint8_t reg, uint8_t val);

#ifdef __cplusplus
}
#endif