Loom_ZXGesture Class Reference

#include <Loom_ZXGesture.h>

Inheritance diagram for Loom_ZXGesture:

Collaboration diagram for Loom_ZXGesture:

Classes
struct	Position

Public Types
enum	Mode { POS , GEST }

Public Member Functions
	Loom_ZXGesture (Manager &man, int address=0x10, bool useMux=false, Mode mode=Mode::POS)
const char *	getGesture ()
uint8_t	getGestureSpeed ()
Position	getPosition ()
Public Member Functions inherited from I2CDevice
	I2CDevice (const char *modName)
bool	checkDeviceConnection ()
Public Member Functions inherited from Module
	Module (const char *modName)
void	setModuleName (const char *modName)
virtual const char *	getModuleName ()
virtual void	printModuleName (const char *message)
virtual void	initialize ()=0
virtual void	measure ()=0
virtual void	package ()=0
virtual void	power_up ()=0
virtual void	power_down ()=0
virtual void	display_data ()

Protected Member Functions
void	power_up () override
void	power_down () override
void	measure () override
void	initialize () override
void	package () override

Additional Inherited Members
Public Attributes inherited from I2CDevice
bool	needsReinit = false
Public Attributes inherited from Module
bool	moduleInitialized = true
int	module_address = -1

Detailed Description

ZX Gesture distance sensor

Author

Will Richards

Member Enumeration Documentation

Mode

enum Loom_ZXGesture::Mode

Mode to put the sensor into which alters what type of data it is trying to sense

Constructor & Destructor Documentation

Loom_ZXGesture()

Loom_ZXGesture::Loom_ZXGesture	(	Manager &	man,
		int	address = 0x10,
		bool	useMux = false,
		Mode	mode = Mode::POS
	)

Constructs a new TSL2591 sensor

Parameters

man	Reference to the manager that is used to universally package all data
address	I2C address that is assigned to the sensor
mode	Measuring mode we want to interpret data using

Member Function Documentation

getGesture()

const char * Loom_ZXGesture::getGesture ( )

inline

Get last recorded gesture

getGestureSpeed()

uint8_t Loom_ZXGesture::getGestureSpeed ( )

inline

Get the speed at which the last gesture has been preformed

getPosition()

Position Loom_ZXGesture::getPosition ( )

inline

Get position in mm

initialize()

void Loom_ZXGesture::initialize ( )

overrideprotectedvirtual

Implements Module.

measure()

void Loom_ZXGesture::measure ( )

overrideprotectedvirtual

Implements Module.

package()

void Loom_ZXGesture::package ( )

overrideprotectedvirtual

Implements Module.

power_down()

void Loom_ZXGesture::power_down ( )

inlineoverrideprotectedvirtual

Implements Module.

power_up()

void Loom_ZXGesture::power_up ( )

inlineoverrideprotectedvirtual

Implements Module.

---

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

• C:/Users/jwilt/AppData/Local/Arduino15/packages/loom4/hardware/samd/4.5/libraries/Loom/src/Sensors/I2C/Loom_ZXGesture/Loom_ZXGesture.h
• C:/Users/jwilt/AppData/Local/Arduino15/packages/loom4/hardware/samd/4.5/libraries/Loom/src/Sensors/I2C/Loom_ZXGesture/Loom_ZXGesture.cpp