Difference between revisions of "Component: Colour Sensor (Grove 101020341) (101020341) (Light)"

Revision as of 12:01, 3 February 2023

Author	Matrix TSL
Version	1.0
Category	Light

Colour Sensor (Grove 101020341) component

Based on the color sensor TCS34725FN with digital output I2C. Based on the 8*2 array of filtered photodiodes and 16-bits analog-to-digital converters, you can gain the color chromaticity of ambient light or the color of objects. Of the 16 photodiodes, 4 have red filters, 4 have green filters, 4 have blue filters and 4 have no filter(clear). With the synchronization input pin, external pulsed light source can provides precise synchronous conversion control.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_temp/I2C_Colour_Sensor.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/I2C_Colour_Sensor.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

CalculateLux

	CalculateLux
Uses the RGB values stored in RAM from the last Sample to calculate the luminance in lux.
- UINT	Return

CalculateTemp

	CalculateTemp
Uses the RGB values stored in RAM from the last Sample to calculate the colour temperature in degrees Kelvin.
- UINT	Return

ClearInterrupt

	ClearInterrupt
Clears the interrupt flag allowing the device to interrupt again.
- VOID	Return

ControlInterrupt

	ControlInterrupt
Enables or Disables the Interrupt pin to fire when the light levels are inside the interrupt limits.
- BYTE	Enable
Range: 0 to 1 - 0=Interrupt Off / 1=Interrupt On
- UINT	LowLevel

- UINT	HighLevel

- VOID	Return

DisableSensor

	DisableSensor
Powers down the device to save power.
- VOID	Return

EnableSensor

	EnableSensor
Powers up the device ready for taking colour readings.
- VOID	Return

Initialise

	Initialise
Initialise the sensor configuration as set by the component properties. Sets the default intigration time and gain as well as enable the sensor.
- VOID	Return

ReadDataChannel

	ReadDataChannel
Returns the value of the selected colour channel from the last sample. The Red, Green and Blue channels have a colour filter to remove light of other colours. The Clear channel has no filter allowing the ambient light level to be easily collected.
- BYTE	ColourChannel
Range: 0 to 3 - 0=Red, 1=Green, 2=Blue, 3=Clear
- UINT	Return

SampleSensor

	SampleSensor
Reads the raw colour channels from the sensor and stores the readings into RAM to be collected by the ReadDataChannel macro.
- VOID	Return

SetGain

	SetGain
Controls the gain. 0x00 = 1X 0x01 = 4X 0x02 = 16X 0x03 = 60X
- BYTE	Setting
Range: 0 to 3
- VOID	Return

SetIntegrationTime

	SetIntegrationTime
Controls the integration time. 0 = 700mS / 1 = 154mS / 2 = 101mS / 3 = 50mS / 4 = 24mS / 5 = 2.4mS
- BYTE	Setting
Range: 0 to 5
- VOID	Return

Property reference

	Properties
	Sensor Settings
	Integration Time
Length of time period used to sample the sensor frequency (longer is more accurate)
	Gain
Length of time period used to sample the sensor frequency (longer is more accurate)
	I2C Settings
	Channel
Channel selection
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	Simulation
	Simulation Type
Selects the simulation type for the component. Component GUI - Interacts with the panel to sense the colour of a object in close proximity to the sensor. I2C Injector - Performs the I2C commands allowing you to connect an injector component or view and debug the I2C communications.

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_I2C_Colour_Sensor.fcfx FC_Comp_Source_I2C_Colour_Sensor.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/I2C_Colour_Sensor.fcfx FC_Comp_Source_temp/I2C_Colour_Sensor.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_I2C_Colour_Sensor.fcfx FC_Comp_Source_I2C_Colour_Sensor.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/I2C_Colour_Sensor.fcfx FC_Comp_Source_temp/I2C_Colour_Sensor.fcfx]
 ==Detailed description==
@@ Line 57: / Line 57: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 65: / Line 67: @@
 ==Macro reference==
-===ControlInterrupt===
+===CalculateLux===
 {| 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;" | '''ControlInterrupt'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CalculateLux'''
 |-
-| colspan="2" | Enables or Disables the Interrupt pin to fire when the light levels are inside the interrupt limits.&nbsp;
+| colspan="2" | Uses the RGB values stored in RAM from the last Sample to calculate the luminance in lux.&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%" | Enable
-|-
-| colspan="2" | Range: 0 to 1 - 0=Interrupt Off / 1=Interrupt On&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | LowLevel
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | HighLevel
-|-
-| 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''
 |}
