Difference between revisions of "Component: Colour Sensor (EBM018) (EBM Modules)"
From Flowcode Help
Jump to navigationJump to search| Line 62: | Line 62: | ||
{{Fcfile|EBM018 - Test Program.fcfx|EBM018 Example}} | {{Fcfile|EBM018 - Test Program.fcfx|EBM018 Example}} | ||
| + | |||
| + | |||
| Line 68: | Line 70: | ||
==Macro reference== | ==Macro reference== | ||
| + | ===SetConfig=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 86: | Line 89: | ||
| + | ===SetLEDOn=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 99: | Line 103: | ||
| + | ===SetFrequencyRange=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 117: | Line 122: | ||
| + | ===GetFrequency=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 130: | Line 136: | ||
| + | ===SetFilter=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 148: | Line 155: | ||
| + | ===SetLEDOff=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 161: | Line 169: | ||
| + | ===Initialise=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Revision as of 11:49, 3 February 2023
| Author | Matrix TSL |
| Version | 1.1 |
| Category | EBM Modules |
Contents
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
Macro reference
SetConfig
|
SetConfig |
| Sends the config data byte to the sensor using clock and data pins | |
 - BYTE
|
Data |
 - VOID
|
Return |
SetLEDOn
|
|
SetLEDOn |
| Turn on the White LEDs | |
| - VOID
|
Return |
SetFrequencyRange
|
|
SetFrequencyRange |
| Dynamically change the sensor output frequency range to a new setting | |
| - BYTE
|
Freq |
| Percentage range (2,20,100) | |
| - VOID
|
Return |
GetFrequency
|
|
GetFrequency |
| Samples and returns the sensor output frequency (Hz) | |
 - UINT
|
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 |
SetLEDOff
|
|
SetLEDOff |
| Turn off the White LEDs | |
| - VOID
|
Return |
Initialise
|
|
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) | |
