PAJ7620U2 unit. More...

#include <unit_PAJ7620U2.hpp>

Inheritance diagram for m5::unit::UnitPAJ7620U2:

Classes
struct	config_t
	Settings for begin. More...

Public Member Functions
	UnitPAJ7620U2 (const uint8_t addr=DEFAULT_ADDRESS)
	Constructor.

virtual	~UnitPAJ7620U2 ()
	Destructor.

virtual bool	begin () override
	Begin communication with the sensor.

virtual void	update (const bool force=false) override
	Update periodic measurement data.

uint8_t	rotation () const
	Get the rotation.

void	setRotate (const uint8_t rot)
	Set the rotation.

paj7620u2::Frequency	frequency () const
	Gets the inner frequency.

bool	readFrequency (uint16_t &raw)
	Read the raw R_IDLE_TIME register value.

bool	readFrequency (paj7620u2::Frequency &f)
	Read the frequency.

bool	writeFrequency (const paj7620u2::Frequency f)
	Write the frequency.

float	readFrequencyHz ()
	Read the current frequency in Hz from hardware.

bool	writeFrequencyHz (const float hz)
	Write the frequency in Hz.

bool	readHorizontalFlip (bool &flip)
	Read the horizontal flipping.

bool	readVerticalFlip (bool &flip)
	Read the vertical flipping.

bool	writeHorizontalFlip (const bool flip)
	Write the horizontal flipping.

bool	writeVerticalFlip (const bool flip)
	Write the vertical flipping.

Settings for begin
config_t	config ()
	Gets the configuration.

void	config (const config_t &cfg)
	Set the configuration.

Measurement data by periodic
paj7620u2::Gesture	gesture () const
	Oldest gesture.

uint8_t	brightness () const
	Oldest brightness if Proximity mode.

bool	approach () const
	Oldest approach status if Proximity mode.

uint16_t	cursorX () const
	Oldest cursor X if Cursor mode.

uint16_t	cursorY () const
	Oldest cursor Y if Cursor mode.

Periodic measurement
bool	startPeriodicMeasurement (const uint32_t intervalMs=0)
	Start periodic measurement in the current settings.

bool	startPeriodicMeasurement (const paj7620u2::Mode mode, const paj7620u2::Frequency freq, const uint32_t intervalMs)
	Start periodic measurement.

bool	stopPeriodicMeasurement ()
	Stop periodic measurement.

For detect gesture
bool	readGesture (paj7620u2::Gesture &gesture)
	Read gesture.

bool	readObjectCenter (uint16_t &x, uint16_t &y)
	Object center position.

bool	readObjectSize (uint16_t &sz)
	Read gesture object size.

bool	existsObject (bool &exists)
	Is the object present within the detection range?

bool	readNoObjectCount (uint8_t &cnt)
	State counter with no objects detected.

bool	readNoMotionCount (uint8_t &cnt)
	State counter which a non-moving object is detected.

For detect proximity
bool	readProximity (uint8_t &brightness, uint8_t &approach)
	Read proximity.

bool	readApproachThreshold (uint8_t &high, uint8_t &low)
	Read the threshold for detect approach.

bool	writeApproachThreshold (const uint8_t high, const uint8_t low)
	Write the threshold for detect approach.

For detect cursor
bool	readCursor (uint16_t &x, uint16_t &y)
	Cursor position.

Detection mode
paj7620u2::Mode	mode () const
	Gets the detection mode.

bool	writeMode (const paj7620u2::Mode mode)
	Write the detection mode.

General purpose
bool	enable (const bool flag)
	Enable/disable sensor.

bool	enable ()
	enable sensor

bool	disable ()
	disable sensor

bool	suspend ()
	suspend

bool	resume ()
	resume from suspended

Protected Member Functions
bool	start_periodic_measurement (const uint32_t intervalMs=0)

bool	start_periodic_measurement (const paj7620u2::Mode mode, const paj7620u2::Frequency freq, const uint32_t intervalMs)

bool	stop_periodic_measurement ()

	M5_UNIT_COMPONENT_PERIODIC_MEASUREMENT_ADAPTER_HPP_BUILDER (UnitPAJ7620U2, paj7620u2::Data)

bool	select_bank (const uint8_t bank, const bool force=false)

bool	read_banked_register (const uint16_t reg, uint8_t *buf, const size_t len)

bool	read_banked_register8 (const uint16_t reg, uint8_t &value)

bool	write_banked_register (const uint16_t reg, const uint8_t *buf, const size_t len)

bool	write_banked_register8 (const uint16_t reg, const uint8_t value)

bool	update_gesture (paj7620u2::Data &d)

