Component: Colour Sensor (EBM018) (EBM Modules): Difference between revisions

Latest revision as of 13:09, 7 February 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

GetFrequency

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

Initialise

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

SetConfig

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

- VOID	Return

SetFilter

	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

SetFrequencyRange

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

SetLEDOff

	SetLEDOff
Turn off the White LEDs
- VOID	Return

SetLEDOn

	SetLEDOn
Turn on the White LEDs
- 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)

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_EBM018v2.fcfx FC_Comp_Source_EBM018v2.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/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==
@@ Line 28: / Line 40: @@
 ==Examples==
@@ Line 42: / Line 64: @@
-==Downloadable macro reference==
+==Macro reference==
+===GetFrequency===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFrequency'''
 |-
-| colspan="2" | Sends the config data byte to the sensor using clock and data pins&nbsp;
+| colspan="2" | Samples and returns the sensor output frequency (Hz)&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Data
-|-
-| colspan="2" | &nbsp;
-|-
-| 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''
 |}
+===Initialise===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| colspan="2" | Turn on the White LEDs&nbsp;
+| colspan="2" | Initialise the sensor configuration as set by the component properties&nbsp;
 |-
 |-
@@ Line 75: / Line 104: @@
+===SetConfig===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetConfig'''
 |-
-| colspan="2" | Dynamically change the sensor output frequency range to a new setting&nbsp;
+| colspan="2" | Sends the config data byte to the sensor using clock and data pins&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Freq
+| width="90%" | Data
 |-
-| colspan="2" | Percentage range (2,20,100)&nbsp;
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 93: / Line 123: @@
+===SetFilter===
 {| 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'''
+| 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&nbsp;
+|-
 |-
-| colspan="2" | Samples and returns the sensor output frequency (Hz)&nbsp;
+| 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&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| 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''
 |}
+===SetFrequencyRange===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetFrequencyRange'''
 |-
-| colspan="2" | Dynamically change the sensor filter to RGB or W. Red = 0 Green = 1 Blue = 2 White = 3&nbsp;
+| colspan="2" | Dynamically change the sensor output frequency range to a new setting&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | FilterColour
+| width="90%" | Freq
 |-
-| colspan="2" | Filter Colour; Red = 0, Green = 1, Blue = 2 and White = 3&nbsp;
+| colspan="2" | Percentage range (2,20,100)&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 124: / Line 161: @@
+===SetLEDOff===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 137: / Line 175: @@
+===SetLEDOn===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLEDOn'''
 |-
-| colspan="2" | Initialise the sensor configuration as set by the component properties&nbsp;
+| colspan="2" | Turn on the White LEDs&nbsp;
 |-
 |-
@@ Line 148: / Line 187: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}

Wiki bot (talk | contribs)