frc::ADXL362 Class Reference

ADXL362 SPI Accelerometer. More...

#include <frc/ADXL362.h>

Inheritance diagram for frc::ADXL362:

Classes
struct	AllAxes
	Container type for accelerations from all axes. More...

Public Types
enum	Range { kRange_2G = 0 , kRange_4G = 1 , kRange_8G = 2 }
	Accelerometer range. More...
enum	Axes { kAxis_X = 0x00 , kAxis_Y = 0x02 , kAxis_Z = 0x04 }
	Accelerometer axes. More...

Public Member Functions
	ADXL362 (Range range=kRange_2G)
	Constructor. More...
	ADXL362 (SPI::Port port, Range range=kRange_2G)
	Constructor. More...
	~ADXL362 () override=default
	ADXL362 (ADXL362 &&)=default
ADXL362 &	operator= (ADXL362 &&)=default
SPI::Port	GetSpiPort () const
void	SetRange (Range range)
	Set the measuring range of the accelerometer. More...
double	GetX ()
	Returns the acceleration along the X axis in g-forces. More...
double	GetY ()
	Returns the acceleration along the Y axis in g-forces. More...
double	GetZ ()
	Returns the acceleration along the Z axis in g-forces. More...
virtual double	GetAcceleration (Axes axis)
	Get the acceleration of one axis in Gs. More...
virtual AllAxes	GetAccelerations ()
	Get the acceleration of all axes in Gs. More...
void	InitSendable (nt::NTSendableBuilder &builder) override
	Initializes this Sendable object. More...
Public Member Functions inherited from nt::NTSendable
virtual void	InitSendable (NTSendableBuilder &builder)=0
	Initializes this Sendable object. More...
void	InitSendable (wpi::SendableBuilder &builder) override
	Initializes this Sendable object. More...
Public Member Functions inherited from wpi::Sendable
virtual	~Sendable ()=default
virtual void	InitSendable (SendableBuilder &builder)=0
	Initializes this Sendable object. More...
Public Member Functions inherited from wpi::SendableHelper< ADXL362 >
	SendableHelper (const SendableHelper &rhs)=default
	SendableHelper (SendableHelper &&rhs)
SendableHelper &	operator= (const SendableHelper &rhs)=default
SendableHelper &	operator= (SendableHelper &&rhs)

Additional Inherited Members
Protected Member Functions inherited from wpi::SendableHelper< ADXL362 >
	SendableHelper ()=default
	~SendableHelper ()

Detailed Description

ADXL362 SPI Accelerometer.

This class allows access to an Analog Devices ADXL362 3-axis accelerometer.

Member Enumeration Documentation

Axes

enum frc::ADXL362::Axes

Accelerometer axes.

Enumerator
kAxis_X	X axis.
kAxis_Y	Y axis.
kAxis_Z	Z axis.

Range

enum frc::ADXL362::Range

Accelerometer range.

Enumerator
kRange_2G	2 Gs max.
kRange_4G	4 Gs max.
kRange_8G	8 Gs max.

Constructor & Destructor Documentation

ADXL362() [1/3]

frc::ADXL362::ADXL362 ( Range  range = kRange_2G )

explicit

Constructor.

Uses the onboard CS1.

Parameters

range

The range (+ or -) that the accelerometer will measure.

ADXL362() [2/3]

frc::ADXL362::ADXL362 ( SPI::Port  port, Range  range = kRange_2G  )

explicit

Constructor.

Parameters

port	The SPI port the accelerometer is attached to
range	The range (+ or -) that the accelerometer will measure.

~ADXL362()

frc::ADXL362::~ADXL362 ( )

overridedefault

ADXL362() [3/3]

frc::ADXL362::ADXL362 ( ADXL362 &&  )

default

Member Function Documentation

GetAcceleration()

virtual double frc::ADXL362::GetAcceleration ( Axes  axis )

virtual

Get the acceleration of one axis in Gs.

Parameters

axis	The axis to read from.

Returns

Acceleration of the ADXL362 in Gs.

GetAccelerations()

virtual AllAxes frc::ADXL362::GetAccelerations ( )

virtual

Get the acceleration of all axes in Gs.

Returns

An object containing the acceleration measured on each axis of the ADXL362 in Gs.

GetSpiPort()

SPI::Port frc::ADXL362::GetSpiPort

(

)

const

GetX()

double frc::ADXL362::GetX

(

)

Returns the acceleration along the X axis in g-forces.

Returns

The acceleration along the X axis in g-forces.

GetY()

double frc::ADXL362::GetY

(

)

Returns the acceleration along the Y axis in g-forces.

Returns

The acceleration along the Y axis in g-forces.

GetZ()

double frc::ADXL362::GetZ

(

)

Returns the acceleration along the Z axis in g-forces.

Returns

The acceleration along the Z axis in g-forces.

InitSendable()

void frc::ADXL362::InitSendable ( nt::NTSendableBuilder &  builder )

overridevirtual

Initializes this Sendable object.

Parameters

builder

sendable builder

Implements nt::NTSendable.

operator=()

ADXL362 & frc::ADXL362::operator= ( ADXL362 &&  )

default

SetRange()

void frc::ADXL362::SetRange

(

Range

range

)

Set the measuring range of the accelerometer.

Parameters

range

The maximum acceleration, positive or negative, that the accelerometer will measure.

---

The documentation for this class was generated from the following file:

• frc/ADXL362.h