Component: Ultrasonic Ranger (Grove 101020010) (101020010) (Audio)
| Author | Matrix Ltd |
| Version | 1.0 |
| Category | Audio |
Ultrasonic Ranger (Grove 101020010) component
The ultrasonic sensor is a non-contact distance measurement module. It's designed for easy modular project usage with industrial performance. Detecting range: 3cm to 4m, best in 30 degree angle.
Detailed description
No detailed description exists yet for this component
Examples
This example performs an ultrasonic range sample and then converts the sample from a timing into a measurement in millimetres.
Downloadable macro reference
|
WaitForEcho |
| Waits until the echo has been received from the Ping macro allowing you to perform your own timing. | |
 - VOID
|
Return |
|
|
MeasureDistance |
| Converts a micro second time from the ultrasonic range sensor and returns the range in mm, cm or inches. | |
 - UINT
|
TimeDelay |
| Microsecond reading from Ultrasound module | |
 - BYTE
|
Scale |
| 0=MM / 1=CM / 2=Inch | |
| - UINT
|
Return |
|
|
Ping |
| Performs a transmit ping allowing you to monitor the incoming signal and perform your own timings maybe using a rising edge interrupt and a timer. | |
| - VOID
|
Return |
|
|
SampleSensor |
| Sends out an ultrasonic ping and times how long it takes to receive the echo. Returns the time in microseconds. Performs the timing using software so depending on the speed of the micro will be an approximation. For better results use the Ping macro. | |
| - UINT
|
Return |
|
|
SetIntBits |
| Sets the size of an int LUT entry | |
| - BYTE
|
Bits |
| - VOID
|
Return |
|
|
GetFloatBits |
| Gets the number of bits-per-float in the LUT | |
| - BYTE
|
Return |
|
|
ClearFloats |
| Clear all float LUT values | |
| - VOID
|
Return |
|
|
GetFloat |
| Gets a float from the LUT | |
 - ULONG
|
Index |
| [[File:]] - | Return |
|
|
GetInts |
| Gets the int LUT | |
| - ULONG
|
Dest |
| - VOID
|
Return |
|
|
GetLUTCount |
| Gets the number of individual data entries stored in the LUT. | |
| - UINT
|
Return |
|
|
GetInt |
| Gets an integer from the LUT | |
| - ULONG
|
Index |
| - ULONG
|
Return |
|
|
SetFloatBits |
| Sets the size of a float LUT entry | |
| - BYTE
|
Bits |
| - VOID
|
Return |
|
|
AddInt |
| Int to add to the int array | |
| - ULONG
|
Value |
| Int to add to the int array | |
| - VOID
|
Return |
|
|
AddFloat |
| Add a float to the floating point LUT | |
| [[File:]] - | Value |
| Floating point values | |
| - VOID
|
Return |
|
|
Initialise |
| Sets up the GSM module. Returns 0 for OK, 255 for no reply and 254 for command fail. | |
| - BYTE
|
Return |
|
|
SampleAccel |
| Samples the accelerometer 0 = no new data, 1 = new data available | |
| - BYTE
|
Return |
|
|
Left |
| Rotates the robot left - waits for the angle to be traversed before returning | |
| - UINT
|
Angle |
| Angle to turn in degrees | |
| - VOID
|
Return |
|
|
ReadIR |
| Reads an IR sensor 0=Left, 1=FrontLeft, 2=Front, 3=FrontRight, 4=Right, 5=RearRight, 6=Rear, 7=RearLeft | |
| - BYTE
|
index |
| 0=Left, 1=FrontLeft, 2=Front, 3=FrontRight, 4=Right, 5=RearRight, 6=Rear, 7=RearLeft | |
| - UINT
|
Return |
|
|
LCDDrawPixel |
| Allows a single pixel on the LCD to be set or cleared | |
| - BYTE
|
X |
| X Pixel 0-127 | |
| - BYTE
|
Y |
| Y Pixel 0-31 | |
| - BYTE
|
State |
| 0=White (Off), 1=Black (On) | |
| - VOID
|
Return |
|
|
ServoSetPosition |
| Allows one of the servo positions to be assigned | |
| - BYTE
|
Channel |
| Range 0-3 | |
| - BYTE
|
Position |
| Range 0-255 | |
| - VOID
|
Return |
|
|
CardBitmap |
| Displays a monochrome bitmap read from the card on the LCD | |
| - BYTE
|
X |
| Range 0-127 | |
| - BYTE
|
Y |
| Range 0-31 | |
 - STRING
