Inclinometer Inclinometer Inclinometer Inclinometer Class

Represents an inclinometer sensor.

This sensor returns pitch, roll, and yaw values that correspond to rotation angles around the x, y, and z axes, respectively.

Syntax

Declaration

public sealed class Inclinometerpublic sealed class InclinometerPublic NotInheritable Class Inclinometer

Remarks

Sensor data is provided relative to the device's fixed sensor coordinate system, and is independent of display orientation. For applications that rely on sensor data for input control or to manipulate elements on the screen, the developer must take current display orientation into account and compensate the data appropriately. For more info about the sensor coordinate system, see Sensor data and display orientation.

The following example demonstrates how a Windows Store app built with XAML and C# uses the GetDefault(Windows.Devices.Sensors.SensorReadingType) method to establish a connection to an inclinometer. If no integrated inclinometer is found, the method will return a null value.

_inclinometer = Inclinometer.GetDefault();

The following example demonstrates how a Windows Store app built with XAML registers a ReadingChanged event handler.

private void ScenarioEnable(object sender, RoutedEventArgs e)
{
    if (_inclinometer != null)
    {
        // Establish the report interval
        _inclinometer.ReportInterval = _desiredReportInterval;

        Window.Current.VisibilityChanged += new WindowVisibilityChangedEventHandler(VisibilityChanged);
        _inclinometer.ReadingChanged += new TypedEventHandler<Inclinometer, InclinometerReadingChangedEventArgs>(ReadingChanged);

        ScenarioEnableButton.IsEnabled = false;
        ScenarioDisableButton.IsEnabled = true;
    }
    else
    {
        rootPage.NotifyUser("No inclinometer found", NotifyType.StatusMessage);
    }
}

The following example shows the ReadingChanged event handler.

async private void ReadingChanged(object sender, InclinometerReadingChangedEventArgs e)
{
    await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () =>
    {
        InclinometerReading reading = e.Reading;
        ScenarioOutput_X.Text = String.Format("{0,5:0.00}", reading.PitchDegrees);
        ScenarioOutput_Y.Text = String.Format("{0,5:0.00}", reading.RollDegrees);
        ScenarioOutput_Z.Text = String.Format("{0,5:0.00}", reading.YawDegrees);
    });
}

Properties summary

Gets the device identifier.

Gets the minimum report interval supported by the inclinometer.

Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data.

Gets the sensor reading type.

Gets or sets the current report interval for the inclinometer.

Methods summary

Gets the current inclinometer reading.

Returns the default inclinometer.

Returns the default inclinometer based on the SensorReadingType.

Returns the default inclinometer.

Events summary

Occurs each time the inclinometer reports a new sensor reading.

Properties

  • DeviceId
    DeviceId
    DeviceId
    DeviceId

    Gets the device identifier.

    public string DeviceId { get; }public string DeviceId { get; }Public ReadOnly Property DeviceId As string

    Property Value

    • string
      string
      string
      string

      The device identifier.

  • MinimumReportInterval
    MinimumReportInterval
    MinimumReportInterval
    MinimumReportInterval

    Gets the minimum report interval supported by the inclinometer.

    public uint MinimumReportInterval { get; }public uint MinimumReportInterval { get; }Public ReadOnly Property MinimumReportInterval As uint

    Property Value

    • uint
      uint
      uint
      uint

      The minimum ReportInterval supported by the sensor.

  • ReadingTransform
    ReadingTransform
    ReadingTransform
    ReadingTransform

    Gets or sets the transformation that needs to be applied to sensor data. Transformations to be applied are tied to the display orientation with which to align the sensor data.

    public DisplayOrientations ReadingTransform { get; set; }public DisplayOrientations ReadingTransform { get; set; }Public ReadWrite Property ReadingTransform As DisplayOrientations

    Property Value

  • ReadingType
    ReadingType
    ReadingType
    ReadingType

    Gets the sensor reading type.

    public SensorReadingType ReadingType { get; }public SensorReadingType ReadingType { get; }Public ReadOnly Property ReadingType As SensorReadingType

    Property Value

  • ReportInterval
    ReportInterval
    ReportInterval
    ReportInterval

    Gets or sets the current report interval for the inclinometer.

    public uint ReportInterval { get; set; }public uint ReportInterval { get; set; }Public ReadWrite Property ReportInterval As uint

    Property Value

    • uint
      uint
      uint
      uint

      The current report interval.

    Remarks

    The report interval is specified in milliseconds.

    The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app does not want to use this default value, you should set the report interval to a non-zero value prior to registering an event handler or calling GetCurrentReading(). The sensor will then attempt to allocate resources to satisfy the application’s requirements but the sensor also has to balance the needs of other apps using the sensor.

    Changes to the report interval after an event handler has been registered or GetCurrentReading() has been called may apply to the delivery of subsequent sensor readings.

    Conversely, when an application is finished with the sensor, it should explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection.

    The application should consult the MinimumReportInterval property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results.

    Although the application can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller.

    Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic.

    The Sensor platform automatically sets the change sensitivity for inclinometers based on the current report interval. This table specifies the change sensitivity values for given intervals.

    Current report interval (specified in milliseconds)Change sensitivity (specified in degrees)
    1 ms – 16 ms0.01 degreees
    17 ms – 32 ms0.5 degrees
    >= 33 ms2 degrees

