Bme680 Class

Definition

Namespace:

Iot.Device.Bmxx80

Assembly:

Iot.Device.Bindings.dll

Package:

Iot.Device.Bindings v3.0.0

Represents a BME680 temperature, pressure, relative humidity and VOC gas sensor.

[System.Device.Model.Interface("Represents a BME680 temperature, pressure, relative humidity and VOC gas sensor.")]
public class Bme680 : Iot.Device.Bmxx80.Bmxx80Base

[<System.Device.Model.Interface("Represents a BME680 temperature, pressure, relative humidity and VOC gas sensor.")>]
type Bme680 = class
    inherit Bmxx80Base

Public Class Bme680
Inherits Bmxx80Base

Inheritance

Object

Bmxx80Base

Bme680

Attributes

InterfaceAttribute

Constructors

Bme680(I2cDevice)	Initialize a new instance of the Bme680 class.
Bme680(I2cDevice, Temperature)	Initialize a new instance of the Bme680 class.

Fields

_communicationProtocol	Chosen communication protocol. (Inherited from Bmxx80Base)
_controlRegister	The control register of the sensor. (Inherited from Bmxx80Base)
_i2cDevice	I2C device used to communicate with the device. (Inherited from Bmxx80Base)
DefaultI2cAddress	Default I2C bus address.
SecondaryI2cAddress	Secondary I2C bus address.
TemperatureFine	(Inherited from Bmxx80Base)

Properties

_tempCalibrationFactor	(Inherited from Bmxx80Base)
FilterMode	Gets or sets the filtering mode to be used for measurements.
GasConversionIsEnabled	Gets or sets whether gas conversions are enabled.
HeaterIsEnabled	Gets or sets whether the heater is enabled.
HeaterProfile	Gets or sets the heater profile to be used for measurements. Current heater profile is only set if the chosen profile is configured.
HumiditySampling	Gets or sets the humidity sampling.
PressureSampling	Gets or sets the pressure sampling. (Inherited from Bmxx80Base)
TempCalibrationFactor	The temperature calibration factor.
TemperatureFine	The variable TemperatureFine carries a fine resolution temperature value over to the pressure compensation formula and could be implemented as a global variable. (Inherited from Bmxx80Base)
TemperatureSampling	Gets or sets the temperature sampling. (Inherited from Bmxx80Base)

Methods

ByteToSampling(Byte)	Converts byte to Sampling. (Inherited from Bmxx80Base)
CompensateTemperature(Int32)	Compensates the temperature. (Inherited from Bmxx80Base)
ConfigureHeatingProfile(Bme680HeaterProfile, Temperature, Duration, Temperature)	Configures a heater profile, making it ready for use.
Dispose()	Cleanup. (Inherited from Bmxx80Base)
Dispose(Boolean)	Releases the unmanaged resources used by the Bmxx80 and optionally releases the managed resources. (Inherited from Bmxx80Base)
GetMeasurementDuration(Bme680HeaterProfile)	Gets the required time in ms to perform a measurement. The duration of the gas measurement is not considered if GasConversionIsEnabled is set to false or the chosen Bme680HeaterProfile is not configured. The precision of this duration is within 1ms of the actual measurement time.
Read()	Performs a synchronous reading.
Read16BitsFromRegister(Byte)	(Inherited from Bmxx80Base)
Read16BitsFromRegister(Byte, Bmxx80Base+Endianness)	Reads a 16 bit value over I2C. (Inherited from Bmxx80Base)
Read24BitsFromRegister(Byte)	(Inherited from Bmxx80Base)
Read24BitsFromRegister(Byte, Bmxx80Base+Endianness)	Reads a 24 bit value over I2C. (Inherited from Bmxx80Base)
Read8BitsFromRegister(Byte)	Reads an 8 bit value from a register. (Inherited from Bmxx80Base)
ReadAsync()	Performs an asynchronous reading.
ReadGasMeasurementInProcess()	Reads whether a gas measurement is in process.
ReadHeaterIsStable()	Reads whether the target heater temperature is reached.
ReadMeasurementInProcess()	Reads whether a measurement of any kind is in process.
ReadNewDataIsAvailable()	Reads whether new data is available.
ReadPowerMode()	Read the Bme680PowerMode state.
ReadPressureSampling()	(Inherited from Bmxx80Base)
ReadTemperatureSampling()	(Inherited from Bmxx80Base)
Reset()	When called, the device is reset using the complete power-on-reset procedure. The device will reset to the default configuration. (Inherited from Bmxx80Base)
SetDefaultConfiguration()	Sets the default configuration for the sensor.
SetPowerMode(Bme680PowerMode)	Sets the power mode to the given mode
SetPressureSampling(Sampling)	(Inherited from Bmxx80Base)
SetTemperatureSampling(Sampling)	(Inherited from Bmxx80Base)
TryReadGasResistance(ElectricResistance)	Reads the gas resistance. A return value indicates whether the reading succeeded.
TryReadHumidity(RelativeHumidity)	Reads the humidity. A return value indicates whether the reading succeeded.
TryReadPressure(Pressure)	Reads the pressure. A return value indicates whether the reading succeeded.
TryReadTemperature(Temperature)	Reads the temperature. A return value indicates whether the reading succeeded.