Passer::RoboidControl::UltrasonicSensor Class Reference

An HC-SR04 ultrasonic distance sensor. More...

#include <UltrasonicSensor.h>

Inheritance diagram for Passer::RoboidControl::UltrasonicSensor:

Public Member Functions
	UltrasonicSensor ()
	Setup an ultrasonic sensor.
	UltrasonicSensor (uint8_t pinTrigger, uint8_t pinEcho)
	Setup the ultrasonic sensor.
float	GetDistance ()
	perform an ultrasonic 'ping' to determine the distance to the nearest object
bool	IsOn ()
	Indicate that an object is nearby.
bool	IsMotor ()
	Check if the Thing is a Motor.
bool	IsSensor ()
	Check if the Thing is a Sensor.

Public Attributes
uint8_t	pinTrigger
	The pin number of the trigger signal.
uint8_t	pinEcho
	The pin number of the echo signal.
float	triggerDistance = 1
	The distance at which ObjectNearby triggers.
unsigned int	type
	The type of Thing.

Static Public Attributes
static const unsigned int	SwitchType = SensorType | (unsigned int)Type::Switch
static const unsigned int	DistanceSensorType
static const unsigned int	ControlledMotorType
static const unsigned int	UncontrolledMotorType

Protected Types
enum class	Type {   Undetermined , Switch , DistanceSensor , ControlledMotor ,   UncontrolledMotor }
	Basic Thing types. More...

Protected Attributes
float	distance = 0
	Distance to the closest object.

Static Protected Attributes
static const unsigned int	MotorType = 0x8000
	Bitmask for Motor type.
static const unsigned int	SensorType = 0x4000
	Bitmap for Sensor type.

Detailed Description

An HC-SR04 ultrasonic distance sensor.

Member Enumeration Documentation

Type

enum class Passer::RoboidControl::Thing::Type

strongprotectedinherited

Basic Thing types.

Enumerator
Undetermined
Switch
DistanceSensor
ControlledMotor
UncontrolledMotor

Constructor & Destructor Documentation

UltrasonicSensor() [1/2]

Passer::RoboidControl::UltrasonicSensor::UltrasonicSensor

(

)

Setup an ultrasonic sensor.

UltrasonicSensor() [2/2]

UltrasonicSensor::UltrasonicSensor	(	uint8_t	pinTrigger,
		uint8_t	pinEcho
	)

Setup the ultrasonic sensor.

Parameters

pinTrigger	the pin number of the trigger signal
pinEcho	the pin number of the echo signal

Member Function Documentation

GetDistance()

float UltrasonicSensor::GetDistance ( )

virtual

perform an ultrasonic 'ping' to determine the distance to the nearest object

Returns

the measured distance in meters to the nearest object

Reimplemented from Passer::RoboidControl::DistanceSensor.

IsOn()

bool DistanceSensor::IsOn ( )

inherited

Indicate that an object is nearby.

Returns

True when an object is nearby

IsMotor()

bool Thing::IsMotor ( )

inherited

Check if the Thing is a Motor.

Returns

True when the Thing is a Motor and False otherwise

IsSensor()

bool Thing::IsSensor ( )

inherited

Check if the Thing is a Sensor.

Returns

True when the Thing is a Sensor and False otherwise

Member Data Documentation

pinTrigger

uint8_t Passer::RoboidControl::UltrasonicSensor::pinTrigger

The pin number of the trigger signal.

pinEcho

uint8_t Passer::RoboidControl::UltrasonicSensor::pinEcho

The pin number of the echo signal.

triggerDistance

float Passer::RoboidControl::DistanceSensor::triggerDistance = 1

inherited

The distance at which ObjectNearby triggers.

distance

float Passer::RoboidControl::DistanceSensor::distance = 0

protectedinherited

Distance to the closest object.

type

unsigned int Passer::RoboidControl::Thing::type

inherited

The type of Thing.

SwitchType

const unsigned int Thing::SwitchType = SensorType | (unsigned int)Type::Switch

staticinherited

DistanceSensorType

const unsigned int Thing::DistanceSensorType

staticinherited

Initial value:

=
    SensorType | (unsigned int)Type::DistanceSensor

ControlledMotorType

const unsigned int Thing::ControlledMotorType

staticinherited

Initial value:

=
    MotorType | (unsigned int)Type::ControlledMotor

UncontrolledMotorType

const unsigned int Thing::UncontrolledMotorType

staticinherited

Initial value:

=
    MotorType | (unsigned int)Type::UncontrolledMotor

MotorType

const unsigned int Passer::RoboidControl::Thing::MotorType = 0x8000

staticprotectedinherited

Bitmask for Motor type.

SensorType

const unsigned int Passer::RoboidControl::Thing::SensorType = 0x4000

staticprotectedinherited

Bitmap for Sensor type.

---

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

• d:/PlatformIO/RoboidControlArduino/src/UltrasonicSensor.h
• d:/PlatformIO/RoboidControlArduino/src/UltrasonicSensor.cpp