MSS / FXAS21002

Dependents:   test_FXAS21002 testSensor RD-KL25Z-AGMP01_SensorStream pelion-example-frdm ... more

Embed: (wiki syntax)

« Back to documentation index

FXAS21002 Class Reference

FXAS21002 Class Reference

#include <FXAS21002.h>

Public Member Functions

 FXAS21002 (PinName sda, PinName scl, int addr)
 FXAS21002 constructor.
 ~FXAS21002 ()
 FXAS21002 destructor.
uint8_t getStatus (void)
 status register
int16_t getX (void)
 getX returns the value of REG_OUT_X_MSB REG_OUT_X_LSB as a signed 16bit integer
int16_t getY (void)
 getY returns the value of REG_OUT_Y_MSB REG_OUT_Y_LSB as a signed 16bit integer
int16_t getZ (void)
 getZ returns the value of REG_OUT_Z_MSB REG_OUT_Z_LSB as a signed 16bit integer
void activate (bool mode)
 activate/deactivate the sensor
void selftest (bool mode)
 Self-Test enable.
void ready (bool mode)
 Standby/Ready mode selection.
uint8_t getCTRL1 (void)
 get value of CTRL_REG1
void setCTRL1 (uint8_t value)
 set value to CTRL_REG1
uint8_t getCTRL2 (void)
 get value of CTRL_REG2
void setCTRL2 (uint8_t value)
 set value to CTRL_REG2
uint8_t getCTRL3 (void)
 get value of CTRL_REG3
void setCTRL3 (uint8_t value)
 set value to CTRL_REG3

Detailed Description

#include "mbed.h"
#include "FXAS21002.h"
#define FXAS21002_I2C_ADDRESS (0x20)

#if defined (TARGET_KL25Z)
#define PIN_SCL  PTE1
#define PIN_SDA  PTE0
#elif defined (TARGET_KL46Z)
#define PIN_SCL  PTE1
#define PIN_SDA  PTE0
#elif defined (TARGET_K64F)
#define PIN_SCL  PTE24
#define PIN_SDA  PTE25
#elif defined (TARGET_K22F)
#define PIN_SCL  PTE1
#define PIN_SDA  PTE0
#elif defined (TARGET_KL05Z)
#define PIN_SCL  PTB3
#define PIN_SDA  PTB4
#elif defined (TARGET_NUCLEO_F411RE)
#define PIN_SCL  PB_8
#define PIN_SDA  PB_9
#else
 #error TARGET NOT DEFINED
#endif

int main() {
    uint16_t result = 0 ;
    int16_t temperature = 0 ;
    FXAS21002  FXAS21002(PIN_SDA, PIN_SCL, FXAS21002_I2C_ADDRESS) ;
    
    while(1) {
        result = FXAS21002 .getValue(&temperature) ;
        printf("Temp %d C\n", temperature) ;
        wait(1) ;
    }
}

Definition at line 53 of file FXAS21002.h.


Constructor & Destructor Documentation

FXAS21002 ( PinName  sda,
PinName  scl,
int  addr 
)

FXAS21002 constructor.

Parameters:
sdaSDA pin
sdlSCL pin
addraddr of the I2C peripheral

Definition at line 29 of file FXAS21002.cpp.

~FXAS21002 (  )

FXAS21002 destructor.

Definition at line 33 of file FXAS21002.cpp.


Member Function Documentation

void activate ( bool  mode )

activate/deactivate the sensor

Parameters:
modetrue: Active false: Standby

Definition at line 84 of file FXAS21002.cpp.

uint8_t getCTRL1 ( void   )

get value of CTRL_REG1

Definition at line 108 of file FXAS21002.cpp.

uint8_t getCTRL2 ( void   )

get value of CTRL_REG2

Definition at line 123 of file FXAS21002.cpp.

uint8_t getCTRL3 ( void   )

get value of CTRL_REG3

Definition at line 138 of file FXAS21002.cpp.

uint8_t getStatus ( void   )

status register

Definition at line 35 of file FXAS21002.cpp.

int16_t getX ( void   )

getX returns the value of REG_OUT_X_MSB REG_OUT_X_LSB as a signed 16bit integer

Definition at line 42 of file FXAS21002.cpp.

int16_t getY ( void   )

getY returns the value of REG_OUT_Y_MSB REG_OUT_Y_LSB as a signed 16bit integer

Definition at line 52 of file FXAS21002.cpp.

int16_t getZ ( void   )

getZ returns the value of REG_OUT_Z_MSB REG_OUT_Z_LSB as a signed 16bit integer

Definition at line 62 of file FXAS21002.cpp.

void ready ( bool  mode )

Standby/Ready mode selection.

Parameters:
modetrue: Ready, false: Standby

Definition at line 96 of file FXAS21002.cpp.

void selftest ( bool  mode )

Self-Test enable.

Parameters:
modetrue: Self-Test enabled, false: Self-Test disabled

Definition at line 72 of file FXAS21002.cpp.

void setCTRL1 ( uint8_t  value )

set value to CTRL_REG1

Parameters:
valuevalue for CTRL_REG1

Definition at line 115 of file FXAS21002.cpp.

void setCTRL2 ( uint8_t  value )

set value to CTRL_REG2

Parameters:
valuevalue for CTRL_REG2

Definition at line 130 of file FXAS21002.cpp.

void setCTRL3 ( uint8_t  value )

set value to CTRL_REG3

Parameters:
valuevalue for CTRL_REG3

Definition at line 145 of file FXAS21002.cpp.