Meadow.Foundation.Sensors.Motion.Hmc5883 1.8.0.8-beta

This is a prerelease version of Meadow.Foundation.Sensors.Motion.Hmc5883.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Meadow.Foundation.Sensors.Motion.Hmc5883 --version 1.8.0.8-beta                
NuGet\Install-Package Meadow.Foundation.Sensors.Motion.Hmc5883 -Version 1.8.0.8-beta                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Meadow.Foundation.Sensors.Motion.Hmc5883" Version="1.8.0.8-beta" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Meadow.Foundation.Sensors.Motion.Hmc5883 --version 1.8.0.8-beta                
#r "nuget: Meadow.Foundation.Sensors.Motion.Hmc5883, 1.8.0.8-beta"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Meadow.Foundation.Sensors.Motion.Hmc5883 as a Cake Addin
#addin nuget:?package=Meadow.Foundation.Sensors.Motion.Hmc5883&version=1.8.0.8-beta&prerelease

// Install Meadow.Foundation.Sensors.Motion.Hmc5883 as a Cake Tool
#tool nuget:?package=Meadow.Foundation.Sensors.Motion.Hmc5883&version=1.8.0.8-beta&prerelease                

Meadow.Foundation.Sensors.Motion.Hmc5883

Hmc5883 / Qmc5883 I2C digital compass

The Hmc5883 library is designed for the Wilderness Labs Meadow .NET IoT platform and is part of Meadow.Foundation.

The Meadow.Foundation peripherals library is an open-source repository of drivers and libraries that streamline and simplify adding hardware to your C# .NET Meadow IoT application.

For more information on developing for Meadow, visit developer.wildernesslabs.co.

To view all Wilderness Labs open-source projects, including samples, visit github.com/wildernesslabs.

Usage

Hmc5883 sensor;

public override Task Initialize()
{
    Resolver.Log.Info("Initialize...");

    sensor = new Hmc5883(Device.CreateI2cBus());

    // classical .NET events can also be used:
    sensor.Updated += (sender, result) =>
    {
        Resolver.Log.Info($"Direction: [X:{result.New.X:N2}," +
            $"Y:{result.New.Y:N2}," +
            $"Z:{result.New.Z:N2}]");

        Resolver.Log.Info($"Heading: [{Hmc5883.DirectionToHeading(result.New).DecimalDegrees:N2}] degrees");
    };

    // Example that uses an IObservable subscription to only be notified when the filter is satisfied
    var consumer = Hmc5883.CreateObserver(
        handler: result => Resolver.Log.Info($"Observer: [x] changed by threshold; new [x]: X:{Hmc5883.DirectionToHeading(result.New):N2}," +
                $" old: X:{((result.Old != null) ? Hmc5883.DirectionToHeading(result.Old.Value) : "n/a"):N2} degrees"),
        // only notify if there's a greater than 5° of heading change
        filter: result =>
        {
            if (result.Old is { } old)
            {
                return (Hmc5883.DirectionToHeading(result.New - old) > new Azimuth(5));
            }
            return false;
        });

    sensor.Subscribe(consumer);

    return Task.CompletedTask;
}

public async override Task Run()
{
    var result = await sensor.Read();
    Resolver.Log.Info("Initial Readings:");
    Resolver.Log.Info($"Direction: [X:{result.X:N2}," +
        $"Y:{result.Y:N2}," +
        $"Z:{result.Z:N2}]");

    Resolver.Log.Info($"Heading: [{Hmc5883.DirectionToHeading(result).DecimalDegrees:N2}] degrees");

    sensor.StartUpdating(TimeSpan.FromMilliseconds(1000));
}

How to Contribute

Need Help?

If you have questions or need assistance, please join the Wilderness Labs community on Slack.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Meadow.Foundation.Sensors.Motion.Hmc5883:

Package Downloads
Meadow.Foundation.Grove.Sensors.Motion.3-AxisDigitalCompass

