Status.cs

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System;

namespace Iot.Device.Hmc5883l
{
    /// <summary>
    /// The status of HMC5883L device
    /// </summary>
    [Flags]
    public enum Status : byte
    {
        /// <summary>
        /// Ready Bit. Set when data is written to all six data registers. Cleared when device initiates a write to the data output
        /// registers, when in off mode, and after one or more of the data output registers are written to.
        /// When RDY bit is clear it shall remain cleared for a minimum of a 250 μs.
        /// </summary>
        Ready = 0b_0000_0001,

        /// <summary>
        /// Data output register lock. This bit is set when some but not all for of the six data output registers have been read.
        /// When this bit is set, the six data output registers are locked and any new data will not be placed in these register until
        /// one of four conditions are met: all six have been read or the mode changed, a POR is issued, the mode is changed, the measurement is changed.
        /// </summary>
        Lock = 0b_0000_0010,

        /// <summary>
        /// Regulator Enabled Bit. This bit is set when the internal voltage regulator is enabled.
        /// This bit is cleared when the internal regulator is disabled.
        /// </summary>
        RegulatorEnabled = 0b_0000_0100
    }
}