Contents
Display Legacy Contents

 Print
    Get Battery Status    
Gets the values of battery from the terminal device.

Parameters

Battery


AC Power Status <unquoted string>: the control or variable that saves the status of AC Power. If the terminal is plugged in to the electrical power the value is 1 - Online, if the terminal isn't plugged in to the electrical power the value is 0 - Offline, otherwise the value is -1 - Unknow.
 

Battery Charge Status <unquoted string>: the control or variable that saves the status of the battery charge. Please see in the notes section the possible values for this parameter.

 

Remaining Battery (%) <unquoted string>: the control or variable that saves the value of the remaining battery in percentage. The value is "0%" to "100%" or "-1 - Unknow".

 

Remaining Battery (s) <unquoted string>: the control or variable that saves the value of the remaining battery in seconds. The value is "0 s" to "999999 s" or "-1 - Unknow".

 

Full Battery Seconds (s) <unquoted string>: the control or variable that saves the value of the full battery in seconds. The value is "0 s" to "999999 s" or "-1 - Unknow".

 
Voltage
 

Voltage (mV) <unquoted string>: the control or variable that saves the voltage of the battery. The possible values are from "0 mV" to "65,535 mV".

 

Current (mA) <unquoted string>: the control or variable that saves the current of the battery. The possible values are from "-32,768 mA" to "32,767 mA".

 

Average Current (mA) <unquoted string>: the control or variable that saves the average current of the battery. The possible values are from "-32,768 mA" to "32,767 mA".

 

Average Interval (ms) <unquoted string>: the control or variable that saves the time (in miliseconds) of integration used in reporting Average Current

 

Current Consumed (mAH) <unquoted string>: the control or variable that saves the power consumed by the battery. The possible values are from "-32,768 mAH" to "0 mAH".

 
Others

 

Temperature (ºC) <unquoted string>: the control or variable that saves the temperature of the battery. The possible value are from "-3,276.8 ºC" to "3,276.8 ºC".

 

Chemestry <unquoted string>: the control or variable that saves the chemistry of the battery.

 
Backup: the following parameters refer to the Backup Battery.

 

Battery Charge Status <unquoted string>: the control or variable that saves the status of the backup battery charge. Please see in the notes section the possible values for this parameter.

 

Remaining Battery (%) <unquoted string>: the control or variable that saves the value of the remaining backup battery in percentage. The value is "0%" to "100%" or "-1 - Unknow".

 

Remaining Battery (s) <unquoted string>: the control or variable that saves the value of the remaining backup battery in seconds. The value is "0 s" to "999999 s" or "-1 - Unknow".

 

Full Battery Seconds (s) <unquoted string>: the control or variable that saves the value of the full backup battery in seconds. The value is "0 s" to "999999 s" or "-1 - Unknow".

 

Voltage (mV) <unquoted string>: the control or variable that saves the voltage of the backup battery. The possible values are from "0 mV" to "65,535 mV".

     
  • The possible values for the parameter Battery Charge Status are:
    • 1- High.
    • 2 - Low.
    • 3 - Critical.
    • 4 - Charging.
    • 5 - Charging/High.
    • 6 - Charging/Low.
    • 7 - Charging/Critical.
    • 128 - No system battery.
    • -1 - Unknow status.

See also
Samples

 
 
Updated: 3/22/2018 3:05 PM