bma250e.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 "bma250e_defs.h"

#ifdef __cplusplus
extern "C" {
#endif

    typedef struct _bma250e_context {
        mraa_i2c_context i2c;
        mraa_spi_context spi;
        mraa_gpio_context gpioCS; // SPI CS pin
        mraa_gpio_context gpio1;  // intr 1
        mraa_gpio_context gpio2;  // intr 2

        // using SPI?
        bool isSPI;
        // use the FIFO?
        bool useFIFO;

        // always stored in C
        float temperature;

        // does this chip support the fifo?
        bool fifoAvailable;

        // supported resolution
        BMA250E_RESOLUTION_T resolution;

        // acc data
        float accX;
        float accY;
        float accZ;

        // acceleration scaling
        float accScale;
    } *bma250e_context;

    bma250e_context bma250e_init(int bus, int addr, int cs);

    void bma250e_close(bma250e_context dev);

    upm_result_t bma250e_update(const bma250e_context dev);

    uint8_t bma250e_get_chip_id(const bma250e_context dev);

    void bma250e_get_accelerometer(const bma250e_context dev,
                                   float *x, float *y, float *z);

    float bma250e_get_temperature(const bma250e_context dev);

    upm_result_t bma250e_devinit(const bma250e_context dev,
                                 BMA250E_POWER_MODE_T pwr,
                                 BMA250E_RANGE_T range,
                                 BMA250E_BW_T bw);

    upm_result_t bma250e_reset(const bma250e_context dev);

    upm_result_t bma250e_set_range(const bma250e_context dev,
                                   BMA250E_RANGE_T range);

    upm_result_t bma250e_set_bandwidth(const bma250e_context dev,
                                       BMA250E_BW_T bw);

    upm_result_t bma250e_set_power_mode(const bma250e_context dev,
                                        BMA250E_POWER_MODE_T power);

    void bma250e_enable_fifo(const bma250e_context dev, bool useFIFO);

    upm_result_t bma250e_fifo_set_watermark(const bma250e_context dev, int wm);

    upm_result_t bma250e_fifo_config(const bma250e_context dev,
                                     BMA250E_FIFO_MODE_T mode,
                                     BMA250E_FIFO_DATA_SEL_T axes);

    upm_result_t bma250e_set_self_test(const bma250e_context dev,
                                       bool sign, bool amp,
                                       BMA250E_SELFTTEST_AXIS_T axis);

    uint8_t bma250e_get_interrupt_enable0(const bma250e_context dev);

    upm_result_t bma250e_set_interrupt_enable0(const bma250e_context dev,
                                               uint8_t bits);

    uint8_t bma250e_get_interrupt_enable1(const bma250e_context dev);

    upm_result_t bma250e_set_interrupt_enable1(const bma250e_context dev,
                                               uint8_t bits);
    uint8_t bma250e_get_interrupt_enable2(const bma250e_context dev);

    upm_result_t bma250e_set_interrupt_enable2(const bma250e_context dev,
                                               uint8_t bits);

    uint8_t bma250e_get_interrupt_map0(const bma250e_context dev);

    upm_result_t bma250e_set_interrupt_map0(const bma250e_context dev,
                                            uint8_t bits);

    uint8_t bma250e_get_interrupt_map1(const bma250e_context dev);

    upm_result_t bma250e_set_interrupt_map1(const bma250e_context dev,
                                            uint8_t bits);

    uint8_t bma250e_get_interrupt_map2(const bma250e_context dev);

    upm_result_t bma250e_set_interrupt_map2(const bma250e_context dev,
                                            uint8_t bits);

    uint8_t bma250e_get_interrupt_src(const bma250e_context dev);

    upm_result_t bma250e_set_interrupt_src(const bma250e_context dev,
                                           uint8_t bits);

    uint8_t bma250e_get_interrupt_output_control(const bma250e_context dev);

    upm_result_t bma250e_set_interrupt_output_control(const bma250e_context dev,
                                                      uint8_t bits);

    upm_result_t bma250e_clear_interrupt_latches(const bma250e_context dev);

    BMA250E_RST_LATCH_T bma250e_get_interrupt_latch_behavior(
        const bma250e_context dev);

    upm_result_t bma250e_set_interrupt_latch_behavior(
        const bma250e_context dev,
        BMA250E_RST_LATCH_T latch);

    uint8_t bma250e_get_interrupt_status0(const bma250e_context dev);

    uint8_t bma250e_get_interrupt_status1(const bma250e_context dev);

    uint8_t bma250e_get_interrupt_status2(const bma250e_context dev);

    uint8_t bma250e_get_interrupt_status3_bits(const bma250e_context dev);

    BMA250E_ORIENT_T bma250e_get_interrupt_status3_orientation(
        const bma250e_context dev);

    upm_result_t bma250e_enable_register_shadowing(const bma250e_context dev,
                                                   bool shadow);

    upm_result_t bma250e_enable_output_filtering(const bma250e_context dev,
                                                 bool filter);

    upm_result_t bma250e_set_low_power_mode2(const bma250e_context dev);

    upm_result_t bma250e_install_isr(const bma250e_context dev,
                                     BMA250E_INTERRUPT_PINS_T intr, int gpio,
                                     mraa_gpio_edge_t level,
                                     void (*isr)(void *), void *arg);

    void bma250e_uninstall_isr(const bma250e_context dev,
                               BMA250E_INTERRUPT_PINS_T intr);

    uint8_t bma250e_read_reg(const bma250e_context dev, uint8_t reg);

    int bma250e_read_regs(const bma250e_context dev, uint8_t reg,
                          uint8_t *buffer, int len);

    upm_result_t bma250e_write_reg(const bma250e_context dev,
                                   uint8_t reg, uint8_t val);


#ifdef __cplusplus
}
#endif