|
Filename |
| - BYTE
|
Return |
|
|
CardRecordMic |
| Records an audio stream on the card from the microphone | |
| - BYTE
|
BitDepth |
| 0=8-bit, 1=16-bit | |
| - BYTE
|
SampleRate |
| Sample Rate 0=8KHz, 1=16KHz | |
| - UINT
|
RecordTime |
| Time to record for in seconds, Range 0-65535 | |
| - STRING
|
Filename |
| - BYTE
|
Return |
|
|
CardOpen |
| Attempts to open an existing file on the SD card 255=Error, 1=File not found, 0=Open OK | |
| - STRING
|
Filename |
| - BYTE
|
Return |
|
|
Forwards |
| Drives the robot forwards - waits for the distance to be traversed before returning | |
| - UINT
|
Distance |
| Distance in mm | |
| - VOID
|
Return |
|
|
ReadBearing |
| Reads the compass bearing based on the degrees clockwise from magnetic north. | |
| [[File:]] - | Return |
|
|
GetConsoleHandle |
| Gets the handle to the console allowing data displaying on the panel etc. | |
| [[File:]] - | Return |
|
|
LCDDrawLine |
| Allows a single pixel width line to be drawn on the LCD | |
| - BYTE
|
X1 |
| X Pixel 0-127 | |
| - BYTE
|
Y1 |
| Y Pixel 0-31 | |
| - BYTE
|
X2 |
| X Pixel 0-127 | |
| - BYTE
|
Y2 |
| Y Pixel 0-31 | |
| - VOID
|
Return |
|
|
ServoAutoMoveToPosition |
| Allows one of the servo positions to move gradually to a new position | |
| - BYTE
|
Channel |
| Range 0-3 | |
| - BYTE
|
Position |
| Range 0-255 | |
| - VOID
|
Return |
|
|
ReadAllValue |
| Reads a single value stored from the read all command Index dictates which sensor value to read | |
| - BYTE
|
Index |
| 0=SW, 1-8=IR, 9-10=Line, 11=Light, 12=Mic, 13-15=Accel | |
| - UINT
|
Return |
|
|
LCDBacklight |
| Allows the LCD backlight brighntess to be adjusted | |
| - BYTE
|
Intensity |
| Range 0-100, 0=Off, 1=Min Brightness, 100=Max Brightness | |
| - VOID
|
Return |
|
|
LCDDrawRect |
| Allows a rectangle to be drawn on the LCD | |
| - BYTE
|
X1 |
| X Pixel 0-127 | |
| - BYTE
|
Y1 |
| Y Pixel 0-31 | |
| - BYTE
|
X2 |
| X Pixel 0-127 | |
| - BYTE
|
Y2 |
| Y Pixel 0-31 | |
| - VOID
|
Return |
|
|
ReadLine |
| Reads one of the IR line sensors 0-1 0=Left, 1=Right | |
| - BYTE
|
index |
| 0=Left, 1=Right | |
| - UINT
|
Return |
|
|
ServoDisable |
| Allows one of the servo outputs 0-3 to be disabled | |
| - BYTE
|
Channel |
| Range 0-3 | |
| - VOID
|
Return |
|
|
ServoEnable |
| Allows one of the servo outputs 0-3 to be enabled | |
| - BYTE
|
Channel |
| Range 0-3 | |
| - VOID
|
Return |
|
|
CardReadByte |
| Reads a byte from the currently open file. Starts at the beginning of the file and auto increments to the end | |
| - BYTE
|
Return |
|
|
CardErase |
| Attempts to delete an existing file on the SD card 255=Error, 1=File not found, 0=Delete OK | |
| - STRING
|
Filename |
| - BYTE
|
Return |
|
|
CardWriteByte |
| Appends a byte to the end of the currently open file | |
| - BYTE
|
Data |
| - VOID
|
Return |
|
|
EncoderRead |
| Reads one of the motor encoder counters. Approx 0.328296mm of travel per encoder unit. | |
| - BYTE
|
index |
| 0=Left, 1=Right | |
| - UINT
|
Return |
|
|
SetMotors |
| Sets the motor speeds without feedback Range -100 to 100 | |
| [[File:]] - | Left |
| Range -100 to 100 | |
| [[File:]] - | Right |
| Range -100 to 100 | |
| - VOID
|
Return |
|
|
Backwards |
| Drives the robot backwards - waits for the distance to be traversed before returning | |
| - UINT
|
Distance |
| Distance in mm | |
| - VOID
|
Return |
|
|
EncoderReset |
| Resets the motor encoder counters | |
| - VOID
|
Return |
|
|
LCDVerbose |
| Allows the LCD to automatically report the API commands as they get processed. Default - verbose on | |
| - BYTE
|
State |
| 0=Off 1=On | |
| - VOID
|
Return |
|
|
SetProp |
| Allows the COM port property to be set from a parent component. | |
| - STRING
|
PropName |
| - ULONG
|
PropVal |
| - VOID
|
Return |
|
|
CardInit |
| Attempts to startup the SD card 255=No Card, 254=Init Fail, 0=Init OK | |
| - BYTE
|
Return |
|
|
GetProp |
| Allows the property filter for the COM port list to be copied to a parent component. | |
| - STRING
|
PropName |
| - STRING
|
Return |
|
|
LCDClear |
| Clears the LCD | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Time Measurement |
| Controls how the sensors ultrasonic ping is timed, Either using single microsecond delays or using timer hardware. On slower devices e.g. PIC it is advisable to use the Timer method. | |
|
|
Timer |
| Timer Peripheral to use to monitor the passage of time. | |
|
Connections |
|
Control Pin |
| Pin connected to the emitter of the sensor. | |
|
|
Simulations |
|
Discrete Distance |
| Simulation range used to determine if the sense pin is active or not. | |