Difference between revisions of "Component: Photo Reflector 2D (Light)"
From Flowcode Help
Jump to navigationJump to search| Line 16: | Line 16: | ||
==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_PhotoReflector_2d.fcfx FC_Comp_Source_PhotoReflector_2d.fcfx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_PhotoReflector_2d.fcfx FC_Comp_Source_PhotoReflector_2d.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_PhotoReflector_2d.fcfx FC_Comp_Source_PhotoReflector_2d.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 30: | Line 34: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 40: | 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;" | '''SampleSensor''' | ||
| + | |- | ||
| + | | colspan="2" | Samples the sensor and automatically controls the emitter pin if enabled. Returns the analogue reading from the sensor pin. | ||
| + | |- | ||
| + | |- | ||
| + | | 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" | Sets up the I/O to allow the sensor to operate. | ||
| + | |- | ||
| + | |- | ||
| + | | 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-16-icon.png]] | ||
| + | | width="90%" | Emitter Type | ||
| + | |- | ||
| + | | colspan="2" | Decides if the emitter needs to be switched on and off during sampling | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-6-icon.png]] | ||
| + | | width="90%" | Sense Pin | ||
| + | |- | ||
| + | | colspan="2" | Pin connected to the sensor element of the photo transistor | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | ||
| + | | width="90%" | Discrete Distance | ||
| + | |- | ||
| + | | colspan="2" | Simulation range used to determine if the sense pin is active or not. | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 15:24, 20 January 2023
| Author | Matrix Ltd |
| Version | 1.0 |
| Category | Light |
Contents
Photo Reflector 2D component
Uses InfraRed light to detect if an external object is near to the sensor. Returns a discrete analogue signal which can represent distance from the nearest object. Useful for applications like wall following, control based systems and robotics.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_PhotoReflector_2d.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_PhotoReflector_2d.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
SampleSensor |
| Samples the sensor and automatically controls the emitter pin if enabled. Returns the analogue reading from the sensor pin. | |
 - BYTE
|
Return |
|
|
Initialise |
| Sets up the I/O to allow the sensor to operate. | |
 - VOID
|
Return |
Property reference
|
Properties |
|
Emitter Type |
| Decides if the emitter needs to be switched on and off during sampling | |
|
Connections |
|
Sense Pin |
| Pin connected to the sensor element of the photo transistor | |
|
|
Simulation |
|
Discrete Distance |
| Simulation range used to determine if the sense pin is active or not. | |
==Macro reference==
|
|
SampleSensor |
| Samples the sensor and automatically controls the emitter pin if enabled. Returns the analogue reading from the sensor pin. | |
| - BYTE
|
Return |
|
|
Initialise |
| Sets up the I/O to allow the sensor to operate. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Emitter Type |
| Decides if the emitter needs to be switched on and off during sampling | |
|
|
Connections |
|
|
Sense Pin |
| Pin connected to the sensor element of the photo transistor | |
|
|
Simulation |
|
|
Discrete Distance |
| Simulation range used to determine if the sense pin is active or not. | |
==Macro reference==
|
|
SampleSensor |
| Samples the sensor and automatically controls the emitter pin if enabled. Returns the analogue reading from the sensor pin. | |
| - BYTE
|
Return |
|
|
Initialise |
| Sets up the I/O to allow the sensor to operate. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Emitter Type |
| Decides if the emitter needs to be switched on and off during sampling | |
|
|
Connections |
|
|
Sense Pin |
| Pin connected to the sensor element of the photo transistor | |
|
|
Simulation |
|
|
Discrete Distance |
| Simulation range used to determine if the sense pin is active or not. | |
