lis3dh.h

Go to the documentation of this file.

/*
 * Author: Alex Tereschenko <alext.mkrs@gmail.com>
 * Copyright (c) 2018 Alex Tereschenko.
 *
 * Based on LIS2DS12 module by
 * 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 <string.h>
#include <unistd.h>

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

#include "upm.h"

#include "lis3dh_defs.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct _lis3dh_context {
    mraa_i2c_context i2c;
    mraa_spi_context spi;

    mraa_gpio_context gpioCS;   // SPI CS pin
    mraa_gpio_context gpioINT1; // Interrupt 1
    mraa_gpio_context gpioINT2; // Interrupt 2

    // Uncompensated temperature data
    float temperature;

    // Temperature scaling factor. It accounts for storing 8b or 10b actual
    // data in 16b register pair.
    float temperatureFactor;

    // Uncompensated acceleration data
    float accX;
    float accY;
    float accZ;

    // Acceleration scaling - used to calculate actual acceleration,
    // depending on sensor working mode (low power/normal/high resolution)
    float accScale;
} * lis3dh_context;

lis3dh_context lis3dh_init(int bus, int addr, int cs);

void lis3dh_close(lis3dh_context dev);

upm_result_t
lis3dh_devinit(const lis3dh_context dev, LIS3DH_ODR_T odr, LIS3DH_FS_T fs, bool high_res);

upm_result_t lis3dh_enable_axes(const lis3dh_context dev,
                                bool x_axis_enable,
                                bool y_axis_enable,
                                bool z_axis_enable);

upm_result_t lis3dh_enable_bdu_mode(const lis3dh_context dev, bool bdu_enable);

upm_result_t lis3dh_enable_lp_mode(const lis3dh_context dev, bool lp_enable);

upm_result_t lis3dh_enable_hr_mode(const lis3dh_context dev, bool hr_enable);

upm_result_t lis3dh_enable_normal_mode(const lis3dh_context dev);

upm_result_t lis3dh_enable_hp_filtering(const lis3dh_context dev, bool filter);

upm_result_t lis3dh_enable_adc(const lis3dh_context dev, bool adc_enable);

upm_result_t lis3dh_enable_temperature(const lis3dh_context dev, bool temperature_enable);

upm_result_t
lis3dh_enable_interrupt_latching(const lis3dh_context dev, bool int1_latch, bool int2_latch);

upm_result_t lis3dh_set_odr(const lis3dh_context dev, LIS3DH_ODR_T odr);

upm_result_t lis3dh_set_full_scale(const lis3dh_context dev, LIS3DH_FS_T fs);

upm_result_t lis3dh_set_interrupt_active_high(const lis3dh_context dev, bool high);

upm_result_t lis3dh_set_int1_config(const lis3dh_context dev, uint8_t cfg);

upm_result_t lis3dh_set_int2_config(const lis3dh_context dev, uint8_t cfg);

uint8_t lis3dh_read_reg(const lis3dh_context dev, uint8_t reg);

int lis3dh_read_regs(const lis3dh_context dev, uint8_t reg, uint8_t* buffer, int len);

upm_result_t lis3dh_write_reg(const lis3dh_context dev, uint8_t reg, uint8_t val);

upm_result_t lis3dh_update(const lis3dh_context dev);

uint8_t lis3dh_get_chip_id(const lis3dh_context dev);

void lis3dh_get_accelerometer(const lis3dh_context dev, float* x, float* y, float* z);

float lis3dh_get_temperature(const lis3dh_context dev);

uint8_t lis3dh_get_status(const lis3dh_context dev);

uint8_t lis3dh_get_status_aux(const lis3dh_context dev);

upm_result_t lis3dh_install_isr(const lis3dh_context dev,
                                LIS3DH_INTERRUPT_PINS_T intr,
                                int gpio,
                                mraa_gpio_edge_t level,
                                void (*isr)(void*),
                                void* arg);

void lis3dh_uninstall_isr(const lis3dh_context dev, LIS3DH_INTERRUPT_PINS_T intr);

#ifdef __cplusplus
}
#endif