Difference between revisions of "Component: Infrared Array AMG88xx (Light)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_AMG88.fcfx FC_Comp_Source_AMG88.fcfx] |
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_AMG88.fcfx FC_Comp_Source_AMG88.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_AMG88.fcfx FC_Comp_Source_AMG88.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 34: | Line 36: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 46: | Line 50: | ||
==Macro reference== | ==Macro reference== | ||
| + | |||
| + | {| 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''' | ||
| + | |- | ||
| + | | colspan="2" | Set the moving average mode on or off. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | Mode | ||
| + | |- | ||
| + | | colspan="2" | 0 = Off, 1 = On | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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''' | ||
| + | |- | ||
| + | | colspan="2" | Clear any triggered interrupts | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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''' | ||
| + | |- | ||
| + | | colspan="2" | Set the interrupt to either absolute value or difference mode | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | Mode | ||
| + | |- | ||
| + | | colspan="2" | 0 = Difference / 1 = Absolute | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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;" | '''SetInterrupt''' | ||
| + | |- | ||
| + | | colspan="2" | Allows the interrupt pin to be enabled or disabled. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | Mode | ||
| + | |- | ||
| + | | colspan="2" | 0 = Disabled / 1 = Enabled | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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;" | '''SetInterruptLevels''' | ||
| + | |- | ||
| + | | colspan="2" | Set the interrupt levels. Interrupt when going above High or interrupt when going below Low. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | High | ||
| + | |- | ||
| + | | colspan="2" | Range: -1023 to 1023 | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | Low | ||
| + | |- | ||
| + | | colspan="2" | Range: -1023 to 1023 | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | Hysteresis | ||
| + | |- | ||
| + | | colspan="2" | Range: -1023 to 1023 ( Recommend 0.95 * High ) | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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''' | ||
| + | |- | ||
| + | | colspan="2" | Reads Infrared sensor values | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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;" | '''ReadThermistor''' | ||
| + | |- | ||
| + | | colspan="2" | Reads the onboard thermistor Returns the temperature in degrees Celsius as a floating point value | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''ReadPixel''' | ||
| + | |- | ||
| + | | colspan="2" | Reads the temperature of a single pixel value from the last SamplePixels call. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Index | ||
| + | |- | ||
| + | | colspan="2" | Pixel to read. Range: 0 - 63 | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Property reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Address | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Channel | ||
| + | |- | ||
| + | | colspan="2" | Channel selection | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | ||
| + | | width="90%" | SDA | ||
| + | |- | ||
| + | | colspan="2" | Pin used for SDA (data signal) | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | ||
| + | | width="90%" | SCL | ||
| + | |- | ||
| + | | colspan="2" | Pin used for SCL (clock signal) | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Baud Select | ||
| + | |- | ||
| + | | colspan="2" | Baud rate option selector | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
| + | | width="90%" | Baud Rate | ||
| + | |- | ||
| + | | colspan="2" | Baud rate to be used | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Stop Delay | ||
| + | |- | ||
| + | | colspan="2" | 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. | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Scope Traces | ||
| + | |- | ||
| + | | colspan="2" | Selects if the scope traces are automatically generated or not | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Console Data | ||
| + | |- | ||
| + | | colspan="2" | Selects if the console data is automatically generated or not | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | API | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 09:52, 27 January 2023
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Light |
Contents
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
| SetMovingAverageMode | |
| Set the moving average mode on or off. | |
| Mode | |
| 0 = Off, 1 = On | |
| Return | |
| ClearInterrupt | |
| Clear any triggered interrupts | |
| Return | |
| SetInterruptMode | |
| Set the interrupt to either absolute value or difference mode | |
| Mode | |
| 0 = Difference / 1 = Absolute | |
| Return | |
| SetInterrupt | |
| Allows the interrupt pin to be enabled or disabled. | |
| Mode | |
| 0 = Disabled / 1 = Enabled | |
| Return | |
| SamplePixels | |
| Reads Infrared sensor values | |
| Return | |
| ReadThermistor | |
| Reads the onboard thermistor Returns the temperature in degrees Celsius as a floating point value | |
| Return | |
| ReadPixel | |
| Reads the temperature of a single pixel value from the last SamplePixels call. | |
| Index | |
| Pixel to read. Range: 0 - 63 | |
| Return | |
| Initialise | |
| Sets up the I2C interface and initialises the sensor. | |
| Return | |
Property reference
==Macro reference==
| SetMovingAverageMode | |
| Set the moving average mode on or off. | |
| Mode | |
| 0 = Off, 1 = On | |
| Return | |
| ClearInterrupt | |
| Clear any triggered interrupts | |
| Return | |
| SetInterruptMode | |
| Set the interrupt to either absolute value or difference mode | |
| Mode | |
| 0 = Difference / 1 = Absolute | |
| Return | |
| SetInterrupt | |
| Allows the interrupt pin to be enabled or disabled. | |
| Mode | |
| 0 = Disabled / 1 = Enabled | |
| Return | |
| SamplePixels | |
| Reads Infrared sensor values | |
| Return | |
| ReadThermistor | |
| Reads the onboard thermistor Returns the temperature in degrees Celsius as a floating point value | |
| Return | |
| ReadPixel | |
| Reads the temperature of a single pixel value from the last SamplePixels call. | |
| Index | |
| Pixel to read. Range: 0 - 63 | |
| Return | |
| Initialise | |
| Sets up the I2C interface and initialises the sensor. | |
| Return | |
Property reference
==Macro reference==
| SetMovingAverageMode | |
| Set the moving average mode on or off. | |
| Mode | |
| 0 = Off, 1 = On | |
| Return | |
| ClearInterrupt | |
| Clear any triggered interrupts | |
| Return | |
| SetInterruptMode | |
| Set the interrupt to either absolute value or difference mode | |
| Mode | |
| 0 = Difference / 1 = Absolute | |
| Return | |
| SetInterrupt | |
| Allows the interrupt pin to be enabled or disabled. | |
| Mode | |
| 0 = Disabled / 1 = Enabled | |
| Return | |
| SamplePixels | |
| Reads Infrared sensor values | |
| Return | |
| ReadThermistor | |
| Reads the onboard thermistor Returns the temperature in degrees Celsius as a floating point value | |
| Return | |
| ReadPixel | |
| Reads the temperature of a single pixel value from the last SamplePixels call. | |
| Index | |
| Pixel to read. Range: 0 - 63 | |
| Return | |
| Initialise | |
| Sets up the I2C interface and initialises the sensor. | |
| Return | |
Property reference
==Macro reference==
| SetMovingAverageMode | |
| Set the moving average mode on or off. | |
| Mode | |
| 0 = Off, 1 = On | |
| Return | |
| ClearInterrupt | |
| Clear any triggered interrupts | |
| Return | |
| SetInterruptMode | |
| Set the interrupt to either absolute value or difference mode | |
| Mode | |
| 0 = Difference / 1 = Absolute | |
| Return | |
| SetInterrupt | |
| Allows the interrupt pin to be enabled or disabled. | |
| Mode | |
| 0 = Disabled / 1 = Enabled | |
| Return | |
| SamplePixels | |
| Reads Infrared sensor values | |
| Return | |
| ReadThermistor | |
| Reads the onboard thermistor Returns the temperature in degrees Celsius as a floating point value | |
| Return | |
| ReadPixel | |
| Reads the temperature of a single pixel value from the last SamplePixels call. | |
| Index | |
| Pixel to read. Range: 0 - 63 | |
| Return | |
| Initialise | |
| Sets up the I2C interface and initialises the sensor. | |
| Return | |