Component: Colour Sensor (TCS3200) (Light)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix TSL |
| Version | 1.1 |
| Category | Light |
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_Colour_TCS3200.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_Colour_TCS3200.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
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) | |
==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) | |
