Difference between revisions of "Component: Ultrasonic (HCSR04) (Audio)"

From Flowcode Help
Jump to navigationJump to search
 
(18 intermediate revisions by 2 users not shown)
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
 
| Audio
 
| 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==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
  
==[[File:Component Icon c5d9ffa3_5a7d_4fb2_b9ba_ec855ad7b25c.png|Image]] Ultrasonic (HCSR04) component==
+
''No detailed description exists yet for this 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.
 
  
 
==Examples==
 
==Examples==
''<span style="color:red;">No additional examples</span>''
 
  
  
==Downloadable macro reference==
 
  
===<span style="font-weight: normal;"><u><tt>GetDistance</tt></u></span>===
 
Sends a pulse and processes the echo.
 
  
Returns a object distance in cm
 
  
'''Parameters'''
 
  
:''This macro has no parameters''
 
  
  
'''Return value'''
 
  
:[[Variable Types|UINT]]
 
  
  
  
==Simulation macro reference==
 
  
''This component does not contain any simulation macros''
+
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
{{Fcfile|HC-SR04 Distance Sensor Demo.fcfx|HC-SR04 Distance Sensor Demo.fcfx}}
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
==Macro reference==
 +
 
 +
===GetDistance===
 +
{| 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&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''
 +
|}
  
  
 
==Property reference==
 
==Property reference==
<span style="font-weight: normal;"><u>OutputTrig 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'''  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Type
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Use Timer Interrupt
 +
|-
 +
| colspan="2" | For 8bit PICs resuls the timer interrupt  is recomened for increased accuracy&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | OutputTrig Pin
 +
|-
 +
| colspan="2" | Pin used for controlling the output pulse&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Input Echo Pin
 +
|-
 +
| colspan="2" | ADC channel used to monitor the echo&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Rollover Time
 +
|-
 +
| colspan="2" | Maximim rollover time in seconds. Make sure its the lowest value posisble without going below 0.018 0.018 = 18ms which equates to a distance of 310 cm&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Timer Settings
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Timer
 +
|-
 +
| colspan="2" | Timer Peripheral to use to monitor the passage of time.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Bit Depth
 +
|-
 +
| colspan="2" | Number of bits in the timer peripheral. 8-bit timers can count from 0-255 before overflowing. 16-bit timers can count from 0 to 65535 before overflowing.&nbsp;
 +
|}
  
<span style="font-weight: normal;"><u>Input Echo Pin</u></span>
+
==Component Source Code==
  
This property is of type ''Single digital pin'' and can be referenced with the variable name ''ECHO''.
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Ultrasonic_HC_SR04.fcfx FC_Comp_Source_Ultrasonic_HC_SR04.fcfx]
  
ADC channel used to monitor the echo
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Ultrasonic_HC_SR04.fcfx FC_Comp_Source_Ultrasonic_HC_SR04.fcfx]

Latest revision as of 09:14, 16 July 2024

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

FC6 Icon.png HC-SR04 Distance Sensor Demo.fcfx







Macro reference

GetDistance

Fc9-comp-macro.png GetDistance
Sends a pulse and processes the echo. Returns a object distance in cm 
Fc9-u16-icon.png - UINT Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Type
 
Fc9-type-7-icon.png Use Timer Interrupt
For 8bit PICs resuls the timer interrupt is recomened for increased accuracy 
Fc9-type-5-icon.png OutputTrig Pin
Pin used for controlling the output pulse 
Fc9-type-5-icon.png Input Echo Pin
ADC channel used to monitor the echo 
Fc9-type-15-icon.png Rollover Time
Maximim rollover time in seconds. Make sure its the lowest value posisble without going below 0.018 0.018 = 18ms which equates to a distance of 310 cm 
Fc9-conn-icon.png Timer Settings
Fc9-type-16-icon.png Timer
Timer Peripheral to use to monitor the passage of time. 
Fc9-type-21-icon.png Bit Depth
Number of bits in the timer peripheral. 8-bit timers can count from 0-255 before overflowing. 16-bit timers can count from 0 to 65535 before overflowing. 

Component Source Code

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

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