Difference between revisions of "Component: Infrared Array AMG88xx (Light)"

Latest revision as of 10:25, 20 October 2023

Author	Matrix TSL
Version	1.0
Category	Light

Infrared Array AMG88xx component

An 8x8 (64) Pixel infrared sensor array allowing basic none contact temperature detection.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

ClearInterrupt

	ClearInterrupt
Clear any triggered interrupts
- VOID	Return

Initialise

	Initialise
Sets up the I2C interface and initialises the sensor.
- VOID	Return

ReadPixel

	ReadPixel
Reads the temperature of a single pixel value from the last SamplePixels call.
- BYTE	Index
Pixel to read. Range: 0 - 63
- FLOAT	Return

ReadThermistor

	ReadThermistor
Reads the onboard thermistor Returns the temperature in degrees Celsius as a floating point value
- FLOAT	Return

SamplePixels

	SamplePixels
Reads Infrared sensor values
- VOID	Return

SetInterrupt

	SetInterrupt
Allows the interrupt pin to be enabled or disabled.
- BOOL	Mode
0 = Disabled / 1 = Enabled
- VOID	Return

SetInterruptLevels

	SetInterruptLevels
Set the interrupt levels. Interrupt when going above High or interrupt when going below Low.
- FLOAT	High
Range: -1023 to 1023
- FLOAT	Low
Range: -1023 to 1023
- FLOAT	Hysteresis
Range: -1023 to 1023 ( Recommend 0.95 * High )
- VOID	Return

SetInterruptMode

	SetInterruptMode
Set the interrupt to either absolute value or difference mode
- BOOL	Mode
0 = Difference / 1 = Absolute
- VOID	Return

SetMovingAverageMode

	SetMovingAverageMode
Set the moving average mode on or off.
- BOOL	Mode
0 = Off, 1 = On
- VOID	Return

Property reference

	Properties
	Connections
	Address

	Channel
Channel selection
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	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.
	Simulation
	Scope Traces
Selects if the scope traces are automatically generated or not
	Console Data
Selects if the console data is automatically generated or not
	API

@@ Line 56: / Line 56: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 61: / Line 71: @@
 ==Macro reference==
+===ClearInterrupt===
 {| 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;" | '''SetMovingAverageMode'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClearInterrupt'''
+|-
+| colspan="2" | Clear any triggered interrupts&nbsp;
+|-
 |-
-| colspan="2" | Set the moving average mode on or off.&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;" | '''Initialise'''
 |-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| colspan="2" | Sets up the I2C interface and initialises the sensor.&nbsp;
-| width="90%" | Mode
 |-
-| colspan="2" | 0 = Off, 1 = On&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 79: / Line 99: @@
+===ReadPixel===
 {| 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;" | '''ClearInterrupt'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadPixel'''
+|-
+| colspan="2" | Reads the temperature of a single pixel value from the last SamplePixels call.&nbsp;
+|-
 |-
-| colspan="2" | Clear any triggered interrupts&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Index
 |-
+| colspan="2" | Pixel to read. Range: 0 - 63&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===ReadThermistor===
 {| 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;" | '''SetInterruptMode'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadThermistor'''
+|-
+| colspan="2" | Reads the onboard thermistor Returns the temperature in degrees Celsius as a floating point value&nbsp;
+|-
 |-
-| colspan="2" | Set the interrupt to either absolute value or difference mode&nbsp;
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===SamplePixels===
+{| 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;" | '''SamplePixels'''
 |-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| colspan="2" | Reads Infrared sensor values&nbsp;
-| width="90%" | Mode
 |-
-| colspan="2" | 0 = Difference / 1 = Absolute&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 110: / Line 146: @@
+===SetInterrupt===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 128: / Line 165: @@
+===SetInterruptLevels===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 156: / Line 194: @@
+===SetInterruptMode===
 {| 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;" | '''SamplePixels'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetInterruptMode'''
 |-
-| colspan="2" | Reads Infrared sensor values&nbsp;
+| colspan="2" | Set the interrupt to either absolute value or difference mode&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
+| width="90%" | Mode
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| colspan="2" | 0 = Difference / 1 = Absolute&nbsp;
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadThermistor'''
 |-
-| colspan="2" | Reads the onboard thermistor Returns the temperature in degrees Celsius as a floating point value&nbsp;
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===SetMovingAverageMode===
 {| 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;" | '''ReadPixel'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMovingAverageMode'''
 |-
-| colspan="2" | Reads the temperature of a single pixel value from the last SamplePixels call.&nbsp;
+| colspan="2" | Set the moving average mode on or off.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | Index
+| width="90%" | Mode
-|-
-| colspan="2" | Pixel to read. Range: 0 - 63&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
-| 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" | Sets up the I2C interface and initialises the sensor.&nbsp;
 |-
+| colspan="2" | 0 = Off, 1 = On&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''
 |}