Amg88xx Class

Definition

Namespace:

Iot.Device.Amg88xx

Assembly:

Iot.Device.Bindings.dll

Package:

Iot.Device.Bindings v3.0.0

AMG88xx - family of infrared array sensors

C#

public class Amg88xx : IDisposable

Inheritance

Object

Amg88xx

Implements

IDisposable

Constructors

Amg88xx(I2cDevice)

Initializes a new instance of the Amg88xx binding.

Fields

AlternativeI2cAddress	Alternative device address (AD_SELECT pin is high, c.f. reference specification, pg. 11)
DefaultI2cAddress	Standard device address (AD_SELECT pin is low, c.f. reference specification, pg. 11)
Height	Number of sensor pixel array rows
PixelCount	Total number of pixels.
Width	Number of sensor pixel array columns

Properties

FrameRate	Get or sets the frame rate of the sensor internal thermal image update.
InterruptHysteresis	Gets or sets the pixel temperature interrupt hysteresis.
InterruptLowerLevel	Gets or sets the pixel temperature lower interrupt level.
InterruptMode	Gets or sets the pixel temperature interrupt mode.
InterruptPinEnabled	Get or sets whether the interrupt output pin of the sensor is enabled. If enabled, the pin is pulled down if an interrupt is active.
InterruptUpperLevel	Gets or sets the pixel temperature upper interrupt level.
Item[Int32, Int32]	Gets temperature of the specified pixel from the current thermal image.
Item[Int32]	Gets raw reading (12-bit two's complement format) of the specified pixel from the current thermal image.
OperatingMode	Gets or sets the current operating mode Refer to the sensor reference specification for a description of the mode depending sensor bevaviour and the valid mode transistions.
SensorTemperature	Gets the temperature reading from the internal thermistor.
TemperatureImage	Gets temperature for all pixels from the current thermal image as a two-dimensional array. First index specifies the x-coordinate of the pixel and second index specifies y-coordinate of the pixel.
UseMovingAverageMode	Get or sets the state of the moving average mode Important: the reference specification states that the current mode can be read, but it doesn't seem to work at the time being. In this case the property is always read as false.

Methods

ClearAllFlags()	Clears all flags in the status register. Note: it does not clear the interrupt flags of the individual pixels.
ClearInterrupt()	Clears the interrupt flag in the status register
ClearTemperatureOverflow()	Clears the temperature overflow indication.
ClearThermistorOverflow()	Clears the temperature overflow indication.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
GetInterruptFlagTable()	Gets the interrupt flags of all pixels.
HasInterrupt()	Gets the interrupt flag from the status register
HasTemperatureOverflow()	Gets whether any pixel measured a temperature higher than the normal operation range. The event of an overflow does not prevent from continuing reading the sensor. The overflow indication will last even if all pixels are returned to readings within normal range. The indicator is reset using .
HasThermistorOverflow()	Gets the thermistor overflow flag from the status register. The overflow indication will last even if the thermistor temperature returned to normal range. The event of an overflow does not prevent from continuing reading the sensor. The indicator is reset using . Note: the bit is only menthioned in early versions of the reference specification. It is not clear whether this is a specification error or a change in a newer revision of the sensor.
ReadImage()	Reads the current image from the sensor
Reset()	Performs an reset of the sensor. The flags and all configuration registers are reset to default values.
ResetAllFlags()	Performs a reset of all flags (status register, interrupt flag and interrupt table). This method is useful, if using the interrupt mechanism for pixel temperatures. If an upper and lower level has been set along with a hysteresis this reset can clear the interrupt state of all pixels which are within the range between upper and lower level, but still above/below the hystersis level. If this applies to ALL pixels the interrupt flag gets cleared as well. Refer to the binding documentation for more details on interrupt level, hysteresis and flagging.

Applies to