Raspberries/upm
Public Access
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

kx122: Moved definitions, documentation tweaks

Browse Source 
Signed-off-by: Samuli Rissanen <samuli.rissanen@hotmail.com>
Signed-off-by: Noel Eck <noel.eck@intel.com>
This commit is contained in:
Samuli Rissanen
2018-02-23 13:17:37 +02:00
parent 2a17fe094e
commit ad36f83857
4 changed files with 105 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
src/kx122/kx122.hpp
View File

@@ -24,9 +24,7 @@
#include <mraa/gpio.hpp>
extern "C"{
#include "kx122.h"
}
#include "kx122.h"
/**
* @file kx122.hpp
@@ -46,6 +44,8 @@ namespace upm{
Set addr to -1 if using SPI.
When using I2C, set chip_select_pin to -1
If no errors occur, the device gets initialized with default values and gets set to active state.
@param bus I2C or SPI bus to use.
@param addr I2C address of the sensor.
@param chip_select Chip select pin for SPI.
@@ -141,6 +141,9 @@ namespace upm{
applying the electrostatic force to the sensor. If the amount of acceleration increases according
to the values defined in TABLE 1 of the datasheet, the test passes.
The function prints out the minimum, maximum and values calculated during the test
for each axis, and the result of the test for each axis.
See the datasheet for more information.
@throws std::runtime_error on failure.
@@ -162,9 +165,9 @@ namespace upm{
void setSensorActive();
/**
Sets the data sampling rate of the sensor.
Sets the ODR of the sensor.
Sensor needs to be in standby mode when setting the data sampling rate.
Sensor needs to be in standby mode when setting the ODR.
@param odr One of the KX122_ODR_T values.
@throws std::runtime_error on failure.
@@ -186,6 +189,9 @@ namespace upm{
Sensor needs to be in standby mode when setting the sensor resolution.
When sensor is set to low resolution mode, the sensor runs in low power mode, which in turn
enables features such as averaging.(setAverage()).
@param res One of the KX122_RES_T values.
@throws std::runtime_error on failure.
*/
@@ -308,14 +314,20 @@ namespace upm{
See datasheet for more details.
@param data Pointer to a uint8_t variable to store the value.
@throws std::runtime_error on failure.
@return Return true if an interrupt event has occured, returns false if no interrupts have occured.
*/
void getInterruptStatus(uint8_t *data);
bool getInterruptStatus();
/**
Gets the source of the interrupt.
The value stored is one or more of the KX122_INTERRUPT_T values, depending on the interrupts
that have occured.
If multiple interrupts have occured, and you need to determine a specific interrupt,
you can use masking to get the state of the specific interrupt:
(int_source & KX122_DATA_READY_INT) == KX122_DATA_READY_INT)
See datasheet for more details.
@param data Pointer to a uint8_t variable to store the value.