Package com.diozero.devices
Class GarminLidarLiteV4.Status
- java.lang.Object
-
- com.diozero.devices.GarminLidarLiteV4.Status
-
- Enclosing class:
- GarminLidarLiteV4
public static class GarminLidarLiteV4.Status extends Object
-
-
Field Summary
Fields Modifier and Type Field Description static byte
BUSY_BIT
1: Device is busy taking a measurement or powering onstatic byte
DC_BIAS_DONE_BIT
1: noise is within tolerancestatic byte
DC_ERROR_BIT
1: Error detectedstatic byte
LOW_POWER_BIT
1: device is in low power modestatic byte
REFDATA_OVERFLOW_BIT
1: Reference data in correlation record has reached the maximum value before overflowstatic byte
SIGNAL_OVERFLOW_BIT
1: Signal data in correlation record has reached the maximum value before overflow
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description byte
getValue()
boolean
isDataCorrelationNoiseBiasDone()
Data correlation noise bias status.boolean
isDataCorrelationNoiseBiasError()
Data correlation noise bias error flag.boolean
isDeviceBusy()
Device busy status.boolean
isInLowerPowerMode()
Low power flag.boolean
isReferenceDataOverflow()
Reference overflow flag.boolean
isSignalOverflow()
Signal overflow flag.
-
-
-
Field Detail
-
BUSY_BIT
public static final byte BUSY_BIT
1: Device is busy taking a measurement or powering on- See Also:
- Constant Field Values
-
SIGNAL_OVERFLOW_BIT
public static final byte SIGNAL_OVERFLOW_BIT
1: Signal data in correlation record has reached the maximum value before overflow- See Also:
- Constant Field Values
-
REFDATA_OVERFLOW_BIT
public static final byte REFDATA_OVERFLOW_BIT
1: Reference data in correlation record has reached the maximum value before overflow- See Also:
- Constant Field Values
-
LOW_POWER_BIT
public static final byte LOW_POWER_BIT
1: device is in low power mode- See Also:
- Constant Field Values
-
DC_BIAS_DONE_BIT
public static final byte DC_BIAS_DONE_BIT
1: noise is within tolerance- See Also:
- Constant Field Values
-
DC_ERROR_BIT
public static final byte DC_ERROR_BIT
1: Error detected- See Also:
- Constant Field Values
-
-
Method Detail
-
getValue
public byte getValue()
-
isDeviceBusy
public boolean isDeviceBusy()
Device busy status.- Returns:
- true if the device is busy taking a measurement or powering on
-
isSignalOverflow
public boolean isSignalOverflow()
Signal overflow flag.- Returns:
- true if the signal data in correlation record has reached the maximum value before overflow (this occurs with a strong received signal strength)
-
isReferenceDataOverflow
public boolean isReferenceDataOverflow()
Reference overflow flag.- Returns:
- reue if reference data in correlation record has reached the maximum value before overflow (this occurs when taking measurements with biasing enabled)
-
isInLowerPowerMode
public boolean isInLowerPowerMode()
Low power flag.- 0
- Device is powered on. I2C commands can be issued at a normal rate.
- 1
- The device is in low power mode. To allow the device to power on and perform the I2C command, a 10ms delay after each command is recommended.
- Returns:
- true if the device is in low power mode
-
isDataCorrelationNoiseBiasDone
public boolean isDataCorrelationNoiseBiasDone()
Data correlation noise bias status.- false
- The device is performing automatic DC noise bias corrections.
- true
- DC noise is within tolerance, and the automatic DC noise bias corrections are currently idle.
- Returns:
- the data correlation noise bias status
-
isDataCorrelationNoiseBiasError
public boolean isDataCorrelationNoiseBiasError()
Data correlation noise bias error flag.- Returns:
- true if an error was detected in correcting DC noise bias, and distance measurements are expected to be inaccurate
-
-