net.rim.device.api.system
Class DeviceInfo

java.lang.Object
  |
  +--net.rim.device.api.system.DeviceInfo

public final class DeviceInfo

extends Object

This class provides access to fundamental information about the host device.

Field Summary

static int	BSTAT_CHARGING Battery is charging.
static int	BSTAT_DEAD Battery at or below zero percent.
static int	BSTAT_IS_USING_EXTERNAL_POWER Device is connected to an external power source.
static int	BSTAT_LEVEL_CHANGED The level of the battery has changed, call getBatteryLevel() for detailed info on the Battery Level
static int	BSTAT_LOW Battery is low.
static int	BSTAT_LOW_RATE_CHARGING Battery is charging, but at a reduced rate.
static int	BSTAT_NO_RADIO Battery is too low for radio usage.
static int	BSTAT_NO_TURN_ON Battery is too low for device to turn on.
static int	BSTAT_NONE No battery.
static int	BSTAT_REVERSED Battery is inserted backwards.
static int	BSTAT_TOO_COLD Battery is too cold.
static int	BSTAT_TOO_HOT Battery is too hot.
static int	BSTAT_UNKNOWN_BATTERY Battery is not recognized by the firmware.

Method Summary

static int	getBatteryLevel() Retrieves the current battery level.
static int	getBatteryStatus() Retrieves the battery status.
static int	getBatteryTemperature() Retrieves battery's current temperature.
static int	getBatteryVoltage() Retrieves battery's current voltage.
static int	getDeviceId() Retrieves the PIN number for this device.
static String	getDeviceName() Retrieves this device's product name.
static long	getIdleTime() Retrieves the number of seconds since the last key or thumbwheel event.
static String	getManufacturerName() Retrieve the device manufacturer's name.
static int	getOSVersion() Deprecated. This function attempts to pack the String returned by getPlatformVersion() into the format specified above. If it is unsuccessful, it will return 0. Please use getPlatformVersion() instead.
static String	getPlatformVersion() Retrieves the platform version.
static boolean	isBatteryRemovable() Determines if this device has a removable battery.
static boolean	isInHolster() Determines if this device is in the holster.
boolean	isPasswordEnabled() Check if the password is currently enabled on the device.
static boolean	isSimulator() Determines if this device is really a simulator.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BSTAT_DEAD

public static final int BSTAT_DEAD

Battery at or below zero percent.

BSTAT_TOO_COLD

public static final int BSTAT_TOO_COLD

Battery is too cold.

BSTAT_TOO_HOT

public static final int BSTAT_TOO_HOT

Battery is too hot.

BSTAT_LOW

public static final int BSTAT_LOW

Battery is low.

BSTAT_NONE

public static final int BSTAT_NONE

No battery.

BSTAT_REVERSED

public static final int BSTAT_REVERSED

Battery is inserted backwards.

BSTAT_UNKNOWN_BATTERY

public static final int BSTAT_UNKNOWN_BATTERY

Battery is not recognized by the firmware.

Since:

JDE 4.0.0

BSTAT_NO_TURN_ON

public static final int BSTAT_NO_TURN_ON

Battery is too low for device to turn on.

BSTAT_NO_RADIO

public static final int BSTAT_NO_RADIO

Battery is too low for radio usage.

BSTAT_CHARGING

public static final int BSTAT_CHARGING

Battery is charging.

BSTAT_LOW_RATE_CHARGING

public static final int BSTAT_LOW_RATE_CHARGING

Battery is charging, but at a reduced rate. Typically this indicates that the device is connected to a PC that doesn't have the RIM USB driver installed.

Since:

JDE 4.0.0

BSTAT_IS_USING_EXTERNAL_POWER

public static final int BSTAT_IS_USING_EXTERNAL_POWER

Device is connected to an external power source.

Since:

JDE 3.6.0

BSTAT_LEVEL_CHANGED

public static final int BSTAT_LEVEL_CHANGED

The level of the battery has changed, call getBatteryLevel() for detailed info on the Battery Level

Since:

JDE 4.0.2

Method Detail

getDeviceId

public static int getDeviceId()

Retrieves the PIN number for this device.

This method will return the PIN number of a device or the default value of 0x21000000a if connected to the simulator. You can modify the default value associated with the simulator by using the RSIM command line option.

The RSIM command line option takes the form of: /RSIM=<PIN> where PIN is the integer value to be associated with the simulator.

Returns:

Unique ID (PIN) for this device.

getBatteryLevel

public static int getBatteryLevel()

Retrieves the current battery level.

Returns:

Percentage of maximum battery level remaining.

getBatteryStatus

public static int getBatteryStatus()

Retrieves the battery status.

Returns:

Combination of the BSTAT_xxx masks from this class.

isBatteryRemovable

public static boolean isBatteryRemovable()

Determines if this device has a removable battery.

Returns:

True if this device has removable battery.

getOSVersion

public static int getOSVersion()

Deprecated. This function attempts to pack the String returned by getPlatformVersion() into the format specified above. If it is unsuccessful, it will return 0. Please use getPlatformVersion() instead.

Retrieves the OS version.

Returns:

OS version in a 4 byte packet. You should interpret this value on a per-byte basis. Thus, read the returned integer 33557790 as 0x02 00 0D 1E in hex, which is 2.0.13.30 in decimal.

getPlatformVersion

public static String getPlatformVersion()

Retrieves the platform version.

Returns:

A string representing the platform version.

Since:

JDE 4.0.0

isInHolster

public static boolean isInHolster()

Determines if this device is in the holster.

Returns:

True if this device is in the holster; otherwise, false.

getIdleTime

public static long getIdleTime()

Retrieves the number of seconds since the last key or thumbwheel event.

Returns:

Seconds since last key or thumbwheel event.

isSimulator

public static boolean isSimulator()

Determines if this device is really a simulator.

Returns:

True if the code is running in the simulator; otherwise, false.

Since:

JDE 4.0.0

getDeviceName

public static String getDeviceName()

Retrieves this device's product name.

Returns:

This device's product name string.

Since:

JDE 4.0.0

getBatteryVoltage

public static int getBatteryVoltage()

Retrieves battery's current voltage.

Returns:

Current voltage (milliVolts) provided by battery.

Since:

JDE 4.0.0

getBatteryTemperature

public static int getBatteryTemperature()

Retrieves battery's current temperature.

Returns:

Approximate temperature (celsius) of battery.

Since:

JDE 4.0.0

isPasswordEnabled

public boolean isPasswordEnabled()

Check if the password is currently enabled on the device.

Since:

JDE 4.1.0

getManufacturerName

public static String getManufacturerName()

Retrieve the device manufacturer's name.

Returns:

The device manufacturer's name, or null if the name is not available.

Since:

JDE 4.1.0