Methods

  • GetCurrentReading()
    GetCurrentReading()
    GetCurrentReading()
    GetCurrentReading()

    Gets the current inclinometer reading.

    public InclinometerReading GetCurrentReading()public InclinometerReading GetCurrentReading()Public Function GetCurrentReading() As InclinometerReading

    Returns

    Remarks

    An application may use this method to poll the sensor for the current reading as an alternative to registering a ReadingChanged event handler. This would be the preferred alternative for an application that updates its user interface at a specific frame rate. Whether polling once or many times, the application must establish a desired ReportInterval. This informs the sensor driver that resources should be allocated to satisfy subsequent polling requests

    Before using the return value from this method, the application must first check that the value is not null. (If the value is null and you attempt to retrieve it, Windows will generate an exception.)

    The following example demonstrates how a Windows Store app built with XAML and C# retrieves the current reading for the default inclinometer.

    private void DisplayCurrentReading(object sender, object args)
    {
        InclinometerReading reading = _inclinometer.GetCurrentReading();
        if (reading != null)
        {
            ScenarioOutput_X.Text = String.Format("{0,5:0.00}", reading.PitchDegrees);
            ScenarioOutput_Y.Text = String.Format("{0,5:0.00}", reading.RollDegrees);
            ScenarioOutput_Z.Text = String.Format("{0,5:0.00}", reading.YawDegrees);
        }
    }
    

    The following example demonstrates how a Windows Store app built for Windows using JavaScript retrieves the current reading for the default inclinometer.

    function getCurrentReading() {
        var reading = inclinometer.getCurrentReading();
        if (reading) {
            document.getElementById("readingOutputX").innerHTML = reading.pitchDegrees.toFixed(2);
            document.getElementById("readingOutputY").innerHTML = reading.rollDegrees.toFixed(2);
            document.getElementById("readingOutputZ").innerHTML = reading.yawDegrees.toFixed(2);
        }
    }
    
  • GetDefault()
    GetDefault()
    GetDefault()
    GetDefault()

    Returns the default inclinometer.

    public static Inclinometer GetDefault()public static Inclinometer GetDefault()Public Static Function GetDefault() As Inclinometer

    Returns

    Remarks

    This method only returns values for hardware that has been integrated into the computer by the manufacturer. (The inclinometer readings are derived from multiple sensors.) A null value will be returned if the specified sensor is not available in the system.

    When a system is in Connected Standby, a call to the GetDefault(Windows.Devices.Sensors.SensorReadingType) method will return immediately with a null result.

    The following example demonstrates how a Windows Store app built with XAML and C# used this method to establish a connection to the default inclinometer.

    _inclinometer = Inclinometer.GetDefault();
    

    The following example demonstrates how a Windows Store app built for Windows using JavaScript used this method to establish a connection to the default inclinometer.

    inclinometer = Windows.Devices.Sensors.Inclinometer.getDefault();
    
  • GetDefault(Windows.Devices.Sensors.SensorReadingType)
    GetDefault(Windows.Devices.Sensors.SensorReadingType)
    GetDefault(Windows.Devices.Sensors.SensorReadingType)
    GetDefault(Windows.Devices.Sensors.SensorReadingType)

    Returns the default inclinometer based on the SensorReadingType.

    public static Inclinometer GetDefault(Windows.Devices.Sensors.SensorReadingType sensorReadingtype)public static Inclinometer GetDefault(Windows.Devices.Sensors.SensorReadingType sensorReadingtype)Public Static Function GetDefault(sensorReadingtype As Windows.Devices.Sensors.SensorReadingType) As Inclinometer

    Parameters

    Returns

    Remarks

    This method only returns values for hardware that has been integrated into the computer by the manufacturer. (The inclinometer readings are derived from multiple sensors.) A null value will be returned if the specified sensor is not available in the system.

    When a system is in Connected Standby, a call to the GetDefault(Windows.Devices.Sensors.SensorReadingType) method will return immediately with a null result.

  • GetDefaultForRelativeReadings()
    GetDefaultForRelativeReadings()
    GetDefaultForRelativeReadings()
    GetDefaultForRelativeReadings()

    Returns the default inclinometer.

    public static Inclinometer GetDefaultForRelativeReadings()public static Inclinometer GetDefaultForRelativeReadings()Public Static Function GetDefaultForRelativeReadings() As Inclinometer

    Returns

