MaxBotix_HRXL_MaxSonar_WR Class Reference

UART ultrasonic range reader. Call begin() then turnOn(). The driver and serial port must remain alive while receiving or awaiting timeout. More...

#include <MaxBotix_HRXL_MaxSonar_WR.hpp>

Public Member Functions
	MaxBotix_HRXL_MaxSonar_WR (SerialPort &)
	Bind the sensor serial port without starting it.
void	begin (void(*func)(MaxBotix_HRXL_MaxSonar_WR &, int16_t mm), uint16_t timeoutMsec)
	Configure the receive callback and one-shot timeout.
virtual void	turnOn ()
	Start 9600-baud listening and arm the one-shot timeout.
virtual void	turnOff ()
	Stop the timer and UART listening.

Protected Attributes
SerialPort &	s

Detailed Description

UART ultrasonic range reader. Call begin() then turnOn(). The driver and serial port must remain alive while receiving or awaiting timeout.

Member Function Documentation

begin()

void MaxBotix_HRXL_MaxSonar_WR::begin	(	void(*	func )(MaxBotix_HRXL_MaxSonar_WR &, int16_t mm),
		uint16_t	timeoutMsec )

Configure the receive callback and one-shot timeout.

Parameters

func	Receives this driver and distance in millimeters, or -1 on timeout; nullptr disables notification. Successful reads do not cancel or restart the timer.
timeoutMsec	Timeout in milliseconds, measured from turnOn().

turnOff()

virtual void MaxBotix_HRXL_MaxSonar_WR::turnOff ( )

inlinevirtual

Stop the timer and UART listening.

                         {
    this->timeout.stop();
    this->s.stopListening();
  };

turnOn()

virtual void MaxBotix_HRXL_MaxSonar_WR::turnOn ( )

inlinevirtual

Start 9600-baud listening and arm the one-shot timeout.

                        {
    this->s.begin(9600);
    this->s.listen();
    this->timeout.startOneShot(this->timeoutMsec);
  };

---

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

• include/dev/MaxBotix_HRXL_MaxSonar_WR.hpp