kxtj3.h

/*
* The MIT License (MIT)
*
* Author: Assam Boudjelthia
* Copyright (c) 2018 Rohm Semiconductor.
*
* 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

#ifdef __cplusplus
extern "C"
{
#endif

#include <assert.h>
#include <unistd.h>

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

#include "kxtj3_registers.h"

#define SECOND_IN_MICRO_S 1000000

  typedef enum
  {
    LOW_RES,
    HIGH_RES
  } KXTJ3_RESOLUTION_T;

  typedef enum
  {
    ACTIVE_LOW,
    ACTIVE_HIGH

  } KXTJ3_INTERRUPT_POLARITY_T;

  typedef enum
  {
    LATCH_UNTIL_CLEARED,
    TRANSMIT_ONE_PULSE
  } KXTJ3_INTERRUPT_RESPONSE_T;

  typedef enum
  {
    NO_INTERRUPT,
    KXTJ3_DATA_READY_INTERRUPT = KXTJ3_INT_SOURCE1_DRDY,
    KXTJ3_WAKEUP_INTERRUPT = KXTJ3_INT_SOURCE1_WUFS,
    KXTJ3_DATA_READY_AND_WAKEUP_INT = KXTJ3_INT_SOURCE1_DRDY | KXTJ3_INT_SOURCE1_WUFS
  } KXTJ3_INTERRUPT_SOURCE_T;

  typedef enum
  {
    KXTJ3_RANGE_2G = KXTJ3_CTRL_REG1_GSEL_2G,
    KXTJ3_RANGE_4G = KXTJ3_CTRL_REG1_GSEL_4G,
    KXTJ3_RANGE_8G = KXTJ3_CTRL_REG1_GSEL_8G,
    KXTJ3_RANGE_8G_14 = KXTJ3_CTRL_REG1_GSEL_8G_14,
    KXTJ3_RANGE_16G = KXTJ3_CTRL_REG1_GSEL_16G,
    KXTJ3_RANGE_16G_2 = KXTJ3_CTRL_REG1_GSEL_16G2,
    KXTJ3_RANGE_16G_3 = KXTJ3_CTRL_REG1_GSEL_16G3,
    KXTJ3_RANGE_16G_14 = KXTJ3_CTRL_REG1_GSEL_16G_14
  } KXTJ3_G_RANGE_T;

  typedef enum
  {
    KXTJ3_ODR_0P781 = KXTJ3_DATA_CTRL_REG_OSA_0P781,
    KXTJ3_ODR_1P563 = KXTJ3_DATA_CTRL_REG_OSA_1P563,
    KXTJ3_ODR_3P125 = KXTJ3_DATA_CTRL_REG_OSA_3P125,
    KXTJ3_ODR_6P25 = KXTJ3_DATA_CTRL_REG_OSA_6P25,
    KXTJ3_ODR_12P5 = KXTJ3_DATA_CTRL_REG_OSA_12P5,
    KXTJ3_ODR_25 = KXTJ3_DATA_CTRL_REG_OSA_25,
    KXTJ3_ODR_50 = KXTJ3_DATA_CTRL_REG_OSA_50,
    KXTJ3_ODR_100 = KXTJ3_DATA_CTRL_REG_OSA_100,
    KXTJ3_ODR_200 = KXTJ3_DATA_CTRL_REG_OSA_200,
    KXTJ3_ODR_400 = KXTJ3_DATA_CTRL_REG_OSA_400,
    KXTJ3_ODR_800 = KXTJ3_DATA_CTRL_REG_OSA_800,
    KXTJ3_ODR_1600 = KXTJ3_DATA_CTRL_REG_OSA_1600
  } KXTJ3_ODR_T;

  typedef enum
  {
    KXTJ3_ODR_WAKEUP_0P781 = KXTJ3_CTRL_REG2_OWUF_0P781,
    KXTJ3_ODR_WAKEUP_1P563 = KXTJ3_CTRL_REG2_OWUF_1P563,
    KXTJ3_ODR_WAKEUP_3P125 = KXTJ3_CTRL_REG2_OWUF_3P125,
    KXTJ3_ODR_WAKEUP_6P25 = KXTJ3_CTRL_REG2_OWUF_6P25,
    KXTJ3_ODR_WAKEUP_12P5 = KXTJ3_CTRL_REG2_OWUF_12P5,
    KXTJ3_ODR_WAKEUP_25 = KXTJ3_CTRL_REG2_OWUF_25,
    KXTJ3_ODR_WAKEUP_50 = KXTJ3_CTRL_REG2_OWUF_50,
    KXTJ3_ODR_WAKEUP_100 = KXTJ3_CTRL_REG2_OWUF_100
  } KXTJ3_ODR_WAKEUP_T;

  typedef enum
  {
    X_NEGATIVE = KXTJ3_INT_CTRL_REG2_XNWU,
    X_POSITIVE = KXTJ3_INT_CTRL_REG2_XPWU,
    Y_NEGATIVE = KXTJ3_INT_CTRL_REG2_YNWU,
    Y_POSITIVE = KXTJ3_INT_CTRL_REG2_YPWU,
    Z_NEGATIVE = KXTJ3_INT_CTRL_REG2_ZNWU,
    Z_POSITIVE = KXTJ3_INT_CTRL_REG2_ZPWU
  } KXTJ3_WAKEUP_SOURCE_T;

  typedef struct
  {
    bool X_NEGATIVE,
        X_POSITIVE,
        Y_NEGATIVE,
        Y_POSITIVE,
        Z_NEGATIVE,
        Z_POSITIVE;
  } kxtj3_wakeup_axes;

  typedef struct _kxtj3_context
  {
    mraa_i2c_context i2c;
    KXTJ3_RESOLUTION_T res_mode;
    KXTJ3_G_RANGE_T g_range_mode;
    float acceleration_scale;
    KXTJ3_ODR_T odr;
    float odr_in_sec;
    KXTJ3_ODR_WAKEUP_T odr_wakeup;
    float odr_in_sec_wakeup;
    mraa_gpio_context interrupt_pin;
  } * kxtj3_context;

  kxtj3_context kxtj3_init(int bus, uint8_t addr);

  upm_result_t kxtj3_sensor_init(const kxtj3_context dev, KXTJ3_ODR_T odr, KXTJ3_RESOLUTION_T res, KXTJ3_G_RANGE_T g_range);

  upm_result_t kxtj3_get_who_am_i(const kxtj3_context dev, uint8_t *data);

  void kxtj3_close(kxtj3_context dev);

  upm_result_t kxtj3_set_sensor_active(const kxtj3_context dev);

  upm_result_t kxtj3_set_sensor_standby(const kxtj3_context dev);

  upm_result_t kxtj3_set_g_range(const kxtj3_context dev, KXTJ3_G_RANGE_T g_range);

  upm_result_t kxtj3_set_resolution(const kxtj3_context dev, KXTJ3_RESOLUTION_T resolution);

  upm_result_t kxtj3_set_odr(const kxtj3_context dev, KXTJ3_ODR_T odr);

  upm_result_t kxtj3_set_odr_wakeup_function(const kxtj3_context dev, KXTJ3_ODR_WAKEUP_T odr);

  upm_result_t kxtj3_self_test_digital_communication(kxtj3_context dev);

  upm_result_t kxtj3_sensor_self_test(const kxtj3_context dev);

  upm_result_t kxtj3_sensor_software_reset(const kxtj3_context dev);

  upm_result_t kxtj3_get_acceleration_data_raw(const kxtj3_context dev, float *x, float *y, float *z);

  upm_result_t kxtj3_get_acceleration_data(const kxtj3_context dev, float *x, float *y, float *z);

  float kxtj3_get_acceleration_sampling_period(kxtj3_context dev);

  float kxtj3_get_wakeup_sampling_period(kxtj3_context dev);

  upm_result_t kxtj3_enable_data_ready_interrupt(const kxtj3_context dev);

  upm_result_t kxtj3_disable_data_ready_interrupt(const kxtj3_context dev);

  upm_result_t kxtj3_enable_wakeup_interrupt(const kxtj3_context dev);

  upm_result_t kxtj3_disable_wakeup_interrupt(const kxtj3_context dev);

  upm_result_t kxtj3_enable_interrupt_pin(const kxtj3_context dev, KXTJ3_INTERRUPT_POLARITY_T polarity, KXTJ3_INTERRUPT_RESPONSE_T response_type);

  upm_result_t kxtj3_disable_interrupt_pin(const kxtj3_context dev);

  upm_result_t kxtj3_set_interrupt_polarity(const kxtj3_context dev, KXTJ3_INTERRUPT_POLARITY_T polarity);

  upm_result_t kxtj3_set_interrupt_response(const kxtj3_context dev, KXTJ3_INTERRUPT_RESPONSE_T response_type);

  bool kxtj3_get_interrupt_status(const kxtj3_context dev);

  upm_result_t kxtj3_read_interrupt_source1_reg(const kxtj3_context dev, uint8_t *reg_value);

  KXTJ3_INTERRUPT_SOURCE_T kxtj3_get_interrupt_source(const kxtj3_context dev);

  upm_result_t kxtj3_install_isr(const kxtj3_context dev, mraa_gpio_edge_t edge, int pin, void (*isr)(void *), void *isr_args);

  void kxtj3_uninstall_isr(const kxtj3_context dev);

  upm_result_t kxtj3_clear_interrupt_information(kxtj3_context dev);

  upm_result_t kxtj3_enable_wakeup_single_axis_direction(kxtj3_context dev, KXTJ3_WAKEUP_SOURCE_T axis);

  upm_result_t kxtj3_disable_wakeup_single_axis_direction(kxtj3_context dev, KXTJ3_WAKEUP_SOURCE_T axis);

  kxtj3_wakeup_axes kxtj3_get_wakeup_axis_and_direction(kxtj3_context dev);

  upm_result_t kxtj3_enable_wakeup_latch(kxtj3_context dev);

  upm_result_t kxtj3_disable_wakeup_latch(kxtj3_context dev);

  upm_result_t kxtj3_set_wakeup_motion_counter(kxtj3_context dev, uint8_t count);

  upm_result_t kxtj3_set_wakeup_motion_time(kxtj3_context dev, float desired_time);

  upm_result_t kxtj3_get_wakeup_motion_time(kxtj3_context dev, float *out_time);

  upm_result_t kxtj3_set_wakeup_non_activity_counter(kxtj3_context dev, uint8_t count);

  upm_result_t kxtj3_set_wakeup_non_activity_time(kxtj3_context dev, float desired_time);

  upm_result_t kxtj3_get_wakeup_non_activity_time(kxtj3_context dev, float *out_time);

  upm_result_t kxtj3_set_wakeup_threshold_counter(kxtj3_context dev, uint16_t count);

  upm_result_t kxtj3_set_wakeup_threshold_g_value(kxtj3_context dev, float g_threshold);

  upm_result_t kxtj3_get_wakeup_threshold(kxtj3_context dev, float *out_threshold);

#ifdef __cplusplus
}
#endif