public class BatteryStatusCommand extends AsciiSelfResponderCommandBase implements ICommandParameters
LibraryCommandId
Constructor and Description |
---|
BatteryStatusCommand()
Initializes a new instance of the BatteryStatusCommand class
|
Modifier and Type | Method and Description |
---|---|
protected void |
buildCommandLine(java.lang.StringBuilder line)
Builds the command line to send to the reader to execute the command
|
void |
clearLastResponse()
Clears the response ready to receive a new one
|
TriState |
getAsynchronousReportingEnabled()
Gets or sets a value indicating whether asynchronous battery status reports should be reported.
|
BatteryHealthData |
getBatteryHealthData()
Gets the battery health data
|
int |
getBatteryLevel()
Gets the battery level retrieved from the reader.
|
BatteryServiceData |
getBatteryServiceData()
Gets the battery service data
|
ChargeState |
getChargeStatus()
Gets the battery charging status from the reader.
|
TriState |
getReadBatteryData()
Gets or sets a value indicating whether the battery health & service data should be read
|
TriState |
getReadParameters()
Gets or sets a value indicating whether the command should include a list of supported parameters and their current values
|
TriState |
getResetParameters()
Gets or sets a value indicating whether the command should reset all its parameters to default values
|
TriState |
getTakeNoAction()
Gets or sets a value indicating whether the command primary action should not be performed
(e.g.
|
boolean |
implementsReadParameters()
Gets a value indicating whether the implementing command uses the ReadParameters property
|
boolean |
implementsResetParameters()
Gets a value indicating whether the implementing command uses the ResetParameters property
|
boolean |
implementsTakeNoAction()
Gets a value indicating whether the implementing command uses the TakeNoAction property
|
protected boolean |
processReceivedLine(java.lang.String fullLine,
java.lang.String header,
java.lang.String value,
boolean moreAvailable)
Each correctly terminated line from the device is passed to this method for processing
|
protected boolean |
responseDidReceiveParameter(java.lang.String parameter)
This method is called for each parameter in the parameters (PR:) list.
|
void |
setAsynchronousReportingEnabled(TriState value) |
void |
setReadBatteryData(TriState value) |
void |
setReadParameters(TriState value) |
void |
setResetParameters(TriState value) |
void |
setTakeNoAction(TriState value) |
static BatteryStatusCommand |
synchronousCommand()
Returns a new instance of the BatteryStatusCommand class that will execute synchronously (as its own responder)
|
getMaxSynchronousWaitTime, getSynchronousCommandResponder, setMaxSynchronousWaitTime, setSynchronousCommandResponder
captureNonLibraryResponses, setCaptureNonLibraryResponses
getCommandLine, getCommandName, getResponseLifecycleDelegate, getResponseStarted, isResponseFinished, parseParameters, processReceivedLine, responseDidFinish, responseDidStart, setCommandName, setResponseLifecycleDelegate, setResponseStarted, splitParameters
appendToMessages, appendToParameters, appendToResponse, getErrorCode, getMessages, getParameters, getResponse, isSuccessful, setErrorCode, setIsSuccessful, setResponse
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getCommandLine, getCommandName
public BatteryStatusCommand()
public final boolean implementsReadParameters()
implementsReadParameters
in interface ICommandParameters
public final boolean implementsResetParameters()
implementsResetParameters
in interface ICommandParameters
public final boolean implementsTakeNoAction()
implementsTakeNoAction
in interface ICommandParameters
public final TriState getReadParameters()
ICommandParameters
getReadParameters
in interface ICommandParameters
public final void setReadParameters(TriState value)
setReadParameters
in interface ICommandParameters
public final TriState getResetParameters()
ICommandParameters
getResetParameters
in interface ICommandParameters
public final void setResetParameters(TriState value)
setResetParameters
in interface ICommandParameters
public final TriState getTakeNoAction()
ICommandParameters
getTakeNoAction
in interface ICommandParameters
public final void setTakeNoAction(TriState value)
setTakeNoAction
in interface ICommandParameters
public final int getBatteryLevel()
public final ChargeState getChargeStatus()
public final TriState getReadBatteryData()
public final void setReadBatteryData(TriState value)
public final TriState getAsynchronousReportingEnabled()
public final void setAsynchronousReportingEnabled(TriState value)
public BatteryHealthData getBatteryHealthData()
public BatteryServiceData getBatteryServiceData()
public static BatteryStatusCommand synchronousCommand()
protected void buildCommandLine(java.lang.StringBuilder line)
buildCommandLine
in class AsciiSelfResponderCommandBase
line
- The command line to append to
When overriding this method call the base class to construct the command line as known to the base class and
then append the additional parameters to the end of the linepublic void clearLastResponse()
clearLastResponse
in interface IAsciiCommandResponder
clearLastResponse
in class AsciiCommandResponderBase
protected boolean responseDidReceiveParameter(java.lang.String parameter)
responseDidReceiveParameter
in class AsciiCommandResponderBase
parameter
- A single parameter extracted from the PR: response, excluding the '-' and trimmed of leading and trailing whitespaceprotected boolean processReceivedLine(java.lang.String fullLine, java.lang.String header, java.lang.String value, boolean moreAvailable) throws java.lang.Exception
processReceivedLine
in class AsciiCommandLibraryResponderBase
fullLine
- The line to be processedheader
- The response line header excluding the colon e.g. 'CS' for a command started responsevalue
- The response line following the colon e.g. '.iv'moreAvailable
- When true indicates there are additional lines to be processed (and will also be passed to this method)java.lang.Exception