BGT60 API

Collaboration diagram for BGT60 API:

Data Structures
class	Bgt60Rpi

Functions
	Bgt60Rpi::Bgt60Rpi (uint8_t targetDet, uint8_t phaseDet)
	Constructor of the RaspberryPi Bgt60 object.
	Bgt60Rpi::~Bgt60Rpi ()
	Destructor of the RaspberryPi Bgt60 object.
Error_t	Bgt60Rpi::enableInterrupt (std::function< void(void)> &cback)
	Enable interrupt.

Detailed Description

---

Data Structure Documentation

Bgt60Rpi

class Bgt60Rpi

Inheritance diagram for Bgt60Rpi:

Collaboration diagram for Bgt60Rpi:

Public Types
enum	Motion_t { NO_MOTION = 1 , MOTION = 2 }
	States of motion. More...
enum	Direction_t { NO_DIR = 0 , APPROACHING = 1 , DEPARTING = 2 }
	States of direction. More...
Public Member Functions
	Bgt60Rpi (uint8_t targetDet, uint8_t phaseDet)
	Constructor of the RaspberryPi Bgt60 object.
	~Bgt60Rpi ()
	Destructor of the RaspberryPi Bgt60 object.
Error_t	enableInterrupt (std::function< void(void)> &cback)
	Enable interrupt.
Error_t	enableInterrupt (void(*cback)(void))
	Enables the hardware interrupt.
Error_t	init ()
	Initialize the Bgt60 class object.
Error_t	deinit ()
	De-Initialize the Bgt60 class object.
Error_t	getMotion (Motion_t &motion)
	Read out target-detect-pin.
Error_t	getDirection (Direction_t &direction)
	Read out phase-detect-pin.
Error_t	disableInterrupt (void)
	Disables the hardware interrupt.

Member Enumeration Documentation

Motion_t

enum Bgt60::Motion_t

inherited

States of motion.

Enumerator
NO_MOTION	No presence
MOTION	Presence

Direction_t

enum Bgt60::Direction_t

inherited

States of direction.

Enumerator
NO_DIR	No direction due to no motion
APPROACHING	Target approaching
DEPARTING	Target departing

Member Function Documentation

enableInterrupt()

Error_t Bgt60::enableInterrupt

(

void(*)(void)

cback

)

Enables the hardware interrupt.

Parameters

[in]

*cback

Pointer to the interrupt callback function

Returns

Bgt60 error code

Return values

OK	if success
INTF_ERROR	if interface error

Precondition

init()

init()

Error_t Bgt60::init ( )

inherited

Initialize the Bgt60 class object.

Returns

Bgt60 error code

Return values

OK	if success
INTF_ERROR	if error

Precondition

None

deinit()

Error_t Bgt60::deinit ( )

inherited

De-Initialize the Bgt60 class object.

Returns

Bgt60 error code

Return values

OK	if success
INTF_ERROR	if error

Precondition

init()

Here is the call graph for this function:

getMotion()

Error_t Bgt60::getMotion ( Motion_t &  motion )

inherited

Read out target-detect-pin.

This function reads out the target-detect-pin. Depending on the choosen mode of the board it is either actively polling the status of the pin or mapping an interrupt to the corresponding pin.

Note

If you're using the interrupt mode of the board just call this function once in the setup(). For each object of the BGT60 this function can be called once. Calling it more often can lead to undesired behavior of the radar board.

Parameters

[in,out]

motion

This variable stores the actual state of the target-detect-pin Possible Values: NO_MOTION MOTION

Returns

Bgt60 error code

Return values

OK	if success
INTF_ERROR	if error

Precondition

init()

Here is the call graph for this function:

getDirection()

Error_t Bgt60::getDirection ( Direction_t &  direction )

inherited

Read out phase-detect-pin.

This function reads out the phase-detect-pin. Depending on the choosen mode of the board it is either actively polling the status of the pin or mapping an interrupt to the corresponding pin.

Note

If you're using the interrupt mode of the board just call this function once in the setup(). For each object of the BGT60 this function can be called once. Calling it more often can lead to undesired behavior of the radar board.

Parameters

[in,out]

direction

This variable stores the actual state of the phase-detect-pin Possible Values: NO_DIR APPROACHING DEPARTING

Returns

Bgt60 error code

Return values

OK	if success
INTF_ERROR	if error

Precondition

init()

Here is the call graph for this function:

disableInterrupt()

Error_t Bgt60::disableInterrupt ( void  )

inherited

Disables the hardware interrupt.

Returns

Bgt60 error code

Return values

OK	if success
INTF_ERROR	if interface error

Precondition

init()

Here is the call graph for this function:

Function Documentation

Bgt60Rpi()

Bgt60Rpi::Bgt60Rpi	(	uint8_t	targetDet,
		uint8_t	phaseDet
	)

Constructor of the RaspberryPi Bgt60 object.

This function is the instance constructor. It accepts the Raspberry Pi GPIO pins utilized for target and phase detect from the user. These pins are initialized by creating instances to GPIORpi and then mapped to main Bgt60 class.

Parameters

[in]	targetDet	Pin number of the target detect pin
[in]	phaseDet	Pin number of the phase detect pin
[in]	pinMode	Desired mode of the board, polling or interrupt driven

~Bgt60Rpi()

Bgt60Rpi::~Bgt60Rpi

(

)

Destructor of the RaspberryPi Bgt60 object.

enableInterrupt()

Error_t Bgt60Rpi::enableInterrupt

(

std::function< void(void)> &

cback

)

Enable interrupt.

Parameters

[in]

cback

Pointer to the interrupt callback function

Note

Convenience function to ease pybind11 wrapping of void pointer argument functions

Returns

Bgt60 error code

Return values

OK	if success
INTF_ERROR	if error
CONF_ERROR	if callback resource allocation not avaiable

Here is the call graph for this function: