nanoFramework.Iot.Device.Hmc5883l 1.1.3

Prefix Reserved
.NET Framework This package is compatible with all versions of .NET Framework.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package nanoFramework.Iot.Device.Hmc5883l --version 1.1.3
                    


                    

                
NuGet\Install-Package nanoFramework.Iot.Device.Hmc5883l -Version 1.1.3
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="nanoFramework.Iot.Device.Hmc5883l" Version="1.1.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="nanoFramework.Iot.Device.Hmc5883l" Version="1.1.3" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="nanoFramework.Iot.Device.Hmc5883l" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add nanoFramework.Iot.Device.Hmc5883l --version 1.1.3
                    


                    

                
#r "nuget: nanoFramework.Iot.Device.Hmc5883l, 1.1.3"
#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. 
#addin nuget:?package=nanoFramework.Iot.Device.Hmc5883l&version=1.1.3
                    


                            Install nanoFramework.Iot.Device.Hmc5883l as a Cake Addin
                        

                    

                
#tool nuget:?package=nanoFramework.Iot.Device.Hmc5883l&version=1.1.3
                    


                            Install nanoFramework.Iot.Device.Hmc5883l as a Cake Tool

HMC5883L - 3 Axis Digital Compass

HMC5883L is a surface-mount, multi-chip module designed for low-field magnetic sensing with a digital interface for applications such as lowcost compassing and magnetometry.

Documentation

sensor

Usage

Important: make sure you properly setup the I2C pins especially for ESP32 before creating the I2cDevice, make sure you install the nanoFramework.Hardware.ESP32 nuget:

//////////////////////////////////////////////////////////////////////
// when connecting to an ESP32 device, need to configure the I2C GPIOs
// used for the bus
Configuration.SetPinFunction(21, DeviceFunction.I2C1_DATA);
Configuration.SetPinFunction(22, DeviceFunction.I2C1_CLOCK);

For other devices like STM32, please make sure you're using the preset pins for the I2C bus you want to use.

I2cConnectionSettings settings = new I2cConnectionSettings(1, Hmc5883l.DefaultI2cAddress);
I2cDevice device = I2cDevice.Create(settings);

using (Hmc5883l sensor = new Hmc5883l(device))
{
    // read direction vector
    Vector3 directionVector = sensor.DirectionVector;
    // read heading
    double heading = sensor.Heading;
    // read status
    Status status = sensor.DeviceStatus;
}

From the HMC5883L sample, you can go further with the following:

I2cConnectionSettings settings = new I2cConnectionSettings(1, Hmc5883l.DefaultI2cAddress);
I2cDevice device = I2cDevice.Create(settings);

using (Hmc5883l sensor = new Hmc5883l(device))
{
    while (true)
    {
        // read heading
        Debug.WriteLine($"Heading: {sensor.Heading.ToString("0.00")} °");
        Debug.WriteLine();

        // wait for a second
        Thread.Sleep(1000);
    }
}

Hardware Required

  • HMC5883L
  • Male/Female Jumper Wires

Circuit

circuit

  • SCL - SCL
  • SDA - SDA
  • VCC - 5V
  • GND - GND

Result

running result

Product Compatible and additional computed target framework versions.
.NET Framework net is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.869 171 4/2/2025
1.2.864 154 4/2/2025
1.2.852 174 3/11/2025
1.2.822 118 2/26/2025
1.2.775 124 2/4/2025
1.2.772 105 2/4/2025
1.2.755 115 1/31/2025
1.2.737 98 1/13/2025
1.2.704 118 12/18/2024
1.2.696 115 12/16/2024
1.2.673 117 10/23/2024
1.2.631 116 8/28/2024
1.2.590 122 7/17/2024
1.2.570 123 6/14/2024
1.2.436 279 11/10/2023
1.2.416 119 11/8/2023
1.2.329 219 5/26/2023
1.2.313 180 5/12/2023
1.2.297 184 5/3/2023
1.2.253 294 2/22/2023
1.2.222 328 1/9/2023
1.2.217 373 1/6/2023
1.2.212 329 1/5/2023
1.2.208 365 1/3/2023
1.2.203 353 12/28/2022
1.2.159 403 11/14/2022
1.2.153 390 11/5/2022
1.2.141 431 10/25/2022
1.2.128 423 10/22/2022
1.2.87 537 9/15/2022
1.2.82 538 9/14/2022
1.1.116.8772 507 6/24/2022
1.1.113.2032 476 6/23/2022
1.1.97.17326 504 6/13/2022
1.1.92.53000 466 6/8/2022
1.1.58.10097 481 5/23/2022
1.1.3 543 4/15/2022
1.1.1 492 4/14/2022
1.0.300 498 3/31/2022
1.0.288-preview.114 160 3/25/2022
1.0.288-preview.113 150 3/25/2022
1.0.288-preview.106 151 3/23/2022
1.0.288-preview.104 142 3/22/2022
1.0.288-preview.100 157 3/19/2022
1.0.288-preview.98 151 3/18/2022
1.0.288-preview.95 155 3/15/2022
1.0.288-preview.93 153 3/15/2022
1.0.288-preview.87 153 3/10/2022
1.0.288-preview.65 151 2/18/2022
1.0.288-preview.48 168 2/4/2022
1.0.288-preview.41 170 1/31/2022
1.0.288-preview.29 167 1/28/2022
1.0.288-preview.20 170 1/27/2022
1.0.288-preview.1 171 1/21/2022
1.0.259 374 12/9/2021
1.0.155 362 8/31/2021
1.0.130 206 7/6/2021
1.0.129 204 7/6/2021
1.0.125 235 7/5/2021
1.0.121 243 6/29/2021
1.0.119 276 6/28/2021
1.0.32 214 5/24/2021