Jump to content

Component: Colour Sensor (EBM018) (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 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_EBM018v2.fcfx FC_Comp_Source_EBM018v2.fcfx]


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


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




Line 32: Line 36:


==Examples==
==Examples==




Line 51: Line 57:


==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;" | '''SetConfig'''
|-
| colspan="2" | Sends the config data byte to the sensor using clock and data pins 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" |  
|-
| 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;" | '''SetLEDOn'''
|-
| colspan="2" | Turn on the White LEDs 
|-
|-
| 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;" | '''SetFrequencyRange'''
|-
| colspan="2" | Dynamically change the sensor output frequency range to a new setting 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Freq
|-
| colspan="2" | Percentage range (2,20,100) 
|-
| 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;" | '''GetFrequency'''
|-
| colspan="2" | Samples and returns the sensor output frequency (Hz) 
|-
|-
| 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;" | '''SetFilter'''
|-
| colspan="2" | Dynamically change the sensor filter to RGB or W. Red = 0 Green = 1 Blue = 2 White = 3 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | FilterColour
|-
| colspan="2" | Filter Colour; Red = 0, Green = 1, Blue = 2 and White = 3 
|-
| 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;" | '''SetLEDOff'''
|-
| colspan="2" | Turn off the White LEDs 
|-
|-
| 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" | Initialise the sensor configuration as set by the component properties 
|-
|-
| 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%" | SDA
|-
| colspan="2" | Pin used for sending serial configuration data to the sensor device 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | SCL
|-
| colspan="2" | Pin used as clock pin for sending serial configuration data to the sensor device 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Sensor Output
|-
| colspan="2" | Pin used to monitor the output frequency from the light sensor 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Output Frequency Range
|-
| colspan="2" | Initial sensor output frequency range selection. 100% 0-500KHz  20% 0-100KHz  2% 0-10KHz 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Filter Option
|-
| colspan="2" | Initial filter selected 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | LED Control
|-
| colspan="2" | Initial White LED state 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Sample Time Period
|-
| colspan="2" | Length of time period used to sample the sensor frequency (longer is more accurate) 
|}==Macro reference==


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

Revision as of 15:21, 20 January 2023

Author Matrix TSL
Version 1.1
Category EBM Modules


Colour Sensor component

This board provides the ability to detect colours using the TCS3200 sensor. It will return RGB and W values, dependent on the colour of the object under test.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

Sample program using the EBM018 - Colour sensor

Sets filter to RGB and W and reads values,displays on LCD

EBM018 Example


Macro reference

SetConfig
Sends the config data byte to the sensor using clock and data pins 
- BYTE Data
 
- VOID Return


SetLEDOn
Turn on the White LEDs 
- VOID Return


SetFrequencyRange
Dynamically change the sensor output frequency range to a new setting 
- BYTE Freq
Percentage range (2,20,100) 
- VOID Return


GetFrequency
Samples and returns the sensor output frequency (Hz) 
- UINT Return


SetFilter
Dynamically change the sensor filter to RGB or W. Red = 0 Green = 1 Blue = 2 White = 3 
- BYTE FilterColour
Filter Colour; Red = 0, Green = 1, Blue = 2 and White = 3 
- VOID Return


SetLEDOff
Turn off the White LEDs 
- VOID Return


Initialise
Initialise the sensor configuration as set by the component properties 
- VOID Return



Property reference

Properties
SDA
Pin used for sending serial configuration data to the sensor device 
SCL
Pin used as clock pin for sending serial configuration data to the sensor device 
Sensor Output
Pin used to monitor the output frequency from the light sensor 
Output Frequency Range
Initial sensor output frequency range selection. 100% 0-500KHz 20% 0-100KHz 2% 0-10KHz 
Filter Option
Initial filter selected 
LED Control
Initial White LED state 
Sample Time Period
Length of time period used to sample the sensor frequency (longer is more accurate) 

==Macro reference==

SetConfig
Sends the config data byte to the sensor using clock and data pins 
- BYTE Data
 
- VOID Return


SetLEDOn
Turn on the White LEDs 
- VOID Return


SetFrequencyRange
Dynamically change the sensor output frequency range to a new setting 
- BYTE Freq
Percentage range (2,20,100) 
- VOID Return


GetFrequency
Samples and returns the sensor output frequency (Hz) 
- UINT Return


SetFilter
Dynamically change the sensor filter to RGB or W. Red = 0 Green = 1 Blue = 2 White = 3 
- BYTE FilterColour
Filter Colour; Red = 0, Green = 1, Blue = 2 and White = 3 
- VOID Return


SetLEDOff
Turn off the White LEDs 
- VOID Return


Initialise
Initialise the sensor configuration as set by the component properties 
- VOID Return



Property reference

Properties
SDA
Pin used for sending serial configuration data to the sensor device 
SCL
Pin used as clock pin for sending serial configuration data to the sensor device 
Sensor Output
Pin used to monitor the output frequency from the light sensor 
Output Frequency Range
Initial sensor output frequency range selection. 100% 0-500KHz 20% 0-100KHz 2% 0-10KHz 
Filter Option
Initial filter selected 
LED Control
Initial White LED state 
Sample Time Period
Length of time period used to sample the sensor frequency (longer is more accurate) 

==Macro reference==

SetConfig
Sends the config data byte to the sensor using clock and data pins 
- BYTE Data
 
- VOID Return


SetLEDOn
Turn on the White LEDs 
- VOID Return


SetFrequencyRange
Dynamically change the sensor output frequency range to a new setting 
- BYTE Freq
Percentage range (2,20,100) 
- VOID Return


GetFrequency
Samples and returns the sensor output frequency (Hz) 
- UINT Return


SetFilter
Dynamically change the sensor filter to RGB or W. Red = 0 Green = 1 Blue = 2 White = 3 
- BYTE FilterColour
Filter Colour; Red = 0, Green = 1, Blue = 2 and White = 3 
- VOID Return


SetLEDOff
Turn off the White LEDs 
- VOID Return


Initialise
Initialise the sensor configuration as set by the component properties 
- VOID Return



Property reference

Properties
SDA
Pin used for sending serial configuration data to the sensor device 
SCL
Pin used as clock pin for sending serial configuration data to the sensor device 
Sensor Output
Pin used to monitor the output frequency from the light sensor 
Output Frequency Range
Initial sensor output frequency range selection. 100% 0-500KHz 20% 0-100KHz 2% 0-10KHz 
Filter Option
Initial filter selected 
LED Control
Initial White LED state 
Sample Time Period
Length of time period used to sample the sensor frequency (longer is more accurate) 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Colour_Sensor_(EBM018)_(EBM_Modules)&oldid=33270"