Events

  • ReadingChanged
    ReadingChanged
    ReadingChanged
    ReadingChanged

    Occurs each time the inclinometer reports a new sensor reading.

    public event TypedEventHandler ReadingChangedpublic event TypedEventHandler ReadingChangedPublic Event ReadingChanged

    Remarks

    Applications can set the frequency of this event by setting the ReportInterval property.

    The following example demonstrates how a Windows Store app built with C# and XAML registered its ReadingChanged event handler.

    private void ScenarioEnable(object sender, RoutedEventArgs e)
    {
        if (_inclinometer != null)
        {
            // Establish the report interval
            _inclinometer.ReportInterval = _desiredReportInterval;
    
            Window.Current.VisibilityChanged += new WindowVisibilityChangedEventHandler(VisibilityChanged);
            _inclinometer.ReadingChanged += new TypedEventHandler<Inclinometer, InclinometerReadingChangedEventArgs>(ReadingChanged);
    
            ScenarioEnableButton.IsEnabled = false;
            ScenarioDisableButton.IsEnabled = true;
        }
        else
        {
            rootPage.NotifyUser("No inclinometer found", NotifyType.StatusMessage);
        }
    }
    

    The following example shows the ReadingChanged event handler.

    async private void ReadingChanged(object sender, InclinometerReadingChangedEventArgs e)
    {
        await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () =>
        {
            InclinometerReading reading = e.Reading;
            ScenarioOutput_X.Text = String.Format("{0,5:0.00}", reading.PitchDegrees);
            ScenarioOutput_Y.Text = String.Format("{0,5:0.00}", reading.RollDegrees);
            ScenarioOutput_Z.Text = String.Format("{0,5:0.00}", reading.YawDegrees);
        });
    }
    

    The following example demonstrates how a Windows Store app built with JavaScript registers its ReadingChanged event handler.

    function enableReadingChangedScenario() {
        if (inclinometer) {
            // Set the reportInterval to enable the sensor events
            inclinometer.reportInterval = reportInterval;
    
            document.addEventListener("msvisibilitychange", msVisibilityChangeHandler, false);
            inclinometer.addEventListener("readingchanged", onDataChanged);
            document.getElementById("scenario1Open").disabled = true;
            document.getElementById("scenario1Revoke").disabled = false;
        } else {
            WinJS.log && WinJS.log("No inclinometer found", "sample", "error");
        }
    }
    

    The following example shows the ReadingChanged event handler.

    function onDataChanged(e) {
        var reading = e.reading;
    
        document.getElementById("eventOutputX").innerHTML = reading.pitchDegrees.toFixed(2);
        document.getElementById("eventOutputY").innerHTML = reading.rollDegrees.toFixed(2);
        document.getElementById("eventOutputZ").innerHTML = reading.yawDegrees.toFixed(2);
    }
    

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.StaticAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.StaticAttribute
Windows.Foundation.Metadata.ThreadingAttribute
Windows.Foundation.Metadata.DualApiPartitionAttribute
Windows.Foundation.Metadata.StaticAttribute

Details

Assembly

Windows.Devices.Sensors.dll