Grove I2C 3-axis digital compass

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.15.0.6-beta 0 11/20/2024
1.15.0.5-beta 22 11/19/2024
1.15.0.4-beta 60 11/16/2024
1.15.0.3-beta 81 11/4/2024
1.15.0.2-beta 74 10/29/2024
1.15.0.1-beta 83 10/22/2024
1.15.0 101 10/15/2024
1.14.0.6-beta 93 10/8/2024
1.14.0.5-beta 87 10/2/2024
1.14.0.4-beta 86 9/24/2024
1.14.0.3-beta 117 9/17/2024
1.14.0.2-beta 123 9/12/2024
1.14.0.1-beta 118 9/10/2024
1.14.0 131 9/5/2024
1.13.0.1-beta 139 8/21/2024
1.13.0 161 8/15/2024
1.12.8.7-beta 130 8/14/2024
1.12.8.6-beta 97 8/6/2024
1.12.8.5-beta 83 7/30/2024
1.12.8.4-beta 93 7/30/2024
1.12.8.2-beta 96 7/24/2024
1.12.8.1-beta 130 7/17/2024
1.12.8 159 7/11/2024
1.12.2.9-beta 109 7/9/2024
1.12.2.7-beta 126 7/3/2024
1.12.2.6-beta 123 6/29/2024
1.12.2.5-beta 131 6/28/2024
1.12.2.4-beta 111 6/24/2024
1.12.2.3-beta 117 6/24/2024
1.12.2.1-beta 125 6/19/2024
1.12.2 126 6/11/2024
1.12.0.2-beta 96 6/4/2024
1.12.0.1-beta 99 5/30/2024
1.12.0 160 5/28/2024
1.11.0.5-beta 123 5/24/2024
1.11.0.4-beta 126 5/21/2024
1.11.0.3-beta 138 5/15/2024
1.11.0.2-beta 103 5/9/2024
1.11.0.1-beta 106 5/8/2024
1.11.0 207 4/30/2024
1.10.2.1-beta 128 4/23/2024
1.10.2 161 4/17/2024
1.10.0.3-beta 145 4/15/2024
1.10.0.2-beta 137 4/11/2024
1.10.0.1-beta 132 4/5/2024
1.10.0 166 3/26/2024
1.9.0.6-beta 134 3/25/2024
1.9.0.5-beta 139 3/19/2024
1.9.0.4-beta 111 3/13/2024
1.9.0.3 158 3/6/2024
1.9.0.2-beta 118 3/6/2024
1.9.0.1 159 3/1/2024
1.9.0 293 2/27/2024
1.8.0.8-beta 119 2/23/2024
1.8.0.7-beta 115 2/22/2024
1.8.0.6-beta 124 2/20/2024
1.8.0.5-beta 125 2/13/2024
1.8.0.4-beta 143 2/6/2024
1.8.0.3-beta 122 2/1/2024
1.8.0.2-beta 134 1/24/2024
1.8.0.1 159 1/20/2024
1.8.0 429 1/16/2024
1.7.0 165 1/9/2024
1.6.0.6-beta 149 1/3/2024
1.6.0.5-beta 132 12/27/2023
1.6.0.4-beta 175 12/20/2023
1.6.0.3-beta 126 12/19/2023
1.6.0.2-beta 184 12/12/2023
1.6.0 369 12/6/2023
1.5.0.1-beta 159 12/4/2023
1.5.0 181 11/28/2023
1.4.0.9-beta 149 11/28/2023
1.4.0.8-beta 132 11/27/2023
1.4.0.7-beta 143 11/8/2023
1.4.0.6-beta 130 11/7/2023
1.4.0.4-beta 112 11/1/2023
1.4.0.3 221 10/31/2023
1.3.4.10-beta 168 10/25/2023
1.3.4.9-beta 134 10/24/2023
1.3.4.8-beta 128 10/17/2023
1.3.4.7-beta 146 10/10/2023
1.3.4.6-beta 149 10/5/2023
1.3.4.5-beta 132 10/4/2023
1.3.4.4-beta 148 10/3/2023
1.3.4.3-beta 140 10/3/2023
1.3.4.2-beta 141 9/30/2023
1.3.4.1-beta 135 9/30/2023
1.3.4 217 9/26/2023
1.3.2.5-beta 141 9/21/2023
1.3.2.4-beta 126 9/20/2023
1.3.2.3-beta 122 9/19/2023
1.3.2.2-beta 120 9/15/2023
1.3.2.1-beta 138 9/14/2023
1.3.2-beta 138 9/13/2023
1.3.1.1-beta 145 9/5/2023
1.3.0 270 8/29/2023
1.2.1.11-beta 154 8/24/2023
1.2.1.9-beta 145 8/17/2023
1.2.1.8-beta 167 8/8/2023
1.2.1.6-beta 149 8/4/2023
1.2.0 226 8/1/2023
1.1.1.11-beta 169 7/24/2023
1.1.1.10-beta 165 7/22/2023
1.1.1.9-beta 158 7/22/2023
1.1.1.8-beta 157 7/21/2023
1.1.0 199 7/11/2023
1.0.2.1 170 6/3/2023
1.0.2 184 6/3/2023
1.0.0.1 188 5/30/2023
1.0.0 221 5/28/2023
0.99.0 600 5/28/2023
0.98.2-alpha 161 5/27/2023
0.98.0 265 5/6/2023
0.96.0 311 4/2/2023
0.95.0 367 3/5/2023
0.94.2 384 2/7/2023
0.94.1 425 2/2/2023
0.92.5 456 12/31/2022
0.90.0 861 11/23/2022
0.89.2 348 11/23/2022
0.1.21 356 11/21/2022
0.1.20 648 10/24/2022
0.1.17 669 5/30/2022
0.1.11 466 3/7/2022