-===SetGain===
+===CalculateTemp===
 {| 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;" | '''SetGain'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CalculateTemp'''
 |-
-| colspan="2" | Controls the gain. 0x00 = 1X 0x01 = 4X 0x02 = 16X 0x03 = 60X&nbsp;
+| colspan="2" | Uses the RGB values stored in RAM from the last Sample to calculate the colour temperature in degrees Kelvin.&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%" | Setting
-|-
-| colspan="2" | Range: 0 to 3&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''
 |}
@@ Line 127: / Line 109: @@
-===CalculateTemp===
+===ControlInterrupt===
 {| 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;" | '''CalculateTemp'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ControlInterrupt'''
+|-
+| colspan="2" | Enables or Disables the Interrupt pin to fire when the light levels are inside the interrupt limits.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Enable
+|-
+| colspan="2" | Range: 0 to 1 - 0=Interrupt Off / 1=Interrupt On&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | LowLevel
+|-
+| colspan="2" | &nbsp;
 |-
-| colspan="2" | Uses the RGB values stored in RAM from the last Sample to calculate the colour temperature in degrees Kelvin.&nbsp;
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | HighLevel
 |-
+| colspan="2" | &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''
 |}
-===EnableSensor===
+===DisableSensor===
 {| 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;" | '''EnableSensor'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisableSensor'''
 |-
-| colspan="2" | Powers up the device ready for taking colour readings.&nbsp;
+| colspan="2" | Powers down the device to save power.&nbsp;
 |-
 |-
@@ Line 155: / Line 152: @@
-===CalculateLux===
+===EnableSensor===
 {| 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;" | '''CalculateLux'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''EnableSensor'''
 |-
-| colspan="2" | Uses the RGB values stored in RAM from the last Sample to calculate the luminance in lux.&nbsp;
+| colspan="2" | Powers up the device ready for taking colour readings.&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''
 |}
-===SampleSensor===
+===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;" | '''SampleSensor'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| colspan="2" | Reads the raw colour channels from the sensor and stores the readings into RAM to be collected by the ReadDataChannel macro.&nbsp;
+| colspan="2" | Initialise the sensor configuration as set by the component properties. Sets the default intigration time and gain as well as enable the sensor.&nbsp;
 |-
 |-
@@ Line 202: / Line 199: @@
-===DisableSensor===
+===SampleSensor===
 {| 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;" | '''DisableSensor'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SampleSensor'''
 |-
-| colspan="2" | Powers down the device to save power.&nbsp;
+| colspan="2" | Reads the raw colour channels from the sensor and stores the readings into RAM to be collected by the ReadDataChannel macro.&nbsp;
 |-
 |-
@@ Line 216: / Line 213: @@
-===SetIntegrationTime===
+===SetGain===
 {| 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;" | '''SetIntegrationTime'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetGain'''
 |-
-| colspan="2" | Controls the integration time. 0 = 700mS / 1 = 154mS / 2 = 101mS / 3 = 50mS / 4 = 24mS / 5 = 2.4mS&nbsp;
+| colspan="2" | Controls the gain. 0x00 = 1X 0x01 = 4X 0x02 = 16X 0x03 = 60X&nbsp;
 |-
 |-
@@ Line 228: / Line 225: @@
 | width="90%" | Setting
 |-
-| colspan="2" | Range: 0 to 5&nbsp;
+| colspan="2" | Range: 0 to 3&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 235: / Line 232: @@
-===Initialise===
+===SetIntegrationTime===
 {| 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;" | '''SetIntegrationTime'''
+|-
+| colspan="2" | Controls the integration time. 0 = 700mS / 1 = 154mS / 2 = 101mS / 3 = 50mS / 4 = 24mS / 5 = 2.4mS&nbsp;
+|-
 |-
-| colspan="2" | Initialise the sensor configuration as set by the component properties. Sets the default intigration time and gain as well as enable the sensor.&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Setting
 |-
+| colspan="2" | Range: 0 to 5&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID