HallSwitch Class Reference

#include <hall-switch.hpp>

Inheritance diagram for HallSwitch:

Collaboration diagram for HallSwitch:

Classes
class	Hall_GPIO
class	Interrupt

Public Types
typedef void(*	CBack_t) (Result_t)
	Callback function type for interrupt mode.
Error codes
enum	Error_t { OK = 0 , INTF_ERROR = -1 , CONF_ERROR = -2 }
Power modes
enum	PowerMode_t { MAIN = 1 , SWITCH = 2 }
Status
enum	Status_t { UNINITED = 0 , INITED = 1 , POWER_ON = 2 , POWER_OFF = 3 }
Measuring mode
enum	MeasMode_t { POLLING = 1 , INTERRUPT = 2 }
Magnetic field value
enum	Result_t { B_FIELD_UNDEF = -1 , B_FIELD_OFF = 0 , B_FIELD_ON = 1 }

Public Member Functions
	HallSwitch ()
	Hall Switch Default Constructor.
	HallSwitch (Hall_GPIO *output, CBack_t cBack=NULL, Hall_GPIO *power=NULL)
	Hall Switch Constructor.
	~HallSwitch ()
	Hall Switch Destructor Disables the sensor:
Error_t	init ()
	Initializes the hardware interfaces.
Error_t	deinit ()
	Deinitializes the hardware interfaces.
Error_t	enable ()
	Enables the sensor.
Error_t	disable ()
	Disables the sensor.
Status_t	getStatus ()
	Gets the sensor status.
Error_t	updateBField ()
	Updates instance magnetic field value.
Result_t	getBField ()
	Gets magnetic field.

Protected Member Functions
virtual void	callback ()
	Interrupt mode callback function.

Protected Attributes
Status_t	status
Hall_GPIO *	output
Result_t	bfieldVal
CBack_t	cBack
MeasMode_t	measMode
Hall_GPIO *	power
PowerMode_t	powerMode

Member Typedef Documentation

CBack_t

typedef void(* HallSwitch::CBack_t) (Result_t)

Callback function type for interrupt mode.

Parameters

[in]

Result_t

B field value. The interrupt read the B field value and will pass it to the callback

Returns

void

Member Enumeration Documentation

Error_t

enum HallSwitch::Error_t

Enumerator
OK	No error
INTF_ERROR	Interface error
CONF_ERROR	Configuration error

PowerMode_t

enum HallSwitch::PowerMode_t

Enumerator
MAIN	Same as MCU VDD supply signal
SWITCH	Switched controlled power from MCU

Status_t

enum HallSwitch::Status_t

Enumerator
UNINITED	Not initialized
INITED	Initialized (external interfaces initialized)
POWER_ON	Power on
POWER_OFF	Power off

MeasMode_t

enum HallSwitch::MeasMode_t

Enumerator
POLLING	Polling mode
INTERRUPT	Interrupt mode

Result_t

enum HallSwitch::Result_t

Enumerator
B_FIELD_UNDEF	Output default high. Undefined at initialization
B_FIELD_OFF	No magnetic field present. Off. Q output high
B_FIELD_ON	Magnetic field present. On. Q output low

Constructor & Destructor Documentation

HallSwitch() [1/2]

HallSwitch::HallSwitch

(

)

Hall Switch Default Constructor.

• Hardware interfaces pointers set to NULL
• Default modes polling (for measure mode) and main (for switch power mode)
  

  Precondition

  None

HallSwitch() [2/2]

HallSwitch::HallSwitch	(	Hall_GPIO *	output,
		CBack_t	cBack = NULL,
		Hall_GPIO *	power = NULL
	)

Hall Switch Constructor.

Mandatory arguments:

• Sensor output GPIO pointer

Optional arguments:

• Interrupt callback. By default NULL. Required to enable interrupt mode.
• Sensor power GPIO pointer (only for switch powered mode platform). By default it is NULL.

Parameters

