le_info_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Macros
#define	LE_INFO_IMEI_MAX_LEN   15
#define	LE_INFO_MAX_VERS_LEN   256
#define	LE_INFO_MAX_MODEL_LEN   256

Functions
void	le_info_ConnectService (void)
void	le_info_DisconnectService (void)
le_result_t	le_info_GetImei (char *imei, size_t imeiNumElements)
le_result_t	le_info_GetFirmwareVersion (char *version, size_t versionNumElements)
le_result_t	le_info_GetBootloaderVersion (char *version, size_t versionNumElements)
le_result_t	le_info_GetDeviceModel (char *modelPtr, size_t modelPtrNumElements)

Detailed Description

Legato Modem Information include file.

Copyright (C) Sierra Wireless, Inc. 2014. Use of this work is subject to license.

Macro Definition Documentation

#define LE_INFO_IMEI_MAX_LEN   15

Maximum IMEI length (15 digits)

#define LE_INFO_MAX_MODEL_LEN   256

Maximum length of a model string

#define LE_INFO_MAX_VERS_LEN   256

Maximum length of a version string

Function Documentation

void le_info_ConnectService

(

void

)

Connect the client to the service

void le_info_DisconnectService

(

void

)

Disconnect the client from the service

le_result_t le_info_GetBootloaderVersion	(	char *	version,
		size_t	versionNumElements
	)

Get the bootloader version string

Returns

• LE_OK on success
• LE_NOT_FOUND if the version string is not available
• LE_NOT_POSSIBLE for any other errors

Parameters

[out]	version	Bootloader version string
[in]	versionNumElements

le_result_t le_info_GetDeviceModel	(	char *	modelPtr,
		size_t	modelPtrNumElements
	)

Get the device model identity (Target Hardware Platform).

Returns

• LE_OK The function succeeded.
• LE_FAULT The function failed to get the value.
• LE_OVERFLOW The device model identity length exceed the maximum length.

Parameters

[out]	modelPtr	The model identity string (null-terminated).
[in]	modelPtrNumElements

le_result_t le_info_GetFirmwareVersion	(	char *	version,
		size_t	versionNumElements
	)

Get the firmware version string

Returns

• LE_OK on success
• LE_NOT_FOUND if the version string is not available
• LE_NOT_POSSIBLE for any other errors

Parameters

[out]	version	Firmware version string
[in]	versionNumElements

le_result_t le_info_GetImei	(	char *	imei,
		size_t	imeiNumElements
	)

Retrieve the International Mobile Equipment Identity (IMEI).

Returns

LE_FAULT Function failed to retrieve the IMEI.

LE_OVERFLOW IMEI length exceed the maximum length.

LE_OK Function succeeded.

Note

If the caller passes a bad pointer into this function, it's a fatal error; the function will not return.

Parameters

[out]	imei	IMEI string.
[in]	imeiNumElements