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 17: Line 17:
==Component Source Code==
==Component Source Code==


Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_EBM019v1.fcfx FC_Comp_Source_EBM019v1.fcfx]
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EBM019v1.fcfx FC_Comp_Source_EBM019v1.fcfx]


Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBM019v1.fcfx FC_Comp_Source_EBM019v1.fcfx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBM019v1.fcfx FC_Comp_Source_EBM019v1.fcfx]


==Detailed description==
==Detailed description==




Line 36: Line 38:


==Examples==
==Examples==




Line 57: Line 61:


==Macro reference==
==Macro reference==
{| 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;" | '''GetDistance'''
|-
| colspan="2" | Sends a pulse and processes the echo. Returns a object distance in cm 
|-
|-
| 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''
|}
{| 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 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | delay
|-
| colspan="2" | delay time in microseconds 
|-
| 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''
|}
{| 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 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | value
|-
| colspan="2" | trigger point for echo detection 
|-
| 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''
|}
{| 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) 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | pulse
|-
| colspan="2" | width of pulse in microseconds 
|-
| 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''
|}
{| 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;" | '''Initialise'''
|-
| colspan="2" | Setup the device. This sets the control output to logic 0 
|-
|-
| 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''
|}
==Property reference==
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Output Pulse Pin
|-
| colspan="2" | Pin used for controlling the output pulse 
|-
| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
| width="90%" | Echo ADC channel
|-
| colspan="2" | ADC channel used to monitor the echo 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Pulse Width (uS)
|-
| colspan="2" | Output ultrasonic pulse width in microseconds 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Read Delay (uS)
|-
| colspan="2" | Time delay in microseconds before sampling for echo 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Pulse Detection Value
|-
| colspan="2" | Detection ADC delta trigger value A lower value is more sensitive 
|}==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 09:56, 27 January 2023

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 Source Code

Please click here to download the component source project: FC_Comp_Source_EBM019v1.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_EBM019v1.fcfx

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


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 

==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 

==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 

==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 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Ultrasonic_(EBM019)_(EBM_Modules)&oldid=34137"