[in]	*output	Sensor output GPIO interface pointer
[in]	cBack	Callback for interrupt mode. When passed, it enables interrupt mode
[in]	*power	Sensor switch power controller GPIO interface pointer. Default NULL will set power mode to MAIN

Precondition

None

~HallSwitch()

HallSwitch::~HallSwitch

(

)

Hall Switch Destructor Disables the sensor:

• If "interrupt measuring mode" is enabled, the interrupt is disabled
• If "switch power mode" is configured, the sensor power is disabled
  

  Precondition

  None

Here is the call graph for this function:

Member Function Documentation

init()

HallSwitch::Error_t HallSwitch::init

(

)

Initializes the hardware interfaces.

Precondition

None

Returns

HallSwitch error code

Return values

OK	if success
INTF_ERROR	if hardware interface error

Here is the call graph for this function:

deinit()

HallSwitch::Error_t HallSwitch::deinit

(

)

Deinitializes the hardware interfaces.

Precondition

Instance has called init()

Instance has called disable() if enable() was called

Returns

HallSwitch error code

Return values

OK	if success
INTF_ERROR	if hardware interface error

Here is the call graph for this function:

enable()

HallSwitch::Error_t HallSwitch::enable

(

)

Enables the sensor.

• If "switch power mode " is configured, the sensor is powered up
• If "interrupt measuring mode" is configured, the interrupt is enabled

Precondition

Instance has called init()

Returns

HallSwitch error code

Return values

OK	if success
INTF_ERROR	if hardware interface error

Here is the call graph for this function:

disable()

HallSwitch::Error_t HallSwitch::disable

(

)

Disables the sensor.

• If the "interrupt measuring mode" is configured, the interrupt is disabled
• If the "switch power mode" is configured, the sensor is powered off

Precondition

Instance has called enable()

Returns

HallSwitch error code

Return values

OK	if success
INTF_ERROR	if hardware interface error

Here is the call graph for this function:

getStatus()

HallSwitch::Status_t HallSwitch::getStatus

(

)

Gets the sensor status.

Returns

HallSwitch status

updateBField()

HallSwitch::Error_t HallSwitch::updateBField

(

)

Updates instance magnetic field value.

• Magnetic field present if the GPIO voltage level is low
• Mangnetic field not present if the GPIO voltage level is high

The "bfieldVal" object member is updated with the read GPIO value.

Precondition

Instance has called enable()

Returns

HallSwitch error code

Return values

OK	if success
INTF_ERROR	if hardware interface error

Here is the call graph for this function:

getBField()

HallSwitch::Result_t HallSwitch::getBField

(

)

Gets magnetic field.

This functions returns the last read value updated in the object member bfieldVal variable, either from a explicit updateBField() call or due to an interrupt event.

Precondition

If polling mode is used, updateBField() has to be called preivously in order to get the actual value.

Returns

HallSwitch Result_t magnetic field value

Return values

B_FIELD_ON	if magnetic field present
B_FIELD_OFF	if magnetic field NOT present

callback()

void HallSwitch::callback ( )

protectedvirtual

Interrupt mode callback function.

The instance updates on its own bfieldVal member when the interrupt occurs.

Additionally, the user callback function is executed.

Returns

void

Reimplemented in HallSpeed.

Here is the call graph for this function:

Member Data Documentation

status

Status_t HallSwitch::status

protected

Status

output

Hall_GPIO* HallSwitch::output

protected

Output GPIO hardware interface pointer

bfieldVal

Result_t HallSwitch::bfieldVal

protected

Magnetic field value

cBack

CBack_t HallSwitch::cBack

protected

Interrupt mode callback function

measMode

MeasMode_t HallSwitch::measMode

protected

Measuring mode

power

Hall_GPIO* HallSwitch::power

protected

Power switch controller mode GPIO hardware interface pointer

powerMode

PowerMode_t HallSwitch::powerMode

protected

Power mode

---

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

• hall-switch.hpp
• hall-switch.cpp