kxtj3.hpp

/*
* 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

#include <vector>
#include <mraa/gpio.hpp>

#include "kxtj3.h"

namespace upm
{
class KXTJ3
{
public:
  KXTJ3(int bus, uint8_t addr = 0x0f);

  virtual ~KXTJ3();

  void SensorInit(KXTJ3_ODR_T odr, KXTJ3_RESOLUTION_T resolution, KXTJ3_G_RANGE_T g_range);

  uint8_t GetWhoAmI();

  void SensorActive();

  void SensorStandby();

  void SetGRange(KXTJ3_G_RANGE_T g_range);

  void SetResolution(KXTJ3_RESOLUTION_T resolution);

  void SetOdr(KXTJ3_ODR_T odr);

  void SetOdrForWakeup(KXTJ3_ODR_WAKEUP_T odr);

  void SelfTestDigitalCommunication();

  void SensorSelfTest();

  void SensorSoftwareReset();

  std::vector<float> GetAccelerationRawVector();

  std::vector<float> GetAccelerationVector();

  float GetAccelerationSamplePeriod();

  float GetWakeUpSamplePeriod();

  void EnableDataReadyInterrupt();

  void DisableDataReadyInterrupt();

  void EnableWakeUpInterrupt();

  void DisableWakeUpInterrupt();

  void EnableInterruptPin(KXTJ3_INTERRUPT_POLARITY_T polarity, KXTJ3_INTERRUPT_RESPONSE_T response_type);

  void DisableInterruptPin();

  void SetInterruptPolarity(KXTJ3_INTERRUPT_POLARITY_T polarity);

  void SetInerruptResponse(KXTJ3_INTERRUPT_RESPONSE_T response_type);

  bool GetInterruptStatus();

  uint8_t ReadInterruptSource1();

  KXTJ3_INTERRUPT_SOURCE_T GetInterruptSource();

  void InstallIsr(mraa_gpio_edge_t edge, int pin, void (*isr)(void *), void *isr_args);

  void UninstallIsr();

  void ClearInterrupt();

  void EnableWakeUpSingleAxisDirection(KXTJ3_WAKEUP_SOURCE_T axis);

  void DisableWakeUpSingleAxisDirection(KXTJ3_WAKEUP_SOURCE_T axis);

  kxtj3_wakeup_axes GetWakeUpAxisDirection();

  void EnableWakeUpLatch();

  void DisableWakeUpLatch();

  void SetWakeUpMotionCounter(uint8_t count);

  void SetWakeUpMotionTime(float desired_time);

  float GetWakeUpMotionTime();

  void SetWakeUpNonActivityCounter(uint8_t count);

  void SetWakeUpNonActivityTime(float desired_time);

  float GetWakeUpNonActivityTime();

  void SetWakeUpThresholdCounter(uint16_t count);

  void SetWakeUpThresholdGRange(float g_threshold);

  float GetWakeUpThresholdGRange();

private:
  kxtj3_context m_kxtj3;

  /* Disable implicit copy and assignment operators */
  KXTJ3(const KXTJ3 &) = delete;
  KXTJ3 &operator=(const KXTJ3 &) = delete;
};
} // namespace upm