Difference between revisions of "Component: Infrared (EBM020) (EBM Modules)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EBM020v1.fcfx FC_Comp_Source_EBM020v1.fcfx] |
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBM020v1.fcfx FC_Comp_Source_EBM020v1.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBM020v1.fcfx FC_Comp_Source_EBM020v1.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 32: | Line 34: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 42: | Line 46: | ||
==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;" | '''SetTxOff''' | ||
| + | |- | ||
| + | | colspan="2" | Turns off the IR Transmitter | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''SetTxOn''' | ||
| + | |- | ||
| + | | colspan="2" | Turns on the IR Transmitter | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''GetDistanceValue''' | ||
| + | |- | ||
| + | | colspan="2" | Returns the calculated distance for the given ADC reading | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | adc | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''GetADCValue''' | ||
| + | |- | ||
| + | | colspan="2" | Gets the raw ADC input value for the IR receiver | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | 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" | Initialise the component by loading the default calibration table | ||
| + | |- | ||
| + | |- | ||
| + | | 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-6-icon.png]] | ||
| + | | width="90%" | Input ADC Channel | ||
| + | |- | ||
| + | | colspan="2" | Analog input channel for the IR receiver | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | ||
| + | | width="90%" | Output Enable Pin | ||
| + | |- | ||
| + | | colspan="2" | Pin used to control the IR Transmitter | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Initial/ Hardware Calibration Table | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Point 1 ADC Value | ||
| + | |- | ||
| + | | colspan="2" | The ADC value that would give the Point 1 Distance. If the ADC value is 0 the point is ignored. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Point 1 Distance (mm) | ||
| + | |- | ||
| + | | colspan="2" | The distance returned for an ADC reading given by Point 1 ADC value | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Point 2 ADC Value | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Point 2 Distance (mm) | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Point 3 ADC Value | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Point 3 Distance (mm) | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Point 4 ADC Value | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Point 4 Distance (mm) | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |}==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 |
Contents
Infrared component
The Infrared sensor board contains both an IR transmitter and receiver. The transmitter is enabled via a digital control signal and the receiver provides an analogue output. By enabling the transmitter and reading the variable voltage output of the receiver it is possible to measure the distance of a reflecting object in the region of 1cm to 10cm.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_EBM020v1.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_EBM020v1.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
SetTxOff |
| Turns off the IR Transmitter | |
 - VOID
|
Return |
|
|
SetTxOn |
| Turns on the IR Transmitter | |
| - VOID
|
Return |
|
|
GetDistanceValue |
| Returns the calculated distance for the given ADC reading | |
 - BYTE
|
adc |
 - UINT
|
Return |
|
|
GetADCValue |
| Gets the raw ADC input value for the IR receiver | |
| - BYTE
|
Return |
|
|
Initialise |
| Initialise the component by loading the default calibration table | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Input ADC Channel |
| Analog input channel for the IR receiver | |
|
Output Enable Pin |
| Pin used to control the IR Transmitter | |
|
Initial/ Hardware Calibration Table |
|
Point 1 ADC Value |
| The ADC value that would give the Point 1 Distance. If the ADC value is 0 the point is ignored. | |
|
|
Point 1 Distance (mm) |
| The distance returned for an ADC reading given by Point 1 ADC value | |
|
|
Point 2 ADC Value |
|
|
Point 2 Distance (mm) |
|
|
Point 3 ADC Value |
|
|
Point 3 Distance (mm) |
|
|
Point 4 ADC Value |
|
|
Point 4 Distance (mm) |
==Macro reference==
|
|
SetTxOff |
| Turns off the IR Transmitter | |
| - VOID
|
Return |
|
|
SetTxOn |
| Turns on the IR Transmitter | |
| - VOID
|
Return |
|
|
GetDistanceValue |
| Returns the calculated distance for the given ADC reading | |
| - BYTE
|
adc |
| - UINT
|
Return |
|
|
GetADCValue |
| Gets the raw ADC input value for the IR receiver | |
| - BYTE
|
Return |
|
|
Initialise |
| Initialise the component by loading the default calibration table | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Input ADC Channel |
| Analog input channel for the IR receiver | |
|
|
Output Enable Pin |
| Pin used to control the IR Transmitter | |
|
|
Initial/ Hardware Calibration Table |
|
|
Point 1 ADC Value |
| The ADC value that would give the Point 1 Distance. If the ADC value is 0 the point is ignored. | |
|
|
Point 1 Distance (mm) |
| The distance returned for an ADC reading given by Point 1 ADC value | |
|
|
Point 2 ADC Value |
|
|
Point 2 Distance (mm) |
|
|
Point 3 ADC Value |
|
|
Point 3 Distance (mm) |
|
|
Point 4 ADC Value |
|
|
Point 4 Distance (mm) |
==Macro reference==
|
|
SetTxOff |
| Turns off the IR Transmitter | |
| - VOID
|
Return |
|
|
SetTxOn |
| Turns on the IR Transmitter | |
| - VOID
|
Return |
|
|
GetDistanceValue |
| Returns the calculated distance for the given ADC reading | |
| - BYTE
|
adc |
| - UINT
|
Return |
|
|
GetADCValue |
| Gets the raw ADC input value for the IR receiver | |
| - BYTE
|
Return |
|
|
Initialise |
| Initialise the component by loading the default calibration table | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Input ADC Channel |
| Analog input channel for the IR receiver | |
|
|
Output Enable Pin |
| Pin used to control the IR Transmitter | |
|
|
Initial/ Hardware Calibration Table |
|
|
Point 1 ADC Value |
| The ADC value that would give the Point 1 Distance. If the ADC value is 0 the point is ignored. | |
|
|
Point 1 Distance (mm) |
| The distance returned for an ADC reading given by Point 1 ADC value | |
|
|
Point 2 ADC Value |
|
|
Point 2 Distance (mm) |
|
|
Point 3 ADC Value |
|
|
Point 3 Distance (mm) |
|
|
Point 4 ADC Value |
|
|
Point 4 Distance (mm) |
==Macro reference==
|
|
SetTxOff |
| Turns off the IR Transmitter | |
| - VOID
|
Return |
|
|
SetTxOn |
| Turns on the IR Transmitter | |
| - VOID
|
Return |
|
|
GetDistanceValue |
| Returns the calculated distance for the given ADC reading | |
| - BYTE
|
adc |
| - UINT
|
Return |
|
|
GetADCValue |
| Gets the raw ADC input value for the IR receiver | |
| - BYTE
|
Return |
|
|
Initialise |
| Initialise the component by loading the default calibration table | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Input ADC Channel |
| Analog input channel for the IR receiver | |
|
|
Output Enable Pin |
| Pin used to control the IR Transmitter | |
|
|
Initial/ Hardware Calibration Table |
|
|
Point 1 ADC Value |
| The ADC value that would give the Point 1 Distance. If the ADC value is 0 the point is ignored. | |
|
|
Point 1 Distance (mm) |
| The distance returned for an ADC reading given by Point 1 ADC value | |
|
|
Point 2 ADC Value |
|
|
Point 2 Distance (mm) |
|
|
Point 3 ADC Value |
|
|
Point 3 Distance (mm) |
|
|
Point 4 ADC Value |
|
|
Point 4 Distance (mm) |
