WPILibC++  2019.1.1-beta-1-18-g2e3e3a4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Accelerometer Functions

Functions

 HAL_ENUM (HAL_AccelerometerRange)
 The acceptable accelerometer ranges.
 
void HAL_SetAccelerometerActive (HAL_Bool active)
 Sets the accelerometer to active or standby mode. More...
 
void HAL_SetAccelerometerRange (HAL_AccelerometerRange range)
 Sets the range of values that can be measured (either 2, 4, or 8 g-forces). More...
 
double HAL_GetAccelerometerX (void)
 Gets the x-axis acceleration. More...
 
double HAL_GetAccelerometerY (void)
 Gets the y-axis acceleration. More...
 
double HAL_GetAccelerometerZ (void)
 Gets the z-axis acceleration. More...
 

Detailed Description

Function Documentation

double HAL_GetAccelerometerX ( void  )

Gets the x-axis acceleration.

This is a floating point value in units of 1 g-force.

Returns
the X acceleration
double HAL_GetAccelerometerY ( void  )

Gets the y-axis acceleration.

This is a floating point value in units of 1 g-force.

Returns
the Y acceleration
double HAL_GetAccelerometerZ ( void  )

Gets the z-axis acceleration.

This is a floating point value in units of 1 g-force.

Returns
the Z acceleration
void HAL_SetAccelerometerActive ( HAL_Bool  active)

Sets the accelerometer to active or standby mode.

It must be in standby mode to change any configuration.

Parameters
activetrue to set to active, false for standby
void HAL_SetAccelerometerRange ( HAL_AccelerometerRange  range)

Sets the range of values that can be measured (either 2, 4, or 8 g-forces).

The accelerometer should be in standby mode when this is called.

Parameters
rangethe accelerometer range