Show / Hide Table of Contents

    Class Bme280

    Represents a BME280 temperature, barometric pressure and humidity sensor.

    Inheritance
    Object
    Bmxx80Base
    Bmx280Base
    Bme280
    Implements
    IDisposable
    Inherited Members
    Bmx280Base.DefaultI2cAddress
    Bmx280Base.SecondaryI2cAddress
    Bmx280Base.s_osToMeasCycles
    Bmx280Base.FilterMode
    Bmx280Base.StandbyTime
    Bmx280Base.TryReadTemperature(Temperature)
    Bmx280Base.ReadPowerMode()
    Bmx280Base.TryReadPressure(Pressure)
    Bmx280Base.TryReadAltitude(Pressure, Length)
    Bmx280Base.TryReadAltitude(Length)
    Bmx280Base.ReadStatus()
    Bmx280Base.SetPowerMode(Bmx280PowerMode)
    Bmx280Base.TryReadTemperatureCore(Temperature)
    Bmx280Base.TryReadPressureCore(Pressure, Boolean)
    Bmxx80Base._i2cDevice
    Bmxx80Base._communicationProtocol
    Bmxx80Base._controlRegister
    Bmxx80Base.TemperatureFine
    Bmxx80Base.TempCalibrationFactor
    Bmxx80Base.PressureSampling
    Bmxx80Base.TemperatureSampling
    Bmxx80Base.Reset()
    Bmxx80Base.CompensateTemperature(Int32)
    Bmxx80Base.Read8BitsFromRegister(Byte)
    Bmxx80Base.Read16BitsFromRegister(Byte, Bmxx80Base.Endianness)
    Bmxx80Base.Read24BitsFromRegister(Byte, Bmxx80Base.Endianness)
    Bmxx80Base.ByteToSampling(Byte)
    Bmxx80Base.Dispose()
    Bmxx80Base.Dispose(Boolean)
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Iot.Device.Bmxx80
    Assembly: Iot.Device.Bmxx80.dll
    Syntax
    [Interface("Represents a BME280 temperature, barometric pressure and humidity sensor.")]
    public class Bme280 : Bmx280Base, IDisposable

    Constructors

    | Improve this Doc View Source

    Bme280(I2cDevice)

    Initializes a new instance of the Bme280 class.

    Declaration
    public Bme280(I2cDevice i2cDevice)
    Parameters
    Type Name Description
    I2cDevice i2cDevice

    The I2cDevice to create with.

    Properties

    | Improve this Doc View Source

    HumiditySampling

    Gets or sets the humidity sampling.

    Declaration
    [Property]
    public Sampling HumiditySampling { get; set; }
    Property Value
    Type Description
    Sampling
    Exceptions
    Type Condition
    ArgumentOutOfRangeException

    Thrown when the Sampling is set to an undefined mode.

    Methods

    | Improve this Doc View Source

    GetMeasurementDuration()

    Gets the required time in ms to perform a measurement with the current sampling modes.

    Declaration
    public override int GetMeasurementDuration()
    Returns
    Type Description
    Int32

    The time it takes for the chip to read data in milliseconds rounded up.

    Overrides
    Bmx280Base.GetMeasurementDuration()
    | Improve this Doc View Source

    Read()

    Performs a synchronous reading.

    Declaration
    public Bme280ReadResult Read()
    Returns
    Type Description
    Bme280ReadResult

    Bme280ReadResult

    | Improve this Doc View Source

    SetDefaultConfiguration()

    Sets the default configuration for the sensor.

    Declaration
    protected override void SetDefaultConfiguration()
    Overrides
    Bmx280Base.SetDefaultConfiguration()
    | Improve this Doc View Source

    TryReadHumidity(out RelativeHumidity)

    Reads the humidity. A return value indicates whether the reading succeeded.

    Declaration
    [Telemetry("Humidity")]
    public bool TryReadHumidity(out RelativeHumidity humidity)
    Parameters
    Type Name Description
    UnitsNet.RelativeHumidity humidity

    Contains the measured humidity as %rH if the HumiditySampling was not set to Skipped. Contains an undefined value if the return value is false.

    Returns
    Type Description
    Boolean
    true
    if measurement was not skipped, otherwise
    false
    .

    Implements

    IDisposable
    • Improve this Doc
    • View Source
    Back to top Copyright © 2018 nanoFramework Contributors
    Generated by DocFX