bool	update_proximity (paj7620u2::Data &d)

bool	update_cursor (paj7620u2::Data &d)

bool	read_gesture (paj7620u2::Data &d)

bool	read_proximity (paj7620u2::Data &d)

bool	read_cursor (paj7620u2::Data &d)

bool	wakeup ()

bool	was_wakeup ()

bool	read_chip_id (uint16_t &id)

bool	read_version (uint8_t &version)

Protected Attributes
uint8_t	_current_bank {0xFF}

paj7620u2::Mode	_mode {}

paj7620u2::Frequency	_frequency {}

uint8_t	_rotation {}

std::unique_ptr< m5::container::CircularBuffer< paj7620u2::Data > >	_data {}

config_t	_cfg {}

Detailed Description

PAJ7620U2 unit.

Constructor & Destructor Documentation

◆ UnitPAJ7620U2()

m5::unit::UnitPAJ7620U2::UnitPAJ7620U2 ( const uint8_t addr = DEFAULT_ADDRESS )

inlineexplicit

Constructor.

Parameters

addr	I2C address (default: 0x73)

Member Function Documentation

◆ begin()

bool m5::unit::UnitPAJ7620U2::begin ( )

overridevirtual

Begin communication with the sensor.

Returns: True if successful

◆ enable()

bool m5::unit::UnitPAJ7620U2::enable ( const bool flag )

Enable/disable sensor.

Parameters

flag	true:enable false:disable

Returns: True if successful

◆ existsObject()

bool m5::unit::UnitPAJ7620U2::existsObject ( bool & exists )

inline

Is the object present within the detection range?

Parameters

[out] exists true if exists

Returns: True if successful

◆ readApproachThreshold()

bool m5::unit::UnitPAJ7620U2::readApproachThreshold	(	uint8_t &	high,
		uint8_t &	low )

Read the threshold for detect approach.

Parameters

[out]	high	High threshold
[out]	low	Low threshold

Returns: True if successful

Note: Approach:brightness >= high; Not approach: brightness <= low

Warning: Only valid in Proximity mode

◆ readCursor()

bool m5::unit::UnitPAJ7620U2::readCursor	(	uint16_t &	x,
		uint16_t &	y )

Cursor position.

Parameters

[out]	x	X coordinate
[out]	y	Y coordinate

Returns: True if successful

Warning: Only valid in Cursor mode

◆ readFrequency() [1/2]

bool m5::unit::UnitPAJ7620U2::readFrequency ( paj7620u2::Frequency & f )

Read the frequency.

Parameters

[out] f Frequency

Returns: True if successful

◆ readFrequency() [2/2]

bool m5::unit::UnitPAJ7620U2::readFrequency ( uint16_t & raw )

Read the raw R_IDLE_TIME register value.

Parameters

[out] raw R_IDLE_TIME[15:0]

Returns: True if successful

◆ readFrequencyHz()

float m5::unit::UnitPAJ7620U2::readFrequencyHz ( )

Read the current frequency in Hz from hardware.

Returns: Frequency in Hz, or 0.0f on error

◆ readGesture()

bool m5::unit::UnitPAJ7620U2::readGesture ( paj7620u2::Gesture & gesture )

Read gesture.

Parameters

[out] gesture Detected gesture result

Returns: True if successful

◆ readHorizontalFlip()

bool m5::unit::UnitPAJ7620U2::readHorizontalFlip ( bool & flip )

Read the horizontal flipping.

Parameters

[out] flip Horizontal flip state

Returns: True if successful

◆ readNoMotionCount()

bool m5::unit::UnitPAJ7620U2::readNoMotionCount ( uint8_t & cnt )

State counter which a non-moving object is detected.

Parameters

[out] cnt Count in ticks [0...12]

Returns: True if successful

◆ readNoObjectCount()

bool m5::unit::UnitPAJ7620U2::readNoObjectCount ( uint8_t & cnt )

State counter with no objects detected.

Parameters

[out] cnt Count in ticks [0...255]

Returns: True if successful

◆ readObjectCenter()

bool m5::unit::UnitPAJ7620U2::readObjectCenter	(	uint16_t &	x,
		uint16_t &	y )

Object center position.

Parameters

[out]	x	X coordinate
[out]	y	Y coordinate

Returns: True if successful

◆ readObjectSize()

bool m5::unit::UnitPAJ7620U2::readObjectSize ( uint16_t & sz )

Read gesture object size.

Parameters

[out] sz size [0~900]

Returns: True if successful

◆ readProximity()

bool m5::unit::UnitPAJ7620U2::readProximity	(	uint8_t &	brightness,
		uint8_t &	approach )

