mma7361.h

Go to the documentation of this file.

/*
 * Author: Jon Trulson <jtrulson@ics.com>
 * Copyright (c) 2016 Intel Corporation.
 *
 * 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 <stdint.h>
#include "upm.h"
#include "mraa/aio.h"
#include "mraa/gpio.h"

#ifdef __cplusplus
extern "C" {
#endif

  typedef struct _mma7361_context {
    // at least one of these must be intialized
    mraa_aio_context    aio_x;
    mraa_aio_context    aio_y;
    mraa_aio_context    aio_z;
    
    // optional - enable selftest
    mraa_gpio_context   gpio_selftest;
    
    // optional - enable sleep mode
    mraa_gpio_context   gpio_sleep;
    
    // optional - detect free fall (0g)
    mraa_gpio_context   gpio_freefall;
    
    // optional - if unconnected, range is 1.5g
    mraa_gpio_context   gpio_range;
    
    // selected G range
    float g_range;

    // analog ADC resolution
    float               a_res;

    // analog reference voltage
    float               a_ref;
    
    // for external offset and scaling of the results
    float               offset_x;
    float               offset_y;
    float               offset_z;

    float               scale_x;
    float               scale_y;
    float               scale_z;
    
    // our measurements
    float               accel_x;
    float               accel_y;
    float               accel_z;

    // volts
    float               volts_x;
    float               volts_y;
    float               volts_z;

    // normalized ADC
    float               normalized_x;
    float               normalized_y;
    float               normalized_z;
  } *mma7361_context;
  
  mma7361_context mma7361_init(int x_pin, int y_pin, int z_pin,
                               int selftest_pin, int sleep_pin,
                               int freefall_pin, int range_pin,
                               float a_ref);

  void mma7361_close(mma7361_context dev);

  void mma7361_set_range(const mma7361_context dev, bool range);

  upm_result_t mma7361_sleep(const mma7361_context dev, bool sleep);

  upm_result_t mma7361_freefall(const mma7361_context dev, bool *freefall);

  upm_result_t mma7361_selftest(const mma7361_context dev, bool selftest);

  upm_result_t mma7361_update(const mma7361_context dev);

  void mma7361_set_offset(const mma7361_context dev, float x, float y,
                          float z);

  void mma7361_set_scale(const mma7361_context dev, float x, float y,
                         float z);

  void mma7361_get_acceleration(const mma7361_context dev,
                                float *x, float *y, float *z);

  void mma7361_get_volts(const mma7361_context dev,
                         float *x, float *y, float *z);

  void mma7361_get_normalized(const mma7361_context dev,
                              float *x, float *y, float *z);

#ifdef __cplusplus
}
#endif