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.

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.

Query Reset Information

le_info_GetResetInformation() is used to retrieve the last reset reason. For each reset reason, an information string is provided to specify the reset cause. These strings are listed in the table below. This list may be partially supported by some platforms.

Note: See platform constraints Information

Reset type	Information string	Description
LE_INFO_RESET_USER	"Reset, User Requested"	User requested the reboot
LE_INFO_RESET_HARD	"Reset, Hardware Switch"	Hardware switch pushed
LE_INFO_RESET_UPDATE	"Reset, Swap"	System Swap (dual platforms)
LE_INFO_RESET_UPDATE	"Reset, Swap_sync"	System Swap and synchronize (dual platforms)
LE_INFO_RESET_UPDATE	"Reset, Software Update"	Software Update
LE_INFO_RESET_UPDATE	"Reset, Configuration Update"	Reset caused by a configuration update
LE_INFO_RESET_UPDATE	"Reset, LWM2M Update"	Reset caused by a LWM2M update
LE_INFO_RESET_UPDATE	"Reset, OMA-DM Update"	Reset caused by a OMA-DM update
LE_INFO_RESET_UPDATE	"Reset, FOTA Update"	Reset caused by a FOTA update
LE_INFO_POWER_DOWN	"Reset, Crash"	Software crash
LE_INFO_POWER_DOWN	"Power Down"	Power source unplugged
LE_INFO_TEMP_CRIT	"Power Down, Critical Temp"	Power down due to a critical voltage level
LE_INFO_VOLT_CRIT	"Power Down, Critical Voltage"	Power down due to a ciritcal temperature level

le_info_GetExpectedResetsCount() returns the number of expected resets

Expected resets can be due to normal system shutdown/restart or a software update

le_info_GetUnexpectedResetsCount() return the number of unexpected resets

Unexpected resets can be due to software crash, a critical voltage level or a critical temperature level