Serial Wombat Arduino Library
Public Types | Public Member Functions | List of all members
SerialWombatUltrasonicDistanceSensor Class Reference

A Class which uses one or two Serial Wombat 18AB pins to measure distance using an Ultrasonic distance sensor.
More...

#include <SerialWombatUltrasonicDistanceSensor.h>

Inheritance diagram for SerialWombatUltrasonicDistanceSensor:
SerialWombatPin SerialWombatAbstractProcessedInput

Public Types

enum  driver { HC_SR04 = 0 }
 
- Public Types inherited from SerialWombatAbstractProcessedInput
enum  Period {
  PERIOD_1mS = 0, PERIOD_2mS = 1, PERIOD_4mS = 2, PERIOD_8mS = 3,
  PERIOD_16mS = 4, PERIOD_32mS = 5, PERIOD_64mS = 6, PERIOD_128mS = 7,
  PERIOD_256mS = 8, PERIOD_512mS = 9, PERIOD_1024mS = 10
}
 
enum  OutputValue { RAW = 0, FIRST_ORDER_FILTERED = 1, AVERAGE = 2 }
 
enum  Transform { NONE = 0, SCALE_RANGE = 1, LINEAR_MXB = 2 }
 

Public Member Functions

 SerialWombatUltrasonicDistanceSensor (SerialWombatChip &serialWombat)
 Class constructor for SerialWombatPulseTimer. More...
 
int16_t begin (uint8_t echoPin, driver driver, uint8_t triggerPin, bool autoTrigger=true, bool pullUp=false)
 Initialization routine for SerialWombatUltrasonicDistanceSensor. More...
 
uint16_t readPulseCount ()
 get the number of pulses that have been sent.
More...
 
int16_t manualTrigger ()
 Manually trigger a distance reading. More...
 
uint8_t pin ()
 Facilitates Inheritance. More...
 
uint8_t swPinModeNumber ()
 Facilitates Inheritance. More...
 
- Public Member Functions inherited from SerialWombatPin
 SerialWombatPin (SerialWombatChip &serialWombatChip)
 Instantiates a Serial Wombat Pin. More...
 
 SerialWombatPin (SerialWombatChip &serialWombatChip, uint8_t pin)
 Instantiates a Serial Wombat Pin. More...
 
uint16_t readPublicData ()
 Read the 16 Bit public data associated with this pin. More...
 
void pinMode (uint8_t mode)
 Set pin to INPUT or OUTPUT. More...
 
void pinMode (uint8_t mode, bool pullDown, bool openDrain)
 Set pin to INPUT or OUTPUT, with options for pull Ups and open Drain settings. More...
 
void digitalWrite (uint8_t val)
 Set output pin High or Low. More...
 
int digitalRead ()
 Reads the state of the Pin. More...
 
uint16_t writePublicData (uint16_t value)
 Write a 16 bit value to this pin. More...
 
uint8_t pin ()
 Returns the current SW pin number. Used primarily for virtual calls by derived classes. More...
 
uint8_t swPinModeNumber ()
 Returns the Mode number. Used primarily by derived classes to populate packet data. More...
 
- Public Member Functions inherited from SerialWombatAbstractProcessedInput
 SerialWombatAbstractProcessedInput (SerialWombatChip &sw)
 Constructor for the SerialWombatAbstractScaledOutput Class. More...
 
int16_t writeInverted (bool inverted)
 if enabled subtract the input value from 65535 before doing any other processing. More...
 
int16_t writeFirstOrderFilteringConstant (uint16_t constant)
 Set a first order filtering constant to be applied to the signal Higher is heavier filtering. More...
 
int16_t writeAveragingNumberOfSamples (uint16_t numberOfSamples)
 Set a number of samples to average for each update of the downstream signal. More...
 
int16_t writeExcludeBelowAbove (uint16_t low, uint16_t high)
 Sets input value ranges which are discarded rather than processed. More...
 
int16_t configureQueue (SerialWombatQueue *queue, Period period, bool queueHighByte=true, bool queueLowByte=true)
 Sets up the queueing feature for this pin mode. Queue must have been initialized prior to this queue. More...
 
int16_t configureOutputValue (OutputValue outputValue)
 Configures whether the pin's public data value is averaged, filtered, or neither. More...
 
int16_t writeTransformScaleRange (uint16_t min, uint16_t max)
 Scale incoming values to a range of 0 to 65535. More...
 
int16_t writeTransformLinearMXB (int32_t m, int32_t b)
 Scale incoming values based on an mx+b linear equation. More...
 
int16_t writeProcessedInputEnable (bool enabled)
 Enables or disables all input processing functions If disabled, the raw input value is placed directly in the pin's 16 bit public data buffer. More...
 
uint16_t readMinimum (bool resetAfterRead=false)
 Retreive the maximum public data output value since the last call with reset= true. More...
 
uint16_t readMaximum (bool resetAfterRead=false)
 Retreive the minimum public data output value since the last call with reset= true. More...
 
uint16_t readAverage ()
 Retreive the last completed averaged value. More...
 
uint16_t readFiltered ()
 Retreive the filtered value. More...
 

Additional Inherited Members

- Protected Attributes inherited from SerialWombatPin
uint8_t _pin = 255
 
SerialWombatChip_sw
 
uint8_t _pinMode = 0
 

Detailed Description

A Class which uses one or two Serial Wombat 18AB pins to measure distance using an Ultrasonic distance sensor.

A video Tutorial on this pin mode is available:

//TODO

TODO https://youtu.be/

Member Enumeration Documentation

◆ driver

Enumerator
HC_SR04 

Standard buffered mode. Colors are uploaded by the host.

Constructor & Destructor Documentation

◆ SerialWombatUltrasonicDistanceSensor()

SerialWombatUltrasonicDistanceSensor::SerialWombatUltrasonicDistanceSensor ( SerialWombatChip serialWombat)

Class constructor for SerialWombatPulseTimer.

Parameters
serialWombatThe Serial Wombat chip on which the SerialWombatPulseTimer pinmode will be run

Member Function Documentation

◆ begin()

int16_t SerialWombatUltrasonicDistanceSensor::begin ( uint8_t  echoPin,
driver  driver,
uint8_t  triggerPin,
bool  autoTrigger = true,
bool  pullUp = false 
)

Initialization routine for SerialWombatUltrasonicDistanceSensor.

Parameters
echoPinPin used to time input pulses. For 5V sensors, 5V tolerant pins 9,10,11,12, 14 and 15 are good choices
driverChip used for distance measurement. Currently only HC_SR04 is supported.
triggerPinPin used for triggering the sensor. If same as echo pin (e.g. 3 pin sensors) set equal to echoPin
Returns
0 or higher if successful, negative error code if not successful.

◆ manualTrigger()

int16_t SerialWombatUltrasonicDistanceSensor::manualTrigger ( )

Manually trigger a distance reading.

Use this interface to trigger a reading if begin was called with autoTrigger = false

Returns
0 or higher if successful, negative error code if not successful.

◆ pin()

uint8_t SerialWombatUltrasonicDistanceSensor::pin ( )
inlinevirtual

Facilitates Inheritance.

Implements SerialWombatAbstractProcessedInput.

◆ readPulseCount()

uint16_t SerialWombatUltrasonicDistanceSensor::readPulseCount ( )

get the number of pulses that have been sent.

Returns
The number of pulses that have been sent. Rolls over at 65536

◆ swPinModeNumber()

uint8_t SerialWombatUltrasonicDistanceSensor::swPinModeNumber ( )
inlinevirtual

Facilitates Inheritance.

Implements SerialWombatAbstractProcessedInput.