Show / Hide Table of Contents

    Class Bmx280Base

    Represents the core functionality of the Bmx280 family.

    Inheritance
    Object
    Bmxx80Base
    Bmx280Base
    Bme280
    Bmp280
    Implements
    IDisposable
    Inherited Members
    Bmxx80Base.TemperatureFine
    Bmxx80Base.TempCalibrationFactor
    Bmxx80Base.PressureSampling
    Bmxx80Base.TemperatureSampling
    Bmxx80Base.ControlRegister
    Bmxx80Base.CommunicationProtocol1
    Bmxx80Base.I2cDevice
    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 the core functionality of the Bmx280 family.")]
    public abstract class Bmx280Base : Bmxx80Base, IDisposable

    Constructors

    | Improve this Doc View Source

    Bmx280Base(Byte, I2cDevice)

    Initializes a new instance of the Bmx280Base class.

    Declaration
    protected Bmx280Base(byte deviceId, I2cDevice i2cDevice)
    Parameters
    Type Name Description
    Byte deviceId

    The ID of the device.

    I2cDevice i2cDevice

    The I2cDevice to create with.

    Fields

    | Improve this Doc View Source

    DefaultI2cAddress

    Default I2C bus address.

    Declaration
    public const byte DefaultI2cAddress = 119
    Field Value
    Type Description
    Byte
    | Improve this Doc View Source

    OsToMeasCycles

    Converts oversampling to needed measurement cycles for that oversampling.

    Declaration
    protected static readonly int[] OsToMeasCycles
    Field Value
    Type Description
    Int32[]
    | Improve this Doc View Source

    SecondaryI2cAddress

    Secondary I2C bus address.

    Declaration
    public const byte SecondaryI2cAddress = 118
    Field Value
    Type Description
    Byte

    Properties

    | Improve this Doc View Source

    FilterMode

    Gets or sets the IIR filter mode.

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

    Thrown when the Bmx280FilteringMode is set to an undefined mode.

    | Improve this Doc View Source

    StandbyTime

    Gets or sets the standby time between two consecutive measurements.

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

    Thrown when the StandbyTime 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
    [Property("MeasurementDuration")]
    public virtual int GetMeasurementDuration()
    Returns
    Type Description
    Int32

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

    | Improve this Doc View Source

    ReadPowerMode()

    Read the Bmx280PowerMode state.

    Declaration
    [Property("PowerMode")]
    public Bmx280PowerMode ReadPowerMode()
    Returns
    Type Description
    Bmx280PowerMode

    The current Bmx280PowerMode.

    Exceptions
    Type Condition
    NotImplementedException

    Thrown when the power mode does not match a defined mode in Bmx280PowerMode.

    | Improve this Doc View Source

    ReadStatus()

    Get the current status of the device.

    Declaration
    [Telemetry("Status")]
    public DeviceStatus ReadStatus()
    Returns
    Type Description
    DeviceStatus

    The DeviceStatus.

    | Improve this Doc View Source

    SetDefaultConfiguration()

    Sets the default configuration for the sensor.

    Declaration
    [Command]
    protected override void SetDefaultConfiguration()
    Overrides
    Bmxx80Base.SetDefaultConfiguration()
    | Improve this Doc View Source

    SetPowerMode(Bmx280PowerMode)

    Sets the power mode to the given mode.

    Declaration
    [Property("PowerMode")]
    public void SetPowerMode(Bmx280PowerMode powerMode)
    Parameters
    Type Name Description
    Bmx280PowerMode powerMode

    The Bmx280PowerMode to set.

    | Improve this Doc View Source

    TryReadAltitude(out Length)

    Calculates the altitude in meters from the mean sea-level pressure.

    Declaration
    public bool TryReadAltitude(out Length altitude)
    Parameters
    Type Name Description
    UnitsNet.Length altitude

    Contains the calculated metres above sea-level if the PressureSampling was not set to Skipped. Contains NaN otherwise.

    Returns
    Type Description
    Boolean
    true
    if pressure measurement was not skipped, otherwise
    false
    .
    | Improve this Doc View Source

    TryReadAltitude(Pressure, out Length)

    Calculates the altitude in meters from the specified sea-level pressure(in hPa).

    Declaration
    public bool TryReadAltitude(Pressure seaLevelPressure, out Length altitude)
    Parameters
    Type Name Description
    UnitsNet.Pressure seaLevelPressure

    Sea-level pressure.

    UnitsNet.Length altitude

    Contains the calculated metres above sea-level if the PressureSampling was not set to Skipped. Contains NaN otherwise.

    Returns
    Type Description
    Boolean
    true
    if pressure measurement was not skipped, otherwise
    false
    .
    | Improve this Doc View Source

    TryReadPressure(out Pressure)

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

    Declaration
    [Telemetry("Pressure")]
    public override bool TryReadPressure(out Pressure pressure)
    Parameters
    Type Name Description
    UnitsNet.Pressure pressure

    Contains the measured pressure in Pa if the PressureSampling was not set to Skipped. Contains NaN otherwise.

    Returns
    Type Description
    Boolean
    true
    if measurement was not skipped, otherwise
    false
    .
    Overrides
    Bmxx80Base.TryReadPressure(out Pressure)
    | Improve this Doc View Source

    TryReadPressureCore(out Pressure, Boolean)

    Performs a pressure reading.

    Declaration
    protected bool TryReadPressureCore(out Pressure pressure, bool skipTempFineRead = false)
    Parameters
    Type Name Description
    UnitsNet.Pressure pressure

    Current preasure reeading.

    Boolean skipTempFineRead

    Don't know. Change it.

    Returns
    Type Description
    Boolean

    True if the reading was sucesfully performed.

    | Improve this Doc View Source

    TryReadTemperature(out Temperature)

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

    Declaration
    [Telemetry("Temperature")]
    public override bool TryReadTemperature(out Temperature temperature)
    Parameters
    Type Name Description
    UnitsNet.Temperature temperature

    Contains the measured temperature if the TemperatureSampling was not set to Skipped. Contains NaN otherwise.

    Returns
    Type Description
    Boolean
    true
    if measurement was not skipped, otherwise
    false
    .
    Overrides
    Bmxx80Base.TryReadTemperature(out Temperature)
    | Improve this Doc View Source

    TryReadTemperatureCore(out Temperature)

    Performs a temperature reading.

    Declaration
    protected bool TryReadTemperatureCore(out Temperature temperature)
    Parameters
    Type Name Description
    UnitsNet.Temperature temperature

    Current temperature reading.

    Returns
    Type Description
    Boolean

    True if reading was sucesfully performed.

    Implements

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