Read proximity.

Parameters

[out]	brightness	0:Out of bounds [1:far ... 255:near]
[out]	approach	Approach object

Returns: True if successful

◆ readVerticalFlip()

bool m5::unit::UnitPAJ7620U2::readVerticalFlip ( bool & flip )

Read the vertical flipping.

Parameters

[out] flip Vertical flip state

Returns: True if successful

◆ rotation()

uint8_t m5::unit::UnitPAJ7620U2::rotation ( ) const

inline

Get the rotation.

Returns: Rotation [0...3]

See also: setRotate

◆ setRotate()

void m5::unit::UnitPAJ7620U2::setRotate ( const uint8_t rot )

inline

Set the rotation.

Parameters

rot	Rotation [0...3] +-------++ \|\|\| \|\| rot:0 up \|\|\| O \| left right +--------+ down rot 1,2,3... Treat as 90 deg counter-clockwise rotation m5::unit::UnitPAJ7620U2::rotation uint8_t rotation() const Get the rotation. Definition unit_PAJ7620U2.hpp:310

See also: rotation

◆ startPeriodicMeasurement() [1/2]

bool m5::unit::UnitPAJ7620U2::startPeriodicMeasurement	(	const paj7620u2::Mode	mode,
		const paj7620u2::Frequency	freq,
		const uint32_t	intervalMs )

inline

Start periodic measurement.

Parameters

mode	Operation mode
freq	Frequency
intervalMs	Measurement Interval(ms)

Returns: True if successful

◆ startPeriodicMeasurement() [2/2]

bool m5::unit::UnitPAJ7620U2::startPeriodicMeasurement ( const uint32_t intervalMs = 0 )

inline

Start periodic measurement in the current settings.

Parameters

intervalMs Measurement Interval(ms)

Returns: True if successful

◆ stopPeriodicMeasurement()

bool m5::unit::UnitPAJ7620U2::stopPeriodicMeasurement ( )

inline

Stop periodic measurement.

Returns: True if successful

◆ update()

void m5::unit::UnitPAJ7620U2::update ( const bool force = false )

overridevirtual

Update periodic measurement data.

Parameters

force If true, force update regardless of interval

◆ writeApproachThreshold()

bool m5::unit::UnitPAJ7620U2::writeApproachThreshold	(	const uint8_t	high,
		const uint8_t	low )

Write the threshold for detect approach.

Parameters

high	High threshold
low	Low threshold

Returns: True if successful

Note: Approach:brightness >= high; Not approach: brightness <= low

Warning: Only valid in Proximity mode

◆ writeFrequency()

bool m5::unit::UnitPAJ7620U2::writeFrequency ( const paj7620u2::Frequency f )

Write the frequency.

Parameters

f Frequency

Returns: True if successful

◆ writeFrequencyHz()

bool m5::unit::UnitPAJ7620U2::writeFrequencyHz ( const float hz )

Write the frequency in Hz.

Parameters

hz	Frequency in Hz (must be > 0)

Returns: True if successful

◆ writeHorizontalFlip()

bool m5::unit::UnitPAJ7620U2::writeHorizontalFlip ( const bool flip )

Write the horizontal flipping.

Parameters

flip	Horizontal flip state

Returns: True if successful

◆ writeMode()

bool m5::unit::UnitPAJ7620U2::writeMode ( const paj7620u2::Mode mode )

Write the detection mode.

Parameters

mode	detection mode

Returns: True if successful

◆ writeVerticalFlip()

bool m5::unit::UnitPAJ7620U2::writeVerticalFlip ( const bool flip )

Write the vertical flipping.

Parameters

flip	Vertical flip state

Returns: True if successful

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ UnitPAJ7620U2()

Member Function Documentation

◆ begin()

◆ enable()

◆ existsObject()

◆ readApproachThreshold()

◆ readCursor()

◆ readFrequency() [1/2]

◆ readFrequency() [2/2]

◆ readFrequencyHz()

◆ readGesture()

◆ readHorizontalFlip()

◆ readNoMotionCount()

◆ readNoObjectCount()

◆ readObjectCenter()

◆ readObjectSize()

◆ readProximity()

◆ readVerticalFlip()

◆ rotation()

◆ setRotate()

◆ startPeriodicMeasurement() [1/2]

◆ startPeriodicMeasurement() [2/2]

◆ stopPeriodicMeasurement()

◆ update()

◆ writeApproachThreshold()

◆ writeFrequency()

◆ writeFrequencyHz()

◆ writeHorizontalFlip()

◆ writeMode()

◆ writeVerticalFlip()