A110X Class Reference

API for the A110X Hall Effect sensors. More...

Detailed Description

• ID: a110x
• Name: A110X Hall Effect Sensor
• Other Names: A1101, A1102, A1103, A1004, A1106
• Other Names: Grove Hall Sensor
• Category: electric
• Manufacturer: seeed
• Link: http://www.allegromicro.com/en/Products/Magnetic-Digital-Position-Sensor-ICs/Hall-Effect-Unipolar-Switches/A1101-2-3-4-6.aspx
• Connection: gpio

UPM module for the A110X (A1101, A1102, A1103, A1104, and A1106) Hall Effect sensors. It outputs a digital signal indicating whether it is detecting a magnetic field with south polarity perpendicular to the sensor element.

An example showing a simple test for the presence of a field

  // Instantiate an A110X sensor on digital pin D2
  upm::A110X* hall = new upm::A110X(2);
  
  // check every second for the presence of a magnetic field (south
  // polarity)
  while (shouldRun)
    {
      bool val = hall->magnetDetected();
      if (val)
        cout << "Magnet (south polarity) detected." << endl;
      else
        cout << "No magnet detected." << endl;

      sleep(1);
    }

An example demonstrating the use of an interrupt handler to count pulses

  // Instantiate an A110X sensor on digital pin D2
  upm::A110X* hall = new upm::A110X(2);
  
  // This example uses a user-supplied interrupt handler to count
  // pulses that occur when a magnetic field of the correct polarity
  // is detected.  This could be used to measure the rotations per
  // minute (RPM) of a rotor for example.

  hall->installISR(hallISR, NULL);

  while (shouldRun)
    {
      cout << "Pulses detected: " << counter << endl;

      sleep(1);
    }

Public Member Functions
	A110X (int pin)
	~A110X ()
bool	magnetDetected ()
void	installISR (void(*isr)(void *), void *arg)
void	uninstallISR ()

Constructor & Destructor Documentation

A110X

(

int

pin

)

A110x digital sensor constructor

Parameters

pin	digital pin to use

~A110X

(

)

A110X Destructor

Member Function Documentation

bool magnetDetected

(

)

Determine whether a magnetic field of south polarity has been detected

Returns

True if magnetic field detected

void installISR	(	void(*)(void *)	isr,
		void *	arg
	)

Install an Interrupt Service Routine (ISR) to be called when the appropriate magnetic field is detected.

Parameters

fptr	function pointer to function to be called on interrupt
arg	pointer to an object that will be supplied as an arguement to the ISR.

void uninstallISR

(

)

Uninstall the previously installed Interrupt Service Routine (ISR)

---

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

• /var/lib/jenkins/workspace/upm-doc-stable/src/a110x/a110x.h
• /var/lib/jenkins/workspace/upm-doc-stable/src/a110x/a110x.cxx