io.github.robolib.module.sensor

Enum HMC5883L.OperatingMode

java.lang.Object

java.lang.Enum<HMC5883L.OperatingMode>

io.github.robolib.module.sensor.HMC5883L.OperatingMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HMC5883L.OperatingMode>

Enclosing class:

HMC5883L

public static enum HMC5883L.OperatingMode
extends java.lang.Enum<HMC5883L.OperatingMode>

Mode Select Bits. These bits select the operation mode of this device.

Author:

noriah

Enum Constant Summary

Enum Constants

Enum Constant and Description
kCONTINUOUS Continuous-Measurement Mode In continuous-measurement mode, the device continuously performs measurements and places the result in the data register.
kIDLE Idle Mode (Power Saving) Device is placed in idle mode.
kSINGLE Single-Measurement Mode (Default) When single-measurement mode is selected, device performs a single measurement, sets RDY high and returned to idle mode.
MODE_RES Reserved

Field Summary

Fields

Modifier and Type	Field and Description
byte	value

Method Summary

Modifier and Type	Method and Description
static HMC5883L.OperatingMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HMC5883L.OperatingMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

kCONTINUOUS

public static final HMC5883L.OperatingMode kCONTINUOUS

Continuous-Measurement Mode In continuous-measurement mode, the device continuously performs measurements and places the result in the data register. RDY goes high when new data is placed in all three registers. After a power-on or a write to the mode or configuration register, the first measurement set is available from all three data output registers after a period of 2/fDO and subsequent measurements are available at a frequency of fDO, where fDO is the frequency of data output.

kSINGLE

public static final HMC5883L.OperatingMode kSINGLE

Single-Measurement Mode (Default) When single-measurement mode is selected, device performs a single measurement, sets RDY high and returned to idle mode. Mode register returns to idle mode bit values. The measurement remains in the data output register and RDY remains high until the data output register is read or another measurement is performed.

kIDLE

public static final HMC5883L.OperatingMode kIDLE

Idle Mode (Power Saving) Device is placed in idle mode.

MODE_RES

public static final HMC5883L.OperatingMode MODE_RES

Reserved

Field Detail

value

public byte value

Method Detail

values

public static HMC5883L.OperatingMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HMC5883L.OperatingMode c : HMC5883L.OperatingMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HMC5883L.OperatingMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null