Jump to content

Component: Ultrasonic (EBM019) (EBM Modules): Difference between revisions

From Flowcode Help
← Older editNewer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
No edit summary
No edit summary
Line 1: Line 1:
 
{| style="width:50%"
 
{| width="50%"
|-
|-
| width="20%" style="color: gray;" | Author
| width="20%" style="color:gray;" | Author
| Matrix TSL
| Matrix TSL
|-
|-
| width="20%" style="color: gray;" | Version
| width="20%" style="color:gray;" | Version
| 1.0 (Release)
| 1.0
|-
|-
| width="20%" style="color: gray;" | Category
| width="20%" style="color:gray;" | Category
| EBM Modules
| EBM Modules
|}
|}




==Ultrasonic component==
This  board  has  both  an  ultrasonic  transmitter  and receiver. The transmitter is driven by an on-board 40KHz  oscillator which is enabled by the host microprocessor.  The receiving sensor signal is amplified and provided as an analogue signal to be processed by a single channel  ADC of the microprocessor. By measuring the time delay between  enabling  a  transmit  pulse  and  receiving  an  echo the distance of objects in a range of around 3cm to 3m can be determined.
==Component Pack==


==[[File:Component Icon feb064a2_e087_45e1_a7f9_c9fa0edfdace.png|Image]] Ultrasonic (EBM019) component==
SENSORS
This  board  has  both  an  ultrasonic  transmitter  and receiver. The transmitter is driven by an on-board 40KHz
 
oscillator which is enabled by the host microprocessor.
==Detailed description==
The receiving sensor signal is amplified and provided as an analogue signal to be processed by a single channel
 
ADC of the microprocessor. By measuring the time delay between  enabling  a  transmit  pulse  and  receiving  an
''No detailed description exists yet for this component''
echo the distance of objects in a range of around 3cm to 3m can be determined.


==Examples==
==Examples==


Sample program using the EBM019 - Ultrasonic sensor.
Sample program using the EBM019 - Ultrasonic sensor.
Line 33: Line 36:
==Downloadable macro reference==
==Downloadable macro reference==


===<span style="font-weight: normal;"><u><tt>GetDistance</tt></u></span>===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Sends a pulse and processes the echo.
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDistance'''
|-
| colspan="2" | Sends a pulse and processes the echo. Returns a object distance in cm&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


Returns a object distance in cm


'''Parameters'''
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDelayTime'''
|-
| colspan="2" | Set the delay time before sampling for the echo, in microseconds&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | delay
|-
| colspan="2" | delay time in microseconds&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:''This macro has no parameters''


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDetectionValue'''
|-
| colspan="2" | Set the delta value for echo detection&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | value
|-
| colspan="2" | trigger point for echo detection&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Return value'''


:[[Variable Types|UINT]]
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPulseWidth'''
|-
| colspan="2" | Set the output pulse width, in microsecond (0-255uS)&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | pulse
|-
| colspan="2" | width of pulse in microseconds&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




===<span style="font-weight: normal;"><u><tt>SetDelayTime</tt></u></span>===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Set the delay time before sampling for the echo, in microseconds
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
'''Parameters'''
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 
|-
:[[Variable Types|UINT]] ''delay''
| colspan="2" | Setup the device. This sets the control output to logic 0&nbsp;
::delay time in microseconds
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
'''Return value'''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
:''This call does not return a value''
 
 
===<span style="font-weight: normal;"><u><tt>SetDetectionValue</tt></u></span>===
Set the delta value for echo detection
 
'''Parameters'''
 
:[[Variable Types|BYTE]] ''value''
::trigger point for echo detection
 
 
'''Return value'''
 
:''This call does not return a value''
 
 
===<span style="font-weight: normal;"><u><tt>SetPulseWidth</tt></u></span>===
Set the output pulse width, in microsecond (0-255uS)


'''Parameters'''


:[[Variable Types|BYTE]] ''pulse''
::width of pulse in microseconds
'''Return value'''
:''This call does not return a value''
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
Setup the device.
This sets the control output to logic 0
'''Parameters'''
:''This macro has no parameters''
'''Return value'''
:''This call does not return a value''
==Simulation macro reference==
''This component does not contain any simulation macros''




==Property reference==
==Property reference==
<span style="font-weight: normal;"><u>Output Pulse Pin</u></span>


This property is of type ''Single digital pin'' and can be referenced with the variable name ''OPP''.
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
Pin used for controlling the output pulse
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
<span style="font-weight: normal;"><u>Echo ADC channel</u></span>
|-
 
|-
This property is of type ''Single analog pin'' and can be referenced with the variable name ''ECHO''.
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
| width="90%" | Output Pulse Pin
ADC channel used to monitor the echo
|-
 
| colspan="2" | Pin used for controlling the output pulse&nbsp;
<span style="font-weight: normal;"><u>Pulse Width (uS)</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''PULSE''.
| width="90%" | Echo ADC channel
 
|-
Output ultrasonic pulse width in microseconds
| colspan="2" | ADC channel used to monitor the echo&nbsp;
 
|-
<span style="font-weight: normal;"><u>Read Delay (uS)</u></span>
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
| width="90%" | Pulse Width (uS)
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''DELAY''.
|-
 
| colspan="2" | Output ultrasonic pulse width in microseconds&nbsp;
Time delay in microseconds before sampling for echo
|-
 
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
<span style="font-weight: normal;"><u>Pulse Detection Value</u></span>
| width="90%" | Read Delay (uS)
 
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''THRESHOLD''.
| colspan="2" | Time delay in microseconds before sampling for echo&nbsp;
 
|-
Detection ADC delta trigger value
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
| width="90%" | Pulse Detection Value
A lower value is more sensitive
|-
| colspan="2" | Detection ADC delta trigger value A lower value is more sensitive&nbsp;
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''  
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''  
|-
|}

Revision as of 16:23, 7 January 2022

Author Matrix TSL
Version 1.0
Category EBM Modules


Ultrasonic component

This board has both an ultrasonic transmitter and receiver. The transmitter is driven by an on-board 40KHz oscillator which is enabled by the host microprocessor. The receiving sensor signal is amplified and provided as an analogue signal to be processed by a single channel ADC of the microprocessor. By measuring the time delay between enabling a transmit pulse and receiving an echo the distance of objects in a range of around 3cm to 3m can be determined.

Component Pack

SENSORS

Detailed description

No detailed description exists yet for this component

Examples

Sample program using the EBM019 - Ultrasonic sensor.

Sends out a pulse and determines distance from time taken to receive reflection.

EBM019 Example


Downloadable macro reference

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


SetDelayTime
Set the delay time before sampling for the echo, in microseconds 
- UINT delay
delay time in microseconds 
- VOID Return


SetDetectionValue
Set the delta value for echo detection 
- BYTE value
trigger point for echo detection 
- VOID Return


SetPulseWidth
Set the output pulse width, in microsecond (0-255uS) 
- BYTE pulse
width of pulse in microseconds 
- VOID Return


Initialise
Setup the device. This sets the control output to logic 0 
- VOID Return



Property reference

Properties
Output Pulse Pin
Pin used for controlling the output pulse 
Echo ADC channel
ADC channel used to monitor the echo 
Pulse Width (uS)
Output ultrasonic pulse width in microseconds 
Read Delay (uS)
Time delay in microseconds before sampling for echo 
Pulse Detection Value
Detection ADC delta trigger value A lower value is more sensitive 
Connections
Simulations
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Ultrasonic_(EBM019)_(EBM_Modules)&oldid=27812"