Meadow.Foundation.Sensors.Motion.Hmc5883 1.11.0

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Meadow.Foundation.Sensors.Motion.Hmc5883 --version 1.11.0
NuGet\Install-Package Meadow.Foundation.Sensors.Motion.Hmc5883 -Version 1.11.0
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.11.0" />
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.11.0
#r "nuget: Meadow.Foundation.Sensors.Motion.Hmc5883, 1.11.0"
#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.11.0

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

Meadow.Foundation.Sensors.Motion.Hmc5883

Hmc5883 / Qmc5883 I2C digital compass

The Hmc5883 library is included in the Meadow.Foundation.Sensors.Motion.Hmc5883 nuget package and is designed for the Wilderness Labs Meadow .NET IoT platform.

This driver is part of the Meadow.Foundation peripherals library, an open-source repository of drivers and libraries that streamline and simplify adding hardware to your C# .NET Meadow IoT applications.

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.

Installation

You can install the library from within Visual studio using the the NuGet Package Manager or from the command line using the .NET CLI:

dotnet add package Meadow.Foundation.Sensors.Motion.Hmc5883

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.

About Meadow

Meadow is a complete, IoT platform with defense-grade security that runs full .NET applications on embeddable microcontrollers and Linux single-board computers including Raspberry Pi and NVIDIA Jetson.

Build

Use the full .NET platform and tooling such as Visual Studio and plug-and-play hardware drivers to painlessly build IoT solutions.

Connect

Utilize native support for WiFi, Ethernet, and Cellular connectivity to send sensor data to the Cloud and remotely control your peripherals.

Deploy

Instantly deploy and manage your fleet in the cloud for OtA, health-monitoring, logs, command + control, and enterprise backend integrations.

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.11.0.4-beta 83 5/21/2024
1.11.0.3-beta 89 5/15/2024
1.11.0.2-beta 61 5/9/2024
1.11.0.1-beta 64 5/8/2024
1.11.0 133 4/30/2024
1.10.2.1-beta 92 4/23/2024
1.10.2 112 4/17/2024
1.10.0.3-beta 84 4/15/2024
1.10.0.2-beta 83 4/11/2024
1.10.0.1-beta 61 4/5/2024
1.10.0 128 3/26/2024
1.9.0.6-beta 64 3/25/2024
1.9.0.5-beta 79 3/19/2024
1.9.0.4-beta 61 3/13/2024
1.9.0.3 118 3/6/2024
1.9.0.2-beta 87 3/6/2024
1.9.0.1 116 3/1/2024
1.9.0 260 2/27/2024
1.8.0.8-beta 57 2/23/2024
1.8.0.7-beta 71 2/22/2024
1.8.0.6-beta 70 2/20/2024
1.8.0.5-beta 78 2/13/2024
1.8.0.4-beta 82 2/6/2024
1.8.0.3-beta 65 2/1/2024
1.8.0.2-beta 68 1/24/2024
1.8.0.1 121 1/20/2024
1.8.0 385 1/16/2024
1.7.0 140 1/9/2024
1.6.0.6-beta 94 1/3/2024
1.6.0.5-beta 75 12/27/2023
1.6.0.4-beta 85 12/20/2023
1.6.0.3-beta 66 12/19/2023
1.6.0.2-beta 97 12/12/2023
1.6.0 312 12/6/2023
1.5.0.1-beta 110 12/4/2023
1.5.0 156 11/28/2023
1.4.0.9-beta 97 11/28/2023
1.4.0.8-beta 95 11/27/2023
1.4.0.7-beta 96 11/8/2023
1.4.0.6-beta 92 11/7/2023
1.4.0.4-beta 90 11/1/2023
1.4.0.3 182 10/31/2023
1.3.4.10-beta 110 10/25/2023
1.3.4.9-beta 99 10/24/2023
1.3.4.8-beta 89 10/17/2023
1.3.4.7-beta 98 10/10/2023
1.3.4.6-beta 114 10/5/2023
1.3.4.5-beta 100 10/4/2023
1.3.4.4-beta 106 10/3/2023
1.3.4.3-beta 103 10/3/2023
1.3.4.2-beta 108 9/30/2023
1.3.4.1-beta 98 9/30/2023
1.3.4 186 9/26/2023
1.3.2.5-beta 107 9/21/2023
1.3.2.4-beta 92 9/20/2023
1.3.2.3-beta 92 9/19/2023
1.3.2.2-beta 95 9/15/2023
1.3.2.1-beta 102 9/14/2023
1.3.2-beta 100 9/13/2023
1.3.1.1-beta 106 9/5/2023
1.3.0 230 8/29/2023
1.2.1.11-beta 121 8/24/2023
1.2.1.9-beta 116 8/17/2023
1.2.1.8-beta 140 8/8/2023
1.2.1.6-beta 115 8/4/2023
1.2.0 200 8/1/2023
1.1.1.11-beta 136 7/24/2023
1.1.1.10-beta 137 7/22/2023
1.1.1.9-beta 129 7/22/2023
1.1.1.8-beta 128 7/21/2023
1.1.0 166 7/11/2023
1.0.2.1 145 6/3/2023
1.0.2 151 6/3/2023
1.0.0.1 155 5/30/2023
1.0.0 176 5/28/2023
0.99.0 470 5/28/2023
0.98.2-alpha 130 5/27/2023
0.98.0 217 5/6/2023
0.96.0 269 4/2/2023
0.95.0 318 3/5/2023
0.94.2 342 2/7/2023
0.94.1 380 2/2/2023
0.92.5 415 12/31/2022
0.90.0 806 11/23/2022
0.89.2 333 11/23/2022
0.1.21 320 11/21/2022
0.1.20 604 10/24/2022
0.1.17 622 5/30/2022
0.1.11 429 3/7/2022