Component: Ultrasonic (HCSR04) (Audio)

Author	Matrix TSL
Version	1.0
Category	Audio

Ultrasonic component

This board has both an ultrasonic transmitter and receiver. When the Trig pin is set high for 10uS, the transmitter sends eight 40KHz pulses. The Echo pin goes high about 2ms later. The duration of the Echo pin is measure when it goes high, and a distance is then calculated based on the high duration. The distance of objects in a range of around 3cm to 2.75m can be determined.

Detailed description

No detailed description exists yet for this component

Examples

HC-SR04 Distance Sensor Demo.fcfx

Downloadable macro reference

	GetDistance
Sends a pulse and processes the echo. Returns a object distance in cm
- UINT	Return

	ReadRegister
Reads a single register from the gyroscope and returns the value as a byte.
- BYTE	Address
- BYTE	Return

	WriteRegister
Writes a single register on the gyroscope.
- BYTE	Address
- BYTE	Data
- VOID	Return

	Initialise
Initialises the SPI bus ready to communicate with the sensor.
- VOID	Return

	Initialise
Initialise the component.
- BYTE	Return

	Initialise
Initialise the component by loading the default calibration table
- VOID	Return

	Initialise
Initialise the sensor configuration as set by the component properties
- VOID	Return

	Initialise
Initialises the component ready for I2C communications
- VOID	Return

	Initialise
Sets up up the communication bus and initialises the accelerometer module. Returns 0 for success and > 0 for fail.
- BYTE	Return

	SimSetGyro
Allows the XYZ slider values to be set via the simulation
[[File:]] -	X
[[File:]] -	Y
[[File:]] -	Z
- VOID	Return

	UpdateAccelerometerData
Reads from the accelerometer and updates the local XYZ variables. Returns 1 for new data and 0 for no new data
- BYTE	Return

	SimSetCompass
Allows the XYZ slider values to be set via the simulation
[[File:]] -	X
[[File:]] -	Y
[[File:]] -	Z
- VOID	Return

	Read_Bearing
Reads the current sensor compass bearing based on degrees CW from magnetic north. Returns 0-359 where 0 = North, 90 = East, 180 = South, 270 = West Requires the ArcTan floating point function to be available to work correctly. Supported on AVR, 16-bit
- BYTE	NumSamples
The number of readings to base the bearing on
- UINT	Return

	Initialise
Sets up up the communication bus and initialises the accelerometer module. Returns 0 for success and > 0 for fail.
- BYTE	Return

	IOSetOutputPin
Sets the selected digital pin to an output and assigns the output state.
- BYTE	Pin
Range: 0-29
[[File:]] -	State
Range: 0-1
- VOID	Return

	UARTReceive
Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available.
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

	ADCSampleAverage10
Reads the voltage present on an Analog pin as an 10-bit value range 0-1023. Performs the selected number of samples with the selected time in microseconds in between samples
- BYTE	ADCChannel
Range: 0, 3-7
- BYTE	SampleCount
Range: 1- 100
- BYTE	SampleDelay
Delay in us between each sample
- UINT	Return

	OneWireScanBus
Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Return

	SPIInitialise
Initialsie the SPI module ready for communications
- BYTE	Channel
Channel Index: Range 0 - SPI Bus Count - 1
- VOID	Return

	OneWireReceiveByte
Receives a byte from the one wire bus a bit at a time
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Return

	I2CSend
Transmit a byte using the I2C bus
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	DataOut
[[File:]] -	Return

	UARTSend
Send a byte via the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Data
Data Byte to send. Range: 0-255
- VOID	Return

	OneWireGetDeviceCount
Returns the number of devices found by the last ScanBus operation.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Return

	PWMSetPrescaler
Sets the prescaler for the PWM output
- BYTE	Channel
Range: 0 - 11
- BYTE	Prescaler
- BYTE	Period
- VOID	Return

	PWMEnable
Enable a PWM output
- BYTE	Channel
Range: 0-11
- VOID	Return

	ADCSampleArray10
Reads the voltage present on an Analog pin as an 10-bit value range 0-1023 Performs the selected number of samples with the selected time in microseconds in between samples and returns each sample in a single packet
- BYTE	ADCChannel
Range: 0, 3-7
- BYTE	SampleCount
Range: 1- 32
- UINT	SampleDelay
Delay in us between each sample
- UINT	Samples
10-bit samples returned from the function
- VOID	Return

	ADCSampleAverage8
Reads the voltage present on an Analog pin as an 8-bit value range 0-255 Performs the selected number of samples with the selected time in microseconds in between samples
- BYTE	ADCChannel
Range: 0, 3-7
- BYTE	SampleCount
Range: 1- 100
- BYTE	SampleDelay
Delay in us between each sample
- BYTE	Return

	Initialise
Initialise the comms to the Arduino board ready for commands to be sent.
- VOID	Return

Property reference

	Properties
	OutputTrig Pin
Pin used for controlling the output pulse
	Input Echo Pin
ADC channel used to monitor the echo
	Connections
	Simulations