Back to the list of classes

Hardware Battery

PATROL Class: MS_HW_BATTERY - Monitor Type: MONITOR - Monitor Category: System
No CDM Class defined.

Monitors a specific battery.

Attributes (Parameters)

Name PATROL Name Units Default Thresholds Description
Charge Charge %

 ALARM
if ∈ [0 %, 30 %]

 WARN
if ∈ [30 %, 50 %]

Percentage of the battery charge.

Value set by batteryColl.

Type: Statistics - Default graph
Present Present 0 = Missing
1 = Present

 ALARM
if = 0 (Missing)

Indicates whether the battery is found or not.

Value set by batteryColl.

Type: Availability
Status Status 0 = OK
1 = Degraded
2 = Failed

 WARN
if = 1 (Degraded)

 ALARM
if = 2 (Failed)

Battery status.

Value set by batteryColl.

Type: Availability - Default graph
Status Information StatusInformation None None

Additional (textual) information about the current status of the battery.

Value set by batteryColl.

Type: Text

Infoboxes (PATROL Console Only)

Name Description
PATROL ID PATROL internal identifier for the battery instance.
Battery Information ......................................................................................................................................................................................................................................
Manufacturer Name of the battery manufacturer.
Model Details about the model of the battery.
Type Details about the type of the battery.
Chemistry Chemistry type contained in the battery.
Device ID ID of the monitored battery as communicated by the instrumentation layer.
Identifying Information Any additional information available for the battery.
Connector Information ......................................................................................................................................................................................................................................
Connector Display Name Display name of the connector currently used to monitor the battery.
Connector ID PATROL ID of the connector currently used to monitor the battery.
Connector File Name File name of the connector currently used to monitor the battery.
Connector Version Version number of the connector.
Connector Date Connector build date.
Menu Command Description
Instant Hardware Health Report Displays a text box recapitulating miscellaneous information regarding the monitored device (properties of the object, its parameters, thresholds, etc.).
Pause Monitoring Pauses the monitoring of the selected battery.
Resume Monitoring Resumes the monitoring of the selected battery.
Remove Removes the battery from the monitoring environment.
Refresh Parameters Refreshes all battery parameters.
Keywords:
hardware km patrol