Modem Information

API Reference


This file contains prototype definitions for Modem Information APIs.

IPC interfaces binding

All the functions of this API are provided by the modemService.

Here's a code sample binding to modem services:

bindings:
{
   clientExe.clientComponent.le_info -> modemService.le_info
}

Query Firmware Version

le_info_GetFirmwareVersion() is used to query the current firmware version. le_info_GetBootloaderVersion() is used to query the current bootloader version. In both cases, the version is returned as a human readable string.

The linux kernel version can be queried using standard linux methods, such as the uname command, or the uname() API.

Query Device information

le_info_GetDeviceModel() is used to retrieve the target hardware platform identity.

le_info_GetImei() is used to retrieve the International Mobile Equipment Identity (IMEI).

le_info_GetImeiSv() is used to retrieve the International Mobile Equipment Identity software version number(IMEISV).

le_info_GetMeid() is used to retrieve the CDMA device Mobile Equipment Identifier (MEID).

le_info_GetEsn() is used to retrieve Electronic Serial Number (ESN) of the device.

le_info_GetMdn() is used to retrieve the Mobile Directory Number (MDN) of the device.

le_info_GetMin() is used to retrieve the CDMA Mobile Identification Number (MIN).

le_info_GetPrlVersion() is used to retrieve the CDMA version of Preferred Roaming List (PRL).

le_info_GetPrlOnlyPreference() is used to retrieve the CDMA Preferred Roaming List (PRL) only preferences status.

le_info_GetNai() is used to retrieve the CDMA Network Access Identifier (NAI) string.

le_info_GetManufacturerName() is used to retrieve the Manufacturer name.

le_info_GetPriId() is used to retrieve the Product Requirement Information Identifier (PRI ID) Part Number and the Revision number. The Part number is a 7-digit string. Revision Number string contains 2-digit major version + '.' char + 2-digit minor version (xx.xx).

le_info_GetCarrierPri() is used to retrieve the Carrier Product Requirement Information (CAPRI) Name and the Revision number. Revision Number string is in major.minor_buildver format.

le_info_GetSku() is used to retrieve the product stock keeping unit number (SKU).

le_info_GetPlatformSerialNumber() is used to retrieve the Platform Serial Number (PSN) string.

le_info_GetRfDeviceStatus() is used to retrieve the RF devices working status (i.e. working or broken) of modem's RF devices such as power amplifier, antenna switch and transceiver. That status is updated every time the module power on.