Interface AntPlusCommonPcc.IBatteryStatusReceiver
- Enclosing class:
- AntPlusCommonPcc
public static interface AntPlusCommonPcc.IBatteryStatusReceiver
Receiver for the BatteryStatus event, which is:
Information about the battery status and operating time.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
onNewBatteryStatus
(long estTimestamp, EnumSet<EventFlag> eventFlags, long cumulativeOperatingTime, BigDecimal batteryVoltage, BatteryStatus batteryStatus, int cumulativeOperatingTimeResolution, int numberOfBatteries, int batteryIdentifier) Receives the data from a BatteryStatus event.
-
Method Details
-
onNewBatteryStatus
void onNewBatteryStatus(long estTimestamp, EnumSet<EventFlag> eventFlags, long cumulativeOperatingTime, BigDecimal batteryVoltage, BatteryStatus batteryStatus, int cumulativeOperatingTimeResolution, int numberOfBatteries, int batteryIdentifier) Receives the data from a BatteryStatus event.- Parameters:
estTimestamp
- The estimated timestamp of when this event was triggered. Useful for correlating multiple events and determining when data was sent for more accurate time records.eventFlags
- Informational flags about the event.cumulativeOperatingTime
- The cumulative operating time since the battery was inserted. Units: seconds (resolution indicated by cumulativeOperatingTimeResolution]). Rollover: Every 16777215s*resolution. ie:~1.1yrs at 2s resolution, ~8.5yrs at 16s resolution.batteryVoltage
- Current battery voltage. Invalid = -1. Units: Volts (with 1/256V resolution).batteryStatus
- The current reportedBatteryStatus
.cumulativeOperatingTimeResolution
- The resolution accuracy of the cumulativeOperatingTime. Units: seconds.numberOfBatteries
- Specifies how many batteries are available in the system. Invalid = -1. Unsupported, requires upgrade to ANT+ Plugin Service Version 2.3.0 or newer = -2. @since 2.1.7; requires Plugin Service 2.2.8+batteryIdentifier
- Identifies the battery in system to which this battery status pertains. Invalid = -1. Unsupported, requires upgrade to ANT+ Plugin Service Version 2.3.0 or newer = -2. @since 2.1.7; requires Plugin Service 2.2.8+
-